Gitiles
Code Review Sign In
gerrit.nordix.org / onap / sdc / 2a473f639dd543d78d1f2c6ca439722dccebefd1 / . / docs / openapi / openapi-sdce-2-sdce-5.yaml
blob: 84427af781d6ca07533f378115f3fda964ef7d46 [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
213 responses:
214 "200":
215 description: allDataTypes
216 "400":
217 description: Invalid content / Missing content
218 "403":
219 description: Restricted operation
220 "404":
221 description: Data types not found
222 default:
223 content:
224 application/json:
225 schema:
226 type: array
227 items:
228 type: object
229 properties:
230 allowedMethods:
231 type: array
232 items:
233 type: string
234 uniqueItems: true
235 cookies:
236 type: object
237 additionalProperties:
238 type: object
239 properties:
240 comment:
241 type: string
242 domain:
243 type: string
244 expiry:
245 type: string
246 format: date-time
247 httpOnly:
248 type: boolean
249 maxAge:
250 type: integer
251 format: int32
252 name:
253 type: string
254 path:
255 type: string
256 secure:
257 type: boolean
258 value:
259 type: string
260 version:
261 type: integer
262 format: int32
263 date:
264 type: string
265 format: date-time
266 entity:
267 type: object
268 entityTag:
269 type: object
270 properties:
271 value:
272 type: string
273 weak:
274 type: boolean
275 headers:
276 type: object
277 additionalProperties:
278 type: array
279 items:
280 type: object
281 language:
282 type: object
283 properties:
284 country:
285 type: string
286 displayCountry:
287 type: string
288 displayLanguage:
289 type: string
290 displayName:
291 type: string
292 displayScript:
293 type: string
294 displayVariant:
295 type: string
296 extensionKeys:
297 type: array
298 items:
299 type: string
300 uniqueItems: true
301 iso3Country:
302 type: string
303 iso3Language:
304 type: string
305 language:
306 type: string
307 script:
308 type: string
309 unicodeLocaleAttributes:
310 type: array
311 items:
312 type: string
313 uniqueItems: true
314 unicodeLocaleKeys:
315 type: array
316 items:
317 type: string
318 uniqueItems: true
319 variant:
320 type: string
321 lastModified:
322 type: string
323 format: date-time
324 length:
325 type: integer
326 format: int32
327 links:
328 type: array
329 items:
330 type: object
331 properties:
332 params:
333 type: object
334 additionalProperties:
335 type: string
336 rel:
337 type: string
338 rels:
339 type: array
340 items:
341 type: string
342 title:
343 type: string
344 type:
345 type: string
346 uri:
347 type: string
348 format: uri
349 uriBuilder:
350 type: object
351 uniqueItems: true
352 location:
353 type: string
354 format: uri
355 mediaType:
356 type: object
357 properties:
358 parameters:
359 type: object
360 additionalProperties:
361 type: string
362 subtype:
363 type: string
364 type:
365 type: string
366 wildcardSubtype:
367 type: boolean
368 wildcardType:
369 type: boolean
370 metadata:
371 type: object
372 additionalProperties:
373 type: array
374 items:
375 type: object
376 status:
377 type: integer
378 format: int32
379 statusInfo:
380 type: object
381 properties:
382 family:
383 type: string
384 enum:
385 - INFORMATIONAL
386 - SUCCESSFUL
387 - REDIRECTION
388 - CLIENT_ERROR
389 - SERVER_ERROR
390 - OTHER
391 reasonPhrase:
392 type: string
393 statusCode:
394 type: integer
395 format: int32
396 stringHeaders:
397 type: object
398 additionalProperties:
399 type: array
400 items:
401 type: string
402 servers:
403 - url: /sdc2/rest
404 variables: {}
405 summary: Returns all data types from all models
406 tags:
407 - SDCE-2 APIs
408 /v1/catalog/archive:
409 get:
410 description: Get all Archived Components
411 operationId: getArchivedComponents
412 parameters:
413 - in: header
414 name: USER_ID
415 schema:
416 type: string
417 responses:
418 "200":
419 description: Success
420 "400":
421 description: Bad request
422 "403":
423 description: Restricted operation
424 "500":
425 description: Internal Error
426 default:
427 content:
428 application/json:
429 schema:
430 type: array
431 items:
432 type: string
433 servers:
434 - url: /sdc2/rest
435 variables: {}
436 summary: Get all Archived Components
437 tags:
438 - SDCE-2 APIs
439 /v1/catalog/artifactTypes:
440 get:
441 description: Get Tosca ArtifactTypes
442 operationId: getAllToscaArtifactTypes
443 parameters:
444 - description: Model name
445 in: query
446 name: model
447 schema:
448 type: string
449 - in: header
450 name: USER_ID
451 schema:
452 type: string
453 responses:
454 "200":
455 description: Listing successful
456 "400":
457 description: Invalid content / Missing content
458 "403":
459 description: Restricted operation
460 "404":
461 description: Tosca Artifact Types not found
462 default:
463 content:
464 '*/*':
465 schema:
466 type: array
467 items:
468 type: object
469 properties:
470 allowedMethods:
471 type: array
472 items:
473 type: string
474 uniqueItems: true
475 cookies:
476 type: object
477 additionalProperties:
478 type: object
479 properties:
480 comment:
481 type: string
482 domain:
483 type: string
484 expiry:
485 type: string
486 format: date-time
487 httpOnly:
488 type: boolean
489 maxAge:
490 type: integer
491 format: int32
492 name:
493 type: string
494 path:
495 type: string
496 secure:
497 type: boolean
498 value:
499 type: string
500 version:
501 type: integer
502 format: int32
503 date:
504 type: string
505 format: date-time
506 entity:
507 type: object
508 entityTag:
509 type: object
510 properties:
511 value:
512 type: string
513 weak:
514 type: boolean
515 headers:
516 type: object
517 additionalProperties:
518 type: array
519 items:
520 type: object
521 language:
522 type: object
523 properties:
524 country:
525 type: string
526 displayCountry:
527 type: string
528 displayLanguage:
529 type: string
530 displayName:
531 type: string
532 displayScript:
533 type: string
534 displayVariant:
535 type: string
536 extensionKeys:
537 type: array
538 items:
539 type: string
540 uniqueItems: true
541 iso3Country:
542 type: string
543 iso3Language:
544 type: string
545 language:
546 type: string
547 script:
548 type: string
549 unicodeLocaleAttributes:
550 type: array
551 items:
552 type: string
553 uniqueItems: true
554 unicodeLocaleKeys:
555 type: array
556 items:
557 type: string
558 uniqueItems: true
559 variant:
560 type: string
561 lastModified:
562 type: string
563 format: date-time
564 length:
565 type: integer
566 format: int32
567 links:
568 type: array
569 items:
570 type: object
571 properties:
572 params:
573 type: object
574 additionalProperties:
575 type: string
576 rel:
577 type: string
578 rels:
579 type: array
580 items:
581 type: string
582 title:
583 type: string
584 type:
585 type: string
586 uri:
587 type: string
588 format: uri
589 uriBuilder:
590 type: object
591 uniqueItems: true
592 location:
593 type: string
594 format: uri
595 mediaType:
596 type: object
597 properties:
598 parameters:
599 type: object
600 additionalProperties:
601 type: string
602 subtype:
603 type: string
604 type:
605 type: string
606 wildcardSubtype:
607 type: boolean
608 wildcardType:
609 type: boolean
610 metadata:
611 type: object
612 additionalProperties:
613 type: array
614 items:
615 type: object
616 status:
617 type: integer
618 format: int32
619 statusInfo:
620 type: object
621 properties:
622 family:
623 type: string
624 enum:
625 - INFORMATIONAL
626 - SUCCESSFUL
627 - REDIRECTION
628 - CLIENT_ERROR
629 - SERVER_ERROR
630 - OTHER
631 reasonPhrase:
632 type: string
633 statusCode:
634 type: integer
635 format: int32
636 stringHeaders:
637 type: object
638 additionalProperties:
639 type: array
640 items:
641 type: string
642 servers:
643 - url: /sdc2/rest
644 variables: {}
645 summary: Returns tosca artifact types
646 tags:
647 - SDCE-2 APIs
648 /v1/catalog/audit-records/{componentType}/{componentUniqueId}:
649 get:
650 description: get component audit records
651 operationId: getComponentAuditRecords
652 parameters:
653 - in: path
654 name: componentType
655 required: true
656 schema:
657 type: string
658 - in: path
659 name: componentUniqueId
660 required: true
661 schema:
662 type: string
663 - in: header
664 name: USER_ID
665 schema:
666 type: string
667 responses:
668 "200":
669 description: Service found
670 "403":
671 description: Restricted operation
672 default:
673 content:
674 application/json:
675 schema:
676 type: array
677 items:
678 type: object
679 properties:
680 allowedMethods:
681 type: array
682 items:
683 type: string
684 uniqueItems: true
685 cookies:
686 type: object
687 additionalProperties:
688 type: object
689 properties:
690 comment:
691 type: string
692 domain:
693 type: string
694 expiry:
695 type: string
696 format: date-time
697 httpOnly:
698 type: boolean
699 maxAge:
700 type: integer
701 format: int32
702 name:
703 type: string
704 path:
705 type: string
706 secure:
707 type: boolean
708 value:
709 type: string
710 version:
711 type: integer
712 format: int32
713 date:
714 type: string
715 format: date-time
716 entity:
717 type: object
718 entityTag:
719 type: object
720 properties:
721 value:
722 type: string
723 weak:
724 type: boolean
725 headers:
726 type: object
727 additionalProperties:
728 type: array
729 items:
730 type: object
731 language:
732 type: object
733 properties:
734 country:
735 type: string
736 displayCountry:
737 type: string
738 displayLanguage:
739 type: string
740 displayName:
741 type: string
742 displayScript:
743 type: string
744 displayVariant:
745 type: string
746 extensionKeys:
747 type: array
748 items:
749 type: string
750 uniqueItems: true
751 iso3Country:
752 type: string
753 iso3Language:
754 type: string
755 language:
756 type: string
757 script:
758 type: string
759 unicodeLocaleAttributes:
760 type: array
761 items:
762 type: string
763 uniqueItems: true
764 unicodeLocaleKeys:
765 type: array
766 items:
767 type: string
768 uniqueItems: true
769 variant:
770 type: string
771 lastModified:
772 type: string
773 format: date-time
774 length:
775 type: integer
776 format: int32
777 links:
778 type: array
779 items:
780 type: object
781 properties:
782 params:
783 type: object
784 additionalProperties:
785 type: string
786 rel:
787 type: string
788 rels:
789 type: array
790 items:
791 type: string
792 title:
793 type: string
794 type:
795 type: string
796 uri:
797 type: string
798 format: uri
799 uriBuilder:
800 type: object
801 uniqueItems: true
802 location:
803 type: string
804 format: uri
805 mediaType:
806 type: object
807 properties:
808 parameters:
809 type: object
810 additionalProperties:
811 type: string
812 subtype:
813 type: string
814 type:
815 type: string
816 wildcardSubtype:
817 type: boolean
818 wildcardType:
819 type: boolean
820 metadata:
821 type: object
822 additionalProperties:
823 type: array
824 items:
825 type: object
826 status:
827 type: integer
828 format: int32
829 statusInfo:
830 type: object
831 properties:
832 family:
833 type: string
834 enum:
835 - INFORMATIONAL
836 - SUCCESSFUL
837 - REDIRECTION
838 - CLIENT_ERROR
839 - SERVER_ERROR
840 - OTHER
841 reasonPhrase:
842 type: string
843 statusCode:
844 type: integer
845 format: int32
846 stringHeaders:
847 type: object
848 additionalProperties:
849 type: array
850 items:
851 type: string
852 servers:
853 - url: /sdc2/rest
854 variables: {}
855 summary: get audit records for a service or a resource
856 tags:
857 - SDCE-2 APIs
858 /v1/catalog/capabilityTypes:
859 get:
860 description: Get capability types
861 operationId: getAllCapabilityTypesServlet
862 parameters:
863 - in: header
864 name: USER_ID
865 schema:
866 type: string
867 - description: model
868 in: query
869 name: model
870 schema:
871 type: string
872 responses:
873 "200":
874 description: capabilityTypes
875 "400":
876 description: Invalid content / Missing content
877 "403":
878 description: Restricted operation
879 "404":
880 description: Capability types not found
881 default:
882 content:
883 application/json:
884 schema:
885 type: array
886 items:
887 type: object
888 properties:
889 allowedMethods:
890 type: array
891 items:
892 type: string
893 uniqueItems: true
894 cookies:
895 type: object
896 additionalProperties:
897 type: object
898 properties:
899 comment:
900 type: string
901 domain:
902 type: string
903 expiry:
904 type: string
905 format: date-time
906 httpOnly:
907 type: boolean
908 maxAge:
909 type: integer
910 format: int32
911 name:
912 type: string
913 path:
914 type: string
915 secure:
916 type: boolean
917 value:
918 type: string
919 version:
920 type: integer
921 format: int32
922 date:
923 type: string
924 format: date-time
925 entity:
926 type: object
927 entityTag:
928 type: object
929 properties:
930 value:
931 type: string
932 weak:
933 type: boolean
934 headers:
935 type: object
936 additionalProperties:
937 type: array
938 items:
939 type: object
940 language:
941 type: object
942 properties:
943 country:
944 type: string
945 displayCountry:
946 type: string
947 displayLanguage:
948 type: string
949 displayName:
950 type: string
951 displayScript:
952 type: string
953 displayVariant:
954 type: string
955 extensionKeys:
956 type: array
957 items:
958 type: string
959 uniqueItems: true
960 iso3Country:
961 type: string
962 iso3Language:
963 type: string
964 language:
965 type: string
966 script:
967 type: string
968 unicodeLocaleAttributes:
969 type: array
970 items:
971 type: string
972 uniqueItems: true
973 unicodeLocaleKeys:
974 type: array
975 items:
976 type: string
977 uniqueItems: true
978 variant:
979 type: string
980 lastModified:
981 type: string
982 format: date-time
983 length:
984 type: integer
985 format: int32
986 links:
987 type: array
988 items:
989 type: object
990 properties:
991 params:
992 type: object
993 additionalProperties:
994 type: string
995 rel:
996 type: string
997 rels:
998 type: array
999 items:
1000 type: string
1001 title:
1002 type: string
1003 type:
1004 type: string
1005 uri:
1006 type: string
1007 format: uri
1008 uriBuilder:
1009 type: object
1010 uniqueItems: true
1011 location:
1012 type: string
1013 format: uri
1014 mediaType:
1015 type: object
1016 properties:
1017 parameters:
1018 type: object
1019 additionalProperties:
1020 type: string
1021 subtype:
1022 type: string
1023 type:
1024 type: string
1025 wildcardSubtype:
1026 type: boolean
1027 wildcardType:
1028 type: boolean
1029 metadata:
1030 type: object
1031 additionalProperties:
1032 type: array
1033 items:
1034 type: object
1035 status:
1036 type: integer
1037 format: int32
1038 statusInfo:
1039 type: object
1040 properties:
1041 family:
1042 type: string
1043 enum:
1044 - INFORMATIONAL
1045 - SUCCESSFUL
1046 - REDIRECTION
1047 - CLIENT_ERROR
1048 - SERVER_ERROR
1049 - OTHER
1050 reasonPhrase:
1051 type: string
1052 statusCode:
1053 type: integer
1054 format: int32
1055 stringHeaders:
1056 type: object
1057 additionalProperties:
1058 type: array
1059 items:
1060 type: string
1061 servers:
1062 - url: /sdc2/rest
1063 variables: {}
1064 summary: Returns capability types
1065 tags:
1066 - SDCE-2 APIs
1067 /v1/catalog/data-types/{dataTypeUid}:
1068 get:
1069 description: Get data types
1070 operationId: fetchDataType
1071 parameters:
1072 - in: header
1073 name: USER_ID
1074 schema:
1075 type: string
1076 - in: path
1077 name: dataTypeUid
1078 required: true
1079 schema:
1080 type: string
1081 responses:
1082 "200":
1083 description: Data type found
1084 "400":
1085 description: Invalid content / Missing content
1086 "403":
1087 description: Restricted operation
1088 "404":
1089 description: Data types not found
1090 default:
1091 content:
1092 application/json:
1093 schema:
1094 $ref: '#/components/schemas/DataTypeDataDefinition'
1095 servers:
1096 - url: /sdc2/rest
1097 variables: {}
1098 summary: Returns data types
1099 tags:
1100 - SDCE-2 APIs
1101 /v1/catalog/data-types/{id}/properties:
1102 get:
1103 description: Get a data type properties
1104 operationId: fetchProperties
1105 parameters:
1106 - description: The data type id
1107 in: path
1108 name: id
1109 required: true
1110 schema:
1111 type: string
1112 responses:
1113 "200":
1114 description: "Data type found, properties may be empty"
1115 "403":
1116 description: Restricted operation
1117 "404":
1118 description: Data type not found
1119 default:
1120 content:
1121 application/json:
1122 schema:
1123 type: array
1124 items:
1125 $ref: '#/components/schemas/PropertyDefinition'
1126 servers:
1127 - url: /sdc2/rest
1128 variables: {}
1129 summary: Returns the data type properties
1130 tags:
1131 - SDCE-2 APIs
1132 post:
1133 description: Create a property in the given data type
1134 operationId: createProperty
1135 parameters:
1136 - description: The data type id
1137 in: path
1138 name: id
1139 required: true
1140 schema:
1141 type: string
1142 requestBody:
1143 content:
1144 application/json:
1145 schema:
1146 $ref: '#/components/schemas/PropertyDefinitionDto'
1147 description: Property to add
1148 required: true
1149 responses:
1150 "201":
1151 description: Property created in the data type
1152 "400":
1153 description: Invalid payload
1154 "403":
1155 description: Restricted operation
1156 "404":
1157 description: Data type not found
1158 "409":
1159 description: Property already exists in the data type
1160 default:
1161 content:
1162 application/json:
1163 schema:
1164 $ref: '#/components/schemas/PropertyDefinitionDto'
1165 servers:
1166 - url: /sdc2/rest
1167 variables: {}
1168 summary: Create a property in the given data type
1169 tags:
1170 - SDCE-2 APIs
1171 /v1/catalog/dataTypes:
1172 get:
1173 description: Get data types
1174 operationId: getAllDataTypesServlet
1175 parameters:
1176 - in: header
1177 name: USER_ID
1178 schema:
1179 type: string
1180 - description: model
1181 in: query
1182 name: model
1183 schema:
1184 type: string
1185 responses:
1186 "200":
1187 description: datatypes
1188 "400":
1189 description: Invalid content / Missing content
1190 "403":
1191 description: Restricted operation
1192 "404":
1193 description: Data types not found
1194 default:
1195 content:
1196 application/json:
1197 schema:
1198 type: array
1199 items:
1200 type: object
1201 properties:
1202 allowedMethods:
1203 type: array
1204 items:
1205 type: string
1206 uniqueItems: true
1207 cookies:
1208 type: object
1209 additionalProperties:
1210 type: object
1211 properties:
1212 comment:
1213 type: string
1214 domain:
1215 type: string
1216 expiry:
1217 type: string
1218 format: date-time
1219 httpOnly:
1220 type: boolean
1221 maxAge:
1222 type: integer
1223 format: int32
1224 name:
1225 type: string
1226 path:
1227 type: string
1228 secure:
1229 type: boolean
1230 value:
1231 type: string
1232 version:
1233 type: integer
1234 format: int32
1235 date:
1236 type: string
1237 format: date-time
1238 entity:
1239 type: object
1240 entityTag:
1241 type: object
1242 properties:
1243 value:
1244 type: string
1245 weak:
1246 type: boolean
1247 headers:
1248 type: object
1249 additionalProperties:
1250 type: array
1251 items:
1252 type: object
1253 language:
1254 type: object
1255 properties:
1256 country:
1257 type: string
1258 displayCountry:
1259 type: string
1260 displayLanguage:
1261 type: string
1262 displayName:
1263 type: string
1264 displayScript:
1265 type: string
1266 displayVariant:
1267 type: string
1268 extensionKeys:
1269 type: array
1270 items:
1271 type: string
1272 uniqueItems: true
1273 iso3Country:
1274 type: string
1275 iso3Language:
1276 type: string
1277 language:
1278 type: string
1279 script:
1280 type: string
1281 unicodeLocaleAttributes:
1282 type: array
1283 items:
1284 type: string
1285 uniqueItems: true
1286 unicodeLocaleKeys:
1287 type: array
1288 items:
1289 type: string
1290 uniqueItems: true
1291 variant:
1292 type: string
1293 lastModified:
1294 type: string
1295 format: date-time
1296 length:
1297 type: integer
1298 format: int32
1299 links:
1300 type: array
1301 items:
1302 type: object
1303 properties:
1304 params:
1305 type: object
1306 additionalProperties:
1307 type: string
1308 rel:
1309 type: string
1310 rels:
1311 type: array
1312 items:
1313 type: string
1314 title:
1315 type: string
1316 type:
1317 type: string
1318 uri:
1319 type: string
1320 format: uri
1321 uriBuilder:
1322 type: object
1323 uniqueItems: true
1324 location:
1325 type: string
1326 format: uri
1327 mediaType:
1328 type: object
1329 properties:
1330 parameters:
1331 type: object
1332 additionalProperties:
1333 type: string
1334 subtype:
1335 type: string
1336 type:
1337 type: string
1338 wildcardSubtype:
1339 type: boolean
1340 wildcardType:
1341 type: boolean
1342 metadata:
1343 type: object
1344 additionalProperties:
1345 type: array
1346 items:
1347 type: object
1348 status:
1349 type: integer
1350 format: int32
1351 statusInfo:
1352 type: object
1353 properties:
1354 family:
1355 type: string
1356 enum:
1357 - INFORMATIONAL
1358 - SUCCESSFUL
1359 - REDIRECTION
1360 - CLIENT_ERROR
1361 - SERVER_ERROR
1362 - OTHER
1363 reasonPhrase:
1364 type: string
1365 statusCode:
1366 type: integer
1367 format: int32
1368 stringHeaders:
1369 type: object
1370 additionalProperties:
1371 type: array
1372 items:
1373 type: string
1374 servers:
1375 - url: /sdc2/rest
1376 variables: {}
1377 summary: Returns data types
1378 tags:
1379 - SDCE-2 APIs
1380 /v1/catalog/directives:
1381 get:
1382 description: Retrieve all Directives values from configuration file
1383 operationId: getConfCategoriesAndVersion
1384 parameters:
1385 - in: header
1386 name: USER_ID
1387 schema:
1388 type: string
1389 responses:
1390 "200":
1391 description: Returns Directive values from configuration file Ok
1392 "404":
1393 description: Directive not found
1394 "500":
1395 description: Internal Server Error
1396 default:
1397 content:
1398 application/json:
1399 schema:
1400 type: array
1401 items:
1402 $ref: '#/components/schemas/User'
1403 summary: Retrieve all Directives
1404 tags:
1405 - SDCE-2 APIs
1406 /v1/catalog/gab/searchFor:
1407 post:
1408 description: Search json paths inside the yaml
1409 operationId: searchFor
1410 requestBody:
1411 content:
1412 application/json:
1413 schema:
1414 $ref: '#/components/schemas/GenericArtifactQueryInfo'
1415 description: Generic Artifact search model
1416 required: true
1417 responses:
1418 "200":
1419 description: Returned yaml entries
1420 "400":
1421 description: Invalid content / Missing content
1422 default:
1423 content:
1424 application/json:
1425 schema:
1426 type: array
1427 items:
1428 type: object
1429 properties:
1430 allowedMethods:
1431 type: array
1432 items:
1433 type: string
1434 uniqueItems: true
1435 cookies:
1436 type: object
1437 additionalProperties:
1438 type: object
1439 properties:
1440 comment:
1441 type: string
1442 domain:
1443 type: string
1444 expiry:
1445 type: string
1446 format: date-time
1447 httpOnly:
1448 type: boolean
1449 maxAge:
1450 type: integer
1451 format: int32
1452 name:
1453 type: string
1454 path:
1455 type: string
1456 secure:
1457 type: boolean
1458 value:
1459 type: string
1460 version:
1461 type: integer
1462 format: int32
1463 date:
1464 type: string
1465 format: date-time
1466 entity:
1467 type: object
1468 entityTag:
1469 type: object
1470 properties:
1471 value:
1472 type: string
1473 weak:
1474 type: boolean
1475 headers:
1476 type: object
1477 additionalProperties:
1478 type: array
1479 items:
1480 type: object
1481 language:
1482 type: object
1483 properties:
1484 country:
1485 type: string
1486 displayCountry:
1487 type: string
1488 displayLanguage:
1489 type: string
1490 displayName:
1491 type: string
1492 displayScript:
1493 type: string
1494 displayVariant:
1495 type: string
1496 extensionKeys:
1497 type: array
1498 items:
1499 type: string
1500 uniqueItems: true
1501 iso3Country:
1502 type: string
1503 iso3Language:
1504 type: string
1505 language:
1506 type: string
1507 script:
1508 type: string
1509 unicodeLocaleAttributes:
1510 type: array
1511 items:
1512 type: string
1513 uniqueItems: true
1514 unicodeLocaleKeys:
1515 type: array
1516 items:
1517 type: string
1518 uniqueItems: true
1519 variant:
1520 type: string
1521 lastModified:
1522 type: string
1523 format: date-time
1524 length:
1525 type: integer
1526 format: int32
1527 links:
1528 type: array
1529 items:
1530 type: object
1531 properties:
1532 params:
1533 type: object
1534 additionalProperties:
1535 type: string
1536 rel:
1537 type: string
1538 rels:
1539 type: array
1540 items:
1541 type: string
1542 title:
1543 type: string
1544 type:
1545 type: string
1546 uri:
1547 type: string
1548 format: uri
1549 uriBuilder:
1550 type: object
1551 uniqueItems: true
1552 location:
1553 type: string
1554 format: uri
1555 mediaType:
1556 type: object
1557 properties:
1558 parameters:
1559 type: object
1560 additionalProperties:
1561 type: string
1562 subtype:
1563 type: string
1564 type:
1565 type: string
1566 wildcardSubtype:
1567 type: boolean
1568 wildcardType:
1569 type: boolean
1570 metadata:
1571 type: object
1572 additionalProperties:
1573 type: array
1574 items:
1575 type: object
1576 status:
1577 type: integer
1578 format: int32
1579 statusInfo:
1580 type: object
1581 properties:
1582 family:
1583 type: string
1584 enum:
1585 - INFORMATIONAL
1586 - SUCCESSFUL
1587 - REDIRECTION
1588 - CLIENT_ERROR
1589 - SERVER_ERROR
1590 - OTHER
1591 reasonPhrase:
1592 type: string
1593 statusCode:
1594 type: integer
1595 format: int32
1596 stringHeaders:
1597 type: object
1598 additionalProperties:
1599 type: array
1600 items:
1601 type: string
1602 servers:
1603 - url: /sdc2/rest
1604 variables: {}
1605 summary: Returns found entries of json paths
1606 tags:
1607 - SDCE-2 APIs
1608 /v1/catalog/groupTypes:
1609 get:
1610 description: 'Get group types '
1611 operationId: getGroupTypes
1612 parameters:
1613 - in: header
1614 name: USER_ID
1615 schema:
1616 type: string
1617 - description: An optional parameter to indicate the type of the container from
1618 where this call is executed
1619 in: query
1620 name: internalComponentType
1621 schema:
1622 type: string
1623 - in: query
1624 name: componentModel
1625 schema:
1626 type: string
1627 responses:
1628 "200":
1629 description: group types found
1630 "400":
1631 description: "field name invalid type/length, characters; mandatory field\
1632 \ is absent, already exists (name)"
1633 "403":
1634 description: Restricted operation
1635 "500":
1636 description: Internal Error
1637 default:
1638 content:
1639 application/json:
1640 schema:
1641 type: array
1642 items:
1643 $ref: '#/components/schemas/GroupTypeDefinition'
1644 servers:
1645 - url: /sdc2/rest
1646 variables: {}
1647 summary: Returns group types
1648 tags:
1649 - SDCE-2 APIs
1650 /v1/catalog/handleException:
1651 get:
1652 description: Handle exception
1653 operationId: sendError
1654 responses:
1655 "500":
1656 content:
1657 application/json:
1658 schema:
1659 type: object
1660 properties:
1661 allowedMethods:
1662 type: array
1663 items:
1664 type: string
1665 uniqueItems: true
1666 cookies:
1667 type: object
1668 additionalProperties:
1669 type: object
1670 properties:
1671 comment:
1672 type: string
1673 domain:
1674 type: string
1675 expiry:
1676 type: string
1677 format: date-time
1678 httpOnly:
1679 type: boolean
1680 maxAge:
1681 type: integer
1682 format: int32
1683 name:
1684 type: string
1685 path:
1686 type: string
1687 secure:
1688 type: boolean
1689 value:
1690 type: string
1691 version:
1692 type: integer
1693 format: int32
1694 date:
1695 type: string
1696 format: date-time
1697 entity:
1698 type: object
1699 entityTag:
1700 type: object
1701 properties:
1702 value:
1703 type: string
1704 weak:
1705 type: boolean
1706 headers:
1707 type: object
1708 additionalProperties:
1709 type: array
1710 items:
1711 type: object
1712 language:
1713 type: object
1714 properties:
1715 country:
1716 type: string
1717 displayCountry:
1718 type: string
1719 displayLanguage:
1720 type: string
1721 displayName:
1722 type: string
1723 displayScript:
1724 type: string
1725 displayVariant:
1726 type: string
1727 extensionKeys:
1728 type: array
1729 items:
1730 type: string
1731 uniqueItems: true
1732 iso3Country:
1733 type: string
1734 iso3Language:
1735 type: string
1736 language:
1737 type: string
1738 script:
1739 type: string
1740 unicodeLocaleAttributes:
1741 type: array
1742 items:
1743 type: string
1744 uniqueItems: true
1745 unicodeLocaleKeys:
1746 type: array
1747 items:
1748 type: string
1749 uniqueItems: true
1750 variant:
1751 type: string
1752 lastModified:
1753 type: string
1754 format: date-time
1755 length:
1756 type: integer
1757 format: int32
1758 links:
1759 type: array
1760 items:
1761 type: object
1762 properties:
1763 params:
1764 type: object
1765 additionalProperties:
1766 type: string
1767 rel:
1768 type: string
1769 rels:
1770 type: array
1771 items:
1772 type: string
1773 title:
1774 type: string
1775 type:
1776 type: string
1777 uri:
1778 type: string
1779 format: uri
1780 uriBuilder:
1781 type: object
1782 uniqueItems: true
1783 location:
1784 type: string
1785 format: uri
1786 mediaType:
1787 type: object
1788 properties:
1789 parameters:
1790 type: object
1791 additionalProperties:
1792 type: string
1793 subtype:
1794 type: string
1795 type:
1796 type: string
1797 wildcardSubtype:
1798 type: boolean
1799 wildcardType:
1800 type: boolean
1801 metadata:
1802 type: object
1803 additionalProperties:
1804 type: array
1805 items:
1806 type: object
1807 status:
1808 type: integer
1809 format: int32
1810 statusInfo:
1811 type: object
1812 properties:
1813 family:
1814 type: string
1815 enum:
1816 - INFORMATIONAL
1817 - SUCCESSFUL
1818 - REDIRECTION
1819 - CLIENT_ERROR
1820 - SERVER_ERROR
1821 - OTHER
1822 reasonPhrase:
1823 type: string
1824 statusCode:
1825 type: integer
1826 format: int32
1827 stringHeaders:
1828 type: object
1829 additionalProperties:
1830 type: array
1831 items:
1832 type: string
1833 description: Internal Error
1834 servers:
1835 - url: /sdc2/rest
1836 variables: {}
1837 tags:
1838 - SDCE-2 APIs
1839 /v1/catalog/interfaceLifecycleTypes:
1840 get:
1841 description: Get interface lifecycle types
1842 operationId: getInterfaceLifecycleTypes
1843 parameters:
1844 - in: header
1845 name: USER_ID
1846 schema:
1847 type: string
1848 - description: model
1849 in: query
1850 name: model
1851 schema:
1852 type: string
1853 responses:
1854 "200":
1855 description: Interface lifecycle types
1856 "400":
1857 description: Invalid content / Missing content
1858 "403":
1859 description: Restricted operation
1860 "404":
1861 description: Interface lifecycle types not found
1862 default:
1863 content:
1864 application/json:
1865 schema:
1866 type: array
1867 items:
1868 type: object
1869 properties:
1870 allowedMethods:
1871 type: array
1872 items:
1873 type: string
1874 uniqueItems: true
1875 cookies:
1876 type: object
1877 additionalProperties:
1878 type: object
1879 properties:
1880 comment:
1881 type: string
1882 domain:
1883 type: string
1884 expiry:
1885 type: string
1886 format: date-time
1887 httpOnly:
1888 type: boolean
1889 maxAge:
1890 type: integer
1891 format: int32
1892 name:
1893 type: string
1894 path:
1895 type: string
1896 secure:
1897 type: boolean
1898 value:
1899 type: string
1900 version:
1901 type: integer
1902 format: int32
1903 date:
1904 type: string
1905 format: date-time
1906 entity:
1907 type: object
1908 entityTag:
1909 type: object
1910 properties:
1911 value:
1912 type: string
1913 weak:
1914 type: boolean
1915 headers:
1916 type: object
1917 additionalProperties:
1918 type: array
1919 items:
1920 type: object
1921 language:
1922 type: object
1923 properties:
1924 country:
1925 type: string
1926 displayCountry:
1927 type: string
1928 displayLanguage:
1929 type: string
1930 displayName:
1931 type: string
1932 displayScript:
1933 type: string
1934 displayVariant:
1935 type: string
1936 extensionKeys:
1937 type: array
1938 items:
1939 type: string
1940 uniqueItems: true
1941 iso3Country:
1942 type: string
1943 iso3Language:
1944 type: string
1945 language:
1946 type: string
1947 script:
1948 type: string
1949 unicodeLocaleAttributes:
1950 type: array
1951 items:
1952 type: string
1953 uniqueItems: true
1954 unicodeLocaleKeys:
1955 type: array
1956 items:
1957 type: string
1958 uniqueItems: true
1959 variant:
1960 type: string
1961 lastModified:
1962 type: string
1963 format: date-time
1964 length:
1965 type: integer
1966 format: int32
1967 links:
1968 type: array
1969 items:
1970 type: object
1971 properties:
1972 params:
1973 type: object
1974 additionalProperties:
1975 type: string
1976 rel:
1977 type: string
1978 rels:
1979 type: array
1980 items:
1981 type: string
1982 title:
1983 type: string
1984 type:
1985 type: string
1986 uri:
1987 type: string
1988 format: uri
1989 uriBuilder:
1990 type: object
1991 uniqueItems: true
1992 location:
1993 type: string
1994 format: uri
1995 mediaType:
1996 type: object
1997 properties:
1998 parameters:
1999 type: object
2000 additionalProperties:
2001 type: string
2002 subtype:
2003 type: string
2004 type:
2005 type: string
2006 wildcardSubtype:
2007 type: boolean
2008 wildcardType:
2009 type: boolean
2010 metadata:
2011 type: object
2012 additionalProperties:
2013 type: array
2014 items:
2015 type: object
2016 status:
2017 type: integer
2018 format: int32
2019 statusInfo:
2020 type: object
2021 properties:
2022 family:
2023 type: string
2024 enum:
2025 - INFORMATIONAL
2026 - SUCCESSFUL
2027 - REDIRECTION
2028 - CLIENT_ERROR
2029 - SERVER_ERROR
2030 - OTHER
2031 reasonPhrase:
2032 type: string
2033 statusCode:
2034 type: integer
2035 format: int32
2036 stringHeaders:
2037 type: object
2038 additionalProperties:
2039 type: array
2040 items:
2041 type: string
2042 servers:
2043 - url: /sdc2/rest
2044 variables: {}
2045 summary: Returns interface lifecycle types
2046 tags:
2047 - SDCE-2 APIs
2048 /v1/catalog/lock:
2049 post:
2050 description: Toggle disable locking
2051 operationId: toggleDisableLocking
2052 parameters:
2053 - in: header
2054 name: USER_ID
2055 schema:
2056 type: string
2057 requestBody:
2058 content:
2059 application/json:
2060 schema:
2061 type: boolean
2062 description: Disable Locking
2063 responses:
2064 "200":
2065 description: Disable locking successfully updated
2066 "500":
2067 description: Update disable locking failed
2068 default:
2069 content:
2070 application/json:
2071 schema:
2072 type: object
2073 properties:
2074 allowedMethods:
2075 type: array
2076 items:
2077 type: string
2078 uniqueItems: true
2079 cookies:
2080 type: object
2081 additionalProperties:
2082 type: object
2083 properties:
2084 comment:
2085 type: string
2086 domain:
2087 type: string
2088 expiry:
2089 type: string
2090 format: date-time
2091 httpOnly:
2092 type: boolean
2093 maxAge:
2094 type: integer
2095 format: int32
2096 name:
2097 type: string
2098 path:
2099 type: string
2100 secure:
2101 type: boolean
2102 value:
2103 type: string
2104 version:
2105 type: integer
2106 format: int32
2107 date:
2108 type: string
2109 format: date-time
2110 entity:
2111 type: object
2112 entityTag:
2113 type: object
2114 properties:
2115 value:
2116 type: string
2117 weak:
2118 type: boolean
2119 headers:
2120 type: object
2121 additionalProperties:
2122 type: array
2123 items:
2124 type: object
2125 language:
2126 type: object
2127 properties:
2128 country:
2129 type: string
2130 displayCountry:
2131 type: string
2132 displayLanguage:
2133 type: string
2134 displayName:
2135 type: string
2136 displayScript:
2137 type: string
2138 displayVariant:
2139 type: string
2140 extensionKeys:
2141 type: array
2142 items:
2143 type: string
2144 uniqueItems: true
2145 iso3Country:
2146 type: string
2147 iso3Language:
2148 type: string
2149 language:
2150 type: string
2151 script:
2152 type: string
2153 unicodeLocaleAttributes:
2154 type: array
2155 items:
2156 type: string
2157 uniqueItems: true
2158 unicodeLocaleKeys:
2159 type: array
2160 items:
2161 type: string
2162 uniqueItems: true
2163 variant:
2164 type: string
2165 lastModified:
2166 type: string
2167 format: date-time
2168 length:
2169 type: integer
2170 format: int32
2171 links:
2172 type: array
2173 items:
2174 type: object
2175 properties:
2176 params:
2177 type: object
2178 additionalProperties:
2179 type: string
2180 rel:
2181 type: string
2182 rels:
2183 type: array
2184 items:
2185 type: string
2186 title:
2187 type: string
2188 type:
2189 type: string
2190 uri:
2191 type: string
2192 format: uri
2193 uriBuilder:
2194 type: object
2195 uniqueItems: true
2196 location:
2197 type: string
2198 format: uri
2199 mediaType:
2200 type: object
2201 properties:
2202 parameters:
2203 type: object
2204 additionalProperties:
2205 type: string
2206 subtype:
2207 type: string
2208 type:
2209 type: string
2210 wildcardSubtype:
2211 type: boolean
2212 wildcardType:
2213 type: boolean
2214 metadata:
2215 type: object
2216 additionalProperties:
2217 type: array
2218 items:
2219 type: object
2220 status:
2221 type: integer
2222 format: int32
2223 statusInfo:
2224 type: object
2225 properties:
2226 family:
2227 type: string
2228 enum:
2229 - INFORMATIONAL
2230 - SUCCESSFUL
2231 - REDIRECTION
2232 - CLIENT_ERROR
2233 - SERVER_ERROR
2234 - OTHER
2235 reasonPhrase:
2236 type: string
2237 statusCode:
2238 type: integer
2239 format: int32
2240 stringHeaders:
2241 type: object
2242 additionalProperties:
2243 type: array
2244 items:
2245 type: string
2246 servers:
2247 - url: /sdc2/rest
2248 variables: {}
2249 tags:
2250 - SDCE-2 APIs
2251 /v1/catalog/model:
2252 get:
2253 description: List all the existing TOSCA models
2254 operationId: listModels
2255 parameters:
2256 - in: header
2257 name: USER_ID
2258 schema:
2259 type: string
2260 - in: query
2261 name: modelType
2262 schema:
2263 type: string
2264 responses:
2265 "200":
2266 description: Listing successful
2267 "403":
2268 description: Restricted operation
2269 default:
2270 content:
2271 application/json:
2272 schema:
2273 type: array
2274 items:
2275 $ref: '#/components/schemas/Model'
2276 servers:
2277 - url: /sdc2/rest
2278 variables: {}
2279 summary: List TOSCA models
2280 tags:
2281 - SDCE-2 APIs
2282 post:
2283 description: "Create a TOSCA model, along with its imports files"
2284 operationId: createModel
2285 parameters:
2286 - in: header
2287 name: USER_ID
2288 schema:
2289 type: string
2290 requestBody:
2291 content:
2292 multipart/form-data:
2293 schema:
2294 type: object
2295 properties:
2296 model:
2297 $ref: '#/components/schemas/ModelCreateRequest'
2298 modelImportsZip:
2299 type: object
2300 description: the model TOSCA imports zipped
2301 required:
2302 - model
2303 - modelImportsZip
2304 responses:
2305 "201":
2306 description: Model created
2307 "400":
2308 description: Invalid content / Missing content
2309 "403":
2310 description: Restricted operation
2311 "409":
2312 description: Model already exists
2313 default:
2314 content:
2315 application/json:
2316 schema:
2317 type: array
2318 items:
2319 type: object
2320 properties:
2321 allowedMethods:
2322 type: array
2323 items:
2324 type: string
2325 uniqueItems: true
2326 cookies:
2327 type: object
2328 additionalProperties:
2329 type: object
2330 properties:
2331 comment:
2332 type: string
2333 domain:
2334 type: string
2335 expiry:
2336 type: string
2337 format: date-time
2338 httpOnly:
2339 type: boolean
2340 maxAge:
2341 type: integer
2342 format: int32
2343 name:
2344 type: string
2345 path:
2346 type: string
2347 secure:
2348 type: boolean
2349 value:
2350 type: string
2351 version:
2352 type: integer
2353 format: int32
2354 date:
2355 type: string
2356 format: date-time
2357 entity:
2358 type: object
2359 entityTag:
2360 type: object
2361 properties:
2362 value:
2363 type: string
2364 weak:
2365 type: boolean
2366 headers:
2367 type: object
2368 additionalProperties:
2369 type: array
2370 items:
2371 type: object
2372 language:
2373 type: object
2374 properties:
2375 country:
2376 type: string
2377 displayCountry:
2378 type: string
2379 displayLanguage:
2380 type: string
2381 displayName:
2382 type: string
2383 displayScript:
2384 type: string
2385 displayVariant:
2386 type: string
2387 extensionKeys:
2388 type: array
2389 items:
2390 type: string
2391 uniqueItems: true
2392 iso3Country:
2393 type: string
2394 iso3Language:
2395 type: string
2396 language:
2397 type: string
2398 script:
2399 type: string
2400 unicodeLocaleAttributes:
2401 type: array
2402 items:
2403 type: string
2404 uniqueItems: true
2405 unicodeLocaleKeys:
2406 type: array
2407 items:
2408 type: string
2409 uniqueItems: true
2410 variant:
2411 type: string
2412 lastModified:
2413 type: string
2414 format: date-time
2415 length:
2416 type: integer
2417 format: int32
2418 links:
2419 type: array
2420 items:
2421 type: object
2422 properties:
2423 params:
2424 type: object
2425 additionalProperties:
2426 type: string
2427 rel:
2428 type: string
2429 rels:
2430 type: array
2431 items:
2432 type: string
2433 title:
2434 type: string
2435 type:
2436 type: string
2437 uri:
2438 type: string
2439 format: uri
2440 uriBuilder:
2441 type: object
2442 uniqueItems: true
2443 location:
2444 type: string
2445 format: uri
2446 mediaType:
2447 type: object
2448 properties:
2449 parameters:
2450 type: object
2451 additionalProperties:
2452 type: string
2453 subtype:
2454 type: string
2455 type:
2456 type: string
2457 wildcardSubtype:
2458 type: boolean
2459 wildcardType:
2460 type: boolean
2461 metadata:
2462 type: object
2463 additionalProperties:
2464 type: array
2465 items:
2466 type: object
2467 status:
2468 type: integer
2469 format: int32
2470 statusInfo:
2471 type: object
2472 properties:
2473 family:
2474 type: string
2475 enum:
2476 - INFORMATIONAL
2477 - SUCCESSFUL
2478 - REDIRECTION
2479 - CLIENT_ERROR
2480 - SERVER_ERROR
2481 - OTHER
2482 reasonPhrase:
2483 type: string
2484 statusCode:
2485 type: integer
2486 format: int32
2487 stringHeaders:
2488 type: object
2489 additionalProperties:
2490 type: array
2491 items:
2492 type: string
2493 servers:
2494 - url: /sdc2/rest
2495 variables: {}
2496 summary: Create a TOSCA model
2497 tags:
2498 - SDCE-2 APIs
2499 /v1/catalog/model/imports:
2500 put:
2501 description: Update a model TOSCA imports
2502 operationId: updateModelImports
2503 parameters:
2504 - in: header
2505 name: USER_ID
2506 schema:
2507 type: string
2508 requestBody:
2509 content:
2510 multipart/form-data:
2511 schema:
2512 type: object
2513 properties:
2514 modelImportsZip:
2515 type: object
2516 description: the model TOSCA imports zipped
2517 modelName:
2518 type: string
2519 description: model to be created
2520 required:
2521 - modelImportsZip
2522 - modelName
2523 responses:
2524 "204":
2525 description: Model imports updated
2526 "400":
2527 description: Invalid content / Missing content
2528 "403":
2529 description: Restricted operation
2530 "404":
2531 description: Model not found
2532 default:
2533 content:
2534 application/json:
2535 schema:
2536 type: array
2537 items:
2538 type: object
2539 properties:
2540 allowedMethods:
2541 type: array
2542 items:
2543 type: string
2544 uniqueItems: true
2545 cookies:
2546 type: object
2547 additionalProperties:
2548 type: object
2549 properties:
2550 comment:
2551 type: string
2552 domain:
2553 type: string
2554 expiry:
2555 type: string
2556 format: date-time
2557 httpOnly:
2558 type: boolean
2559 maxAge:
2560 type: integer
2561 format: int32
2562 name:
2563 type: string
2564 path:
2565 type: string
2566 secure:
2567 type: boolean
2568 value:
2569 type: string
2570 version:
2571 type: integer
2572 format: int32
2573 date:
2574 type: string
2575 format: date-time
2576 entity:
2577 type: object
2578 entityTag:
2579 type: object
2580 properties:
2581 value:
2582 type: string
2583 weak:
2584 type: boolean
2585 headers:
2586 type: object
2587 additionalProperties:
2588 type: array
2589 items:
2590 type: object
2591 language:
2592 type: object
2593 properties:
2594 country:
2595 type: string
2596 displayCountry:
2597 type: string
2598 displayLanguage:
2599 type: string
2600 displayName:
2601 type: string
2602 displayScript:
2603 type: string
2604 displayVariant:
2605 type: string
2606 extensionKeys:
2607 type: array
2608 items:
2609 type: string
2610 uniqueItems: true
2611 iso3Country:
2612 type: string
2613 iso3Language:
2614 type: string
2615 language:
2616 type: string
2617 script:
2618 type: string
2619 unicodeLocaleAttributes:
2620 type: array
2621 items:
2622 type: string
2623 uniqueItems: true
2624 unicodeLocaleKeys:
2625 type: array
2626 items:
2627 type: string
2628 uniqueItems: true
2629 variant:
2630 type: string
2631 lastModified:
2632 type: string
2633 format: date-time
2634 length:
2635 type: integer
2636 format: int32
2637 links:
2638 type: array
2639 items:
2640 type: object
2641 properties:
2642 params:
2643 type: object
2644 additionalProperties:
2645 type: string
2646 rel:
2647 type: string
2648 rels:
2649 type: array
2650 items:
2651 type: string
2652 title:
2653 type: string
2654 type:
2655 type: string
2656 uri:
2657 type: string
2658 format: uri
2659 uriBuilder:
2660 type: object
2661 uniqueItems: true
2662 location:
2663 type: string
2664 format: uri
2665 mediaType:
2666 type: object
2667 properties:
2668 parameters:
2669 type: object
2670 additionalProperties:
2671 type: string
2672 subtype:
2673 type: string
2674 type:
2675 type: string
2676 wildcardSubtype:
2677 type: boolean
2678 wildcardType:
2679 type: boolean
2680 metadata:
2681 type: object
2682 additionalProperties:
2683 type: array
2684 items:
2685 type: object
2686 status:
2687 type: integer
2688 format: int32
2689 statusInfo:
2690 type: object
2691 properties:
2692 family:
2693 type: string
2694 enum:
2695 - INFORMATIONAL
2696 - SUCCESSFUL
2697 - REDIRECTION
2698 - CLIENT_ERROR
2699 - SERVER_ERROR
2700 - OTHER
2701 reasonPhrase:
2702 type: string
2703 statusCode:
2704 type: integer
2705 format: int32
2706 stringHeaders:
2707 type: object
2708 additionalProperties:
2709 type: array
2710 items:
2711 type: string
2712 servers:
2713 - url: /sdc2/rest
2714 variables: {}
2715 summary: Update a model TOSCA imports
2716 tags:
2717 - SDCE-2 APIs
2718 /v1/catalog/nodeTypes:
2719 get:
2720 description: Get node types
2721 operationId: getAllNodeTypesServlet
2722 parameters:
2723 - in: header
2724 name: USER_ID
2725 schema:
2726 type: string
2727 - description: model
2728 in: query
2729 name: model
2730 schema:
2731 type: string
2732 responses:
2733 "200":
2734 description: nodeTypes
2735 "400":
2736 description: Invalid content / Missing content
2737 "403":
2738 description: Restricted operation
2739 "404":
2740 description: Node types not found
2741 default:
2742 content:
2743 application/json:
2744 schema:
2745 type: array
2746 items:
2747 type: object
2748 properties:
2749 allowedMethods:
2750 type: array
2751 items:
2752 type: string
2753 uniqueItems: true
2754 cookies:
2755 type: object
2756 additionalProperties:
2757 type: object
2758 properties:
2759 comment:
2760 type: string
2761 domain:
2762 type: string
2763 expiry:
2764 type: string
2765 format: date-time
2766 httpOnly:
2767 type: boolean
2768 maxAge:
2769 type: integer
2770 format: int32
2771 name:
2772 type: string
2773 path:
2774 type: string
2775 secure:
2776 type: boolean
2777 value:
2778 type: string
2779 version:
2780 type: integer
2781 format: int32
2782 date:
2783 type: string
2784 format: date-time
2785 entity:
2786 type: object
2787 entityTag:
2788 type: object
2789 properties:
2790 value:
2791 type: string
2792 weak:
2793 type: boolean
2794 headers:
2795 type: object
2796 additionalProperties:
2797 type: array
2798 items:
2799 type: object
2800 language:
2801 type: object
2802 properties:
2803 country:
2804 type: string
2805 displayCountry:
2806 type: string
2807 displayLanguage:
2808 type: string
2809 displayName:
2810 type: string
2811 displayScript:
2812 type: string
2813 displayVariant:
2814 type: string
2815 extensionKeys:
2816 type: array
2817 items:
2818 type: string
2819 uniqueItems: true
2820 iso3Country:
2821 type: string
2822 iso3Language:
2823 type: string
2824 language:
2825 type: string
2826 script:
2827 type: string
2828 unicodeLocaleAttributes:
2829 type: array
2830 items:
2831 type: string
2832 uniqueItems: true
2833 unicodeLocaleKeys:
2834 type: array
2835 items:
2836 type: string
2837 uniqueItems: true
2838 variant:
2839 type: string
2840 lastModified:
2841 type: string
2842 format: date-time
2843 length:
2844 type: integer
2845 format: int32
2846 links:
2847 type: array
2848 items:
2849 type: object
2850 properties:
2851 params:
2852 type: object
2853 additionalProperties:
2854 type: string
2855 rel:
2856 type: string
2857 rels:
2858 type: array
2859 items:
2860 type: string
2861 title:
2862 type: string
2863 type:
2864 type: string
2865 uri:
2866 type: string
2867 format: uri
2868 uriBuilder:
2869 type: object
2870 uniqueItems: true
2871 location:
2872 type: string
2873 format: uri
2874 mediaType:
2875 type: object
2876 properties:
2877 parameters:
2878 type: object
2879 additionalProperties:
2880 type: string
2881 subtype:
2882 type: string
2883 type:
2884 type: string
2885 wildcardSubtype:
2886 type: boolean
2887 wildcardType:
2888 type: boolean
2889 metadata:
2890 type: object
2891 additionalProperties:
2892 type: array
2893 items:
2894 type: object
2895 status:
2896 type: integer
2897 format: int32
2898 statusInfo:
2899 type: object
2900 properties:
2901 family:
2902 type: string
2903 enum:
2904 - INFORMATIONAL
2905 - SUCCESSFUL
2906 - REDIRECTION
2907 - CLIENT_ERROR
2908 - SERVER_ERROR
2909 - OTHER
2910 reasonPhrase:
2911 type: string
2912 statusCode:
2913 type: integer
2914 format: int32
2915 stringHeaders:
2916 type: object
2917 additionalProperties:
2918 type: array
2919 items:
2920 type: string
2921 servers:
2922 - url: /sdc2/rest
2923 variables: {}
2924 summary: Returns node types
2925 tags:
2926 - SDCE-2 APIs
2927 /v1/catalog/notif/vsp/archived:
2928 post:
2929 description: Notify about an archived VSP. All VFs with relation to the given
2930 CSAR IDs will be martked as vspArchived=true
2931 operationId: onVspArchived
2932 parameters:
2933 - in: header
2934 name: USER_ID
2935 schema:
2936 type: string
2937 requestBody:
2938 content:
2939 application/json:
2940 schema:
2941 type: array
2942 items:
2943 type: string
2944 responses:
2945 "200":
2946 description: Success
2947 "400":
2948 description: Bad request
2949 "403":
2950 description: Restricted operation
2951 "500":
2952 description: Internal Error. A list of the failed CSAR IDs may be returned.
2953 servers:
2954 - url: /sdc2/rest
2955 variables: {}
2956 tags:
2957 - SDCE-2 APIs
2958 /v1/catalog/notif/vsp/restored:
2959 post:
2960 description: Notify about a restored VSP. All VFs with relation to the given
2961 CSAR IDs will be martked as vspArchived=false
2962 operationId: onVspRestored
2963 parameters:
2964 - in: header
2965 name: USER_ID
2966 schema:
2967 type: string
2968 requestBody:
2969 content:
2970 application/json:
2971 schema:
2972 type: array
2973 items:
2974 type: string
2975 responses:
2976 "200":
2977 description: Success
2978 "400":
2979 description: Bad request
2980 "403":
2981 description: Restricted operation
2982 "500":
2983 description: Internal Error. A list of the failed CSAR IDs may be returned.
2984 servers:
2985 - url: /sdc2/rest
2986 variables: {}
2987 tags:
2988 - SDCE-2 APIs
2989 /v1/catalog/policyTypes:
2990 get:
2991 description: 'Get policy types '
2992 operationId: getPolicyTypes
2993 parameters:
2994 - description: An optional parameter to indicate the type of the container from
2995 where this call is executed
2996 in: query
2997 name: internalComponentType
2998 schema:
2999 type: string
3000 - in: query
3001 name: componentModel
3002 schema:
3003 type: string
3004 - description: The user id
3005 in: header
3006 name: USER_ID
3007 required: true
3008 schema:
3009 type: string
3010 responses:
3011 "200":
3012 description: policy types found
3013 "403":
3014 description: Restricted operation
3015 "500":
3016 description: The GET request failed due to internal SDC problem.
3017 default:
3018 content:
3019 application/json:
3020 schema:
3021 type: array
3022 items:
3023 $ref: '#/components/schemas/PolicyTypeDefinition'
3024 servers:
3025 - url: /sdc2/rest
3026 variables: {}
3027 summary: Returns policy types
3028 tags:
3029 - SDCE-2 APIs
3030 /v1/catalog/relationshipTypes:
3031 get:
3032 description: Get relationship types
3033 operationId: getAllRelationshipTypesServlet
3034 parameters:
3035 - in: header
3036 name: USER_ID
3037 schema:
3038 type: string
3039 - description: model
3040 in: query
3041 name: model
3042 schema:
3043 type: string
3044 responses:
3045 "200":
3046 description: relationshipTypes
3047 "400":
3048 description: Invalid content / Missing content
3049 "403":
3050 description: Restricted operation
3051 "404":
3052 description: Relationship types not found
3053 default:
3054 content:
3055 application/json:
3056 schema:
3057 type: array
3058 items:
3059 type: object
3060 properties:
3061 allowedMethods:
3062 type: array
3063 items:
3064 type: string
3065 uniqueItems: true
3066 cookies:
3067 type: object
3068 additionalProperties:
3069 type: object
3070 properties:
3071 comment:
3072 type: string
3073 domain:
3074 type: string
3075 expiry:
3076 type: string
3077 format: date-time
3078 httpOnly:
3079 type: boolean
3080 maxAge:
3081 type: integer
3082 format: int32
3083 name:
3084 type: string
3085 path:
3086 type: string
3087 secure:
3088 type: boolean
3089 value:
3090 type: string
3091 version:
3092 type: integer
3093 format: int32
3094 date:
3095 type: string
3096 format: date-time
3097 entity:
3098 type: object
3099 entityTag:
3100 type: object
3101 properties:
3102 value:
3103 type: string
3104 weak:
3105 type: boolean
3106 headers:
3107 type: object
3108 additionalProperties:
3109 type: array
3110 items:
3111 type: object
3112 language:
3113 type: object
3114 properties:
3115 country:
3116 type: string
3117 displayCountry:
3118 type: string
3119 displayLanguage:
3120 type: string
3121 displayName:
3122 type: string
3123 displayScript:
3124 type: string
3125 displayVariant:
3126 type: string
3127 extensionKeys:
3128 type: array
3129 items:
3130 type: string
3131 uniqueItems: true
3132 iso3Country:
3133 type: string
3134 iso3Language:
3135 type: string
3136 language:
3137 type: string
3138 script:
3139 type: string
3140 unicodeLocaleAttributes:
3141 type: array
3142 items:
3143 type: string
3144 uniqueItems: true
3145 unicodeLocaleKeys:
3146 type: array
3147 items:
3148 type: string
3149 uniqueItems: true
3150 variant:
3151 type: string
3152 lastModified:
3153 type: string
3154 format: date-time
3155 length:
3156 type: integer
3157 format: int32
3158 links:
3159 type: array
3160 items:
3161 type: object
3162 properties:
3163 params:
3164 type: object
3165 additionalProperties:
3166 type: string
3167 rel:
3168 type: string
3169 rels:
3170 type: array
3171 items:
3172 type: string
3173 title:
3174 type: string
3175 type:
3176 type: string
3177 uri:
3178 type: string
3179 format: uri
3180 uriBuilder:
3181 type: object
3182 uniqueItems: true
3183 location:
3184 type: string
3185 format: uri
3186 mediaType:
3187 type: object
3188 properties:
3189 parameters:
3190 type: object
3191 additionalProperties:
3192 type: string
3193 subtype:
3194 type: string
3195 type:
3196 type: string
3197 wildcardSubtype:
3198 type: boolean
3199 wildcardType:
3200 type: boolean
3201 metadata:
3202 type: object
3203 additionalProperties:
3204 type: array
3205 items:
3206 type: object
3207 status:
3208 type: integer
3209 format: int32
3210 statusInfo:
3211 type: object
3212 properties:
3213 family:
3214 type: string
3215 enum:
3216 - INFORMATIONAL
3217 - SUCCESSFUL
3218 - REDIRECTION
3219 - CLIENT_ERROR
3220 - SERVER_ERROR
3221 - OTHER
3222 reasonPhrase:
3223 type: string
3224 statusCode:
3225 type: integer
3226 format: int32
3227 stringHeaders:
3228 type: object
3229 additionalProperties:
3230 type: array
3231 items:
3232 type: string
3233 servers:
3234 - url: /sdc2/rest
3235 variables: {}
3236 summary: Returns relationship types
3237 tags:
3238 - SDCE-2 APIs
3239 /v1/catalog/resources:
3240 post:
3241 description: Create Resource
3242 operationId: createResource
3243 parameters:
3244 - in: header
3245 name: USER_ID
3246 schema:
3247 type: string
3248 requestBody:
3249 content:
3250 application/json:
3251 schema:
3252 type: string
3253 description: Resource object to be created
3254 required: true
3255 responses:
3256 "201":
3257 description: Resource created
3258 "400":
3259 description: Invalid content / Missing content
3260 "403":
3261 description: Restricted operation
3262 "409":
3263 description: Resource already exist
3264 default:
3265 content:
3266 application/json:
3267 schema:
3268 type: array
3269 items:
3270 $ref: '#/components/schemas/Resource'
3271 servers:
3272 - url: /sdc2/rest
3273 variables: {}
3274 summary: Returns created resource
3275 tags:
3276 - SDCE-2 APIs
3277 /v1/catalog/resources/certified/abstract:
3278 get:
3279 operationId: getCertifiedAbstractResources
3280 parameters:
3281 - in: header
3282 name: USER_ID
3283 schema:
3284 type: string
3285 responses:
3286 default:
3287 content:
3288 application/json: {}
3289 description: default response
3290 servers:
3291 - url: /sdc2/rest
3292 variables: {}
3293 tags:
3294 - SDCE-2 APIs
3295 /v1/catalog/resources/certified/notabstract:
3296 get:
3297 operationId: getCertifiedNotAbstractResources
3298 parameters:
3299 - in: header
3300 name: USER_ID
3301 schema:
3302 type: string
3303 responses:
3304 default:
3305 content:
3306 application/json: {}
3307 description: default response
3308 servers:
3309 - url: /sdc2/rest
3310 variables: {}
3311 tags:
3312 - SDCE-2 APIs
3313 /v1/catalog/resources/csar/{csaruuid}:
3314 get:
3315 description: Create Resource
3316 operationId: getResourceFromCsar
3317 parameters:
3318 - in: header
3319 name: USER_ID
3320 schema:
3321 type: string
3322 - in: path
3323 name: csaruuid
3324 required: true
3325 schema:
3326 type: string
3327 responses:
3328 "201":
3329 description: Resource retrieced
3330 "400":
3331 description: Invalid content / Missing content
3332 "403":
3333 description: Restricted operation
3334 default:
3335 content:
3336 application/json:
3337 schema:
3338 type: array
3339 items:
3340 $ref: '#/components/schemas/Resource'
3341 servers:
3342 - url: /sdc2/rest
3343 variables: {}
3344 summary: Returns resource created from csar uuid
3345 tags:
3346 - SDCE-2 APIs
3347 /v1/catalog/resources/importReplaceResource:
3348 post:
3349 description: Import Resource
3350 operationId: importReplaceResource
3351 parameters:
3352 - description: The user id
3353 in: header
3354 name: USER_ID
3355 required: true
3356 schema:
3357 type: string
3358 - description: X-ECOMP-RequestID header
3359 in: header
3360 name: X-ECOMP-RequestID
3361 schema:
3362 type: string
3363 - description: X-ECOMP-InstanceID header
3364 in: header
3365 name: X-ECOMP-InstanceID
3366 required: true
3367 schema:
3368 type: string
3369 - description: Determines the format of the body of the response
3370 in: header
3371 name: Accept
3372 schema:
3373 type: string
3374 - description: The username and password
3375 in: header
3376 name: Authorization
3377 required: true
3378 schema:
3379 type: string
3380 requestBody:
3381 content:
3382 '*/*':
3383 schema:
3384 type: object
3385 properties:
3386 resourceZip:
3387 $ref: '#/components/schemas/FormDataContentDisposition'
3388 resourceZipMetadata:
3389 type: string
3390 description: resourceMetadata
3391 responses:
3392 "201":
3393 description: Resource created
3394 "400":
3395 description: Invalid content / Missing content
3396 "403":
3397 description: Restricted operation
3398 "409":
3399 description: Resource already exist
3400 servers:
3401 - url: /sdc2/rest
3402 variables: {}
3403 summary: Returns imported resource
3404 tags:
3405 - SDCE-2 APIs
3406 /v1/catalog/resources/resourceName/{resourceName}/resourceVersion/{resourceVersion}:
3407 get:
3408 description: Retrieve Resource by name and version
3409 operationId: getResourceByNameAndVersion
3410 parameters:
3411 - in: path
3412 name: resourceName
3413 required: true
3414 schema:
3415 type: string
3416 - in: path
3417 name: resourceVersion
3418 required: true
3419 schema:
3420 type: string
3421 - in: header
3422 name: USER_ID
3423 schema:
3424 type: string
3425 responses:
3426 "200":
3427 description: Resource found
3428 "403":
3429 description: Restricted operation
3430 "404":
3431 description: Resource not found
3432 default:
3433 content:
3434 application/json:
3435 schema:
3436 type: array
3437 items:
3438 $ref: '#/components/schemas/Resource'
3439 servers:
3440 - url: /sdc2/rest
3441 variables: {}
3442 summary: Returns resource according to resourceId
3443 tags:
3444 - SDCE-2 APIs
3445 /v1/catalog/resources/validate-name/{resourceName}:
3446 get:
3447 description: validate resource name
3448 operationId: validateResourceName
3449 parameters:
3450 - in: path
3451 name: resourceName
3452 required: true
3453 schema:
3454 type: string
3455 - in: query
3456 name: subtype
3457 schema:
3458 type: string
3459 - in: header
3460 name: USER_ID
3461 schema:
3462 type: string
3463 responses:
3464 "200":
3465 description: Resource found
3466 "403":
3467 description: Restricted operation
3468 default:
3469 content:
3470 application/json:
3471 schema:
3472 type: array
3473 items:
3474 $ref: '#/components/schemas/Resource'
3475 servers:
3476 - url: /sdc2/rest
3477 variables: {}
3478 summary: 'checks if the chosen resource name is available '
3479 tags:
3480 - SDCE-2 APIs
3481 /v1/catalog/resources/{componentId}/archive:
3482 post:
3483 description: Archive Resource
3484 operationId: archiveResources
3485 parameters:
3486 - in: path
3487 name: componentId
3488 required: true
3489 schema:
3490 type: string
3491 - in: header
3492 name: USER_ID
3493 schema:
3494 type: string
3495 responses:
3496 "200":
3497 description: Archive successful
3498 "400":
3499 description: Bad request
3500 "403":
3501 description: Restricted operation
3502 "404":
3503 description: Resource not found
3504 "500":
3505 description: Internal Error
3506 default:
3507 content:
3508 application/json:
3509 schema:
3510 type: array
3511 items:
3512 type: string
3513 servers:
3514 - url: /sdc2/rest
3515 variables: {}
3516 summary: Marks a resource as archived. Can be restored with restore action
3517 tags:
3518 - SDCE-2 APIs
3519 /v1/catalog/resources/{componentId}/interfaceOperation:
3520 put:
3521 description: Update Interface Operation
3522 operationId: updateResourceInterfaceOperation
3523 parameters:
3524 - description: Component Id
3525 in: path
3526 name: componentId
3527 required: true
3528 schema:
3529 type: string
3530 - in: header
3531 name: USER_ID
3532 schema:
3533 type: string
3534 responses:
3535 "201":
3536 description: Update Interface Operation
3537 "400":
3538 description: Invalid content / Missing content
3539 "403":
3540 description: Restricted operation
3541 default:
3542 content:
3543 application/json:
3544 schema:
3545 type: array
3546 items:
3547 type: object
3548 properties:
3549 allowedMethods:
3550 type: array
3551 items:
3552 type: string
3553 uniqueItems: true
3554 cookies:
3555 type: object
3556 additionalProperties:
3557 type: object
3558 properties:
3559 comment:
3560 type: string
3561 domain:
3562 type: string
3563 expiry:
3564 type: string
3565 format: date-time
3566 httpOnly:
3567 type: boolean
3568 maxAge:
3569 type: integer
3570 format: int32
3571 name:
3572 type: string
3573 path:
3574 type: string
3575 secure:
3576 type: boolean
3577 value:
3578 type: string
3579 version:
3580 type: integer
3581 format: int32
3582 date:
3583 type: string
3584 format: date-time
3585 entity:
3586 type: object
3587 entityTag:
3588 type: object
3589 properties:
3590 value:
3591 type: string
3592 weak:
3593 type: boolean
3594 headers:
3595 type: object
3596 additionalProperties:
3597 type: array
3598 items:
3599 type: object
3600 language:
3601 type: object
3602 properties:
3603 country:
3604 type: string
3605 displayCountry:
3606 type: string
3607 displayLanguage:
3608 type: string
3609 displayName:
3610 type: string
3611 displayScript:
3612 type: string
3613 displayVariant:
3614 type: string
3615 extensionKeys:
3616 type: array
3617 items:
3618 type: string
3619 uniqueItems: true
3620 iso3Country:
3621 type: string
3622 iso3Language:
3623 type: string
3624 language:
3625 type: string
3626 script:
3627 type: string
3628 unicodeLocaleAttributes:
3629 type: array
3630 items:
3631 type: string
3632 uniqueItems: true
3633 unicodeLocaleKeys:
3634 type: array
3635 items:
3636 type: string
3637 uniqueItems: true
3638 variant:
3639 type: string
3640 lastModified:
3641 type: string
3642 format: date-time
3643 length:
3644 type: integer
3645 format: int32
3646 links:
3647 type: array
3648 items:
3649 type: object
3650 properties:
3651 params:
3652 type: object
3653 additionalProperties:
3654 type: string
3655 rel:
3656 type: string
3657 rels:
3658 type: array
3659 items:
3660 type: string
3661 title:
3662 type: string
3663 type:
3664 type: string
3665 uri:
3666 type: string
3667 format: uri
3668 uriBuilder:
3669 type: object
3670 uniqueItems: true
3671 location:
3672 type: string
3673 format: uri
3674 mediaType:
3675 type: object
3676 properties:
3677 parameters:
3678 type: object
3679 additionalProperties:
3680 type: string
3681 subtype:
3682 type: string
3683 type:
3684 type: string
3685 wildcardSubtype:
3686 type: boolean
3687 wildcardType:
3688 type: boolean
3689 metadata:
3690 type: object
3691 additionalProperties:
3692 type: array
3693 items:
3694 type: object
3695 status:
3696 type: integer
3697 format: int32
3698 statusInfo:
3699 type: object
3700 properties:
3701 family:
3702 type: string
3703 enum:
3704 - INFORMATIONAL
3705 - SUCCESSFUL
3706 - REDIRECTION
3707 - CLIENT_ERROR
3708 - SERVER_ERROR
3709 - OTHER
3710 reasonPhrase:
3711 type: string
3712 statusCode:
3713 type: integer
3714 format: int32
3715 stringHeaders:
3716 type: object
3717 additionalProperties:
3718 type: array
3719 items:
3720 type: string
3721 servers:
3722 - url: /sdc2/rest
3723 variables: {}
3724 summary: Update Interface Operation on ComponentInstance
3725 tags:
3726 - SDCE-2 APIs
3727 /v1/catalog/resources/{componentId}/restore:
3728 post:
3729 description: Restore Resource
3730 operationId: restoreResource
3731 parameters:
3732 - in: path
3733 name: componentId
3734 required: true
3735 schema:
3736 type: string
3737 - in: header
3738 name: USER_ID
3739 schema:
3740 type: string
3741 responses:
3742 "200":
3743 description: Restore successful
3744 "400":
3745 description: Bad request
3746 "403":
3747 description: Restricted operation
3748 "404":
3749 description: Resource not found
3750 "500":
3751 description: Internal Error
3752 default:
3753 content:
3754 application/json:
3755 schema:
3756 type: array
3757 items:
3758 type: string
3759 servers:
3760 - url: /sdc2/rest
3761 variables: {}
3762 summary: Restores a resource from archive.
3763 tags:
3764 - SDCE-2 APIs
3765 /v1/catalog/resources/{resourceId}:
3766 delete:
3767 operationId: deleteResource
3768 parameters:
3769 - in: path
3770 name: resourceId
3771 required: true
3772 schema:
3773 type: string
3774 - description: "Optional parameter to determine the delete action: DELETE, which\
3775 \ will permanently delete the Resource from the system or MARK_AS_DELETE,\
3776 \ which will logically mark the Resource as deleted. Default action is to\
3777 \ MARK_AS_DELETE"
3778 in: query
3779 name: deleteAction
3780 schema:
3781 type: string
3782 enum:
3783 - MARK_AS_DELETE
3784 - DELETE
3785 responses:
3786 default:
3787 content:
3788 '*/*': {}
3789 description: default response
3790 servers:
3791 - url: /sdc2/rest
3792 variables: {}
3793 tags:
3794 - SDCE-2 APIs
3795 get:
3796 description: Retrieve Resource
3797 operationId: getResourceById
3798 parameters:
3799 - in: path
3800 name: resourceId
3801 required: true
3802 schema:
3803 type: string
3804 - in: header
3805 name: USER_ID
3806 schema:
3807 type: string
3808 responses:
3809 "200":
3810 description: Resource found
3811 "403":
3812 description: Restricted operation
3813 "404":
3814 description: Resource not found
3815 default:
3816 content:
3817 application/json:
3818 schema:
3819 type: array
3820 items:
3821 $ref: '#/components/schemas/Resource'
3822 servers:
3823 - url: /sdc2/rest
3824 variables: {}
3825 summary: Returns resource according to resourceId
3826 tags:
3827 - SDCE-2 APIs
3828 put:
3829 description: Update Resource
3830 operationId: updateResource
3831 parameters:
3832 - in: header
3833 name: USER_ID
3834 schema:
3835 type: string
3836 - in: path
3837 name: resourceId
3838 required: true
3839 schema:
3840 type: string
3841 requestBody:
3842 content:
3843 application/json:
3844 schema:
3845 type: string
3846 description: Resource object to be updated
3847 required: true
3848 responses:
3849 "200":
3850 description: Resource updated
3851 "400":
3852 description: Invalid content / Missing content
3853 "403":
3854 description: Restricted operation
3855 "409":
3856 description: Resource already exist
3857 default:
3858 content:
3859 application/json:
3860 schema:
3861 type: array
3862 items:
3863 $ref: '#/components/schemas/Resource'
3864 servers:
3865 - url: /sdc2/rest
3866 variables: {}
3867 summary: Returns updated resource
3868 tags:
3869 - SDCE-2 APIs
3870 /v1/catalog/resources/{resourceId}/additionalinfo:
3871 get:
3872 description: Get all Additional Information under resource
3873 operationId: getAllResourceAdditionalInformationLabel
3874 parameters:
3875 - description: resource id to update with new property
3876 in: path
3877 name: resourceId
3878 required: true
3879 schema:
3880 type: string
3881 - in: header
3882 name: USER_ID
3883 schema:
3884 type: string
3885 responses:
3886 "200":
3887 description: list of additional information
3888 "400":
3889 description: Invalid content / Missing content
3890 "403":
3891 description: Restricted operation
3892 "409":
3893 description: Additional information key already exist
3894 default:
3895 content:
3896 application/json:
3897 schema:
3898 type: array
3899 items:
3900 type: object
3901 properties:
3902 allowedMethods:
3903 type: array
3904 items:
3905 type: string
3906 uniqueItems: true
3907 cookies:
3908 type: object
3909 additionalProperties:
3910 type: object
3911 properties:
3912 comment:
3913 type: string
3914 domain:
3915 type: string
3916 expiry:
3917 type: string
3918 format: date-time
3919 httpOnly:
3920 type: boolean
3921 maxAge:
3922 type: integer
3923 format: int32
3924 name:
3925 type: string
3926 path:
3927 type: string
3928 secure:
3929 type: boolean
3930 value:
3931 type: string
3932 version:
3933 type: integer
3934 format: int32
3935 date:
3936 type: string
3937 format: date-time
3938 entity:
3939 type: object
3940 entityTag:
3941 type: object
3942 properties:
3943 value:
3944 type: string
3945 weak:
3946 type: boolean
3947 headers:
3948 type: object
3949 additionalProperties:
3950 type: array
3951 items:
3952 type: object
3953 language:
3954 type: object
3955 properties:
3956 country:
3957 type: string
3958 displayCountry:
3959 type: string
3960 displayLanguage:
3961 type: string
3962 displayName:
3963 type: string
3964 displayScript:
3965 type: string
3966 displayVariant:
3967 type: string
3968 extensionKeys:
3969 type: array
3970 items:
3971 type: string
3972 uniqueItems: true
3973 iso3Country:
3974 type: string
3975 iso3Language:
3976 type: string
3977 language:
3978 type: string
3979 script:
3980 type: string
3981 unicodeLocaleAttributes:
3982 type: array
3983 items:
3984 type: string
3985 uniqueItems: true
3986 unicodeLocaleKeys:
3987 type: array
3988 items:
3989 type: string
3990 uniqueItems: true
3991 variant:
3992 type: string
3993 lastModified:
3994 type: string
3995 format: date-time
3996 length:
3997 type: integer
3998 format: int32
3999 links:
4000 type: array
4001 items:
4002 type: object
4003 properties:
4004 params:
4005 type: object
4006 additionalProperties:
4007 type: string
4008 rel:
4009 type: string
4010 rels:
4011 type: array
4012 items:
4013 type: string
4014 title:
4015 type: string
4016 type:
4017 type: string
4018 uri:
4019 type: string
4020 format: uri
4021 uriBuilder:
4022 type: object
4023 uniqueItems: true
4024 location:
4025 type: string
4026 format: uri
4027 mediaType:
4028 type: object
4029 properties:
4030 parameters:
4031 type: object
4032 additionalProperties:
4033 type: string
4034 subtype:
4035 type: string
4036 type:
4037 type: string
4038 wildcardSubtype:
4039 type: boolean
4040 wildcardType:
4041 type: boolean
4042 metadata:
4043 type: object
4044 additionalProperties:
4045 type: array
4046 items:
4047 type: object
4048 status:
4049 type: integer
4050 format: int32
4051 statusInfo:
4052 type: object
4053 properties:
4054 family:
4055 type: string
4056 enum:
4057 - INFORMATIONAL
4058 - SUCCESSFUL
4059 - REDIRECTION
4060 - CLIENT_ERROR
4061 - SERVER_ERROR
4062 - OTHER
4063 reasonPhrase:
4064 type: string
4065 statusCode:
4066 type: integer
4067 format: int32
4068 stringHeaders:
4069 type: object
4070 additionalProperties:
4071 type: array
4072 items:
4073 type: string
4074 servers:
4075 - url: /sdc2/rest
4076 variables: {}
4077 summary: Returns Additional Inforamtion property
4078 tags:
4079 - SDCE-2 APIs
4080 post:
4081 description: Create Additional Information Label and Value
4082 operationId: createResourceAdditionalInformationLabel
4083 parameters:
4084 - description: resource id to update with new property
4085 in: path
4086 name: resourceId
4087 required: true
4088 schema:
4089 type: string
4090 - in: header
4091 name: USER_ID
4092 schema:
4093 type: string
4094 requestBody:
4095 content:
4096 application/json:
4097 schema:
4098 type: string
4099 description: Additional information key value to be created
4100 required: true
4101 responses:
4102 "201":
4103 description: Additional information created
4104 "400":
4105 description: Invalid content / Missing content
4106 "403":
4107 description: Restricted operation
4108 "409":
4109 description: Additional information key already exist
4110 default:
4111 content:
4112 application/json:
4113 schema:
4114 type: array
4115 items:
4116 type: object
4117 properties:
4118 allowedMethods:
4119 type: array
4120 items:
4121 type: string
4122 uniqueItems: true
4123 cookies:
4124 type: object
4125 additionalProperties:
4126 type: object
4127 properties:
4128 comment:
4129 type: string
4130 domain:
4131 type: string
4132 expiry:
4133 type: string
4134 format: date-time
4135 httpOnly:
4136 type: boolean
4137 maxAge:
4138 type: integer
4139 format: int32
4140 name:
4141 type: string
4142 path:
4143 type: string
4144 secure:
4145 type: boolean
4146 value:
4147 type: string
4148 version:
4149 type: integer
4150 format: int32
4151 date:
4152 type: string
4153 format: date-time
4154 entity:
4155 type: object
4156 entityTag:
4157 type: object
4158 properties:
4159 value:
4160 type: string
4161 weak:
4162 type: boolean
4163 headers:
4164 type: object
4165 additionalProperties:
4166 type: array
4167 items:
4168 type: object
4169 language:
4170 type: object
4171 properties:
4172 country:
4173 type: string
4174 displayCountry:
4175 type: string
4176 displayLanguage:
4177 type: string
4178 displayName:
4179 type: string
4180 displayScript:
4181 type: string
4182 displayVariant:
4183 type: string
4184 extensionKeys:
4185 type: array
4186 items:
4187 type: string
4188 uniqueItems: true
4189 iso3Country:
4190 type: string
4191 iso3Language:
4192 type: string
4193 language:
4194 type: string
4195 script:
4196 type: string
4197 unicodeLocaleAttributes:
4198 type: array
4199 items:
4200 type: string
4201 uniqueItems: true
4202 unicodeLocaleKeys:
4203 type: array
4204 items:
4205 type: string
4206 uniqueItems: true
4207 variant:
4208 type: string
4209 lastModified:
4210 type: string
4211 format: date-time
4212 length:
4213 type: integer
4214 format: int32
4215 links:
4216 type: array
4217 items:
4218 type: object
4219 properties:
4220 params:
4221 type: object
4222 additionalProperties:
4223 type: string
4224 rel:
4225 type: string
4226 rels:
4227 type: array
4228 items:
4229 type: string
4230 title:
4231 type: string
4232 type:
4233 type: string
4234 uri:
4235 type: string
4236 format: uri
4237 uriBuilder:
4238 type: object
4239 uniqueItems: true
4240 location:
4241 type: string
4242 format: uri
4243 mediaType:
4244 type: object
4245 properties:
4246 parameters:
4247 type: object
4248 additionalProperties:
4249 type: string
4250 subtype:
4251 type: string
4252 type:
4253 type: string
4254 wildcardSubtype:
4255 type: boolean
4256 wildcardType:
4257 type: boolean
4258 metadata:
4259 type: object
4260 additionalProperties:
4261 type: array
4262 items:
4263 type: object
4264 status:
4265 type: integer
4266 format: int32
4267 statusInfo:
4268 type: object
4269 properties:
4270 family:
4271 type: string
4272 enum:
4273 - INFORMATIONAL
4274 - SUCCESSFUL
4275 - REDIRECTION
4276 - CLIENT_ERROR
4277 - SERVER_ERROR
4278 - OTHER
4279 reasonPhrase:
4280 type: string
4281 statusCode:
4282 type: integer
4283 format: int32
4284 stringHeaders:
4285 type: object
4286 additionalProperties:
4287 type: array
4288 items:
4289 type: string
4290 servers:
4291 - url: /sdc2/rest
4292 variables: {}
4293 summary: Returns created Additional Inforamtion property
4294 tags:
4295 - SDCE-2 APIs
4296 /v1/catalog/resources/{resourceId}/additionalinfo/{labelId}:
4297 delete:
4298 description: Create Additional Information Label and Value
4299 operationId: updateResourceAdditionalInformationLabel
4300 parameters:
4301 - description: resource id to update with new property
4302 in: path
4303 name: resourceId
4304 required: true
4305 schema:
4306 type: string
4307 - description: label id
4308 in: path
4309 name: labelId
4310 required: true
4311 schema:
4312 type: string
4313 - in: header
4314 name: USER_ID
4315 schema:
4316 type: string
4317 responses:
4318 "200":
4319 description: Additional information deleted
4320 "400":
4321 description: Invalid content / Missing content
4322 "403":
4323 description: Restricted operation
4324 "409":
4325 description: Additional information key already exist
4326 default:
4327 content:
4328 application/json:
4329 schema:
4330 type: array
4331 items:
4332 type: object
4333 properties:
4334 allowedMethods:
4335 type: array
4336 items:
4337 type: string
4338 uniqueItems: true
4339 cookies:
4340 type: object
4341 additionalProperties:
4342 type: object
4343 properties:
4344 comment:
4345 type: string
4346 domain:
4347 type: string
4348 expiry:
4349 type: string
4350 format: date-time
4351 httpOnly:
4352 type: boolean
4353 maxAge:
4354 type: integer
4355 format: int32
4356 name:
4357 type: string
4358 path:
4359 type: string
4360 secure:
4361 type: boolean
4362 value:
4363 type: string
4364 version:
4365 type: integer
4366 format: int32
4367 date:
4368 type: string
4369 format: date-time
4370 entity:
4371 type: object
4372 entityTag:
4373 type: object
4374 properties:
4375 value:
4376 type: string
4377 weak:
4378 type: boolean
4379 headers:
4380 type: object
4381 additionalProperties:
4382 type: array
4383 items:
4384 type: object
4385 language:
4386 type: object
4387 properties:
4388 country:
4389 type: string
4390 displayCountry:
4391 type: string
4392 displayLanguage:
4393 type: string
4394 displayName:
4395 type: string
4396 displayScript:
4397 type: string
4398 displayVariant:
4399 type: string
4400 extensionKeys:
4401 type: array
4402 items:
4403 type: string
4404 uniqueItems: true
4405 iso3Country:
4406 type: string
4407 iso3Language:
4408 type: string
4409 language:
4410 type: string
4411 script:
4412 type: string
4413 unicodeLocaleAttributes:
4414 type: array
4415 items:
4416 type: string
4417 uniqueItems: true
4418 unicodeLocaleKeys:
4419 type: array
4420 items:
4421 type: string
4422 uniqueItems: true
4423 variant:
4424 type: string
4425 lastModified:
4426 type: string
4427 format: date-time
4428 length:
4429 type: integer
4430 format: int32
4431 links:
4432 type: array
4433 items:
4434 type: object
4435 properties:
4436 params:
4437 type: object
4438 additionalProperties:
4439 type: string
4440 rel:
4441 type: string
4442 rels:
4443 type: array
4444 items:
4445 type: string
4446 title:
4447 type: string
4448 type:
4449 type: string
4450 uri:
4451 type: string
4452 format: uri
4453 uriBuilder:
4454 type: object
4455 uniqueItems: true
4456 location:
4457 type: string
4458 format: uri
4459 mediaType:
4460 type: object
4461 properties:
4462 parameters:
4463 type: object
4464 additionalProperties:
4465 type: string
4466 subtype:
4467 type: string
4468 type:
4469 type: string
4470 wildcardSubtype:
4471 type: boolean
4472 wildcardType:
4473 type: boolean
4474 metadata:
4475 type: object
4476 additionalProperties:
4477 type: array
4478 items:
4479 type: object
4480 status:
4481 type: integer
4482 format: int32
4483 statusInfo:
4484 type: object
4485 properties:
4486 family:
4487 type: string
4488 enum:
4489 - INFORMATIONAL
4490 - SUCCESSFUL
4491 - REDIRECTION
4492 - CLIENT_ERROR
4493 - SERVER_ERROR
4494 - OTHER
4495 reasonPhrase:
4496 type: string
4497 statusCode:
4498 type: integer
4499 format: int32
4500 stringHeaders:
4501 type: object
4502 additionalProperties:
4503 type: array
4504 items:
4505 type: string
4506 servers:
4507 - url: /sdc2/rest
4508 variables: {}
4509 summary: Returns deleted Additional Inforamtion property
4510 tags:
4511 - SDCE-2 APIs
4512 get:
4513 description: Get Additional Information by id
4514 operationId: getResourceAdditionalInformationLabel
4515 parameters:
4516 - description: resource id to update with new property
4517 in: path
4518 name: resourceId
4519 required: true
4520 schema:
4521 type: string
4522 - description: label id
4523 in: path
4524 name: labelId
4525 required: true
4526 schema:
4527 type: string
4528 - in: header
4529 name: USER_ID
4530 schema:
4531 type: string
4532 responses:
4533 "200":
4534 description: fetched additional information
4535 "400":
4536 description: Invalid content / Missing content
4537 "403":
4538 description: Restricted operation
4539 "409":
4540 description: Additional information key already exist
4541 default:
4542 content:
4543 application/json:
4544 schema:
4545 type: array
4546 items:
4547 type: object
4548 properties:
4549 allowedMethods:
4550 type: array
4551 items:
4552 type: string
4553 uniqueItems: true
4554 cookies:
4555 type: object
4556 additionalProperties:
4557 type: object
4558 properties:
4559 comment:
4560 type: string
4561 domain:
4562 type: string
4563 expiry:
4564 type: string
4565 format: date-time
4566 httpOnly:
4567 type: boolean
4568 maxAge:
4569 type: integer
4570 format: int32
4571 name:
4572 type: string
4573 path:
4574 type: string
4575 secure:
4576 type: boolean
4577 value:
4578 type: string
4579 version:
4580 type: integer
4581 format: int32
4582 date:
4583 type: string
4584 format: date-time
4585 entity:
4586 type: object
4587 entityTag:
4588 type: object
4589 properties:
4590 value:
4591 type: string
4592 weak:
4593 type: boolean
4594 headers:
4595 type: object
4596 additionalProperties:
4597 type: array
4598 items:
4599 type: object
4600 language:
4601 type: object
4602 properties:
4603 country:
4604 type: string
4605 displayCountry:
4606 type: string
4607 displayLanguage:
4608 type: string
4609 displayName:
4610 type: string
4611 displayScript:
4612 type: string
4613 displayVariant:
4614 type: string
4615 extensionKeys:
4616 type: array
4617 items:
4618 type: string
4619 uniqueItems: true
4620 iso3Country:
4621 type: string
4622 iso3Language:
4623 type: string
4624 language:
4625 type: string
4626 script:
4627 type: string
4628 unicodeLocaleAttributes:
4629 type: array
4630 items:
4631 type: string
4632 uniqueItems: true
4633 unicodeLocaleKeys:
4634 type: array
4635 items:
4636 type: string
4637 uniqueItems: true
4638 variant:
4639 type: string
4640 lastModified:
4641 type: string
4642 format: date-time
4643 length:
4644 type: integer
4645 format: int32
4646 links:
4647 type: array
4648 items:
4649 type: object
4650 properties:
4651 params:
4652 type: object
4653 additionalProperties:
4654 type: string
4655 rel:
4656 type: string
4657 rels:
4658 type: array
4659 items:
4660 type: string
4661 title:
4662 type: string
4663 type:
4664 type: string
4665 uri:
4666 type: string
4667 format: uri
4668 uriBuilder:
4669 type: object
4670 uniqueItems: true
4671 location:
4672 type: string
4673 format: uri
4674 mediaType:
4675 type: object
4676 properties:
4677 parameters:
4678 type: object
4679 additionalProperties:
4680 type: string
4681 subtype:
4682 type: string
4683 type:
4684 type: string
4685 wildcardSubtype:
4686 type: boolean
4687 wildcardType:
4688 type: boolean
4689 metadata:
4690 type: object
4691 additionalProperties:
4692 type: array
4693 items:
4694 type: object
4695 status:
4696 type: integer
4697 format: int32
4698 statusInfo:
4699 type: object
4700 properties:
4701 family:
4702 type: string
4703 enum:
4704 - INFORMATIONAL
4705 - SUCCESSFUL
4706 - REDIRECTION
4707 - CLIENT_ERROR
4708 - SERVER_ERROR
4709 - OTHER
4710 reasonPhrase:
4711 type: string
4712 statusCode:
4713 type: integer
4714 format: int32
4715 stringHeaders:
4716 type: object
4717 additionalProperties:
4718 type: array
4719 items:
4720 type: string
4721 servers:
4722 - url: /sdc2/rest
4723 variables: {}
4724 summary: Returns Additional Inforamtion property
4725 tags:
4726 - SDCE-2 APIs
4727 put:
4728 description: Update Additional Information Label and Value
4729 operationId: updateResourceAdditionalInformationLabel_1
4730 parameters:
4731 - description: resource id to update with new property
4732 in: path
4733 name: resourceId
4734 required: true
4735 schema:
4736 type: string
4737 - description: label id
4738 in: path
4739 name: labelId
4740 required: true
4741 schema:
4742 type: string
4743 - in: header
4744 name: USER_ID
4745 schema:
4746 type: string
4747 requestBody:
4748 content:
4749 application/json:
4750 schema:
4751 type: string
4752 description: Additional information key value to be created
4753 required: true
4754 responses:
4755 "200":
4756 description: Additional information updated
4757 "400":
4758 description: Invalid content / Missing content
4759 "403":
4760 description: Restricted operation
4761 "409":
4762 description: Additional information key already exist
4763 default:
4764 content:
4765 application/json:
4766 schema:
4767 type: array
4768 items:
4769 type: object
4770 properties:
4771 allowedMethods:
4772 type: array
4773 items:
4774 type: string
4775 uniqueItems: true
4776 cookies:
4777 type: object
4778 additionalProperties:
4779 type: object
4780 properties:
4781 comment:
4782 type: string
4783 domain:
4784 type: string
4785 expiry:
4786 type: string
4787 format: date-time
4788 httpOnly:
4789 type: boolean
4790 maxAge:
4791 type: integer
4792 format: int32
4793 name:
4794 type: string
4795 path:
4796 type: string
4797 secure:
4798 type: boolean
4799 value:
4800 type: string
4801 version:
4802 type: integer
4803 format: int32
4804 date:
4805 type: string
4806 format: date-time
4807 entity:
4808 type: object
4809 entityTag:
4810 type: object
4811 properties:
4812 value:
4813 type: string
4814 weak:
4815 type: boolean
4816 headers:
4817 type: object
4818 additionalProperties:
4819 type: array
4820 items:
4821 type: object
4822 language:
4823 type: object
4824 properties:
4825 country:
4826 type: string
4827 displayCountry:
4828 type: string
4829 displayLanguage:
4830 type: string
4831 displayName:
4832 type: string
4833 displayScript:
4834 type: string
4835 displayVariant:
4836 type: string
4837 extensionKeys:
4838 type: array
4839 items:
4840 type: string
4841 uniqueItems: true
4842 iso3Country:
4843 type: string
4844 iso3Language:
4845 type: string
4846 language:
4847 type: string
4848 script:
4849 type: string
4850 unicodeLocaleAttributes:
4851 type: array
4852 items:
4853 type: string
4854 uniqueItems: true
4855 unicodeLocaleKeys:
4856 type: array
4857 items:
4858 type: string
4859 uniqueItems: true
4860 variant:
4861 type: string
4862 lastModified:
4863 type: string
4864 format: date-time
4865 length:
4866 type: integer
4867 format: int32
4868 links:
4869 type: array
4870 items:
4871 type: object
4872 properties:
4873 params:
4874 type: object
4875 additionalProperties:
4876 type: string
4877 rel:
4878 type: string
4879 rels:
4880 type: array
4881 items:
4882 type: string
4883 title:
4884 type: string
4885 type:
4886 type: string
4887 uri:
4888 type: string
4889 format: uri
4890 uriBuilder:
4891 type: object
4892 uniqueItems: true
4893 location:
4894 type: string
4895 format: uri
4896 mediaType:
4897 type: object
4898 properties:
4899 parameters:
4900 type: object
4901 additionalProperties:
4902 type: string
4903 subtype:
4904 type: string
4905 type:
4906 type: string
4907 wildcardSubtype:
4908 type: boolean
4909 wildcardType:
4910 type: boolean
4911 metadata:
4912 type: object
4913 additionalProperties:
4914 type: array
4915 items:
4916 type: object
4917 status:
4918 type: integer
4919 format: int32
4920 statusInfo:
4921 type: object
4922 properties:
4923 family:
4924 type: string
4925 enum:
4926 - INFORMATIONAL
4927 - SUCCESSFUL
4928 - REDIRECTION
4929 - CLIENT_ERROR
4930 - SERVER_ERROR
4931 - OTHER
4932 reasonPhrase:
4933 type: string
4934 statusCode:
4935 type: integer
4936 format: int32
4937 stringHeaders:
4938 type: object
4939 additionalProperties:
4940 type: array
4941 items:
4942 type: string
4943 servers:
4944 - url: /sdc2/rest
4945 variables: {}
4946 summary: Returns updated Additional Inforamtion property
4947 tags:
4948 - SDCE-2 APIs
4949 /v1/catalog/resources/{resourceId}/artifacts:
4950 post:
4951 description: Create Artifact
4952 operationId: loadArtifact
4953 parameters:
4954 - in: path
4955 name: resourceId
4956 required: true
4957 schema:
4958 type: string
4959 requestBody:
4960 content:
4961 application/json:
4962 schema:
4963 type: string
4964 description: json describe the artifact
4965 required: true
4966 responses:
4967 "201":
4968 description: Resource created
4969 "400":
4970 description: Invalid content / Missing content
4971 "403":
4972 description: Restricted operation
4973 "409":
4974 description: Artifact already exist
4975 default:
4976 content:
4977 application/json:
4978 schema:
4979 type: array
4980 items:
4981 type: object
4982 properties:
4983 allowedMethods:
4984 type: array
4985 items:
4986 type: string
4987 uniqueItems: true
4988 cookies:
4989 type: object
4990 additionalProperties:
4991 type: object
4992 properties:
4993 comment:
4994 type: string
4995 domain:
4996 type: string
4997 expiry:
4998 type: string
4999 format: date-time
5000 httpOnly:
5001 type: boolean
5002 maxAge:
5003 type: integer
5004 format: int32
5005 name:
5006 type: string
5007 path:
5008 type: string
5009 secure:
5010 type: boolean
5011 value:
5012 type: string
5013 version:
5014 type: integer
5015 format: int32
5016 date:
5017 type: string
5018 format: date-time
5019 entity:
5020 type: object
5021 entityTag:
5022 type: object
5023 properties:
5024 value:
5025 type: string
5026 weak:
5027 type: boolean
5028 headers:
5029 type: object
5030 additionalProperties:
5031 type: array
5032 items:
5033 type: object
5034 language:
5035 type: object
5036 properties:
5037 country:
5038 type: string
5039 displayCountry:
5040 type: string
5041 displayLanguage:
5042 type: string
5043 displayName:
5044 type: string
5045 displayScript:
5046 type: string
5047 displayVariant:
5048 type: string
5049 extensionKeys:
5050 type: array
5051 items:
5052 type: string
5053 uniqueItems: true
5054 iso3Country:
5055 type: string
5056 iso3Language:
5057 type: string
5058 language:
5059 type: string
5060 script:
5061 type: string
5062 unicodeLocaleAttributes:
5063 type: array
5064 items:
5065 type: string
5066 uniqueItems: true
5067 unicodeLocaleKeys:
5068 type: array
5069 items:
5070 type: string
5071 uniqueItems: true
5072 variant:
5073 type: string
5074 lastModified:
5075 type: string
5076 format: date-time
5077 length:
5078 type: integer
5079 format: int32
5080 links:
5081 type: array
5082 items:
5083 type: object
5084 properties:
5085 params:
5086 type: object
5087 additionalProperties:
5088 type: string
5089 rel:
5090 type: string
5091 rels:
5092 type: array
5093 items:
5094 type: string
5095 title:
5096 type: string
5097 type:
5098 type: string
5099 uri:
5100 type: string
5101 format: uri
5102 uriBuilder:
5103 type: object
5104 uniqueItems: true
5105 location:
5106 type: string
5107 format: uri
5108 mediaType:
5109 type: object
5110 properties:
5111 parameters:
5112 type: object
5113 additionalProperties:
5114 type: string
5115 subtype:
5116 type: string
5117 type:
5118 type: string
5119 wildcardSubtype:
5120 type: boolean
5121 wildcardType:
5122 type: boolean
5123 metadata:
5124 type: object
5125 additionalProperties:
5126 type: array
5127 items:
5128 type: object
5129 status:
5130 type: integer
5131 format: int32
5132 statusInfo:
5133 type: object
5134 properties:
5135 family:
5136 type: string
5137 enum:
5138 - INFORMATIONAL
5139 - SUCCESSFUL
5140 - REDIRECTION
5141 - CLIENT_ERROR
5142 - SERVER_ERROR
5143 - OTHER
5144 reasonPhrase:
5145 type: string
5146 statusCode:
5147 type: integer
5148 format: int32
5149 stringHeaders:
5150 type: object
5151 additionalProperties:
5152 type: array
5153 items:
5154 type: string
5155 servers:
5156 - url: /sdc2/rest
5157 variables: {}
5158 summary: Returns created ArtifactDefinition
5159 tags:
5160 - SDCE-2 APIs
5161 /v1/catalog/resources/{resourceId}/artifacts/{artifactId}:
5162 delete:
5163 description: Delete Artifact
5164 operationId: deleteArtifact
5165 parameters:
5166 - in: path
5167 name: resourceId
5168 required: true
5169 schema:
5170 type: string
5171 - in: path
5172 name: artifactId
5173 required: true
5174 schema:
5175 type: string
5176 responses:
5177 "201":
5178 description: Resource created
5179 "400":
5180 description: Invalid content / Missing content
5181 "403":
5182 description: Restricted operation
5183 default:
5184 content:
5185 application/json:
5186 schema:
5187 type: array
5188 items:
5189 type: object
5190 properties:
5191 allowedMethods:
5192 type: array
5193 items:
5194 type: string
5195 uniqueItems: true
5196 cookies:
5197 type: object
5198 additionalProperties:
5199 type: object
5200 properties:
5201 comment:
5202 type: string
5203 domain:
5204 type: string
5205 expiry:
5206 type: string
5207 format: date-time
5208 httpOnly:
5209 type: boolean
5210 maxAge:
5211 type: integer
5212 format: int32
5213 name:
5214 type: string
5215 path:
5216 type: string
5217 secure:
5218 type: boolean
5219 value:
5220 type: string
5221 version:
5222 type: integer
5223 format: int32
5224 date:
5225 type: string
5226 format: date-time
5227 entity:
5228 type: object
5229 entityTag:
5230 type: object
5231 properties:
5232 value:
5233 type: string
5234 weak:
5235 type: boolean
5236 headers:
5237 type: object
5238 additionalProperties:
5239 type: array
5240 items:
5241 type: object
5242 language:
5243 type: object
5244 properties:
5245 country:
5246 type: string
5247 displayCountry:
5248 type: string
5249 displayLanguage:
5250 type: string
5251 displayName:
5252 type: string
5253 displayScript:
5254 type: string
5255 displayVariant:
5256 type: string
5257 extensionKeys:
5258 type: array
5259 items:
5260 type: string
5261 uniqueItems: true
5262 iso3Country:
5263 type: string
5264 iso3Language:
5265 type: string
5266 language:
5267 type: string
5268 script:
5269 type: string
5270 unicodeLocaleAttributes:
5271 type: array
5272 items:
5273 type: string
5274 uniqueItems: true
5275 unicodeLocaleKeys:
5276 type: array
5277 items:
5278 type: string
5279 uniqueItems: true
5280 variant:
5281 type: string
5282 lastModified:
5283 type: string
5284 format: date-time
5285 length:
5286 type: integer
5287 format: int32
5288 links:
5289 type: array
5290 items:
5291 type: object
5292 properties:
5293 params:
5294 type: object
5295 additionalProperties:
5296 type: string
5297 rel:
5298 type: string
5299 rels:
5300 type: array
5301 items:
5302 type: string
5303 title:
5304 type: string
5305 type:
5306 type: string
5307 uri:
5308 type: string
5309 format: uri
5310 uriBuilder:
5311 type: object
5312 uniqueItems: true
5313 location:
5314 type: string
5315 format: uri
5316 mediaType:
5317 type: object
5318 properties:
5319 parameters:
5320 type: object
5321 additionalProperties:
5322 type: string
5323 subtype:
5324 type: string
5325 type:
5326 type: string
5327 wildcardSubtype:
5328 type: boolean
5329 wildcardType:
5330 type: boolean
5331 metadata:
5332 type: object
5333 additionalProperties:
5334 type: array
5335 items:
5336 type: object
5337 status:
5338 type: integer
5339 format: int32
5340 statusInfo:
5341 type: object
5342 properties:
5343 family:
5344 type: string
5345 enum:
5346 - INFORMATIONAL
5347 - SUCCESSFUL
5348 - REDIRECTION
5349 - CLIENT_ERROR
5350 - SERVER_ERROR
5351 - OTHER
5352 reasonPhrase:
5353 type: string
5354 statusCode:
5355 type: integer
5356 format: int32
5357 stringHeaders:
5358 type: object
5359 additionalProperties:
5360 type: array
5361 items:
5362 type: string
5363 servers:
5364 - url: /sdc2/rest
5365 variables: {}
5366 summary: Returns delete artifact
5367 tags:
5368 - SDCE-2 APIs
5369 get:
5370 description: Download resource Artifact in Base64
5371 operationId: downloadResourceArtifactBase64
5372 parameters:
5373 - in: path
5374 name: resourceId
5375 required: true
5376 schema:
5377 type: string
5378 - in: path
5379 name: artifactId
5380 required: true
5381 schema:
5382 type: string
5383 responses:
5384 "200":
5385 description: Resource artifact downloaded
5386 "404":
5387 description: Resource/Artifact not found
5388 default:
5389 content:
5390 application/json:
5391 schema:
5392 type: array
5393 items:
5394 type: object
5395 properties:
5396 allowedMethods:
5397 type: array
5398 items:
5399 type: string
5400 uniqueItems: true
5401 cookies:
5402 type: object
5403 additionalProperties:
5404 type: object
5405 properties:
5406 comment:
5407 type: string
5408 domain:
5409 type: string
5410 expiry:
5411 type: string
5412 format: date-time
5413 httpOnly:
5414 type: boolean
5415 maxAge:
5416 type: integer
5417 format: int32
5418 name:
5419 type: string
5420 path:
5421 type: string
5422 secure:
5423 type: boolean
5424 value:
5425 type: string
5426 version:
5427 type: integer
5428 format: int32
5429 date:
5430 type: string
5431 format: date-time
5432 entity:
5433 type: object
5434 entityTag:
5435 type: object
5436 properties:
5437 value:
5438 type: string
5439 weak:
5440 type: boolean
5441 headers:
5442 type: object
5443 additionalProperties:
5444 type: array
5445 items:
5446 type: object
5447 language:
5448 type: object
5449 properties:
5450 country:
5451 type: string
5452 displayCountry:
5453 type: string
5454 displayLanguage:
5455 type: string
5456 displayName:
5457 type: string
5458 displayScript:
5459 type: string
5460 displayVariant:
5461 type: string
5462 extensionKeys:
5463 type: array
5464 items:
5465 type: string
5466 uniqueItems: true
5467 iso3Country:
5468 type: string
5469 iso3Language:
5470 type: string
5471 language:
5472 type: string
5473 script:
5474 type: string
5475 unicodeLocaleAttributes:
5476 type: array
5477 items:
5478 type: string
5479 uniqueItems: true
5480 unicodeLocaleKeys:
5481 type: array
5482 items:
5483 type: string
5484 uniqueItems: true
5485 variant:
5486 type: string
5487 lastModified:
5488 type: string
5489 format: date-time
5490 length:
5491 type: integer
5492 format: int32
5493 links:
5494 type: array
5495 items:
5496 type: object
5497 properties:
5498 params:
5499 type: object
5500 additionalProperties:
5501 type: string
5502 rel:
5503 type: string
5504 rels:
5505 type: array
5506 items:
5507 type: string
5508 title:
5509 type: string
5510 type:
5511 type: string
5512 uri:
5513 type: string
5514 format: uri
5515 uriBuilder:
5516 type: object
5517 uniqueItems: true
5518 location:
5519 type: string
5520 format: uri
5521 mediaType:
5522 type: object
5523 properties:
5524 parameters:
5525 type: object
5526 additionalProperties:
5527 type: string
5528 subtype:
5529 type: string
5530 type:
5531 type: string
5532 wildcardSubtype:
5533 type: boolean
5534 wildcardType:
5535 type: boolean
5536 metadata:
5537 type: object
5538 additionalProperties:
5539 type: array
5540 items:
5541 type: object
5542 status:
5543 type: integer
5544 format: int32
5545 statusInfo:
5546 type: object
5547 properties:
5548 family:
5549 type: string
5550 enum:
5551 - INFORMATIONAL
5552 - SUCCESSFUL
5553 - REDIRECTION
5554 - CLIENT_ERROR
5555 - SERVER_ERROR
5556 - OTHER
5557 reasonPhrase:
5558 type: string
5559 statusCode:
5560 type: integer
5561 format: int32
5562 stringHeaders:
5563 type: object
5564 additionalProperties:
5565 type: array
5566 items:
5567 type: string
5568 servers:
5569 - url: /sdc2/rest
5570 variables: {}
5571 summary: Returns downloaded artifact
5572 tags:
5573 - SDCE-2 APIs
5574 post:
5575 description: Update Artifact
5576 operationId: updateArtifact
5577 parameters:
5578 - in: path
5579 name: resourceId
5580 required: true
5581 schema:
5582 type: string
5583 - in: path
5584 name: artifactId
5585 required: true
5586 schema:
5587 type: string
5588 requestBody:
5589 content:
5590 application/json:
5591 schema:
5592 type: string
5593 description: json describe the artifact
5594 required: true
5595 responses:
5596 "201":
5597 description: Resource created
5598 "400":
5599 description: Invalid content / Missing content
5600 "403":
5601 description: Restricted operation
5602 default:
5603 content:
5604 application/json:
5605 schema:
5606 type: array
5607 items:
5608 type: object
5609 properties:
5610 allowedMethods:
5611 type: array
5612 items:
5613 type: string
5614 uniqueItems: true
5615 cookies:
5616 type: object
5617 additionalProperties:
5618 type: object
5619 properties:
5620 comment:
5621 type: string
5622 domain:
5623 type: string
5624 expiry:
5625 type: string
5626 format: date-time
5627 httpOnly:
5628 type: boolean
5629 maxAge:
5630 type: integer
5631 format: int32
5632 name:
5633 type: string
5634 path:
5635 type: string
5636 secure:
5637 type: boolean
5638 value:
5639 type: string
5640 version:
5641 type: integer
5642 format: int32
5643 date:
5644 type: string
5645 format: date-time
5646 entity:
5647 type: object
5648 entityTag:
5649 type: object
5650 properties:
5651 value:
5652 type: string
5653 weak:
5654 type: boolean
5655 headers:
5656 type: object
5657 additionalProperties:
5658 type: array
5659 items:
5660 type: object
5661 language:
5662 type: object
5663 properties:
5664 country:
5665 type: string
5666 displayCountry:
5667 type: string
5668 displayLanguage:
5669 type: string
5670 displayName:
5671 type: string
5672 displayScript:
5673 type: string
5674 displayVariant:
5675 type: string
5676 extensionKeys:
5677 type: array
5678 items:
5679 type: string
5680 uniqueItems: true
5681 iso3Country:
5682 type: string
5683 iso3Language:
5684 type: string
5685 language:
5686 type: string
5687 script:
5688 type: string
5689 unicodeLocaleAttributes:
5690 type: array
5691 items:
5692 type: string
5693 uniqueItems: true
5694 unicodeLocaleKeys:
5695 type: array
5696 items:
5697 type: string
5698 uniqueItems: true
5699 variant:
5700 type: string
5701 lastModified:
5702 type: string
5703 format: date-time
5704 length:
5705 type: integer
5706 format: int32
5707 links:
5708 type: array
5709 items:
5710 type: object
5711 properties:
5712 params:
5713 type: object
5714 additionalProperties:
5715 type: string
5716 rel:
5717 type: string
5718 rels:
5719 type: array
5720 items:
5721 type: string
5722 title:
5723 type: string
5724 type:
5725 type: string
5726 uri:
5727 type: string
5728 format: uri
5729 uriBuilder:
5730 type: object
5731 uniqueItems: true
5732 location:
5733 type: string
5734 format: uri
5735 mediaType:
5736 type: object
5737 properties:
5738 parameters:
5739 type: object
5740 additionalProperties:
5741 type: string
5742 subtype:
5743 type: string
5744 type:
5745 type: string
5746 wildcardSubtype:
5747 type: boolean
5748 wildcardType:
5749 type: boolean
5750 metadata:
5751 type: object
5752 additionalProperties:
5753 type: array
5754 items:
5755 type: object
5756 status:
5757 type: integer
5758 format: int32
5759 statusInfo:
5760 type: object
5761 properties:
5762 family:
5763 type: string
5764 enum:
5765 - INFORMATIONAL
5766 - SUCCESSFUL
5767 - REDIRECTION
5768 - CLIENT_ERROR
5769 - SERVER_ERROR
5770 - OTHER
5771 reasonPhrase:
5772 type: string
5773 statusCode:
5774 type: integer
5775 format: int32
5776 stringHeaders:
5777 type: object
5778 additionalProperties:
5779 type: array
5780 items:
5781 type: string
5782 servers:
5783 - url: /sdc2/rest
5784 variables: {}
5785 summary: Returns updated artifact
5786 tags:
5787 - SDCE-2 APIs
5788 /v1/catalog/resources/{resourceId}/attributes:
5789 get:
5790 description: Get Resource Attribute
5791 operationId: getAttributeListInResource
5792 parameters:
5793 - description: resource id of attribute
5794 in: path
5795 name: resourceId
5796 required: true
5797 schema:
5798 type: string
5799 - in: header
5800 name: USER_ID
5801 schema:
5802 type: string
5803 responses:
5804 "200":
5805 description: attribute
5806 "400":
5807 description: Invalid content / Missing content
5808 "403":
5809 description: Restricted operation
5810 "404":
5811 description: Resource attribute not found
5812 default:
5813 content:
5814 application/json:
5815 schema:
5816 type: array
5817 items:
5818 type: object
5819 properties:
5820 allowedMethods:
5821 type: array
5822 items:
5823 type: string
5824 uniqueItems: true
5825 cookies:
5826 type: object
5827 additionalProperties:
5828 type: object
5829 properties:
5830 comment:
5831 type: string
5832 domain:
5833 type: string
5834 expiry:
5835 type: string
5836 format: date-time
5837 httpOnly:
5838 type: boolean
5839 maxAge:
5840 type: integer
5841 format: int32
5842 name:
5843 type: string
5844 path:
5845 type: string
5846 secure:
5847 type: boolean
5848 value:
5849 type: string
5850 version:
5851 type: integer
5852 format: int32
5853 date:
5854 type: string
5855 format: date-time
5856 entity:
5857 type: object
5858 entityTag:
5859 type: object
5860 properties:
5861 value:
5862 type: string
5863 weak:
5864 type: boolean
5865 headers:
5866 type: object
5867 additionalProperties:
5868 type: array
5869 items:
5870 type: object
5871 language:
5872 type: object
5873 properties:
5874 country:
5875 type: string
5876 displayCountry:
5877 type: string
5878 displayLanguage:
5879 type: string
5880 displayName:
5881 type: string
5882 displayScript:
5883 type: string
5884 displayVariant:
5885 type: string
5886 extensionKeys:
5887 type: array
5888 items:
5889 type: string
5890 uniqueItems: true
5891 iso3Country:
5892 type: string
5893 iso3Language:
5894 type: string
5895 language:
5896 type: string
5897 script:
5898 type: string
5899 unicodeLocaleAttributes:
5900 type: array
5901 items:
5902 type: string
5903 uniqueItems: true
5904 unicodeLocaleKeys:
5905 type: array
5906 items:
5907 type: string
5908 uniqueItems: true
5909 variant:
5910 type: string
5911 lastModified:
5912 type: string
5913 format: date-time
5914 length:
5915 type: integer
5916 format: int32
5917 links:
5918 type: array
5919 items:
5920 type: object
5921 properties:
5922 params:
5923 type: object
5924 additionalProperties:
5925 type: string
5926 rel:
5927 type: string
5928 rels:
5929 type: array
5930 items:
5931 type: string
5932 title:
5933 type: string
5934 type:
5935 type: string
5936 uri:
5937 type: string
5938 format: uri
5939 uriBuilder:
5940 type: object
5941 uniqueItems: true
5942 location:
5943 type: string
5944 format: uri
5945 mediaType:
5946 type: object
5947 properties:
5948 parameters:
5949 type: object
5950 additionalProperties:
5951 type: string
5952 subtype:
5953 type: string
5954 type:
5955 type: string
5956 wildcardSubtype:
5957 type: boolean
5958 wildcardType:
5959 type: boolean
5960 metadata:
5961 type: object
5962 additionalProperties:
5963 type: array
5964 items:
5965 type: object
5966 status:
5967 type: integer
5968 format: int32
5969 statusInfo:
5970 type: object
5971 properties:
5972 family:
5973 type: string
5974 enum:
5975 - INFORMATIONAL
5976 - SUCCESSFUL
5977 - REDIRECTION
5978 - CLIENT_ERROR
5979 - SERVER_ERROR
5980 - OTHER
5981 reasonPhrase:
5982 type: string
5983 statusCode:
5984 type: integer
5985 format: int32
5986 stringHeaders:
5987 type: object
5988 additionalProperties:
5989 type: array
5990 items:
5991 type: string
5992 servers:
5993 - url: /sdc2/rest
5994 variables: {}
5995 summary: Returns attribute list of resource
5996 tags:
5997 - SDCE-2 APIs
5998 post:
5999 description: Create Resource Attribute
6000 operationId: createAttribute
6001 parameters:
6002 - description: resource id to update with new attribute
6003 in: path
6004 name: resourceId
6005 required: true
6006 schema:
6007 type: string
6008 - in: header
6009 name: USER_ID
6010 schema:
6011 type: string
6012 requestBody:
6013 content:
6014 application/json:
6015 schema:
6016 type: string
6017 description: Resource attribute to be created
6018 required: true
6019 responses:
6020 "201":
6021 description: Resource property created
6022 "400":
6023 description: Invalid content / Missing content
6024 "403":
6025 description: Restricted operation
6026 "409":
6027 description: Resource attribute already exist
6028 default:
6029 content:
6030 application/json:
6031 schema:
6032 type: array
6033 items:
6034 type: object
6035 properties:
6036 allowedMethods:
6037 type: array
6038 items:
6039 type: string
6040 uniqueItems: true
6041 cookies:
6042 type: object
6043 additionalProperties:
6044 type: object
6045 properties:
6046 comment:
6047 type: string
6048 domain:
6049 type: string
6050 expiry:
6051 type: string
6052 format: date-time
6053 httpOnly:
6054 type: boolean
6055 maxAge:
6056 type: integer
6057 format: int32
6058 name:
6059 type: string
6060 path:
6061 type: string
6062 secure:
6063 type: boolean
6064 value:
6065 type: string
6066 version:
6067 type: integer
6068 format: int32
6069 date:
6070 type: string
6071 format: date-time
6072 entity:
6073 type: object
6074 entityTag:
6075 type: object
6076 properties:
6077 value:
6078 type: string
6079 weak:
6080 type: boolean
6081 headers:
6082 type: object
6083 additionalProperties:
6084 type: array
6085 items:
6086 type: object
6087 language:
6088 type: object
6089 properties:
6090 country:
6091 type: string
6092 displayCountry:
6093 type: string
6094 displayLanguage:
6095 type: string
6096 displayName:
6097 type: string
6098 displayScript:
6099 type: string
6100 displayVariant:
6101 type: string
6102 extensionKeys:
6103 type: array
6104 items:
6105 type: string
6106 uniqueItems: true
6107 iso3Country:
6108 type: string
6109 iso3Language:
6110 type: string
6111 language:
6112 type: string
6113 script:
6114 type: string
6115 unicodeLocaleAttributes:
6116 type: array
6117 items:
6118 type: string
6119 uniqueItems: true
6120 unicodeLocaleKeys:
6121 type: array
6122 items:
6123 type: string
6124 uniqueItems: true
6125 variant:
6126 type: string
6127 lastModified:
6128 type: string
6129 format: date-time
6130 length:
6131 type: integer
6132 format: int32
6133 links:
6134 type: array
6135 items:
6136 type: object
6137 properties:
6138 params:
6139 type: object
6140 additionalProperties:
6141 type: string
6142 rel:
6143 type: string
6144 rels:
6145 type: array
6146 items:
6147 type: string
6148 title:
6149 type: string
6150 type:
6151 type: string
6152 uri:
6153 type: string
6154 format: uri
6155 uriBuilder:
6156 type: object
6157 uniqueItems: true
6158 location:
6159 type: string
6160 format: uri
6161 mediaType:
6162 type: object
6163 properties:
6164 parameters:
6165 type: object
6166 additionalProperties:
6167 type: string
6168 subtype:
6169 type: string
6170 type:
6171 type: string
6172 wildcardSubtype:
6173 type: boolean
6174 wildcardType:
6175 type: boolean
6176 metadata:
6177 type: object
6178 additionalProperties:
6179 type: array
6180 items:
6181 type: object
6182 status:
6183 type: integer
6184 format: int32
6185 statusInfo:
6186 type: object
6187 properties:
6188 family:
6189 type: string
6190 enum:
6191 - INFORMATIONAL
6192 - SUCCESSFUL
6193 - REDIRECTION
6194 - CLIENT_ERROR
6195 - SERVER_ERROR
6196 - OTHER
6197 reasonPhrase:
6198 type: string
6199 statusCode:
6200 type: integer
6201 format: int32
6202 stringHeaders:
6203 type: object
6204 additionalProperties:
6205 type: array
6206 items:
6207 type: string
6208 servers:
6209 - url: /sdc2/rest
6210 variables: {}
6211 summary: Returns created resource attribute
6212 tags:
6213 - SDCE-2 APIs
6214 /v1/catalog/resources/{resourceId}/attributes/{attributeId}:
6215 delete:
6216 description: Create Resource Attribute
6217 operationId: deleteAttribute
6218 parameters:
6219 - description: resource id of attribute
6220 in: path
6221 name: resourceId
6222 required: true
6223 schema:
6224 type: string
6225 - description: Attribute id to delete
6226 in: path
6227 name: attributeId
6228 required: true
6229 schema:
6230 type: string
6231 - in: header
6232 name: USER_ID
6233 schema:
6234 type: string
6235 responses:
6236 "204":
6237 description: deleted attribute
6238 "400":
6239 description: Invalid content / Missing content
6240 "403":
6241 description: Restricted operation
6242 "404":
6243 description: Resource property not found
6244 default:
6245 content:
6246 application/json:
6247 schema:
6248 type: array
6249 items:
6250 type: object
6251 properties:
6252 allowedMethods:
6253 type: array
6254 items:
6255 type: string
6256 uniqueItems: true
6257 cookies:
6258 type: object
6259 additionalProperties:
6260 type: object
6261 properties:
6262 comment:
6263 type: string
6264 domain:
6265 type: string
6266 expiry:
6267 type: string
6268 format: date-time
6269 httpOnly:
6270 type: boolean
6271 maxAge:
6272 type: integer
6273 format: int32
6274 name:
6275 type: string
6276 path:
6277 type: string
6278 secure:
6279 type: boolean
6280 value:
6281 type: string
6282 version:
6283 type: integer
6284 format: int32
6285 date:
6286 type: string
6287 format: date-time
6288 entity:
6289 type: object
6290 entityTag:
6291 type: object
6292 properties:
6293 value:
6294 type: string
6295 weak:
6296 type: boolean
6297 headers:
6298 type: object
6299 additionalProperties:
6300 type: array
6301 items:
6302 type: object
6303 language:
6304 type: object
6305 properties:
6306 country:
6307 type: string
6308 displayCountry:
6309 type: string
6310 displayLanguage:
6311 type: string
6312 displayName:
6313 type: string
6314 displayScript:
6315 type: string
6316 displayVariant:
6317 type: string
6318 extensionKeys:
6319 type: array
6320 items:
6321 type: string
6322 uniqueItems: true
6323 iso3Country:
6324 type: string
6325 iso3Language:
6326 type: string
6327 language:
6328 type: string
6329 script:
6330 type: string
6331 unicodeLocaleAttributes:
6332 type: array
6333 items:
6334 type: string
6335 uniqueItems: true
6336 unicodeLocaleKeys:
6337 type: array
6338 items:
6339 type: string
6340 uniqueItems: true
6341 variant:
6342 type: string
6343 lastModified:
6344 type: string
6345 format: date-time
6346 length:
6347 type: integer
6348 format: int32
6349 links:
6350 type: array
6351 items:
6352 type: object
6353 properties:
6354 params:
6355 type: object
6356 additionalProperties:
6357 type: string
6358 rel:
6359 type: string
6360 rels:
6361 type: array
6362 items:
6363 type: string
6364 title:
6365 type: string
6366 type:
6367 type: string
6368 uri:
6369 type: string
6370 format: uri
6371 uriBuilder:
6372 type: object
6373 uniqueItems: true
6374 location:
6375 type: string
6376 format: uri
6377 mediaType:
6378 type: object
6379 properties:
6380 parameters:
6381 type: object
6382 additionalProperties:
6383 type: string
6384 subtype:
6385 type: string
6386 type:
6387 type: string
6388 wildcardSubtype:
6389 type: boolean
6390 wildcardType:
6391 type: boolean
6392 metadata:
6393 type: object
6394 additionalProperties:
6395 type: array
6396 items:
6397 type: object
6398 status:
6399 type: integer
6400 format: int32
6401 statusInfo:
6402 type: object
6403 properties:
6404 family:
6405 type: string
6406 enum:
6407 - INFORMATIONAL
6408 - SUCCESSFUL
6409 - REDIRECTION
6410 - CLIENT_ERROR
6411 - SERVER_ERROR
6412 - OTHER
6413 reasonPhrase:
6414 type: string
6415 statusCode:
6416 type: integer
6417 format: int32
6418 stringHeaders:
6419 type: object
6420 additionalProperties:
6421 type: array
6422 items:
6423 type: string
6424 servers:
6425 - url: /sdc2/rest
6426 variables: {}
6427 summary: Returns deleted attribute
6428 tags:
6429 - SDCE-2 APIs
6430 put:
6431 description: Update Resource Attribute
6432 operationId: updateAttribute
6433 parameters:
6434 - description: resource id to update with new attribute
6435 in: path
6436 name: resourceId
6437 required: true
6438 schema:
6439 type: string
6440 - description: attribute id to update
6441 in: path
6442 name: attributeId
6443 required: true
6444 schema:
6445 type: string
6446 - in: header
6447 name: USER_ID
6448 schema:
6449 type: string
6450 requestBody:
6451 content:
6452 application/json:
6453 schema:
6454 type: string
6455 description: Resource attribute to update
6456 required: true
6457 responses:
6458 "200":
6459 description: Resource attribute updated
6460 "400":
6461 description: Invalid content / Missing content
6462 "403":
6463 description: Restricted operation
6464 default:
6465 content:
6466 application/json:
6467 schema:
6468 type: array
6469 items:
6470 type: object
6471 properties:
6472 allowedMethods:
6473 type: array
6474 items:
6475 type: string
6476 uniqueItems: true
6477 cookies:
6478 type: object
6479 additionalProperties:
6480 type: object
6481 properties:
6482 comment:
6483 type: string
6484 domain:
6485 type: string
6486 expiry:
6487 type: string
6488 format: date-time
6489 httpOnly:
6490 type: boolean
6491 maxAge:
6492 type: integer
6493 format: int32
6494 name:
6495 type: string
6496 path:
6497 type: string
6498 secure:
6499 type: boolean
6500 value:
6501 type: string
6502 version:
6503 type: integer
6504 format: int32
6505 date:
6506 type: string
6507 format: date-time
6508 entity:
6509 type: object
6510 entityTag:
6511 type: object
6512 properties:
6513 value:
6514 type: string
6515 weak:
6516 type: boolean
6517 headers:
6518 type: object
6519 additionalProperties:
6520 type: array
6521 items:
6522 type: object
6523 language:
6524 type: object
6525 properties:
6526 country:
6527 type: string
6528 displayCountry:
6529 type: string
6530 displayLanguage:
6531 type: string
6532 displayName:
6533 type: string
6534 displayScript:
6535 type: string
6536 displayVariant:
6537 type: string
6538 extensionKeys:
6539 type: array
6540 items:
6541 type: string
6542 uniqueItems: true
6543 iso3Country:
6544 type: string
6545 iso3Language:
6546 type: string
6547 language:
6548 type: string
6549 script:
6550 type: string
6551 unicodeLocaleAttributes:
6552 type: array
6553 items:
6554 type: string
6555 uniqueItems: true
6556 unicodeLocaleKeys:
6557 type: array
6558 items:
6559 type: string
6560 uniqueItems: true
6561 variant:
6562 type: string
6563 lastModified:
6564 type: string
6565 format: date-time
6566 length:
6567 type: integer
6568 format: int32
6569 links:
6570 type: array
6571 items:
6572 type: object
6573 properties:
6574 params:
6575 type: object
6576 additionalProperties:
6577 type: string
6578 rel:
6579 type: string
6580 rels:
6581 type: array
6582 items:
6583 type: string
6584 title:
6585 type: string
6586 type:
6587 type: string
6588 uri:
6589 type: string
6590 format: uri
6591 uriBuilder:
6592 type: object
6593 uniqueItems: true
6594 location:
6595 type: string
6596 format: uri
6597 mediaType:
6598 type: object
6599 properties:
6600 parameters:
6601 type: object
6602 additionalProperties:
6603 type: string
6604 subtype:
6605 type: string
6606 type:
6607 type: string
6608 wildcardSubtype:
6609 type: boolean
6610 wildcardType:
6611 type: boolean
6612 metadata:
6613 type: object
6614 additionalProperties:
6615 type: array
6616 items:
6617 type: object
6618 status:
6619 type: integer
6620 format: int32
6621 statusInfo:
6622 type: object
6623 properties:
6624 family:
6625 type: string
6626 enum:
6627 - INFORMATIONAL
6628 - SUCCESSFUL
6629 - REDIRECTION
6630 - CLIENT_ERROR
6631 - SERVER_ERROR
6632 - OTHER
6633 reasonPhrase:
6634 type: string
6635 statusCode:
6636 type: integer
6637 format: int32
6638 stringHeaders:
6639 type: object
6640 additionalProperties:
6641 type: array
6642 items:
6643 type: string
6644 servers:
6645 - url: /sdc2/rest
6646 variables: {}
6647 summary: Returns updated attribute
6648 tags:
6649 - SDCE-2 APIs
6650 /v1/catalog/resources/{resourceId}/capabilities:
6651 post:
6652 description: Create Capabilities on resource
6653 operationId: createCapabilitiesOnResource
6654 parameters:
6655 - description: Resource Id
6656 in: path
6657 name: resourceId
6658 required: true
6659 schema:
6660 type: string
6661 - in: header
6662 name: USER_ID
6663 schema:
6664 type: string
6665 requestBody:
6666 content:
6667 application/json:
6668 schema:
6669 type: string
6670 description: Capability to create
6671 required: true
6672 responses:
6673 "201":
6674 description: Create Capabilities
6675 "400":
6676 description: Invalid content / Missing content
6677 "403":
6678 description: Restricted operation
6679 "409":
6680 description: Capability already exist
6681 default:
6682 content:
6683 application/json:
6684 schema:
6685 type: array
6686 items:
6687 type: object
6688 properties:
6689 allowedMethods:
6690 type: array
6691 items:
6692 type: string
6693 uniqueItems: true
6694 cookies:
6695 type: object
6696 additionalProperties:
6697 type: object
6698 properties:
6699 comment:
6700 type: string
6701 domain:
6702 type: string
6703 expiry:
6704 type: string
6705 format: date-time
6706 httpOnly:
6707 type: boolean
6708 maxAge:
6709 type: integer
6710 format: int32
6711 name:
6712 type: string
6713 path:
6714 type: string
6715 secure:
6716 type: boolean
6717 value:
6718 type: string
6719 version:
6720 type: integer
6721 format: int32
6722 date:
6723 type: string
6724 format: date-time
6725 entity:
6726 type: object
6727 entityTag:
6728 type: object
6729 properties:
6730 value:
6731 type: string
6732 weak:
6733 type: boolean
6734 headers:
6735 type: object
6736 additionalProperties:
6737 type: array
6738 items:
6739 type: object
6740 language:
6741 type: object
6742 properties:
6743 country:
6744 type: string
6745 displayCountry:
6746 type: string
6747 displayLanguage:
6748 type: string
6749 displayName:
6750 type: string
6751 displayScript:
6752 type: string
6753 displayVariant:
6754 type: string
6755 extensionKeys:
6756 type: array
6757 items:
6758 type: string
6759 uniqueItems: true
6760 iso3Country:
6761 type: string
6762 iso3Language:
6763 type: string
6764 language:
6765 type: string
6766 script:
6767 type: string
6768 unicodeLocaleAttributes:
6769 type: array
6770 items:
6771 type: string
6772 uniqueItems: true
6773 unicodeLocaleKeys:
6774 type: array
6775 items:
6776 type: string
6777 uniqueItems: true
6778 variant:
6779 type: string
6780 lastModified:
6781 type: string
6782 format: date-time
6783 length:
6784 type: integer
6785 format: int32
6786 links:
6787 type: array
6788 items:
6789 type: object
6790 properties:
6791 params:
6792 type: object
6793 additionalProperties:
6794 type: string
6795 rel:
6796 type: string
6797 rels:
6798 type: array
6799 items:
6800 type: string
6801 title:
6802 type: string
6803 type:
6804 type: string
6805 uri:
6806 type: string
6807 format: uri
6808 uriBuilder:
6809 type: object
6810 uniqueItems: true
6811 location:
6812 type: string
6813 format: uri
6814 mediaType:
6815 type: object
6816 properties:
6817 parameters:
6818 type: object
6819 additionalProperties:
6820 type: string
6821 subtype:
6822 type: string
6823 type:
6824 type: string
6825 wildcardSubtype:
6826 type: boolean
6827 wildcardType:
6828 type: boolean
6829 metadata:
6830 type: object
6831 additionalProperties:
6832 type: array
6833 items:
6834 type: object
6835 status:
6836 type: integer
6837 format: int32
6838 statusInfo:
6839 type: object
6840 properties:
6841 family:
6842 type: string
6843 enum:
6844 - INFORMATIONAL
6845 - SUCCESSFUL
6846 - REDIRECTION
6847 - CLIENT_ERROR
6848 - SERVER_ERROR
6849 - OTHER
6850 reasonPhrase:
6851 type: string
6852 statusCode:
6853 type: integer
6854 format: int32
6855 stringHeaders:
6856 type: object
6857 additionalProperties:
6858 type: array
6859 items:
6860 type: string
6861 servers:
6862 - url: /sdc2/rest
6863 variables: {}
6864 summary: Create Capabilities on resource
6865 tags:
6866 - SDCE-2 APIs
6867 put:
6868 description: Update Capabilities on resource
6869 operationId: updateCapabilitiesOnResource
6870 parameters:
6871 - description: Component Id
6872 in: path
6873 name: resourceId
6874 required: true
6875 schema:
6876 type: string
6877 - in: header
6878 name: USER_ID
6879 schema:
6880 type: string
6881 requestBody:
6882 content:
6883 application/json:
6884 schema:
6885 type: string
6886 description: Capabilities to update
6887 required: true
6888 responses:
6889 "201":
6890 description: Update Capabilities
6891 "400":
6892 description: Invalid content / Missing content
6893 "403":
6894 description: Restricted operation
6895 default:
6896 content:
6897 application/json:
6898 schema:
6899 type: array
6900 items:
6901 $ref: '#/components/schemas/CapabilityDefinition'
6902 servers:
6903 - url: /sdc2/rest
6904 variables: {}
6905 summary: Update Capabilities on resource
6906 tags:
6907 - SDCE-2 APIs
6908 /v1/catalog/resources/{resourceId}/capabilities/{capabilityId}:
6909 delete:
6910 description: Delete capability from resource
6911 operationId: deleteCapabilityOnResource
6912 parameters:
6913 - description: capability Id
6914 in: path
6915 name: capabilityId
6916 required: true
6917 schema:
6918 type: string
6919 - description: Resource Id
6920 in: path
6921 name: resourceId
6922 required: true
6923 schema:
6924 type: string
6925 - in: header
6926 name: USER_ID
6927 schema:
6928 type: string
6929 responses:
6930 "201":
6931 description: Delete capability
6932 "400":
6933 description: Invalid content / Missing content
6934 "403":
6935 description: Restricted operation
6936 default:
6937 content:
6938 application/json:
6939 schema:
6940 type: array
6941 items:
6942 $ref: '#/components/schemas/CapabilityDefinition'
6943 servers:
6944 - url: /sdc2/rest
6945 variables: {}
6946 summary: Delete capability from resource
6947 tags:
6948 - SDCE-2 APIs
6949 get:
6950 description: Get Capability from resource
6951 operationId: getCapabilityOnResource
6952 parameters:
6953 - description: Resource Id
6954 in: path
6955 name: resourceId
6956 required: true
6957 schema:
6958 type: string
6959 - description: Capability Id
6960 in: path
6961 name: capabilityId
6962 required: true
6963 schema:
6964 type: string
6965 - in: header
6966 name: USER_ID
6967 schema:
6968 type: string
6969 responses:
6970 "201":
6971 description: GET Capability
6972 "400":
6973 description: Invalid content / Missing content
6974 "403":
6975 description: Restricted operation
6976 default:
6977 content:
6978 application/json:
6979 schema:
6980 type: array
6981 items:
6982 $ref: '#/components/schemas/CapabilityDefinition'
6983 servers:
6984 - url: /sdc2/rest
6985 variables: {}
6986 summary: GET Capability from resource
6987 tags:
6988 - SDCE-2 APIs
6989 /v1/catalog/resources/{resourceId}/interfaceOperations:
6990 post:
6991 description: Create Interface Operations on Resource
6992 operationId: createInterfaceOperationsOnResource
6993 parameters:
6994 - description: Resource Id
6995 in: path
6996 name: resourceId
6997 required: true
6998 schema:
6999 type: string
7000 - in: header
7001 name: USER_ID
7002 schema:
7003 type: string
7004 requestBody:
7005 content:
7006 application/json:
7007 schema:
7008 type: string
7009 description: Interface Operations to create
7010 required: true
7011 responses:
7012 "201":
7013 description: Create Interface Operations on Resource
7014 "400":
7015 description: Invalid content / Missing content
7016 "403":
7017 description: Restricted operation
7018 "404":
7019 description: Resource not found
7020 "409":
7021 description: Interface Operation already exist
7022 default:
7023 content:
7024 application/json:
7025 schema:
7026 type: array
7027 items:
7028 $ref: '#/components/schemas/InterfaceDefinition'
7029 servers:
7030 - url: /sdc2/rest
7031 variables: {}
7032 summary: Create Interface Operations on Resource
7033 tags:
7034 - SDCE-2 APIs
7035 put:
7036 description: Update Interface Operations on Resource
7037 operationId: updateInterfaceOperationsOnResource
7038 parameters:
7039 - description: Resource Id
7040 in: path
7041 name: resourceId
7042 required: true
7043 schema:
7044 type: string
7045 - in: header
7046 name: USER_ID
7047 schema:
7048 type: string
7049 requestBody:
7050 content:
7051 application/json:
7052 schema:
7053 type: string
7054 description: Interface Operations to update
7055 required: true
7056 responses:
7057 "201":
7058 description: Update Interface Operations on Resource
7059 "400":
7060 description: Invalid content / Missing content
7061 "403":
7062 description: Restricted operation
7063 "404":
7064 description: Resource not found
7065 default:
7066 content:
7067 application/json:
7068 schema:
7069 type: array
7070 items:
7071 $ref: '#/components/schemas/InterfaceDefinition'
7072 servers:
7073 - url: /sdc2/rest
7074 variables: {}
7075 summary: Update Interface Operations on Resource
7076 tags:
7077 - SDCE-2 APIs
7078 /v1/catalog/resources/{resourceId}/interfaces/{interfaceId}/operations/{operationId}:
7079 delete:
7080 description: Delete Interface Operation from Resource
7081 operationId: deleteInterfaceOperationsFromResource
7082 parameters:
7083 - description: Resource Id
7084 in: path
7085 name: resourceId
7086 required: true
7087 schema:
7088 type: string
7089 - description: Interface Id
7090 in: path
7091 name: interfaceId
7092 required: true
7093 schema:
7094 type: string
7095 - description: Operation Id
7096 in: path
7097 name: operationId
7098 required: true
7099 schema:
7100 type: string
7101 - in: header
7102 name: USER_ID
7103 schema:
7104 type: string
7105 responses:
7106 "201":
7107 description: Delete Interface Operation from Resource
7108 "400":
7109 description: Invalid content / Missing content
7110 "403":
7111 description: Restricted operation
7112 "404":
7113 description: Resource not found
7114 default:
7115 content:
7116 application/json:
7117 schema:
7118 type: array
7119 items:
7120 $ref: '#/components/schemas/InterfaceDefinition'
7121 servers:
7122 - url: /sdc2/rest
7123 variables: {}
7124 summary: Delete Interface Operation from Resource
7125 tags:
7126 - SDCE-2 APIs
7127 get:
7128 description: Get Interface Operation from Resource
7129 operationId: getInterfaceOperationsFromResource
7130 parameters:
7131 - description: Resource Id
7132 in: path
7133 name: resourceId
7134 required: true
7135 schema:
7136 type: string
7137 - description: Interface Id
7138 in: path
7139 name: interfaceId
7140 required: true
7141 schema:
7142 type: string
7143 - description: Operation Id
7144 in: path
7145 name: operationId
7146 required: true
7147 schema:
7148 type: string
7149 - in: header
7150 name: USER_ID
7151 schema:
7152 type: string
7153 responses:
7154 "201":
7155 description: Delete Interface Operation from Resource
7156 "400":
7157 description: Invalid content / Missing content
7158 "403":
7159 description: Restricted operation
7160 "404":
7161 description: Resource not found
7162 default:
7163 content:
7164 application/json:
7165 schema:
7166 type: array
7167 items:
7168 $ref: '#/components/schemas/InterfaceDefinition'
7169 servers:
7170 - url: /sdc2/rest
7171 variables: {}
7172 summary: GET Interface Operation from Resource
7173 tags:
7174 - SDCE-2 APIs
7175 /v1/catalog/resources/{resourceId}/metadata:
7176 put:
7177 description: Update Resource Metadata
7178 operationId: updateResourceMetadata
7179 parameters:
7180 - in: path
7181 name: resourceId
7182 required: true
7183 schema:
7184 type: string
7185 - in: header
7186 name: USER_ID
7187 schema:
7188 type: string
7189 requestBody:
7190 content:
7191 application/json:
7192 schema:
7193 type: string
7194 description: Resource metadata to be updated
7195 required: true
7196 responses:
7197 "200":
7198 description: Resource metadata updated
7199 "400":
7200 description: Invalid content
7201 "403":
7202 description: Restricted operation
7203 default:
7204 content:
7205 application/json:
7206 schema:
7207 type: array
7208 items:
7209 $ref: '#/components/schemas/Resource'
7210 servers:
7211 - url: /sdc2/rest
7212 variables: {}
7213 summary: Returns updated resource metadata
7214 tags:
7215 - SDCE-2 APIs
7216 /v1/catalog/resources/{resourceId}/properties:
7217 get:
7218 description: Get Resource Property
7219 operationId: getPropertyListInResource
7220 parameters:
7221 - description: resource id of property
7222 in: path
7223 name: resourceId
7224 required: true
7225 schema:
7226 type: string
7227 - in: header
7228 name: USER_ID
7229 schema:
7230 type: string
7231 responses:
7232 "200":
7233 description: property
7234 "400":
7235 description: Invalid content / Missing content
7236 "403":
7237 description: Restricted operation
7238 "404":
7239 description: Resource property not found
7240 default:
7241 content:
7242 application/json:
7243 schema:
7244 type: array
7245 items:
7246 type: object
7247 properties:
7248 allowedMethods:
7249 type: array
7250 items:
7251 type: string
7252 uniqueItems: true
7253 cookies:
7254 type: object
7255 additionalProperties:
7256 type: object
7257 properties:
7258 comment:
7259 type: string
7260 domain:
7261 type: string
7262 expiry:
7263 type: string
7264 format: date-time
7265 httpOnly:
7266 type: boolean
7267 maxAge:
7268 type: integer
7269 format: int32
7270 name:
7271 type: string
7272 path:
7273 type: string
7274 secure:
7275 type: boolean
7276 value:
7277 type: string
7278 version:
7279 type: integer
7280 format: int32
7281 date:
7282 type: string
7283 format: date-time
7284 entity:
7285 type: object
7286 entityTag:
7287 type: object
7288 properties:
7289 value:
7290 type: string
7291 weak:
7292 type: boolean
7293 headers:
7294 type: object
7295 additionalProperties:
7296 type: array
7297 items:
7298 type: object
7299 language:
7300 type: object
7301 properties:
7302 country:
7303 type: string
7304 displayCountry:
7305 type: string
7306 displayLanguage:
7307 type: string
7308 displayName:
7309 type: string
7310 displayScript:
7311 type: string
7312 displayVariant:
7313 type: string
7314 extensionKeys:
7315 type: array
7316 items:
7317 type: string
7318 uniqueItems: true
7319 iso3Country:
7320 type: string
7321 iso3Language:
7322 type: string
7323 language:
7324 type: string
7325 script:
7326 type: string
7327 unicodeLocaleAttributes:
7328 type: array
7329 items:
7330 type: string
7331 uniqueItems: true
7332 unicodeLocaleKeys:
7333 type: array
7334 items:
7335 type: string
7336 uniqueItems: true
7337 variant:
7338 type: string
7339 lastModified:
7340 type: string
7341 format: date-time
7342 length:
7343 type: integer
7344 format: int32
7345 links:
7346 type: array
7347 items:
7348 type: object
7349 properties:
7350 params:
7351 type: object
7352 additionalProperties:
7353 type: string
7354 rel:
7355 type: string
7356 rels:
7357 type: array
7358 items:
7359 type: string
7360 title:
7361 type: string
7362 type:
7363 type: string
7364 uri:
7365 type: string
7366 format: uri
7367 uriBuilder:
7368 type: object
7369 uniqueItems: true
7370 location:
7371 type: string
7372 format: uri
7373 mediaType:
7374 type: object
7375 properties:
7376 parameters:
7377 type: object
7378 additionalProperties:
7379 type: string
7380 subtype:
7381 type: string
7382 type:
7383 type: string
7384 wildcardSubtype:
7385 type: boolean
7386 wildcardType:
7387 type: boolean
7388 metadata:
7389 type: object
7390 additionalProperties:
7391 type: array
7392 items:
7393 type: object
7394 status:
7395 type: integer
7396 format: int32
7397 statusInfo:
7398 type: object
7399 properties:
7400 family:
7401 type: string
7402 enum:
7403 - INFORMATIONAL
7404 - SUCCESSFUL
7405 - REDIRECTION
7406 - CLIENT_ERROR
7407 - SERVER_ERROR
7408 - OTHER
7409 reasonPhrase:
7410 type: string
7411 statusCode:
7412 type: integer
7413 format: int32
7414 stringHeaders:
7415 type: object
7416 additionalProperties:
7417 type: array
7418 items:
7419 type: string
7420 servers:
7421 - url: /sdc2/rest
7422 variables: {}
7423 summary: Returns property list of resource
7424 tags:
7425 - SDCE-2 APIs
7426 post:
7427 description: Create Resource Property
7428 operationId: createPropertyInResource
7429 parameters:
7430 - description: Resource id to update with new property
7431 in: path
7432 name: resourceId
7433 required: true
7434 schema:
7435 type: string
7436 - in: header
7437 name: USER_ID
7438 schema:
7439 type: string
7440 requestBody:
7441 content:
7442 application/json:
7443 schema:
7444 type: string
7445 description: Resource property to be created
7446 required: true
7447 responses:
7448 "201":
7449 description: Resource property created
7450 "400":
7451 description: Invalid content / Missing content
7452 "403":
7453 description: Restricted operation
7454 "409":
7455 description: Resource property already exist
7456 default:
7457 content:
7458 application/json:
7459 schema:
7460 type: array
7461 items:
7462 type: object
7463 properties:
7464 allowedMethods:
7465 type: array
7466 items:
7467 type: string
7468 uniqueItems: true
7469 cookies:
7470 type: object
7471 additionalProperties:
7472 type: object
7473 properties:
7474 comment:
7475 type: string
7476 domain:
7477 type: string
7478 expiry:
7479 type: string
7480 format: date-time
7481 httpOnly:
7482 type: boolean
7483 maxAge:
7484 type: integer
7485 format: int32
7486 name:
7487 type: string
7488 path:
7489 type: string
7490 secure:
7491 type: boolean
7492 value:
7493 type: string
7494 version:
7495 type: integer
7496 format: int32
7497 date:
7498 type: string
7499 format: date-time
7500 entity:
7501 type: object
7502 entityTag:
7503 type: object
7504 properties:
7505 value:
7506 type: string
7507 weak:
7508 type: boolean
7509 headers:
7510 type: object
7511 additionalProperties:
7512 type: array
7513 items:
7514 type: object
7515 language:
7516 type: object
7517 properties:
7518 country:
7519 type: string
7520 displayCountry:
7521 type: string
7522 displayLanguage:
7523 type: string
7524 displayName:
7525 type: string
7526 displayScript:
7527 type: string
7528 displayVariant:
7529 type: string
7530 extensionKeys:
7531 type: array
7532 items:
7533 type: string
7534 uniqueItems: true
7535 iso3Country:
7536 type: string
7537 iso3Language:
7538 type: string
7539 language:
7540 type: string
7541 script:
7542 type: string
7543 unicodeLocaleAttributes:
7544 type: array
7545 items:
7546 type: string
7547 uniqueItems: true
7548 unicodeLocaleKeys:
7549 type: array
7550 items:
7551 type: string
7552 uniqueItems: true
7553 variant:
7554 type: string
7555 lastModified:
7556 type: string
7557 format: date-time
7558 length:
7559 type: integer
7560 format: int32
7561 links:
7562 type: array
7563 items:
7564 type: object
7565 properties:
7566 params:
7567 type: object
7568 additionalProperties:
7569 type: string
7570 rel:
7571 type: string
7572 rels:
7573 type: array
7574 items:
7575 type: string
7576 title:
7577 type: string
7578 type:
7579 type: string
7580 uri:
7581 type: string
7582 format: uri
7583 uriBuilder:
7584 type: object
7585 uniqueItems: true
7586 location:
7587 type: string
7588 format: uri
7589 mediaType:
7590 type: object
7591 properties:
7592 parameters:
7593 type: object
7594 additionalProperties:
7595 type: string
7596 subtype:
7597 type: string
7598 type:
7599 type: string
7600 wildcardSubtype:
7601 type: boolean
7602 wildcardType:
7603 type: boolean
7604 metadata:
7605 type: object
7606 additionalProperties:
7607 type: array
7608 items:
7609 type: object
7610 status:
7611 type: integer
7612 format: int32
7613 statusInfo:
7614 type: object
7615 properties:
7616 family:
7617 type: string
7618 enum:
7619 - INFORMATIONAL
7620 - SUCCESSFUL
7621 - REDIRECTION
7622 - CLIENT_ERROR
7623 - SERVER_ERROR
7624 - OTHER
7625 reasonPhrase:
7626 type: string
7627 statusCode:
7628 type: integer
7629 format: int32
7630 stringHeaders:
7631 type: object
7632 additionalProperties:
7633 type: array
7634 items:
7635 type: string
7636 servers:
7637 - url: /sdc2/rest
7638 variables: {}
7639 summary: Returns created service property
7640 tags:
7641 - SDCE-2 APIs
7642 put:
7643 description: Update Resource Property
7644 operationId: updatePropertyInResource
7645 parameters:
7646 - description: resource id to update with new property
7647 in: path
7648 name: resourceId
7649 required: true
7650 schema:
7651 type: string
7652 - in: header
7653 name: USER_ID
7654 schema:
7655 type: string
7656 requestBody:
7657 content:
7658 application/json:
7659 schema:
7660 type: string
7661 description: Resource property to update
7662 required: true
7663 responses:
7664 "200":
7665 description: Resource property updated
7666 "400":
7667 description: Invalid content / Missing content
7668 "403":
7669 description: Restricted operation
7670 default:
7671 content:
7672 application/json:
7673 schema:
7674 type: array
7675 items:
7676 type: object
7677 properties:
7678 allowedMethods:
7679 type: array
7680 items:
7681 type: string
7682 uniqueItems: true
7683 cookies:
7684 type: object
7685 additionalProperties:
7686 type: object
7687 properties:
7688 comment:
7689 type: string
7690 domain:
7691 type: string
7692 expiry:
7693 type: string
7694 format: date-time
7695 httpOnly:
7696 type: boolean
7697 maxAge:
7698 type: integer
7699 format: int32
7700 name:
7701 type: string
7702 path:
7703 type: string
7704 secure:
7705 type: boolean
7706 value:
7707 type: string
7708 version:
7709 type: integer
7710 format: int32
7711 date:
7712 type: string
7713 format: date-time
7714 entity:
7715 type: object
7716 entityTag:
7717 type: object
7718 properties:
7719 value:
7720 type: string
7721 weak:
7722 type: boolean
7723 headers:
7724 type: object
7725 additionalProperties:
7726 type: array
7727 items:
7728 type: object
7729 language:
7730 type: object
7731 properties:
7732 country:
7733 type: string
7734 displayCountry:
7735 type: string
7736 displayLanguage:
7737 type: string
7738 displayName:
7739 type: string
7740 displayScript:
7741 type: string
7742 displayVariant:
7743 type: string
7744 extensionKeys:
7745 type: array
7746 items:
7747 type: string
7748 uniqueItems: true
7749 iso3Country:
7750 type: string
7751 iso3Language:
7752 type: string
7753 language:
7754 type: string
7755 script:
7756 type: string
7757 unicodeLocaleAttributes:
7758 type: array
7759 items:
7760 type: string
7761 uniqueItems: true
7762 unicodeLocaleKeys:
7763 type: array
7764 items:
7765 type: string
7766 uniqueItems: true
7767 variant:
7768 type: string
7769 lastModified:
7770 type: string
7771 format: date-time
7772 length:
7773 type: integer
7774 format: int32
7775 links:
7776 type: array
7777 items:
7778 type: object
7779 properties:
7780 params:
7781 type: object
7782 additionalProperties:
7783 type: string
7784 rel:
7785 type: string
7786 rels:
7787 type: array
7788 items:
7789 type: string
7790 title:
7791 type: string
7792 type:
7793 type: string
7794 uri:
7795 type: string
7796 format: uri
7797 uriBuilder:
7798 type: object
7799 uniqueItems: true
7800 location:
7801 type: string
7802 format: uri
7803 mediaType:
7804 type: object
7805 properties:
7806 parameters:
7807 type: object
7808 additionalProperties:
7809 type: string
7810 subtype:
7811 type: string
7812 type:
7813 type: string
7814 wildcardSubtype:
7815 type: boolean
7816 wildcardType:
7817 type: boolean
7818 metadata:
7819 type: object
7820 additionalProperties:
7821 type: array
7822 items:
7823 type: object
7824 status:
7825 type: integer
7826 format: int32
7827 statusInfo:
7828 type: object
7829 properties:
7830 family:
7831 type: string
7832 enum:
7833 - INFORMATIONAL
7834 - SUCCESSFUL
7835 - REDIRECTION
7836 - CLIENT_ERROR
7837 - SERVER_ERROR
7838 - OTHER
7839 reasonPhrase:
7840 type: string
7841 statusCode:
7842 type: integer
7843 format: int32
7844 stringHeaders:
7845 type: object
7846 additionalProperties:
7847 type: array
7848 items:
7849 type: string
7850 servers:
7851 - url: /sdc2/rest
7852 variables: {}
7853 summary: Returns updated property
7854 tags:
7855 - SDCE-2 APIs
7856 /v1/catalog/resources/{resourceId}/properties/{propertyId}:
7857 delete:
7858 description: Delete Resource Property
7859 operationId: deletePropertyInResource
7860 parameters:
7861 - description: resource id of property
7862 in: path
7863 name: resourceId
7864 required: true
7865 schema:
7866 type: string
7867 - description: Property id to delete
7868 in: path
7869 name: propertyId
7870 required: true
7871 schema:
7872 type: string
7873 - in: header
7874 name: USER_ID
7875 schema:
7876 type: string
7877 responses:
7878 "204":
7879 description: deleted property
7880 "400":
7881 description: Invalid content / Missing content
7882 "403":
7883 description: Restricted operation
7884 "404":
7885 description: Resource property not found
7886 default:
7887 content:
7888 application/json:
7889 schema:
7890 type: array
7891 items:
7892 type: object
7893 properties:
7894 allowedMethods:
7895 type: array
7896 items:
7897 type: string
7898 uniqueItems: true
7899 cookies:
7900 type: object
7901 additionalProperties:
7902 type: object
7903 properties:
7904 comment:
7905 type: string
7906 domain:
7907 type: string
7908 expiry:
7909 type: string
7910 format: date-time
7911 httpOnly:
7912 type: boolean
7913 maxAge:
7914 type: integer
7915 format: int32
7916 name:
7917 type: string
7918 path:
7919 type: string
7920 secure:
7921 type: boolean
7922 value:
7923 type: string
7924 version:
7925 type: integer
7926 format: int32
7927 date:
7928 type: string
7929 format: date-time
7930 entity:
7931 type: object
7932 entityTag:
7933 type: object
7934 properties:
7935 value:
7936 type: string
7937 weak:
7938 type: boolean
7939 headers:
7940 type: object
7941 additionalProperties:
7942 type: array
7943 items:
7944 type: object
7945 language:
7946 type: object
7947 properties:
7948 country:
7949 type: string
7950 displayCountry:
7951 type: string
7952 displayLanguage:
7953 type: string
7954 displayName:
7955 type: string
7956 displayScript:
7957 type: string
7958 displayVariant:
7959 type: string
7960 extensionKeys:
7961 type: array
7962 items:
7963 type: string
7964 uniqueItems: true
7965 iso3Country:
7966 type: string
7967 iso3Language:
7968 type: string
7969 language:
7970 type: string
7971 script:
7972 type: string
7973 unicodeLocaleAttributes:
7974 type: array
7975 items:
7976 type: string
7977 uniqueItems: true
7978 unicodeLocaleKeys:
7979 type: array
7980 items:
7981 type: string
7982 uniqueItems: true
7983 variant:
7984 type: string
7985 lastModified:
7986 type: string
7987 format: date-time
7988 length:
7989 type: integer
7990 format: int32
7991 links:
7992 type: array
7993 items:
7994 type: object
7995 properties:
7996 params:
7997 type: object
7998 additionalProperties:
7999 type: string
8000 rel:
8001 type: string
8002 rels:
8003 type: array
8004 items:
8005 type: string
8006 title:
8007 type: string
8008 type:
8009 type: string
8010 uri:
8011 type: string
8012 format: uri
8013 uriBuilder:
8014 type: object
8015 uniqueItems: true
8016 location:
8017 type: string
8018 format: uri
8019 mediaType:
8020 type: object
8021 properties:
8022 parameters:
8023 type: object
8024 additionalProperties:
8025 type: string
8026 subtype:
8027 type: string
8028 type:
8029 type: string
8030 wildcardSubtype:
8031 type: boolean
8032 wildcardType:
8033 type: boolean
8034 metadata:
8035 type: object
8036 additionalProperties:
8037 type: array
8038 items:
8039 type: object
8040 status:
8041 type: integer
8042 format: int32
8043 statusInfo:
8044 type: object
8045 properties:
8046 family:
8047 type: string
8048 enum:
8049 - INFORMATIONAL
8050 - SUCCESSFUL
8051 - REDIRECTION
8052 - CLIENT_ERROR
8053 - SERVER_ERROR
8054 - OTHER
8055 reasonPhrase:
8056 type: string
8057 statusCode:
8058 type: integer
8059 format: int32
8060 stringHeaders:
8061 type: object
8062 additionalProperties:
8063 type: array
8064 items:
8065 type: string
8066 servers:
8067 - url: /sdc2/rest
8068 variables: {}
8069 summary: Returns deleted property
8070 tags:
8071 - SDCE-2 APIs
8072 get:
8073 description: Get Resource Property
8074 operationId: getPropertyInResource
8075 parameters:
8076 - description: resource id of property
8077 in: path
8078 name: resourceId
8079 required: true
8080 schema:
8081 type: string
8082 - description: property id to get
8083 in: path
8084 name: propertyId
8085 required: true
8086 schema:
8087 type: string
8088 - in: header
8089 name: USER_ID
8090 schema:
8091 type: string
8092 responses:
8093 "200":
8094 description: property
8095 "400":
8096 description: Invalid content / Missing content
8097 "403":
8098 description: Restricted operation
8099 "404":
8100 description: Resource property not found
8101 default:
8102 content:
8103 application/json:
8104 schema:
8105 type: array
8106 items:
8107 type: object
8108 properties:
8109 allowedMethods:
8110 type: array
8111 items:
8112 type: string
8113 uniqueItems: true
8114 cookies:
8115 type: object
8116 additionalProperties:
8117 type: object
8118 properties:
8119 comment:
8120 type: string
8121 domain:
8122 type: string
8123 expiry:
8124 type: string
8125 format: date-time
8126 httpOnly:
8127 type: boolean
8128 maxAge:
8129 type: integer
8130 format: int32
8131 name:
8132 type: string
8133 path:
8134 type: string
8135 secure:
8136 type: boolean
8137 value:
8138 type: string
8139 version:
8140 type: integer
8141 format: int32
8142 date:
8143 type: string
8144 format: date-time
8145 entity:
8146 type: object
8147 entityTag:
8148 type: object
8149 properties:
8150 value:
8151 type: string
8152 weak:
8153 type: boolean
8154 headers:
8155 type: object
8156 additionalProperties:
8157 type: array
8158 items:
8159 type: object
8160 language:
8161 type: object
8162 properties:
8163 country:
8164 type: string
8165 displayCountry:
8166 type: string
8167 displayLanguage:
8168 type: string
8169 displayName:
8170 type: string
8171 displayScript:
8172 type: string
8173 displayVariant:
8174 type: string
8175 extensionKeys:
8176 type: array
8177 items:
8178 type: string
8179 uniqueItems: true
8180 iso3Country:
8181 type: string
8182 iso3Language:
8183 type: string
8184 language:
8185 type: string
8186 script:
8187 type: string
8188 unicodeLocaleAttributes:
8189 type: array
8190 items:
8191 type: string
8192 uniqueItems: true
8193 unicodeLocaleKeys:
8194 type: array
8195 items:
8196 type: string
8197 uniqueItems: true
8198 variant:
8199 type: string
8200 lastModified:
8201 type: string
8202 format: date-time
8203 length:
8204 type: integer
8205 format: int32
8206 links:
8207 type: array
8208 items:
8209 type: object
8210 properties:
8211 params:
8212 type: object
8213 additionalProperties:
8214 type: string
8215 rel:
8216 type: string
8217 rels:
8218 type: array
8219 items:
8220 type: string
8221 title:
8222 type: string
8223 type:
8224 type: string
8225 uri:
8226 type: string
8227 format: uri
8228 uriBuilder:
8229 type: object
8230 uniqueItems: true
8231 location:
8232 type: string
8233 format: uri
8234 mediaType:
8235 type: object
8236 properties:
8237 parameters:
8238 type: object
8239 additionalProperties:
8240 type: string
8241 subtype:
8242 type: string
8243 type:
8244 type: string
8245 wildcardSubtype:
8246 type: boolean
8247 wildcardType:
8248 type: boolean
8249 metadata:
8250 type: object
8251 additionalProperties:
8252 type: array
8253 items:
8254 type: object
8255 status:
8256 type: integer
8257 format: int32
8258 statusInfo:
8259 type: object
8260 properties:
8261 family:
8262 type: string
8263 enum:
8264 - INFORMATIONAL
8265 - SUCCESSFUL
8266 - REDIRECTION
8267 - CLIENT_ERROR
8268 - SERVER_ERROR
8269 - OTHER
8270 reasonPhrase:
8271 type: string
8272 statusCode:
8273 type: integer
8274 format: int32
8275 stringHeaders:
8276 type: object
8277 additionalProperties:
8278 type: array
8279 items:
8280 type: string
8281 servers:
8282 - url: /sdc2/rest
8283 variables: {}
8284 summary: Returns property of resource
8285 tags:
8286 - SDCE-2 APIs
8287 /v1/catalog/resources/{resourceId}/requirements:
8288 post:
8289 description: Create requirements on resource
8290 operationId: createRequirementsOnResource
8291 parameters:
8292 - description: Resource Id
8293 in: path
8294 name: resourceId
8295 required: true
8296 schema:
8297 type: string
8298 - in: header
8299 name: USER_ID
8300 schema:
8301 type: string
8302 requestBody:
8303 content:
8304 application/json:
8305 schema:
8306 type: string
8307 description: Requirement to create
8308 required: true
8309 responses:
8310 "201":
8311 description: Create requirements
8312 "400":
8313 description: Invalid content / Missing content
8314 "403":
8315 description: Restricted operation
8316 "409":
8317 description: requirement already exist
8318 default:
8319 content:
8320 application/json:
8321 schema:
8322 type: array
8323 items:
8324 type: object
8325 properties:
8326 allowedMethods:
8327 type: array
8328 items:
8329 type: string
8330 uniqueItems: true
8331 cookies:
8332 type: object
8333 additionalProperties:
8334 type: object
8335 properties:
8336 comment:
8337 type: string
8338 domain:
8339 type: string
8340 expiry:
8341 type: string
8342 format: date-time
8343 httpOnly:
8344 type: boolean
8345 maxAge:
8346 type: integer
8347 format: int32
8348 name:
8349 type: string
8350 path:
8351 type: string
8352 secure:
8353 type: boolean
8354 value:
8355 type: string
8356 version:
8357 type: integer
8358 format: int32
8359 date:
8360 type: string
8361 format: date-time
8362 entity:
8363 type: object
8364 entityTag:
8365 type: object
8366 properties:
8367 value:
8368 type: string
8369 weak:
8370 type: boolean
8371 headers:
8372 type: object
8373 additionalProperties:
8374 type: array
8375 items:
8376 type: object
8377 language:
8378 type: object
8379 properties:
8380 country:
8381 type: string
8382 displayCountry:
8383 type: string
8384 displayLanguage:
8385 type: string
8386 displayName:
8387 type: string
8388 displayScript:
8389 type: string
8390 displayVariant:
8391 type: string
8392 extensionKeys:
8393 type: array
8394 items:
8395 type: string
8396 uniqueItems: true
8397 iso3Country:
8398 type: string
8399 iso3Language:
8400 type: string
8401 language:
8402 type: string
8403 script:
8404 type: string
8405 unicodeLocaleAttributes:
8406 type: array
8407 items:
8408 type: string
8409 uniqueItems: true
8410 unicodeLocaleKeys:
8411 type: array
8412 items:
8413 type: string
8414 uniqueItems: true
8415 variant:
8416 type: string
8417 lastModified:
8418 type: string
8419 format: date-time
8420 length:
8421 type: integer
8422 format: int32
8423 links:
8424 type: array
8425 items:
8426 type: object
8427 properties:
8428 params:
8429 type: object
8430 additionalProperties:
8431 type: string
8432 rel:
8433 type: string
8434 rels:
8435 type: array
8436 items:
8437 type: string
8438 title:
8439 type: string
8440 type:
8441 type: string
8442 uri:
8443 type: string
8444 format: uri
8445 uriBuilder:
8446 type: object
8447 uniqueItems: true
8448 location:
8449 type: string
8450 format: uri
8451 mediaType:
8452 type: object
8453 properties:
8454 parameters:
8455 type: object
8456 additionalProperties:
8457 type: string
8458 subtype:
8459 type: string
8460 type:
8461 type: string
8462 wildcardSubtype:
8463 type: boolean
8464 wildcardType:
8465 type: boolean
8466 metadata:
8467 type: object
8468 additionalProperties:
8469 type: array
8470 items:
8471 type: object
8472 status:
8473 type: integer
8474 format: int32
8475 statusInfo:
8476 type: object
8477 properties:
8478 family:
8479 type: string
8480 enum:
8481 - INFORMATIONAL
8482 - SUCCESSFUL
8483 - REDIRECTION
8484 - CLIENT_ERROR
8485 - SERVER_ERROR
8486 - OTHER
8487 reasonPhrase:
8488 type: string
8489 statusCode:
8490 type: integer
8491 format: int32
8492 stringHeaders:
8493 type: object
8494 additionalProperties:
8495 type: array
8496 items:
8497 type: string
8498 servers:
8499 - url: /sdc2/rest
8500 variables: {}
8501 summary: Create requirements on resource
8502 tags:
8503 - SDCE-2 APIs
8504 put:
8505 description: Update Requirements on resource
8506 operationId: updateRequirementsOnResource
8507 parameters:
8508 - description: Component Id
8509 in: path
8510 name: resourceId
8511 required: true
8512 schema:
8513 type: string
8514 - in: header
8515 name: USER_ID
8516 schema:
8517 type: string
8518 requestBody:
8519 content:
8520 application/json:
8521 schema:
8522 type: string
8523 description: Requirements to update
8524 required: true
8525 responses:
8526 "201":
8527 description: Update Requirements
8528 "400":
8529 description: Invalid content / Missing content
8530 "403":
8531 description: Restricted operation
8532 default:
8533 content:
8534 application/json:
8535 schema:
8536 type: array
8537 items:
8538 $ref: '#/components/schemas/RequirementDefinition'
8539 servers:
8540 - url: /sdc2/rest
8541 variables: {}
8542 summary: Update Requirements on resource
8543 tags:
8544 - SDCE-2 APIs
8545 /v1/catalog/resources/{resourceId}/requirements/{requirementId}:
8546 delete:
8547 description: Delete requirements from resource
8548 operationId: deleteRequirementsFromResource
8549 parameters:
8550 - description: Resource Id
8551 in: path
8552 name: resourceId
8553 required: true
8554 schema:
8555 type: string
8556 - description: requirement Id
8557 in: path
8558 name: requirementId
8559 required: true
8560 schema:
8561 type: string
8562 - in: header
8563 name: USER_ID
8564 schema:
8565 type: string
8566 responses:
8567 "201":
8568 description: Delete requirement
8569 "400":
8570 description: Invalid content / Missing content
8571 "403":
8572 description: Restricted operation
8573 default:
8574 content:
8575 application/json:
8576 schema:
8577 type: array
8578 items:
8579 $ref: '#/components/schemas/RequirementDefinition'
8580 servers:
8581 - url: /sdc2/rest
8582 variables: {}
8583 summary: Delete requirements from resource
8584 tags:
8585 - SDCE-2 APIs
8586 get:
8587 description: Get Requirement from resource
8588 operationId: getRequirementsFromResource
8589 parameters:
8590 - description: Resource Id
8591 in: path
8592 name: resourceId
8593 required: true
8594 schema:
8595 type: string
8596 - description: Requirement Id
8597 in: path
8598 name: requirementId
8599 required: true
8600 schema:
8601 type: string
8602 - in: header
8603 name: USER_ID
8604 schema:
8605 type: string
8606 responses:
8607 "201":
8608 description: GET requirement
8609 "400":
8610 description: Invalid content / Missing content
8611 "403":
8612 description: Restricted operation
8613 default:
8614 content:
8615 application/json:
8616 schema:
8617 type: array
8618 items:
8619 $ref: '#/components/schemas/RequirementDefinition'
8620 servers:
8621 - url: /sdc2/rest
8622 variables: {}
8623 summary: GET Requirement from resource
8624 tags:
8625 - SDCE-2 APIs
8626 /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts:
8627 post:
8628 description: Create Artifact and Attach to interface
8629 operationId: loadArtifactToInterface
8630 parameters:
8631 - in: path
8632 name: resourceId
8633 required: true
8634 schema:
8635 type: string
8636 - in: path
8637 name: interfaceType
8638 required: true
8639 schema:
8640 type: string
8641 - in: path
8642 name: operation
8643 required: true
8644 schema:
8645 type: string
8646 - in: header
8647 name: USER_ID
8648 schema:
8649 type: string
8650 - in: header
8651 name: Content-MD5
8652 schema:
8653 type: string
8654 requestBody:
8655 content:
8656 application/json:
8657 schema:
8658 type: string
8659 description: json describe the artifact
8660 required: true
8661 responses:
8662 "201":
8663 description: Resource created
8664 "400":
8665 description: Invalid content / Missing content
8666 "403":
8667 description: Restricted operation
8668 "409":
8669 description: Artifact already exist
8670 default:
8671 content:
8672 application/json:
8673 schema:
8674 type: array
8675 items:
8676 type: object
8677 properties:
8678 allowedMethods:
8679 type: array
8680 items:
8681 type: string
8682 uniqueItems: true
8683 cookies:
8684 type: object
8685 additionalProperties:
8686 type: object
8687 properties:
8688 comment:
8689 type: string
8690 domain:
8691 type: string
8692 expiry:
8693 type: string
8694 format: date-time
8695 httpOnly:
8696 type: boolean
8697 maxAge:
8698 type: integer
8699 format: int32
8700 name:
8701 type: string
8702 path:
8703 type: string
8704 secure:
8705 type: boolean
8706 value:
8707 type: string
8708 version:
8709 type: integer
8710 format: int32
8711 date:
8712 type: string
8713 format: date-time
8714 entity:
8715 type: object
8716 entityTag:
8717 type: object
8718 properties:
8719 value:
8720 type: string
8721 weak:
8722 type: boolean
8723 headers:
8724 type: object
8725 additionalProperties:
8726 type: array
8727 items:
8728 type: object
8729 language:
8730 type: object
8731 properties:
8732 country:
8733 type: string
8734 displayCountry:
8735 type: string
8736 displayLanguage:
8737 type: string
8738 displayName:
8739 type: string
8740 displayScript:
8741 type: string
8742 displayVariant:
8743 type: string
8744 extensionKeys:
8745 type: array
8746 items:
8747 type: string
8748 uniqueItems: true
8749 iso3Country:
8750 type: string
8751 iso3Language:
8752 type: string
8753 language:
8754 type: string
8755 script:
8756 type: string
8757 unicodeLocaleAttributes:
8758 type: array
8759 items:
8760 type: string
8761 uniqueItems: true
8762 unicodeLocaleKeys:
8763 type: array
8764 items:
8765 type: string
8766 uniqueItems: true
8767 variant:
8768 type: string
8769 lastModified:
8770 type: string
8771 format: date-time
8772 length:
8773 type: integer
8774 format: int32
8775 links:
8776 type: array
8777 items:
8778 type: object
8779 properties:
8780 params:
8781 type: object
8782 additionalProperties:
8783 type: string
8784 rel:
8785 type: string
8786 rels:
8787 type: array
8788 items:
8789 type: string
8790 title:
8791 type: string
8792 type:
8793 type: string
8794 uri:
8795 type: string
8796 format: uri
8797 uriBuilder:
8798 type: object
8799 uniqueItems: true
8800 location:
8801 type: string
8802 format: uri
8803 mediaType:
8804 type: object
8805 properties:
8806 parameters:
8807 type: object
8808 additionalProperties:
8809 type: string
8810 subtype:
8811 type: string
8812 type:
8813 type: string
8814 wildcardSubtype:
8815 type: boolean
8816 wildcardType:
8817 type: boolean
8818 metadata:
8819 type: object
8820 additionalProperties:
8821 type: array
8822 items:
8823 type: object
8824 status:
8825 type: integer
8826 format: int32
8827 statusInfo:
8828 type: object
8829 properties:
8830 family:
8831 type: string
8832 enum:
8833 - INFORMATIONAL
8834 - SUCCESSFUL
8835 - REDIRECTION
8836 - CLIENT_ERROR
8837 - SERVER_ERROR
8838 - OTHER
8839 reasonPhrase:
8840 type: string
8841 statusCode:
8842 type: integer
8843 format: int32
8844 stringHeaders:
8845 type: object
8846 additionalProperties:
8847 type: array
8848 items:
8849 type: string
8850 servers:
8851 - url: /sdc2/rest
8852 variables: {}
8853 summary: Returns created resource
8854 tags:
8855 - SDCE-2 APIs
8856 /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts/{artifactId}:
8857 delete:
8858 description: delete Artifact from interface
8859 operationId: deleteArtifactToInterface
8860 parameters:
8861 - in: path
8862 name: resourceId
8863 required: true
8864 schema:
8865 type: string
8866 - in: path
8867 name: interfaceType
8868 required: true
8869 schema:
8870 type: string
8871 - in: path
8872 name: operation
8873 required: true
8874 schema:
8875 type: string
8876 - in: path
8877 name: artifactId
8878 required: true
8879 schema:
8880 type: string
8881 responses:
8882 "201":
8883 description: delete artifact under interface deleted
8884 "400":
8885 description: Invalid content / Missing content
8886 "403":
8887 description: Restricted operation
8888 "409":
8889 description: Artifact already exist
8890 default:
8891 content:
8892 application/json:
8893 schema:
8894 type: array
8895 items:
8896 type: object
8897 properties:
8898 allowedMethods:
8899 type: array
8900 items:
8901 type: string
8902 uniqueItems: true
8903 cookies:
8904 type: object
8905 additionalProperties:
8906 type: object
8907 properties:
8908 comment:
8909 type: string
8910 domain:
8911 type: string
8912 expiry:
8913 type: string
8914 format: date-time
8915 httpOnly:
8916 type: boolean
8917 maxAge:
8918 type: integer
8919 format: int32
8920 name:
8921 type: string
8922 path:
8923 type: string
8924 secure:
8925 type: boolean
8926 value:
8927 type: string
8928 version:
8929 type: integer
8930 format: int32
8931 date:
8932 type: string
8933 format: date-time
8934 entity:
8935 type: object
8936 entityTag:
8937 type: object
8938 properties:
8939 value:
8940 type: string
8941 weak:
8942 type: boolean
8943 headers:
8944 type: object
8945 additionalProperties:
8946 type: array
8947 items:
8948 type: object
8949 language:
8950 type: object
8951 properties:
8952 country:
8953 type: string
8954 displayCountry:
8955 type: string
8956 displayLanguage:
8957 type: string
8958 displayName:
8959 type: string
8960 displayScript:
8961 type: string
8962 displayVariant:
8963 type: string
8964 extensionKeys:
8965 type: array
8966 items:
8967 type: string
8968 uniqueItems: true
8969 iso3Country:
8970 type: string
8971 iso3Language:
8972 type: string
8973 language:
8974 type: string
8975 script:
8976 type: string
8977 unicodeLocaleAttributes:
8978 type: array
8979 items:
8980 type: string
8981 uniqueItems: true
8982 unicodeLocaleKeys:
8983 type: array
8984 items:
8985 type: string
8986 uniqueItems: true
8987 variant:
8988 type: string
8989 lastModified:
8990 type: string
8991 format: date-time
8992 length:
8993 type: integer
8994 format: int32
8995 links:
8996 type: array
8997 items:
8998 type: object
8999 properties:
9000 params:
9001 type: object
9002 additionalProperties:
9003 type: string
9004 rel:
9005 type: string
9006 rels:
9007 type: array
9008 items:
9009 type: string
9010 title:
9011 type: string
9012 type:
9013 type: string
9014 uri:
9015 type: string
9016 format: uri
9017 uriBuilder:
9018 type: object
9019 uniqueItems: true
9020 location:
9021 type: string
9022 format: uri
9023 mediaType:
9024 type: object
9025 properties:
9026 parameters:
9027 type: object
9028 additionalProperties:
9029 type: string
9030 subtype:
9031 type: string
9032 type:
9033 type: string
9034 wildcardSubtype:
9035 type: boolean
9036 wildcardType:
9037 type: boolean
9038 metadata:
9039 type: object
9040 additionalProperties:
9041 type: array
9042 items:
9043 type: object
9044 status:
9045 type: integer
9046 format: int32
9047 statusInfo:
9048 type: object
9049 properties:
9050 family:
9051 type: string
9052 enum:
9053 - INFORMATIONAL
9054 - SUCCESSFUL
9055 - REDIRECTION
9056 - CLIENT_ERROR
9057 - SERVER_ERROR
9058 - OTHER
9059 reasonPhrase:
9060 type: string
9061 statusCode:
9062 type: integer
9063 format: int32
9064 stringHeaders:
9065 type: object
9066 additionalProperties:
9067 type: array
9068 items:
9069 type: string
9070 servers:
9071 - url: /sdc2/rest
9072 variables: {}
9073 summary: delete matching artifact from interface
9074 tags:
9075 - SDCE-2 APIs
9076 post:
9077 description: update Artifact Attach to interface
9078 operationId: updateArtifactToInterface
9079 parameters:
9080 - in: path
9081 name: resourceId
9082 required: true
9083 schema:
9084 type: string
9085 - in: path
9086 name: interfaceType
9087 required: true
9088 schema:
9089 type: string
9090 - in: path
9091 name: operation
9092 required: true
9093 schema:
9094 type: string
9095 - in: path
9096 name: artifactId
9097 required: true
9098 schema:
9099 type: string
9100 - in: header
9101 name: USER_ID
9102 schema:
9103 type: string
9104 - in: header
9105 name: Content-MD5
9106 schema:
9107 type: string
9108 requestBody:
9109 content:
9110 application/json:
9111 schema:
9112 type: string
9113 description: json describe the artifact
9114 required: true
9115 responses:
9116 "201":
9117 description: delete artifact under interface deleted
9118 "400":
9119 description: Invalid content / Missing content
9120 "403":
9121 description: Restricted operation
9122 "409":
9123 description: Artifact already exist
9124 default:
9125 content:
9126 application/json:
9127 schema:
9128 type: array
9129 items:
9130 type: object
9131 properties:
9132 allowedMethods:
9133 type: array
9134 items:
9135 type: string
9136 uniqueItems: true
9137 cookies:
9138 type: object
9139 additionalProperties:
9140 type: object
9141 properties:
9142 comment:
9143 type: string
9144 domain:
9145 type: string
9146 expiry:
9147 type: string
9148 format: date-time
9149 httpOnly:
9150 type: boolean
9151 maxAge:
9152 type: integer
9153 format: int32
9154 name:
9155 type: string
9156 path:
9157 type: string
9158 secure:
9159 type: boolean
9160 value:
9161 type: string
9162 version:
9163 type: integer
9164 format: int32
9165 date:
9166 type: string
9167 format: date-time
9168 entity:
9169 type: object
9170 entityTag:
9171 type: object
9172 properties:
9173 value:
9174 type: string
9175 weak:
9176 type: boolean
9177 headers:
9178 type: object
9179 additionalProperties:
9180 type: array
9181 items:
9182 type: object
9183 language:
9184 type: object
9185 properties:
9186 country:
9187 type: string
9188 displayCountry:
9189 type: string
9190 displayLanguage:
9191 type: string
9192 displayName:
9193 type: string
9194 displayScript:
9195 type: string
9196 displayVariant:
9197 type: string
9198 extensionKeys:
9199 type: array
9200 items:
9201 type: string
9202 uniqueItems: true
9203 iso3Country:
9204 type: string
9205 iso3Language:
9206 type: string
9207 language:
9208 type: string
9209 script:
9210 type: string
9211 unicodeLocaleAttributes:
9212 type: array
9213 items:
9214 type: string
9215 uniqueItems: true
9216 unicodeLocaleKeys:
9217 type: array
9218 items:
9219 type: string
9220 uniqueItems: true
9221 variant:
9222 type: string
9223 lastModified:
9224 type: string
9225 format: date-time
9226 length:
9227 type: integer
9228 format: int32
9229 links:
9230 type: array
9231 items:
9232 type: object
9233 properties:
9234 params:
9235 type: object
9236 additionalProperties:
9237 type: string
9238 rel:
9239 type: string
9240 rels:
9241 type: array
9242 items:
9243 type: string
9244 title:
9245 type: string
9246 type:
9247 type: string
9248 uri:
9249 type: string
9250 format: uri
9251 uriBuilder:
9252 type: object
9253 uniqueItems: true
9254 location:
9255 type: string
9256 format: uri
9257 mediaType:
9258 type: object
9259 properties:
9260 parameters:
9261 type: object
9262 additionalProperties:
9263 type: string
9264 subtype:
9265 type: string
9266 type:
9267 type: string
9268 wildcardSubtype:
9269 type: boolean
9270 wildcardType:
9271 type: boolean
9272 metadata:
9273 type: object
9274 additionalProperties:
9275 type: array
9276 items:
9277 type: object
9278 status:
9279 type: integer
9280 format: int32
9281 statusInfo:
9282 type: object
9283 properties:
9284 family:
9285 type: string
9286 enum:
9287 - INFORMATIONAL
9288 - SUCCESSFUL
9289 - REDIRECTION
9290 - CLIENT_ERROR
9291 - SERVER_ERROR
9292 - OTHER
9293 reasonPhrase:
9294 type: string
9295 statusCode:
9296 type: integer
9297 format: int32
9298 stringHeaders:
9299 type: object
9300 additionalProperties:
9301 type: array
9302 items:
9303 type: string
9304 servers:
9305 - url: /sdc2/rest
9306 variables: {}
9307 summary: updates artifact by interface
9308 tags:
9309 - SDCE-2 APIs
9310 /v1/catalog/resources/{resourceName}/{version}:
9311 delete:
9312 description: Delete Resource By Name And Version
9313 operationId: deleteResourceByNameAndVersion
9314 parameters:
9315 - in: path
9316 name: resourceName
9317 required: true
9318 schema:
9319 type: string
9320 - in: path
9321 name: version
9322 required: true
9323 schema:
9324 type: string
9325 responses:
9326 "204":
9327 description: Resource deleted
9328 "400":
9329 description: Invalid content / Missing content
9330 "403":
9331 description: Restricted operation
9332 "404":
9333 description: Resource not found
9334 default:
9335 content:
9336 '*/*':
9337 schema:
9338 type: array
9339 items:
9340 $ref: '#/components/schemas/Resource'
9341 servers:
9342 - url: /sdc2/rest
9343 variables: {}
9344 summary: Returns no content
9345 tags:
9346 - SDCE-2 APIs
9347 /v1/catalog/services:
9348 post:
9349 description: Create Service
9350 operationId: createService
9351 parameters:
9352 - in: header
9353 name: USER_ID
9354 schema:
9355 type: string
9356 requestBody:
9357 content:
9358 application/json:
9359 schema:
9360 type: string
9361 description: Service object to be created
9362 required: true
9363 responses:
9364 "201":
9365 description: Service created
9366 "400":
9367 description: Invalid content / Missing content
9368 "403":
9369 description: Restricted operation
9370 "409":
9371 description: Service already exist
9372 default:
9373 content:
9374 application/json:
9375 schema:
9376 type: array
9377 items:
9378 $ref: '#/components/schemas/Service'
9379 servers:
9380 - url: /sdc2/rest
9381 variables: {}
9382 summary: Returns created service
9383 tags:
9384 - SDCE-2 APIs
9385 /v1/catalog/services/distribution/{did}:
9386 get:
9387 description: Retrieve Distributions
9388 operationId: getListOfDistributionStatuses
9389 parameters:
9390 - in: path
9391 name: did
9392 required: true
9393 schema:
9394 type: string
9395 - in: header
9396 name: USER_ID
9397 schema:
9398 type: string
9399 responses:
9400 "200":
9401 description: Service found
9402 "403":
9403 description: Restricted operation
9404 "404":
9405 description: Status not found
9406 default:
9407 content:
9408 application/json:
9409 schema:
9410 type: array
9411 items:
9412 $ref: '#/components/schemas/DistributionStatusListResponse'
9413 servers:
9414 - url: /sdc2/rest
9415 variables: {}
9416 summary: Return the list of distribution status objects
9417 tags:
9418 - SDCE-5 APIs
9419 /v1/catalog/services/importService:
9420 post:
9421 description: Import Service
9422 operationId: importNsService
9423 parameters:
9424 - in: header
9425 name: USER_ID
9426 schema:
9427 type: string
9428 requestBody:
9429 content:
9430 application/json:
9431 schema:
9432 type: string
9433 description: Service object to be imported
9434 required: true
9435 responses:
9436 "201":
9437 description: Service created
9438 "400":
9439 description: Invalid content / Missing content
9440 "403":
9441 description: Restricted operation
9442 "409":
9443 description: Service already exist
9444 servers:
9445 - url: /sdc2/rest
9446 variables: {}
9447 summary: Returns imported service
9448 tags:
9449 - SDCE-2 APIs
9450 /v1/catalog/services/replaceVNF:
9451 post:
9452 description: Replace new VNF based on the existing VNF
9453 operationId: replaceVNF
9454 parameters:
9455 - description: The user id
9456 in: header
9457 name: USER_ID
9458 required: true
9459 schema:
9460 type: string
9461 - description: X-ECOMP-RequestID header
9462 in: header
9463 name: X-ECOMP-RequestID
9464 schema:
9465 type: string
9466 - description: X-ECOMP-InstanceID header
9467 in: header
9468 name: X-ECOMP-InstanceID
9469 required: true
9470 schema:
9471 type: string
9472 - description: Determines the format of the body of the response
9473 in: header
9474 name: Accept
9475 schema:
9476 type: string
9477 - description: The username and password
9478 in: header
9479 name: Authorization
9480 required: true
9481 schema:
9482 type: string
9483 requestBody:
9484 content:
9485 '*/*':
9486 schema:
9487 type: string
9488 description: Resource object to be created
9489 required: true
9490 responses:
9491 "200":
9492 content:
9493 '*/*':
9494 schema:
9495 type: array
9496 items:
9497 $ref: '#/components/schemas/ReplaceVNFInfo'
9498 description: ECOMP component is authenticated and list of Catalog Assets
9499 Metadata is returned
9500 "400":
9501 description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001
9502 "401":
9503 description: ECOMP component should authenticate itself and to re-send again HTTP request with
9504 its Basic Authentication credentials - POL5002
9505 "403":
9506 description: ECOMP component is not authorized - POL5003
9507 "404":
9508 description: "Error: Requested '%1' (uuid) resource was not found - SVC4063"
9509 "405":
9510 description: "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST\
9511 \ will be rejected) - POL4050"
9512 "409":
9513 description: Service already exist
9514 "500":
9515 description: The GET request failed either due to internal SDC problem.
9516 ECOMP Component should continue the attempts to get the needed information
9517 - POL5000
9518 servers:
9519 - url: /sdc2/rest
9520 variables: {}
9521 summary: Return whether the replace VNF is successful
9522 tags:
9523 - SDCE-2 APIs
9524 /v1/catalog/services/serviceName/{serviceName}/serviceVersion/{serviceVersion}:
9525 get:
9526 description: Retrieve Service
9527 operationId: getServiceByNameAndVersion
9528 parameters:
9529 - in: path
9530 name: serviceName
9531 required: true
9532 schema:
9533 type: string
9534 - in: path
9535 name: serviceVersion
9536 required: true
9537 schema:
9538 type: string
9539 - in: header
9540 name: USER_ID
9541 schema:
9542 type: string
9543 responses:
9544 "200":
9545 description: Service found
9546 "403":
9547 description: Restricted operation
9548 "404":
9549 description: Service not found
9550 default:
9551 content:
9552 application/json:
9553 schema:
9554 type: array
9555 items:
9556 $ref: '#/components/schemas/Service'
9557 servers:
9558 - url: /sdc2/rest
9559 variables: {}
9560 summary: Returns service according to name and version
9561 tags:
9562 - SDCE-2 APIs
9563 /v1/catalog/services/serviceUUID/{uuid}/importReplaceService:
9564 post:
9565 description: Import Service
9566 operationId: importReplaceService
9567 parameters:
9568 - description: The user id
9569 in: header
9570 name: USER_ID
9571 required: true
9572 schema:
9573 type: string
9574 - description: X-ECOMP-RequestID header
9575 in: header
9576 name: X-ECOMP-RequestID
9577 schema:
9578 type: string
9579 - description: X-ECOMP-InstanceID header
9580 in: header
9581 name: X-ECOMP-InstanceID
9582 required: true
9583 schema:
9584 type: string
9585 - description: Determines the format of the body of the response
9586 in: header
9587 name: Accept
9588 schema:
9589 type: string
9590 - description: The username and password
9591 in: header
9592 name: Authorization
9593 required: true
9594 schema:
9595 type: string
9596 - description: The requested asset uuid
9597 in: path
9598 name: uuid
9599 required: true
9600 schema:
9601 type: string
9602 requestBody:
9603 content:
9604 '*/*':
9605 schema:
9606 type: object
9607 properties:
9608 serviceZip:
9609 $ref: '#/components/schemas/FormDataContentDisposition'
9610 serviceZipMetadata:
9611 type: string
9612 description: serviceMetadata
9613 responses:
9614 "201":
9615 description: Service created
9616 "400":
9617 description: Invalid content / Missing content
9618 "403":
9619 description: Restricted operation
9620 "409":
9621 description: Service already exist
9622 servers:
9623 - url: /sdc2/rest
9624 variables: {}
9625 summary: Returns imported service
9626 tags:
9627 - SDCE-2 APIs
9628 /v1/catalog/services/validate-name/{serviceName}:
9629 get:
9630 description: validate service name
9631 operationId: validateServiceName
9632 parameters:
9633 - in: path
9634 name: serviceName
9635 required: true
9636 schema:
9637 type: string
9638 - in: header
9639 name: USER_ID
9640 schema:
9641 type: string
9642 responses:
9643 "200":
9644 description: Service found
9645 "403":
9646 description: Restricted operation
9647 default:
9648 content:
9649 application/json:
9650 schema:
9651 type: array
9652 items:
9653 type: object
9654 properties:
9655 allowedMethods:
9656 type: array
9657 items:
9658 type: string
9659 uniqueItems: true
9660 cookies:
9661 type: object
9662 additionalProperties:
9663 type: object
9664 properties:
9665 comment:
9666 type: string
9667 domain:
9668 type: string
9669 expiry:
9670 type: string
9671 format: date-time
9672 httpOnly:
9673 type: boolean
9674 maxAge:
9675 type: integer
9676 format: int32
9677 name:
9678 type: string
9679 path:
9680 type: string
9681 secure:
9682 type: boolean
9683 value:
9684 type: string
9685 version:
9686 type: integer
9687 format: int32
9688 date:
9689 type: string
9690 format: date-time
9691 entity:
9692 type: object
9693 entityTag:
9694 type: object
9695 properties:
9696 value:
9697 type: string
9698 weak:
9699 type: boolean
9700 headers:
9701 type: object
9702 additionalProperties:
9703 type: array
9704 items:
9705 type: object
9706 language:
9707 type: object
9708 properties:
9709 country:
9710 type: string
9711 displayCountry:
9712 type: string
9713 displayLanguage:
9714 type: string
9715 displayName:
9716 type: string
9717 displayScript:
9718 type: string
9719 displayVariant:
9720 type: string
9721 extensionKeys:
9722 type: array
9723 items:
9724 type: string
9725 uniqueItems: true
9726 iso3Country:
9727 type: string
9728 iso3Language:
9729 type: string
9730 language:
9731 type: string
9732 script:
9733 type: string
9734 unicodeLocaleAttributes:
9735 type: array
9736 items:
9737 type: string
9738 uniqueItems: true
9739 unicodeLocaleKeys:
9740 type: array
9741 items:
9742 type: string
9743 uniqueItems: true
9744 variant:
9745 type: string
9746 lastModified:
9747 type: string
9748 format: date-time
9749 length:
9750 type: integer
9751 format: int32
9752 links:
9753 type: array
9754 items:
9755 type: object
9756 properties:
9757 params:
9758 type: object
9759 additionalProperties:
9760 type: string
9761 rel:
9762 type: string
9763 rels:
9764 type: array
9765 items:
9766 type: string
9767 title:
9768 type: string
9769 type:
9770 type: string
9771 uri:
9772 type: string
9773 format: uri
9774 uriBuilder:
9775 type: object
9776 uniqueItems: true
9777 location:
9778 type: string
9779 format: uri
9780 mediaType:
9781 type: object
9782 properties:
9783 parameters:
9784 type: object
9785 additionalProperties:
9786 type: string
9787 subtype:
9788 type: string
9789 type:
9790 type: string
9791 wildcardSubtype:
9792 type: boolean
9793 wildcardType:
9794 type: boolean
9795 metadata:
9796 type: object
9797 additionalProperties:
9798 type: array
9799 items:
9800 type: object
9801 status:
9802 type: integer
9803 format: int32
9804 statusInfo:
9805 type: object
9806 properties:
9807 family:
9808 type: string
9809 enum:
9810 - INFORMATIONAL
9811 - SUCCESSFUL
9812 - REDIRECTION
9813 - CLIENT_ERROR
9814 - SERVER_ERROR
9815 - OTHER
9816 reasonPhrase:
9817 type: string
9818 statusCode:
9819 type: integer
9820 format: int32
9821 stringHeaders:
9822 type: object
9823 additionalProperties:
9824 type: array
9825 items:
9826 type: string
9827 servers:
9828 - url: /sdc2/rest
9829 variables: {}
9830 summary: 'checks if the chosen service name is available '
9831 tags:
9832 - SDCE-2 APIs
9833 /v1/catalog/services/{componentId}/archive:
9834 post:
9835 description: Archive Service
9836 operationId: archiveService
9837 parameters:
9838 - in: path
9839 name: componentId
9840 required: true
9841 schema:
9842 type: string
9843 - in: header
9844 name: USER_ID
9845 schema:
9846 type: string
9847 responses:
9848 "200":
9849 description: Archive successful
9850 "400":
9851 description: Bad request
9852 "403":
9853 description: Restricted operation
9854 "404":
9855 description: Service not found
9856 "500":
9857 description: Internal Error
9858 default:
9859 content:
9860 application/json:
9861 schema:
9862 type: array
9863 items:
9864 type: string
9865 servers:
9866 - url: /sdc2/rest
9867 variables: {}
9868 summary: Marks a service as archived. Can be restored with restore action
9869 tags:
9870 - SDCE-2 APIs
9871 /v1/catalog/services/{componentId}/copyComponentInstance/{componentInstanceId}:
9872 post:
9873 description: Copy Component Instance
9874 operationId: copyComponentInstance
9875 parameters:
9876 - description: service unique id in pasted canvas
9877 in: path
9878 name: componentId
9879 required: true
9880 schema:
9881 type: string
9882 - in: path
9883 name: componentInstanceId
9884 required: true
9885 schema:
9886 type: string
9887 requestBody:
9888 content:
9889 application/json:
9890 schema:
9891 type: string
9892 description: Data for copying
9893 required: true
9894 responses:
9895 "201":
9896 description: Copy and Paste Success
9897 "400":
9898 description: Invalid Content / Missing content
9899 "403":
9900 description: Restricted Operation
9901 default:
9902 content:
9903 application/json:
9904 schema:
9905 type: array
9906 items:
9907 $ref: '#/components/schemas/Service'
9908 servers:
9909 - url: /sdc2/rest
9910 variables: {}
9911 summary: Returns updated service information
9912 tags:
9913 - SDCE-2 APIs
9914 /v1/catalog/services/{componentId}/restore:
9915 post:
9916 description: Restore Service
9917 operationId: restoreService
9918 parameters:
9919 - in: path
9920 name: componentId
9921 required: true
9922 schema:
9923 type: string
9924 - in: header
9925 name: USER_ID
9926 schema:
9927 type: string
9928 responses:
9929 "200":
9930 description: Restore successful
9931 "400":
9932 description: Bad request
9933 "403":
9934 description: Restricted operation
9935 "404":
9936 description: Service not found
9937 "500":
9938 description: Internal Error
9939 default:
9940 content:
9941 application/json:
9942 schema:
9943 type: array
9944 items:
9945 type: string
9946 servers:
9947 - url: /sdc2/rest
9948 variables: {}
9949 summary: Restores a service from archive.
9950 tags:
9951 - SDCE-2 APIs
9952 /v1/catalog/services/{serviceId}:
9953 delete:
9954 description: Delete Service
9955 operationId: deleteService
9956 parameters:
9957 - in: path
9958 name: serviceId
9959 required: true
9960 schema:
9961 type: string
9962 - description: "Optional parameter to determine the delete action: DELETE, which\
9963 \ will permanently delete theService from the system or MARK_AS_DELETE,\
9964 \ which will logically mark the service as deleted. Default action is to\
9965 \ MARK_AS_DELETE"
9966 in: query
9967 name: deleteAction
9968 schema:
9969 type: string
9970 enum:
9971 - DELETE
9972 - MARK_AS_DELETE
9973 responses:
9974 "204":
9975 description: Service deleted
9976 "400":
9977 description: Invalid content / Missing content
9978 "403":
9979 description: Restricted operation
9980 "404":
9981 description: Service not found
9982 default:
9983 content:
9984 '*/*':
9985 schema:
9986 type: array
9987 items:
9988 $ref: '#/components/schemas/Service'
9989 servers:
9990 - url: /sdc2/rest
9991 variables: {}
9992 summary: Return no content
9993 tags:
9994 - SDCE-2 APIs
9995 get:
9996 description: Retrieve Service
9997 operationId: getServiceById_1
9998 parameters:
9999 - in: path
10000 name: serviceId
10001 required: true
10002 schema:
10003 type: string
10004 - in: header
10005 name: USER_ID
10006 schema:
10007 type: string
10008 responses:
10009 "200":
10010 description: Service found
10011 "403":
10012 description: Restricted operation
10013 "404":
10014 description: Service not found
10015 default:
10016 content:
10017 application/json:
10018 schema:
10019 type: array
10020 items:
10021 $ref: '#/components/schemas/Service'
10022 servers:
10023 - url: /sdc2/rest
10024 variables: {}
10025 summary: Returns service according to serviceId
10026 tags:
10027 - SDCE-2 APIs
10028 /v1/catalog/services/{serviceId}/additionalinfo:
10029 get:
10030 description: Get all Additional Information under service
10031 operationId: getAllServiceAdditionalInformationLabel
10032 parameters:
10033 - description: service id to update with new property
10034 in: path
10035 name: serviceId
10036 required: true
10037 schema:
10038 type: string
10039 - in: header
10040 name: USER_ID
10041 schema:
10042 type: string
10043 responses:
10044 "200":
10045 description: list of additional information
10046 "400":
10047 description: Invalid content / Missing content
10048 "403":
10049 description: Restricted operation
10050 "409":
10051 description: Additional information key already exist
10052 default:
10053 content:
10054 application/json:
10055 schema:
10056 type: array
10057 items:
10058 type: object
10059 properties:
10060 allowedMethods:
10061 type: array
10062 items:
10063 type: string
10064 uniqueItems: true
10065 cookies:
10066 type: object
10067 additionalProperties:
10068 type: object
10069 properties:
10070 comment:
10071 type: string
10072 domain:
10073 type: string
10074 expiry:
10075 type: string
10076 format: date-time
10077 httpOnly:
10078 type: boolean
10079 maxAge:
10080 type: integer
10081 format: int32
10082 name:
10083 type: string
10084 path:
10085 type: string
10086 secure:
10087 type: boolean
10088 value:
10089 type: string
10090 version:
10091 type: integer
10092 format: int32
10093 date:
10094 type: string
10095 format: date-time
10096 entity:
10097 type: object
10098 entityTag:
10099 type: object
10100 properties:
10101 value:
10102 type: string
10103 weak:
10104 type: boolean
10105 headers:
10106 type: object
10107 additionalProperties:
10108 type: array
10109 items:
10110 type: object
10111 language:
10112 type: object
10113 properties:
10114 country:
10115 type: string
10116 displayCountry:
10117 type: string
10118 displayLanguage:
10119 type: string
10120 displayName:
10121 type: string
10122 displayScript:
10123 type: string
10124 displayVariant:
10125 type: string
10126 extensionKeys:
10127 type: array
10128 items:
10129 type: string
10130 uniqueItems: true
10131 iso3Country:
10132 type: string
10133 iso3Language:
10134 type: string
10135 language:
10136 type: string
10137 script:
10138 type: string
10139 unicodeLocaleAttributes:
10140 type: array
10141 items:
10142 type: string
10143 uniqueItems: true
10144 unicodeLocaleKeys:
10145 type: array
10146 items:
10147 type: string
10148 uniqueItems: true
10149 variant:
10150 type: string
10151 lastModified:
10152 type: string
10153 format: date-time
10154 length:
10155 type: integer
10156 format: int32
10157 links:
10158 type: array
10159 items:
10160 type: object
10161 properties:
10162 params:
10163 type: object
10164 additionalProperties:
10165 type: string
10166 rel:
10167 type: string
10168 rels:
10169 type: array
10170 items:
10171 type: string
10172 title:
10173 type: string
10174 type:
10175 type: string
10176 uri:
10177 type: string
10178 format: uri
10179 uriBuilder:
10180 type: object
10181 uniqueItems: true
10182 location:
10183 type: string
10184 format: uri
10185 mediaType:
10186 type: object
10187 properties:
10188 parameters:
10189 type: object
10190 additionalProperties:
10191 type: string
10192 subtype:
10193 type: string
10194 type:
10195 type: string
10196 wildcardSubtype:
10197 type: boolean
10198 wildcardType:
10199 type: boolean
10200 metadata:
10201 type: object
10202 additionalProperties:
10203 type: array
10204 items:
10205 type: object
10206 status:
10207 type: integer
10208 format: int32
10209 statusInfo:
10210 type: object
10211 properties:
10212 family:
10213 type: string
10214 enum:
10215 - INFORMATIONAL
10216 - SUCCESSFUL
10217 - REDIRECTION
10218 - CLIENT_ERROR
10219 - SERVER_ERROR
10220 - OTHER
10221 reasonPhrase:
10222 type: string
10223 statusCode:
10224 type: integer
10225 format: int32
10226 stringHeaders:
10227 type: object
10228 additionalProperties:
10229 type: array
10230 items:
10231 type: string
10232 servers:
10233 - url: /sdc2/rest
10234 variables: {}
10235 summary: Returns Additional Inforamtion property
10236 tags:
10237 - SDCE-2 APIs
10238 post:
10239 description: Create Additional Information Label and Value
10240 operationId: createServiceAdditionalInformationLabel
10241 parameters:
10242 - description: service id to update with new property
10243 in: path
10244 name: serviceId
10245 required: true
10246 schema:
10247 type: string
10248 - in: header
10249 name: USER_ID
10250 schema:
10251 type: string
10252 requestBody:
10253 content:
10254 application/json:
10255 schema:
10256 type: string
10257 description: Additional information key value to be created
10258 required: true
10259 responses:
10260 "201":
10261 description: Additional information created
10262 "400":
10263 description: Invalid content / Missing content
10264 "403":
10265 description: Restricted operation
10266 "409":
10267 description: Additional information key already exist
10268 default:
10269 content:
10270 application/json:
10271 schema:
10272 type: array
10273 items:
10274 type: object
10275 properties:
10276 allowedMethods:
10277 type: array
10278 items:
10279 type: string
10280 uniqueItems: true
10281 cookies:
10282 type: object
10283 additionalProperties:
10284 type: object
10285 properties:
10286 comment:
10287 type: string
10288 domain:
10289 type: string
10290 expiry:
10291 type: string
10292 format: date-time
10293 httpOnly:
10294 type: boolean
10295 maxAge:
10296 type: integer
10297 format: int32
10298 name:
10299 type: string
10300 path:
10301 type: string
10302 secure:
10303 type: boolean
10304 value:
10305 type: string
10306 version:
10307 type: integer
10308 format: int32
10309 date:
10310 type: string
10311 format: date-time
10312 entity:
10313 type: object
10314 entityTag:
10315 type: object
10316 properties:
10317 value:
10318 type: string
10319 weak:
10320 type: boolean
10321 headers:
10322 type: object
10323 additionalProperties:
10324 type: array
10325 items:
10326 type: object
10327 language:
10328 type: object
10329 properties:
10330 country:
10331 type: string
10332 displayCountry:
10333 type: string
10334 displayLanguage:
10335 type: string
10336 displayName:
10337 type: string
10338 displayScript:
10339 type: string
10340 displayVariant:
10341 type: string
10342 extensionKeys:
10343 type: array
10344 items:
10345 type: string
10346 uniqueItems: true
10347 iso3Country:
10348 type: string
10349 iso3Language:
10350 type: string
10351 language:
10352 type: string
10353 script:
10354 type: string
10355 unicodeLocaleAttributes:
10356 type: array
10357 items:
10358 type: string
10359 uniqueItems: true
10360 unicodeLocaleKeys:
10361 type: array
10362 items:
10363 type: string
10364 uniqueItems: true
10365 variant:
10366 type: string
10367 lastModified:
10368 type: string
10369 format: date-time
10370 length:
10371 type: integer
10372 format: int32
10373 links:
10374 type: array
10375 items:
10376 type: object
10377 properties:
10378 params:
10379 type: object
10380 additionalProperties:
10381 type: string
10382 rel:
10383 type: string
10384 rels:
10385 type: array
10386 items:
10387 type: string
10388 title:
10389 type: string
10390 type:
10391 type: string
10392 uri:
10393 type: string
10394 format: uri
10395 uriBuilder:
10396 type: object
10397 uniqueItems: true
10398 location:
10399 type: string
10400 format: uri
10401 mediaType:
10402 type: object
10403 properties:
10404 parameters:
10405 type: object
10406 additionalProperties:
10407 type: string
10408 subtype:
10409 type: string
10410 type:
10411 type: string
10412 wildcardSubtype:
10413 type: boolean
10414 wildcardType:
10415 type: boolean
10416 metadata:
10417 type: object
10418 additionalProperties:
10419 type: array
10420 items:
10421 type: object
10422 status:
10423 type: integer
10424 format: int32
10425 statusInfo:
10426 type: object
10427 properties:
10428 family:
10429 type: string
10430 enum:
10431 - INFORMATIONAL
10432 - SUCCESSFUL
10433 - REDIRECTION
10434 - CLIENT_ERROR
10435 - SERVER_ERROR
10436 - OTHER
10437 reasonPhrase:
10438 type: string
10439 statusCode:
10440 type: integer
10441 format: int32
10442 stringHeaders:
10443 type: object
10444 additionalProperties:
10445 type: array
10446 items:
10447 type: string
10448 servers:
10449 - url: /sdc2/rest
10450 variables: {}
10451 summary: Returns created Additional Inforamtion property
10452 tags:
10453 - SDCE-2 APIs
10454 /v1/catalog/services/{serviceId}/additionalinfo/{labelId}:
10455 delete:
10456 description: Create Additional Information Label and Value
10457 operationId: deleteServiceAdditionalInformationLabel
10458 parameters:
10459 - description: service id to update with new property
10460 in: path
10461 name: serviceId
10462 required: true
10463 schema:
10464 type: string
10465 - description: label id
10466 in: path
10467 name: labelId
10468 required: true
10469 schema:
10470 type: string
10471 - in: header
10472 name: USER_ID
10473 schema:
10474 type: string
10475 responses:
10476 "200":
10477 description: Additional information deleted
10478 "400":
10479 description: Invalid content / Missing content
10480 "403":
10481 description: Restricted operation
10482 "409":
10483 description: Additional information key already exist
10484 default:
10485 content:
10486 application/json:
10487 schema:
10488 type: array
10489 items:
10490 type: object
10491 properties:
10492 allowedMethods:
10493 type: array
10494 items:
10495 type: string
10496 uniqueItems: true
10497 cookies:
10498 type: object
10499 additionalProperties:
10500 type: object
10501 properties:
10502 comment:
10503 type: string
10504 domain:
10505 type: string
10506 expiry:
10507 type: string
10508 format: date-time
10509 httpOnly:
10510 type: boolean
10511 maxAge:
10512 type: integer
10513 format: int32
10514 name:
10515 type: string
10516 path:
10517 type: string
10518 secure:
10519 type: boolean
10520 value:
10521 type: string
10522 version:
10523 type: integer
10524 format: int32
10525 date:
10526 type: string
10527 format: date-time
10528 entity:
10529 type: object
10530 entityTag:
10531 type: object
10532 properties:
10533 value:
10534 type: string
10535 weak:
10536 type: boolean
10537 headers:
10538 type: object
10539 additionalProperties:
10540 type: array
10541 items:
10542 type: object
10543 language:
10544 type: object
10545 properties:
10546 country:
10547 type: string
10548 displayCountry:
10549 type: string
10550 displayLanguage:
10551 type: string
10552 displayName:
10553 type: string
10554 displayScript:
10555 type: string
10556 displayVariant:
10557 type: string
10558 extensionKeys:
10559 type: array
10560 items:
10561 type: string
10562 uniqueItems: true
10563 iso3Country:
10564 type: string
10565 iso3Language:
10566 type: string
10567 language:
10568 type: string
10569 script:
10570 type: string
10571 unicodeLocaleAttributes:
10572 type: array
10573 items:
10574 type: string
10575 uniqueItems: true
10576 unicodeLocaleKeys:
10577 type: array
10578 items:
10579 type: string
10580 uniqueItems: true
10581 variant:
10582 type: string
10583 lastModified:
10584 type: string
10585 format: date-time
10586 length:
10587 type: integer
10588 format: int32
10589 links:
10590 type: array
10591 items:
10592 type: object
10593 properties:
10594 params:
10595 type: object
10596 additionalProperties:
10597 type: string
10598 rel:
10599 type: string
10600 rels:
10601 type: array
10602 items:
10603 type: string
10604 title:
10605 type: string
10606 type:
10607 type: string
10608 uri:
10609 type: string
10610 format: uri
10611 uriBuilder:
10612 type: object
10613 uniqueItems: true
10614 location:
10615 type: string
10616 format: uri
10617 mediaType:
10618 type: object
10619 properties:
10620 parameters:
10621 type: object
10622 additionalProperties:
10623 type: string
10624 subtype:
10625 type: string
10626 type:
10627 type: string
10628 wildcardSubtype:
10629 type: boolean
10630 wildcardType:
10631 type: boolean
10632 metadata:
10633 type: object
10634 additionalProperties:
10635 type: array
10636 items:
10637 type: object
10638 status:
10639 type: integer
10640 format: int32
10641 statusInfo:
10642 type: object
10643 properties:
10644 family:
10645 type: string
10646 enum:
10647 - INFORMATIONAL
10648 - SUCCESSFUL
10649 - REDIRECTION
10650 - CLIENT_ERROR
10651 - SERVER_ERROR
10652 - OTHER
10653 reasonPhrase:
10654 type: string
10655 statusCode:
10656 type: integer
10657 format: int32
10658 stringHeaders:
10659 type: object
10660 additionalProperties:
10661 type: array
10662 items:
10663 type: string
10664 servers:
10665 - url: /sdc2/rest
10666 variables: {}
10667 summary: Returns deleted Additional Inforamtion property
10668 tags:
10669 - SDCE-2 APIs
10670 get:
10671 description: Get Additional Information by id
10672 operationId: getServiceAdditionalInformationLabel
10673 parameters:
10674 - description: service id to update with new property
10675 in: path
10676 name: serviceId
10677 required: true
10678 schema:
10679 type: string
10680 - description: label id
10681 in: path
10682 name: labelId
10683 required: true
10684 schema:
10685 type: string
10686 - in: header
10687 name: USER_ID
10688 schema:
10689 type: string
10690 responses:
10691 "200":
10692 description: fetched additional information
10693 "400":
10694 description: Invalid content / Missing content
10695 "403":
10696 description: Restricted operation
10697 "409":
10698 description: Additional information key already exist
10699 default:
10700 content:
10701 application/json:
10702 schema:
10703 type: array
10704 items:
10705 type: object
10706 properties:
10707 allowedMethods:
10708 type: array
10709 items:
10710 type: string
10711 uniqueItems: true
10712 cookies:
10713 type: object
10714 additionalProperties:
10715 type: object
10716 properties:
10717 comment:
10718 type: string
10719 domain:
10720 type: string
10721 expiry:
10722 type: string
10723 format: date-time
10724 httpOnly:
10725 type: boolean
10726 maxAge:
10727 type: integer
10728 format: int32
10729 name:
10730 type: string
10731 path:
10732 type: string
10733 secure:
10734 type: boolean
10735 value:
10736 type: string
10737 version:
10738 type: integer
10739 format: int32
10740 date:
10741 type: string
10742 format: date-time
10743 entity:
10744 type: object
10745 entityTag:
10746 type: object
10747 properties:
10748 value:
10749 type: string
10750 weak:
10751 type: boolean
10752 headers:
10753 type: object
10754 additionalProperties:
10755 type: array
10756 items:
10757 type: object
10758 language:
10759 type: object
10760 properties:
10761 country:
10762 type: string
10763 displayCountry:
10764 type: string
10765 displayLanguage:
10766 type: string
10767 displayName:
10768 type: string
10769 displayScript:
10770 type: string
10771 displayVariant:
10772 type: string
10773 extensionKeys:
10774 type: array
10775 items:
10776 type: string
10777 uniqueItems: true
10778 iso3Country:
10779 type: string
10780 iso3Language:
10781 type: string
10782 language:
10783 type: string
10784 script:
10785 type: string
10786 unicodeLocaleAttributes:
10787 type: array
10788 items:
10789 type: string
10790 uniqueItems: true
10791 unicodeLocaleKeys:
10792 type: array
10793 items:
10794 type: string
10795 uniqueItems: true
10796 variant:
10797 type: string
10798 lastModified:
10799 type: string
10800 format: date-time
10801 length:
10802 type: integer
10803 format: int32
10804 links:
10805 type: array
10806 items:
10807 type: object
10808 properties:
10809 params:
10810 type: object
10811 additionalProperties:
10812 type: string
10813 rel:
10814 type: string
10815 rels:
10816 type: array
10817 items:
10818 type: string
10819 title:
10820 type: string
10821 type:
10822 type: string
10823 uri:
10824 type: string
10825 format: uri
10826 uriBuilder:
10827 type: object
10828 uniqueItems: true
10829 location:
10830 type: string
10831 format: uri
10832 mediaType:
10833 type: object
10834 properties:
10835 parameters:
10836 type: object
10837 additionalProperties:
10838 type: string
10839 subtype:
10840 type: string
10841 type:
10842 type: string
10843 wildcardSubtype:
10844 type: boolean
10845 wildcardType:
10846 type: boolean
10847 metadata:
10848 type: object
10849 additionalProperties:
10850 type: array
10851 items:
10852 type: object
10853 status:
10854 type: integer
10855 format: int32
10856 statusInfo:
10857 type: object
10858 properties:
10859 family:
10860 type: string
10861 enum:
10862 - INFORMATIONAL
10863 - SUCCESSFUL
10864 - REDIRECTION
10865 - CLIENT_ERROR
10866 - SERVER_ERROR
10867 - OTHER
10868 reasonPhrase:
10869 type: string
10870 statusCode:
10871 type: integer
10872 format: int32
10873 stringHeaders:
10874 type: object
10875 additionalProperties:
10876 type: array
10877 items:
10878 type: string
10879 servers:
10880 - url: /sdc2/rest
10881 variables: {}
10882 summary: Returns Additional Inforamtion property
10883 tags:
10884 - SDCE-2 APIs
10885 put:
10886 description: Update Additional Information Label and Value
10887 operationId: updateServiceAdditionalInformationLabel
10888 parameters:
10889 - description: service id to update with new property
10890 in: path
10891 name: serviceId
10892 required: true
10893 schema:
10894 type: string
10895 - description: label id
10896 in: path
10897 name: labelId
10898 required: true
10899 schema:
10900 type: string
10901 - in: header
10902 name: USER_ID
10903 schema:
10904 type: string
10905 requestBody:
10906 content:
10907 application/json:
10908 schema:
10909 type: string
10910 description: Additional information key value to be created
10911 required: true
10912 responses:
10913 "200":
10914 description: Additional information updated
10915 "400":
10916 description: Invalid content / Missing content
10917 "403":
10918 description: Restricted operation
10919 "409":
10920 description: Additional information key already exist
10921 default:
10922 content:
10923 application/json:
10924 schema:
10925 type: array
10926 items:
10927 type: object
10928 properties:
10929 allowedMethods:
10930 type: array
10931 items:
10932 type: string
10933 uniqueItems: true
10934 cookies:
10935 type: object
10936 additionalProperties:
10937 type: object
10938 properties:
10939 comment:
10940 type: string
10941 domain:
10942 type: string
10943 expiry:
10944 type: string
10945 format: date-time
10946 httpOnly:
10947 type: boolean
10948 maxAge:
10949 type: integer
10950 format: int32
10951 name:
10952 type: string
10953 path:
10954 type: string
10955 secure:
10956 type: boolean
10957 value:
10958 type: string
10959 version:
10960 type: integer
10961 format: int32
10962 date:
10963 type: string
10964 format: date-time
10965 entity:
10966 type: object
10967 entityTag:
10968 type: object
10969 properties:
10970 value:
10971 type: string
10972 weak:
10973 type: boolean
10974 headers:
10975 type: object
10976 additionalProperties:
10977 type: array
10978 items:
10979 type: object
10980 language:
10981 type: object
10982 properties:
10983 country:
10984 type: string
10985 displayCountry:
10986 type: string
10987 displayLanguage:
10988 type: string
10989 displayName:
10990 type: string
10991 displayScript:
10992 type: string
10993 displayVariant:
10994 type: string
10995 extensionKeys:
10996 type: array
10997 items:
10998 type: string
10999 uniqueItems: true
11000 iso3Country:
11001 type: string
11002 iso3Language:
11003 type: string
11004 language:
11005 type: string
11006 script:
11007 type: string
11008 unicodeLocaleAttributes:
11009 type: array
11010 items:
11011 type: string
11012 uniqueItems: true
11013 unicodeLocaleKeys:
11014 type: array
11015 items:
11016 type: string
11017 uniqueItems: true
11018 variant:
11019 type: string
11020 lastModified:
11021 type: string
11022 format: date-time
11023 length:
11024 type: integer
11025 format: int32
11026 links:
11027 type: array
11028 items:
11029 type: object
11030 properties:
11031 params:
11032 type: object
11033 additionalProperties:
11034 type: string
11035 rel:
11036 type: string
11037 rels:
11038 type: array
11039 items:
11040 type: string
11041 title:
11042 type: string
11043 type:
11044 type: string
11045 uri:
11046 type: string
11047 format: uri
11048 uriBuilder:
11049 type: object
11050 uniqueItems: true
11051 location:
11052 type: string
11053 format: uri
11054 mediaType:
11055 type: object
11056 properties:
11057 parameters:
11058 type: object
11059 additionalProperties:
11060 type: string
11061 subtype:
11062 type: string
11063 type:
11064 type: string
11065 wildcardSubtype:
11066 type: boolean
11067 wildcardType:
11068 type: boolean
11069 metadata:
11070 type: object
11071 additionalProperties:
11072 type: array
11073 items:
11074 type: object
11075 status:
11076 type: integer
11077 format: int32
11078 statusInfo:
11079 type: object
11080 properties:
11081 family:
11082 type: string
11083 enum:
11084 - INFORMATIONAL
11085 - SUCCESSFUL
11086 - REDIRECTION
11087 - CLIENT_ERROR
11088 - SERVER_ERROR
11089 - OTHER
11090 reasonPhrase:
11091 type: string
11092 statusCode:
11093 type: integer
11094 format: int32
11095 stringHeaders:
11096 type: object
11097 additionalProperties:
11098 type: array
11099 items:
11100 type: string
11101 servers:
11102 - url: /sdc2/rest
11103 variables: {}
11104 summary: Returns updated Additional Inforamtion property
11105 tags:
11106 - SDCE-2 APIs
11107 /v1/catalog/services/{serviceId}/artifacts:
11108 post:
11109 description: Create Artifact
11110 operationId: loadInformationArtifact
11111 parameters:
11112 - in: path
11113 name: serviceId
11114 required: true
11115 schema:
11116 type: string
11117 requestBody:
11118 content:
11119 application/json:
11120 schema:
11121 type: string
11122 description: json describe the artifact
11123 required: true
11124 responses:
11125 "201":
11126 description: Resource created
11127 "400":
11128 description: Invalid content / Missing content
11129 "403":
11130 description: Restricted operation
11131 "409":
11132 description: Artifact already exist
11133 default:
11134 content:
11135 application/json:
11136 schema:
11137 type: array
11138 items:
11139 type: object
11140 properties:
11141 allowedMethods:
11142 type: array
11143 items:
11144 type: string
11145 uniqueItems: true
11146 cookies:
11147 type: object
11148 additionalProperties:
11149 type: object
11150 properties:
11151 comment:
11152 type: string
11153 domain:
11154 type: string
11155 expiry:
11156 type: string
11157 format: date-time
11158 httpOnly:
11159 type: boolean
11160 maxAge:
11161 type: integer
11162 format: int32
11163 name:
11164 type: string
11165 path:
11166 type: string
11167 secure:
11168 type: boolean
11169 value:
11170 type: string
11171 version:
11172 type: integer
11173 format: int32
11174 date:
11175 type: string
11176 format: date-time
11177 entity:
11178 type: object
11179 entityTag:
11180 type: object
11181 properties:
11182 value:
11183 type: string
11184 weak:
11185 type: boolean
11186 headers:
11187 type: object
11188 additionalProperties:
11189 type: array
11190 items:
11191 type: object
11192 language:
11193 type: object
11194 properties:
11195 country:
11196 type: string
11197 displayCountry:
11198 type: string
11199 displayLanguage:
11200 type: string
11201 displayName:
11202 type: string
11203 displayScript:
11204 type: string
11205 displayVariant:
11206 type: string
11207 extensionKeys:
11208 type: array
11209 items:
11210 type: string
11211 uniqueItems: true
11212 iso3Country:
11213 type: string
11214 iso3Language:
11215 type: string
11216 language:
11217 type: string
11218 script:
11219 type: string
11220 unicodeLocaleAttributes:
11221 type: array
11222 items:
11223 type: string
11224 uniqueItems: true
11225 unicodeLocaleKeys:
11226 type: array
11227 items:
11228 type: string
11229 uniqueItems: true
11230 variant:
11231 type: string
11232 lastModified:
11233 type: string
11234 format: date-time
11235 length:
11236 type: integer
11237 format: int32
11238 links:
11239 type: array
11240 items:
11241 type: object
11242 properties:
11243 params:
11244 type: object
11245 additionalProperties:
11246 type: string
11247 rel:
11248 type: string
11249 rels:
11250 type: array
11251 items:
11252 type: string
11253 title:
11254 type: string
11255 type:
11256 type: string
11257 uri:
11258 type: string
11259 format: uri
11260 uriBuilder:
11261 type: object
11262 uniqueItems: true
11263 location:
11264 type: string
11265 format: uri
11266 mediaType:
11267 type: object
11268 properties:
11269 parameters:
11270 type: object
11271 additionalProperties:
11272 type: string
11273 subtype:
11274 type: string
11275 type:
11276 type: string
11277 wildcardSubtype:
11278 type: boolean
11279 wildcardType:
11280 type: boolean
11281 metadata:
11282 type: object
11283 additionalProperties:
11284 type: array
11285 items:
11286 type: object
11287 status:
11288 type: integer
11289 format: int32
11290 statusInfo:
11291 type: object
11292 properties:
11293 family:
11294 type: string
11295 enum:
11296 - INFORMATIONAL
11297 - SUCCESSFUL
11298 - REDIRECTION
11299 - CLIENT_ERROR
11300 - SERVER_ERROR
11301 - OTHER
11302 reasonPhrase:
11303 type: string
11304 statusCode:
11305 type: integer
11306 format: int32
11307 stringHeaders:
11308 type: object
11309 additionalProperties:
11310 type: array
11311 items:
11312 type: string
11313 servers:
11314 - url: /sdc2/rest
11315 variables: {}
11316 summary: Returns created ArtifactDefinition
11317 tags:
11318 - SDCE-2 APIs
11319 /v1/catalog/services/{serviceId}/artifacts/api/{artifactId}:
11320 delete:
11321 description: Delete Api Artifact
11322 operationId: deleteApiArtifact
11323 parameters:
11324 - in: path
11325 name: serviceId
11326 required: true
11327 schema:
11328 type: string
11329 - in: path
11330 name: artifactId
11331 required: true
11332 schema:
11333 type: string
11334 - in: header
11335 name: USER_ID
11336 schema:
11337 type: string
11338 - in: header
11339 name: Content-MD5
11340 schema:
11341 type: string
11342 responses:
11343 "204":
11344 description: Api Artifact deleted
11345 "403":
11346 description: Restricted operation
11347 default:
11348 content:
11349 application/json:
11350 schema:
11351 type: array
11352 items:
11353 type: object
11354 properties:
11355 allowedMethods:
11356 type: array
11357 items:
11358 type: string
11359 uniqueItems: true
11360 cookies:
11361 type: object
11362 additionalProperties:
11363 type: object
11364 properties:
11365 comment:
11366 type: string
11367 domain:
11368 type: string
11369 expiry:
11370 type: string
11371 format: date-time
11372 httpOnly:
11373 type: boolean
11374 maxAge:
11375 type: integer
11376 format: int32
11377 name:
11378 type: string
11379 path:
11380 type: string
11381 secure:
11382 type: boolean
11383 value:
11384 type: string
11385 version:
11386 type: integer
11387 format: int32
11388 date:
11389 type: string
11390 format: date-time
11391 entity:
11392 type: object
11393 entityTag:
11394 type: object
11395 properties:
11396 value:
11397 type: string
11398 weak:
11399 type: boolean
11400 headers:
11401 type: object
11402 additionalProperties:
11403 type: array
11404 items:
11405 type: object
11406 language:
11407 type: object
11408 properties:
11409 country:
11410 type: string
11411 displayCountry:
11412 type: string
11413 displayLanguage:
11414 type: string
11415 displayName:
11416 type: string
11417 displayScript:
11418 type: string
11419 displayVariant:
11420 type: string
11421 extensionKeys:
11422 type: array
11423 items:
11424 type: string
11425 uniqueItems: true
11426 iso3Country:
11427 type: string
11428 iso3Language:
11429 type: string
11430 language:
11431 type: string
11432 script:
11433 type: string
11434 unicodeLocaleAttributes:
11435 type: array
11436 items:
11437 type: string
11438 uniqueItems: true
11439 unicodeLocaleKeys:
11440 type: array
11441 items:
11442 type: string
11443 uniqueItems: true
11444 variant:
11445 type: string
11446 lastModified:
11447 type: string
11448 format: date-time
11449 length:
11450 type: integer
11451 format: int32
11452 links:
11453 type: array
11454 items:
11455 type: object
11456 properties:
11457 params:
11458 type: object
11459 additionalProperties:
11460 type: string
11461 rel:
11462 type: string
11463 rels:
11464 type: array
11465 items:
11466 type: string
11467 title:
11468 type: string
11469 type:
11470 type: string
11471 uri:
11472 type: string
11473 format: uri
11474 uriBuilder:
11475 type: object
11476 uniqueItems: true
11477 location:
11478 type: string
11479 format: uri
11480 mediaType:
11481 type: object
11482 properties:
11483 parameters:
11484 type: object
11485 additionalProperties:
11486 type: string
11487 subtype:
11488 type: string
11489 type:
11490 type: string
11491 wildcardSubtype:
11492 type: boolean
11493 wildcardType:
11494 type: boolean
11495 metadata:
11496 type: object
11497 additionalProperties:
11498 type: array
11499 items:
11500 type: object
11501 status:
11502 type: integer
11503 format: int32
11504 statusInfo:
11505 type: object
11506 properties:
11507 family:
11508 type: string
11509 enum:
11510 - INFORMATIONAL
11511 - SUCCESSFUL
11512 - REDIRECTION
11513 - CLIENT_ERROR
11514 - SERVER_ERROR
11515 - OTHER
11516 reasonPhrase:
11517 type: string
11518 statusCode:
11519 type: integer
11520 format: int32
11521 stringHeaders:
11522 type: object
11523 additionalProperties:
11524 type: array
11525 items:
11526 type: string
11527 servers:
11528 - url: /sdc2/rest
11529 variables: {}
11530 summary: Returns Deleted ArtifactDefinition
11531 tags:
11532 - SDCE-2 APIs
11533 post:
11534 description: Update Api Artifact
11535 operationId: updateApiArtifact
11536 parameters:
11537 - in: path
11538 name: serviceId
11539 required: true
11540 schema:
11541 type: string
11542 - in: path
11543 name: artifactId
11544 required: true
11545 schema:
11546 type: string
11547 - in: header
11548 name: USER_ID
11549 schema:
11550 type: string
11551 - in: header
11552 name: Content-MD5
11553 schema:
11554 type: string
11555 requestBody:
11556 content:
11557 application/json:
11558 schema:
11559 type: string
11560 description: json describe the artifact
11561 required: true
11562 responses:
11563 "200":
11564 description: Api Artifact Updated
11565 "400":
11566 description: Invalid content / Missing content
11567 "403":
11568 description: Restricted operation
11569 default:
11570 content:
11571 application/json:
11572 schema:
11573 type: array
11574 items:
11575 type: object
11576 properties:
11577 allowedMethods:
11578 type: array
11579 items:
11580 type: string
11581 uniqueItems: true
11582 cookies:
11583 type: object
11584 additionalProperties:
11585 type: object
11586 properties:
11587 comment:
11588 type: string
11589 domain:
11590 type: string
11591 expiry:
11592 type: string
11593 format: date-time
11594 httpOnly:
11595 type: boolean
11596 maxAge:
11597 type: integer
11598 format: int32
11599 name:
11600 type: string
11601 path:
11602 type: string
11603 secure:
11604 type: boolean
11605 value:
11606 type: string
11607 version:
11608 type: integer
11609 format: int32
11610 date:
11611 type: string
11612 format: date-time
11613 entity:
11614 type: object
11615 entityTag:
11616 type: object
11617 properties:
11618 value:
11619 type: string
11620 weak:
11621 type: boolean
11622 headers:
11623 type: object
11624 additionalProperties:
11625 type: array
11626 items:
11627 type: object
11628 language:
11629 type: object
11630 properties:
11631 country:
11632 type: string
11633 displayCountry:
11634 type: string
11635 displayLanguage:
11636 type: string
11637 displayName:
11638 type: string
11639 displayScript:
11640 type: string
11641 displayVariant:
11642 type: string
11643 extensionKeys:
11644 type: array
11645 items:
11646 type: string
11647 uniqueItems: true
11648 iso3Country:
11649 type: string
11650 iso3Language:
11651 type: string
11652 language:
11653 type: string
11654 script:
11655 type: string
11656 unicodeLocaleAttributes:
11657 type: array
11658 items:
11659 type: string
11660 uniqueItems: true
11661 unicodeLocaleKeys:
11662 type: array
11663 items:
11664 type: string
11665 uniqueItems: true
11666 variant:
11667 type: string
11668 lastModified:
11669 type: string
11670 format: date-time
11671 length:
11672 type: integer
11673 format: int32
11674 links:
11675 type: array
11676 items:
11677 type: object
11678 properties:
11679 params:
11680 type: object
11681 additionalProperties:
11682 type: string
11683 rel:
11684 type: string
11685 rels:
11686 type: array
11687 items:
11688 type: string
11689 title:
11690 type: string
11691 type:
11692 type: string
11693 uri:
11694 type: string
11695 format: uri
11696 uriBuilder:
11697 type: object
11698 uniqueItems: true
11699 location:
11700 type: string
11701 format: uri
11702 mediaType:
11703 type: object
11704 properties:
11705 parameters:
11706 type: object
11707 additionalProperties:
11708 type: string
11709 subtype:
11710 type: string
11711 type:
11712 type: string
11713 wildcardSubtype:
11714 type: boolean
11715 wildcardType:
11716 type: boolean
11717 metadata:
11718 type: object
11719 additionalProperties:
11720 type: array
11721 items:
11722 type: object
11723 status:
11724 type: integer
11725 format: int32
11726 statusInfo:
11727 type: object
11728 properties:
11729 family:
11730 type: string
11731 enum:
11732 - INFORMATIONAL
11733 - SUCCESSFUL
11734 - REDIRECTION
11735 - CLIENT_ERROR
11736 - SERVER_ERROR
11737 - OTHER
11738 reasonPhrase:
11739 type: string
11740 statusCode:
11741 type: integer
11742 format: int32
11743 stringHeaders:
11744 type: object
11745 additionalProperties:
11746 type: array
11747 items:
11748 type: string
11749 servers:
11750 - url: /sdc2/rest
11751 variables: {}
11752 summary: Returns created ArtifactDefinition
11753 tags:
11754 - SDCE-2 APIs
11755 /v1/catalog/services/{serviceId}/artifacts/{artifactId}:
11756 delete:
11757 description: Delete Artifact
11758 operationId: deleteInformationalArtifact
11759 parameters:
11760 - in: path
11761 name: serviceId
11762 required: true
11763 schema:
11764 type: string
11765 - in: path
11766 name: artifactId
11767 required: true
11768 schema:
11769 type: string
11770 responses:
11771 "201":
11772 description: Service artifact deleted
11773 "400":
11774 description: Invalid content / Missing content
11775 "403":
11776 description: Restricted operation
11777 default:
11778 content:
11779 application/json:
11780 schema:
11781 type: array
11782 items:
11783 type: object
11784 properties:
11785 allowedMethods:
11786 type: array
11787 items:
11788 type: string
11789 uniqueItems: true
11790 cookies:
11791 type: object
11792 additionalProperties:
11793 type: object
11794 properties:
11795 comment:
11796 type: string
11797 domain:
11798 type: string
11799 expiry:
11800 type: string
11801 format: date-time
11802 httpOnly:
11803 type: boolean
11804 maxAge:
11805 type: integer
11806 format: int32
11807 name:
11808 type: string
11809 path:
11810 type: string
11811 secure:
11812 type: boolean
11813 value:
11814 type: string
11815 version:
11816 type: integer
11817 format: int32
11818 date:
11819 type: string
11820 format: date-time
11821 entity:
11822 type: object
11823 entityTag:
11824 type: object
11825 properties:
11826 value:
11827 type: string
11828 weak:
11829 type: boolean
11830 headers:
11831 type: object
11832 additionalProperties:
11833 type: array
11834 items:
11835 type: object
11836 language:
11837 type: object
11838 properties:
11839 country:
11840 type: string
11841 displayCountry:
11842 type: string
11843 displayLanguage:
11844 type: string
11845 displayName:
11846 type: string
11847 displayScript:
11848 type: string
11849 displayVariant:
11850 type: string
11851 extensionKeys:
11852 type: array
11853 items:
11854 type: string
11855 uniqueItems: true
11856 iso3Country:
11857 type: string
11858 iso3Language:
11859 type: string
11860 language:
11861 type: string
11862 script:
11863 type: string
11864 unicodeLocaleAttributes:
11865 type: array
11866 items:
11867 type: string
11868 uniqueItems: true
11869 unicodeLocaleKeys:
11870 type: array
11871 items:
11872 type: string
11873 uniqueItems: true
11874 variant:
11875 type: string
11876 lastModified:
11877 type: string
11878 format: date-time
11879 length:
11880 type: integer
11881 format: int32
11882 links:
11883 type: array
11884 items:
11885 type: object
11886 properties:
11887 params:
11888 type: object
11889 additionalProperties:
11890 type: string
11891 rel:
11892 type: string
11893 rels:
11894 type: array
11895 items:
11896 type: string
11897 title:
11898 type: string
11899 type:
11900 type: string
11901 uri:
11902 type: string
11903 format: uri
11904 uriBuilder:
11905 type: object
11906 uniqueItems: true
11907 location:
11908 type: string
11909 format: uri
11910 mediaType:
11911 type: object
11912 properties:
11913 parameters:
11914 type: object
11915 additionalProperties:
11916 type: string
11917 subtype:
11918 type: string
11919 type:
11920 type: string
11921 wildcardSubtype:
11922 type: boolean
11923 wildcardType:
11924 type: boolean
11925 metadata:
11926 type: object
11927 additionalProperties:
11928 type: array
11929 items:
11930 type: object
11931 status:
11932 type: integer
11933 format: int32
11934 statusInfo:
11935 type: object
11936 properties:
11937 family:
11938 type: string
11939 enum:
11940 - INFORMATIONAL
11941 - SUCCESSFUL
11942 - REDIRECTION
11943 - CLIENT_ERROR
11944 - SERVER_ERROR
11945 - OTHER
11946 reasonPhrase:
11947 type: string
11948 statusCode:
11949 type: integer
11950 format: int32
11951 stringHeaders:
11952 type: object
11953 additionalProperties:
11954 type: array
11955 items:
11956 type: string
11957 servers:
11958 - url: /sdc2/rest
11959 variables: {}
11960 summary: Returns delete artifact
11961 tags:
11962 - SDCE-2 APIs
11963 get:
11964 description: Download service Artifact in Base64
11965 operationId: downloadServiceArtifactBase64
11966 parameters:
11967 - in: path
11968 name: serviceId
11969 required: true
11970 schema:
11971 type: string
11972 - in: path
11973 name: artifactId
11974 required: true
11975 schema:
11976 type: string
11977 responses:
11978 "200":
11979 description: Service artifact downloaded
11980 "404":
11981 description: Service/Artifact not found
11982 default:
11983 content:
11984 application/json:
11985 schema:
11986 type: array
11987 items:
11988 type: object
11989 properties:
11990 allowedMethods:
11991 type: array
11992 items:
11993 type: string
11994 uniqueItems: true
11995 cookies:
11996 type: object
11997 additionalProperties:
11998 type: object
11999 properties:
12000 comment:
12001 type: string
12002 domain:
12003 type: string
12004 expiry:
12005 type: string
12006 format: date-time
12007 httpOnly:
12008 type: boolean
12009 maxAge:
12010 type: integer
12011 format: int32
12012 name:
12013 type: string
12014 path:
12015 type: string
12016 secure:
12017 type: boolean
12018 value:
12019 type: string
12020 version:
12021 type: integer
12022 format: int32
12023 date:
12024 type: string
12025 format: date-time
12026 entity:
12027 type: object
12028 entityTag:
12029 type: object
12030 properties:
12031 value:
12032 type: string
12033 weak:
12034 type: boolean
12035 headers:
12036 type: object
12037 additionalProperties:
12038 type: array
12039 items:
12040 type: object
12041 language:
12042 type: object
12043 properties:
12044 country:
12045 type: string
12046 displayCountry:
12047 type: string
12048 displayLanguage:
12049 type: string
12050 displayName:
12051 type: string
12052 displayScript:
12053 type: string
12054 displayVariant:
12055 type: string
12056 extensionKeys:
12057 type: array
12058 items:
12059 type: string
12060 uniqueItems: true
12061 iso3Country:
12062 type: string
12063 iso3Language:
12064 type: string
12065 language:
12066 type: string
12067 script:
12068 type: string
12069 unicodeLocaleAttributes:
12070 type: array
12071 items:
12072 type: string
12073 uniqueItems: true
12074 unicodeLocaleKeys:
12075 type: array
12076 items:
12077 type: string
12078 uniqueItems: true
12079 variant:
12080 type: string
12081 lastModified:
12082 type: string
12083 format: date-time
12084 length:
12085 type: integer
12086 format: int32
12087 links:
12088 type: array
12089 items:
12090 type: object
12091 properties:
12092 params:
12093 type: object
12094 additionalProperties:
12095 type: string
12096 rel:
12097 type: string
12098 rels:
12099 type: array
12100 items:
12101 type: string
12102 title:
12103 type: string
12104 type:
12105 type: string
12106 uri:
12107 type: string
12108 format: uri
12109 uriBuilder:
12110 type: object
12111 uniqueItems: true
12112 location:
12113 type: string
12114 format: uri
12115 mediaType:
12116 type: object
12117 properties:
12118 parameters:
12119 type: object
12120 additionalProperties:
12121 type: string
12122 subtype:
12123 type: string
12124 type:
12125 type: string
12126 wildcardSubtype:
12127 type: boolean
12128 wildcardType:
12129 type: boolean
12130 metadata:
12131 type: object
12132 additionalProperties:
12133 type: array
12134 items:
12135 type: object
12136 status:
12137 type: integer
12138 format: int32
12139 statusInfo:
12140 type: object
12141 properties:
12142 family:
12143 type: string
12144 enum:
12145 - INFORMATIONAL
12146 - SUCCESSFUL
12147 - REDIRECTION
12148 - CLIENT_ERROR
12149 - SERVER_ERROR
12150 - OTHER
12151 reasonPhrase:
12152 type: string
12153 statusCode:
12154 type: integer
12155 format: int32
12156 stringHeaders:
12157 type: object
12158 additionalProperties:
12159 type: array
12160 items:
12161 type: string
12162 servers:
12163 - url: /sdc2/rest
12164 variables: {}
12165 summary: Returns downloaded artifact
12166 tags:
12167 - SDCE-2 APIs
12168 post:
12169 description: Update Artifact
12170 operationId: updateInformationArtifact
12171 parameters:
12172 - in: path
12173 name: serviceId
12174 required: true
12175 schema:
12176 type: string
12177 - in: path
12178 name: artifactId
12179 required: true
12180 schema:
12181 type: string
12182 requestBody:
12183 content:
12184 application/json:
12185 schema:
12186 type: string
12187 description: json describe the artifact
12188 required: true
12189 responses:
12190 "201":
12191 description: Service artifact created
12192 "400":
12193 description: Invalid content / Missing content
12194 "403":
12195 description: Restricted operation
12196 default:
12197 content:
12198 application/json:
12199 schema:
12200 type: array
12201 items:
12202 type: object
12203 properties:
12204 allowedMethods:
12205 type: array
12206 items:
12207 type: string
12208 uniqueItems: true
12209 cookies:
12210 type: object
12211 additionalProperties:
12212 type: object
12213 properties:
12214 comment:
12215 type: string
12216 domain:
12217 type: string
12218 expiry:
12219 type: string
12220 format: date-time
12221 httpOnly:
12222 type: boolean
12223 maxAge:
12224 type: integer
12225 format: int32
12226 name:
12227 type: string
12228 path:
12229 type: string
12230 secure:
12231 type: boolean
12232 value:
12233 type: string
12234 version:
12235 type: integer
12236 format: int32
12237 date:
12238 type: string
12239 format: date-time
12240 entity:
12241 type: object
12242 entityTag:
12243 type: object
12244 properties:
12245 value:
12246 type: string
12247 weak:
12248 type: boolean
12249 headers:
12250 type: object
12251 additionalProperties:
12252 type: array
12253 items:
12254 type: object
12255 language:
12256 type: object
12257 properties:
12258 country:
12259 type: string
12260 displayCountry:
12261 type: string
12262 displayLanguage:
12263 type: string
12264 displayName:
12265 type: string
12266 displayScript:
12267 type: string
12268 displayVariant:
12269 type: string
12270 extensionKeys:
12271 type: array
12272 items:
12273 type: string
12274 uniqueItems: true
12275 iso3Country:
12276 type: string
12277 iso3Language:
12278 type: string
12279 language:
12280 type: string
12281 script:
12282 type: string
12283 unicodeLocaleAttributes:
12284 type: array
12285 items:
12286 type: string
12287 uniqueItems: true
12288 unicodeLocaleKeys:
12289 type: array
12290 items:
12291 type: string
12292 uniqueItems: true
12293 variant:
12294 type: string
12295 lastModified:
12296 type: string
12297 format: date-time
12298 length:
12299 type: integer
12300 format: int32
12301 links:
12302 type: array
12303 items:
12304 type: object
12305 properties:
12306 params:
12307 type: object
12308 additionalProperties:
12309 type: string
12310 rel:
12311 type: string
12312 rels:
12313 type: array
12314 items:
12315 type: string
12316 title:
12317 type: string
12318 type:
12319 type: string
12320 uri:
12321 type: string
12322 format: uri
12323 uriBuilder:
12324 type: object
12325 uniqueItems: true
12326 location:
12327 type: string
12328 format: uri
12329 mediaType:
12330 type: object
12331 properties:
12332 parameters:
12333 type: object
12334 additionalProperties:
12335 type: string
12336 subtype:
12337 type: string
12338 type:
12339 type: string
12340 wildcardSubtype:
12341 type: boolean
12342 wildcardType:
12343 type: boolean
12344 metadata:
12345 type: object
12346 additionalProperties:
12347 type: array
12348 items:
12349 type: object
12350 status:
12351 type: integer
12352 format: int32
12353 statusInfo:
12354 type: object
12355 properties:
12356 family:
12357 type: string
12358 enum:
12359 - INFORMATIONAL
12360 - SUCCESSFUL
12361 - REDIRECTION
12362 - CLIENT_ERROR
12363 - SERVER_ERROR
12364 - OTHER
12365 reasonPhrase:
12366 type: string
12367 statusCode:
12368 type: integer
12369 format: int32
12370 stringHeaders:
12371 type: object
12372 additionalProperties:
12373 type: array
12374 items:
12375 type: string
12376 servers:
12377 - url: /sdc2/rest
12378 variables: {}
12379 summary: Returns updated artifact
12380 tags:
12381 - SDCE-2 APIs
12382 /v1/catalog/services/{serviceId}/attributes:
12383 get:
12384 description: Get Service Attribute
12385 operationId: getAttributeListInService
12386 parameters:
12387 - description: service id of attribute
12388 in: path
12389 name: serviceId
12390 required: true
12391 schema:
12392 type: string
12393 - in: header
12394 name: USER_ID
12395 schema:
12396 type: string
12397 responses:
12398 "200":
12399 description: attribute
12400 "400":
12401 description: Invalid content / Missing content
12402 "403":
12403 description: Restricted operation
12404 "404":
12405 description: Service attribute not found
12406 default:
12407 content:
12408 application/json:
12409 schema:
12410 type: array
12411 items:
12412 type: object
12413 properties:
12414 allowedMethods:
12415 type: array
12416 items:
12417 type: string
12418 uniqueItems: true
12419 cookies:
12420 type: object
12421 additionalProperties:
12422 type: object
12423 properties:
12424 comment:
12425 type: string
12426 domain:
12427 type: string
12428 expiry:
12429 type: string
12430 format: date-time
12431 httpOnly:
12432 type: boolean
12433 maxAge:
12434 type: integer
12435 format: int32
12436 name:
12437 type: string
12438 path:
12439 type: string
12440 secure:
12441 type: boolean
12442 value:
12443 type: string
12444 version:
12445 type: integer
12446 format: int32
12447 date:
12448 type: string
12449 format: date-time
12450 entity:
12451 type: object
12452 entityTag:
12453 type: object
12454 properties:
12455 value:
12456 type: string
12457 weak:
12458 type: boolean
12459 headers:
12460 type: object
12461 additionalProperties:
12462 type: array
12463 items:
12464 type: object
12465 language:
12466 type: object
12467 properties:
12468 country:
12469 type: string
12470 displayCountry:
12471 type: string
12472 displayLanguage:
12473 type: string
12474 displayName:
12475 type: string
12476 displayScript:
12477 type: string
12478 displayVariant:
12479 type: string
12480 extensionKeys:
12481 type: array
12482 items:
12483 type: string
12484 uniqueItems: true
12485 iso3Country:
12486 type: string
12487 iso3Language:
12488 type: string
12489 language:
12490 type: string
12491 script:
12492 type: string
12493 unicodeLocaleAttributes:
12494 type: array
12495 items:
12496 type: string
12497 uniqueItems: true
12498 unicodeLocaleKeys:
12499 type: array
12500 items:
12501 type: string
12502 uniqueItems: true
12503 variant:
12504 type: string
12505 lastModified:
12506 type: string
12507 format: date-time
12508 length:
12509 type: integer
12510 format: int32
12511 links:
12512 type: array
12513 items:
12514 type: object
12515 properties:
12516 params:
12517 type: object
12518 additionalProperties:
12519 type: string
12520 rel:
12521 type: string
12522 rels:
12523 type: array
12524 items:
12525 type: string
12526 title:
12527 type: string
12528 type:
12529 type: string
12530 uri:
12531 type: string
12532 format: uri
12533 uriBuilder:
12534 type: object
12535 uniqueItems: true
12536 location:
12537 type: string
12538 format: uri
12539 mediaType:
12540 type: object
12541 properties:
12542 parameters:
12543 type: object
12544 additionalProperties:
12545 type: string
12546 subtype:
12547 type: string
12548 type:
12549 type: string
12550 wildcardSubtype:
12551 type: boolean
12552 wildcardType:
12553 type: boolean
12554 metadata:
12555 type: object
12556 additionalProperties:
12557 type: array
12558 items:
12559 type: object
12560 status:
12561 type: integer
12562 format: int32
12563 statusInfo:
12564 type: object
12565 properties:
12566 family:
12567 type: string
12568 enum:
12569 - INFORMATIONAL
12570 - SUCCESSFUL
12571 - REDIRECTION
12572 - CLIENT_ERROR
12573 - SERVER_ERROR
12574 - OTHER
12575 reasonPhrase:
12576 type: string
12577 statusCode:
12578 type: integer
12579 format: int32
12580 stringHeaders:
12581 type: object
12582 additionalProperties:
12583 type: array
12584 items:
12585 type: string
12586 servers:
12587 - url: /sdc2/rest
12588 variables: {}
12589 summary: Returns attribute list of service
12590 tags:
12591 - SDCE-2 APIs
12592 /v1/catalog/services/{serviceId}/capabilities:
12593 post:
12594 description: Create Capabilities on service
12595 operationId: createCapabilitiesOnService
12596 parameters:
12597 - description: Service Id
12598 in: path
12599 name: serviceId
12600 required: true
12601 schema:
12602 type: string
12603 - in: header
12604 name: USER_ID
12605 schema:
12606 type: string
12607 requestBody:
12608 content:
12609 application/json:
12610 schema:
12611 type: string
12612 description: Capability to create
12613 required: true
12614 responses:
12615 "201":
12616 description: Create Capabilities
12617 "400":
12618 description: Invalid content / Missing content
12619 "403":
12620 description: Restricted operation
12621 "409":
12622 description: Capability already exist
12623 default:
12624 content:
12625 application/json:
12626 schema:
12627 type: array
12628 items:
12629 type: object
12630 properties:
12631 allowedMethods:
12632 type: array
12633 items:
12634 type: string
12635 uniqueItems: true
12636 cookies:
12637 type: object
12638 additionalProperties:
12639 type: object
12640 properties:
12641 comment:
12642 type: string
12643 domain:
12644 type: string
12645 expiry:
12646 type: string
12647 format: date-time
12648 httpOnly:
12649 type: boolean
12650 maxAge:
12651 type: integer
12652 format: int32
12653 name:
12654 type: string
12655 path:
12656 type: string
12657 secure:
12658 type: boolean
12659 value:
12660 type: string
12661 version:
12662 type: integer
12663 format: int32
12664 date:
12665 type: string
12666 format: date-time
12667 entity:
12668 type: object
12669 entityTag:
12670 type: object
12671 properties:
12672 value:
12673 type: string
12674 weak:
12675 type: boolean
12676 headers:
12677 type: object
12678 additionalProperties:
12679 type: array
12680 items:
12681 type: object
12682 language:
12683 type: object
12684 properties:
12685 country:
12686 type: string
12687 displayCountry:
12688 type: string
12689 displayLanguage:
12690 type: string
12691 displayName:
12692 type: string
12693 displayScript:
12694 type: string
12695 displayVariant:
12696 type: string
12697 extensionKeys:
12698 type: array
12699 items:
12700 type: string
12701 uniqueItems: true
12702 iso3Country:
12703 type: string
12704 iso3Language:
12705 type: string
12706 language:
12707 type: string
12708 script:
12709 type: string
12710 unicodeLocaleAttributes:
12711 type: array
12712 items:
12713 type: string
12714 uniqueItems: true
12715 unicodeLocaleKeys:
12716 type: array
12717 items:
12718 type: string
12719 uniqueItems: true
12720 variant:
12721 type: string
12722 lastModified:
12723 type: string
12724 format: date-time
12725 length:
12726 type: integer
12727 format: int32
12728 links:
12729 type: array
12730 items:
12731 type: object
12732 properties:
12733 params:
12734 type: object
12735 additionalProperties:
12736 type: string
12737 rel:
12738 type: string
12739 rels:
12740 type: array
12741 items:
12742 type: string
12743 title:
12744 type: string
12745 type:
12746 type: string
12747 uri:
12748 type: string
12749 format: uri
12750 uriBuilder:
12751 type: object
12752 uniqueItems: true
12753 location:
12754 type: string
12755 format: uri
12756 mediaType:
12757 type: object
12758 properties:
12759 parameters:
12760 type: object
12761 additionalProperties:
12762 type: string
12763 subtype:
12764 type: string
12765 type:
12766 type: string
12767 wildcardSubtype:
12768 type: boolean
12769 wildcardType:
12770 type: boolean
12771 metadata:
12772 type: object
12773 additionalProperties:
12774 type: array
12775 items:
12776 type: object
12777 status:
12778 type: integer
12779 format: int32
12780 statusInfo:
12781 type: object
12782 properties:
12783 family:
12784 type: string
12785 enum:
12786 - INFORMATIONAL
12787 - SUCCESSFUL
12788 - REDIRECTION
12789 - CLIENT_ERROR
12790 - SERVER_ERROR
12791 - OTHER
12792 reasonPhrase:
12793 type: string
12794 statusCode:
12795 type: integer
12796 format: int32
12797 stringHeaders:
12798 type: object
12799 additionalProperties:
12800 type: array
12801 items:
12802 type: string
12803 servers:
12804 - url: /sdc2/rest
12805 variables: {}
12806 summary: Create Capabilities on service
12807 tags:
12808 - SDCE-2 APIs
12809 put:
12810 description: Update Capabilities on service
12811 operationId: updateCapabilitiesOnService
12812 parameters:
12813 - description: Component Id
12814 in: path
12815 name: serviceId
12816 required: true
12817 schema:
12818 type: string
12819 - in: header
12820 name: USER_ID
12821 schema:
12822 type: string
12823 requestBody:
12824 content:
12825 application/json:
12826 schema:
12827 type: string
12828 description: Capabilities to update
12829 required: true
12830 responses:
12831 "201":
12832 description: Update Capabilities
12833 "400":
12834 description: Invalid content / Missing content
12835 "403":
12836 description: Restricted operation
12837 default:
12838 content:
12839 application/json:
12840 schema:
12841 type: array
12842 items:
12843 $ref: '#/components/schemas/CapabilityDefinition'
12844 servers:
12845 - url: /sdc2/rest
12846 variables: {}
12847 summary: Update Capabilities on service
12848 tags:
12849 - SDCE-2 APIs
12850 /v1/catalog/services/{serviceId}/capabilities/{capabilityId}:
12851 delete:
12852 description: Delete capability from service
12853 operationId: deleteCapabilityOnService
12854 parameters:
12855 - description: capability Id
12856 in: path
12857 name: capabilityId
12858 required: true
12859 schema:
12860 type: string
12861 - description: Service Id
12862 in: path
12863 name: serviceId
12864 required: true
12865 schema:
12866 type: string
12867 - in: header
12868 name: USER_ID
12869 schema:
12870 type: string
12871 responses:
12872 "201":
12873 description: Delete capability
12874 "400":
12875 description: Invalid content / Missing content
12876 "403":
12877 description: Restricted operation
12878 default:
12879 content:
12880 application/json:
12881 schema:
12882 type: array
12883 items:
12884 $ref: '#/components/schemas/CapabilityDefinition'
12885 servers:
12886 - url: /sdc2/rest
12887 variables: {}
12888 summary: Delete capability from service
12889 tags:
12890 - SDCE-2 APIs
12891 get:
12892 description: Get Capability from service
12893 operationId: getCapabilityOnService
12894 parameters:
12895 - description: Service Id
12896 in: path
12897 name: serviceId
12898 required: true
12899 schema:
12900 type: string
12901 - description: Capability Id
12902 in: path
12903 name: capabilityId
12904 required: true
12905 schema:
12906 type: string
12907 - in: header
12908 name: USER_ID
12909 schema:
12910 type: string
12911 responses:
12912 "201":
12913 description: GET Capability
12914 "400":
12915 description: Invalid content / Missing content
12916 "403":
12917 description: Restricted operation
12918 default:
12919 content:
12920 application/json:
12921 schema:
12922 type: array
12923 items:
12924 $ref: '#/components/schemas/CapabilityDefinition'
12925 servers:
12926 - url: /sdc2/rest
12927 variables: {}
12928 summary: GET Capability from service
12929 tags:
12930 - SDCE-2 APIs
12931 /v1/catalog/services/{serviceId}/consumption/{serviceInstanceId}:
12932 post:
12933 description: Service consumption on operation
12934 operationId: addInputToServiceOperation
12935 parameters:
12936 - in: path
12937 name: serviceId
12938 required: true
12939 schema:
12940 type: string
12941 - in: path
12942 name: serviceInstanceId
12943 required: true
12944 schema:
12945 type: string
12946 - in: header
12947 name: USER_ID
12948 schema:
12949 type: string
12950 requestBody:
12951 content:
12952 application/json:
12953 schema:
12954 type: string
12955 description: Service Consumption Data
12956 required: true
12957 responses:
12958 "201":
12959 description: Service property created
12960 "400":
12961 description: Invalid content / Missing content
12962 "403":
12963 description: Restricted operation
12964 "409":
12965 description: Service property already exist
12966 default:
12967 content:
12968 application/json:
12969 schema:
12970 type: array
12971 items:
12972 type: object
12973 properties:
12974 allowedMethods:
12975 type: array
12976 items:
12977 type: string
12978 uniqueItems: true
12979 cookies:
12980 type: object
12981 additionalProperties:
12982 type: object
12983 properties:
12984 comment:
12985 type: string
12986 domain:
12987 type: string
12988 expiry:
12989 type: string
12990 format: date-time
12991 httpOnly:
12992 type: boolean
12993 maxAge:
12994 type: integer
12995 format: int32
12996 name:
12997 type: string
12998 path:
12999 type: string
13000 secure:
13001 type: boolean
13002 value:
13003 type: string
13004 version:
13005 type: integer
13006 format: int32
13007 date:
13008 type: string
13009 format: date-time
13010 entity:
13011 type: object
13012 entityTag:
13013 type: object
13014 properties:
13015 value:
13016 type: string
13017 weak:
13018 type: boolean
13019 headers:
13020 type: object
13021 additionalProperties:
13022 type: array
13023 items:
13024 type: object
13025 language:
13026 type: object
13027 properties:
13028 country:
13029 type: string
13030 displayCountry:
13031 type: string
13032 displayLanguage:
13033 type: string
13034 displayName:
13035 type: string
13036 displayScript:
13037 type: string
13038 displayVariant:
13039 type: string
13040 extensionKeys:
13041 type: array
13042 items:
13043 type: string
13044 uniqueItems: true
13045 iso3Country:
13046 type: string
13047 iso3Language:
13048 type: string
13049 language:
13050 type: string
13051 script:
13052 type: string
13053 unicodeLocaleAttributes:
13054 type: array
13055 items:
13056 type: string
13057 uniqueItems: true
13058 unicodeLocaleKeys:
13059 type: array
13060 items:
13061 type: string
13062 uniqueItems: true
13063 variant:
13064 type: string
13065 lastModified:
13066 type: string
13067 format: date-time
13068 length:
13069 type: integer
13070 format: int32
13071 links:
13072 type: array
13073 items:
13074 type: object
13075 properties:
13076 params:
13077 type: object
13078 additionalProperties:
13079 type: string
13080 rel:
13081 type: string
13082 rels:
13083 type: array
13084 items:
13085 type: string
13086 title:
13087 type: string
13088 type:
13089 type: string
13090 uri:
13091 type: string
13092 format: uri
13093 uriBuilder:
13094 type: object
13095 uniqueItems: true
13096 location:
13097 type: string
13098 format: uri
13099 mediaType:
13100 type: object
13101 properties:
13102 parameters:
13103 type: object
13104 additionalProperties:
13105 type: string
13106 subtype:
13107 type: string
13108 type:
13109 type: string
13110 wildcardSubtype:
13111 type: boolean
13112 wildcardType:
13113 type: boolean
13114 metadata:
13115 type: object
13116 additionalProperties:
13117 type: array
13118 items:
13119 type: object
13120 status:
13121 type: integer
13122 format: int32
13123 statusInfo:
13124 type: object
13125 properties:
13126 family:
13127 type: string
13128 enum:
13129 - INFORMATIONAL
13130 - SUCCESSFUL
13131 - REDIRECTION
13132 - CLIENT_ERROR
13133 - SERVER_ERROR
13134 - OTHER
13135 reasonPhrase:
13136 type: string
13137 statusCode:
13138 type: integer
13139 format: int32
13140 stringHeaders:
13141 type: object
13142 additionalProperties:
13143 type: array
13144 items:
13145 type: string
13146 servers:
13147 - url: /sdc2/rest
13148 variables: {}
13149 summary: Returns consumption data
13150 tags:
13151 - SDCE-2 APIs
13152 /v1/catalog/services/{serviceId}/consumption/{serviceInstanceId}/interfaces/{interfaceId}/operations/{operationId}/inputs:
13153 get:
13154 operationId: getInputsListOfOperation
13155 parameters:
13156 - in: path
13157 name: serviceId
13158 required: true
13159 schema:
13160 type: string
13161 - in: path
13162 name: serviceInstanceId
13163 required: true
13164 schema:
13165 type: string
13166 - in: path
13167 name: interfaceId
13168 required: true
13169 schema:
13170 type: string
13171 - in: path
13172 name: operationId
13173 required: true
13174 schema:
13175 type: string
13176 - in: header
13177 name: USER_ID
13178 schema:
13179 type: string
13180 responses:
13181 default:
13182 content:
13183 application/json: {}
13184 description: default response
13185 servers:
13186 - url: /sdc2/rest
13187 variables: {}
13188 tags:
13189 - SDCE-2 APIs
13190 /v1/catalog/services/{serviceId}/distribution/{did}/markDeployed:
13191 post:
13192 description: Mark distribution as deployed
13193 operationId: markDistributionAsDeployed
13194 parameters:
13195 - in: path
13196 name: serviceId
13197 required: true
13198 schema:
13199 type: string
13200 - in: path
13201 name: did
13202 required: true
13203 schema:
13204 type: string
13205 - in: header
13206 name: USER_ID
13207 schema:
13208 type: string
13209 responses:
13210 "200":
13211 description: Service was marked as deployed
13212 "400":
13213 description: Invalid content / Missing content
13214 "403":
13215 description: Service is not available
13216 "404":
13217 description: Requested service was not found
13218 "409":
13219 description: Restricted operation
13220 "500":
13221 description: Internal Server Error. Please try again later.
13222 servers:
13223 - url: /sdc2/rest
13224 variables: {}
13225 summary: relevant audit record will be created
13226 tags:
13227 - SDCE-5 APIs
13228 /v1/catalog/services/{serviceId}/distribution/{env}/activate:
13229 post:
13230 description: Activate distribution
13231 operationId: activateDistribution
13232 parameters:
13233 - in: path
13234 name: serviceId
13235 required: true
13236 schema:
13237 type: string
13238 - in: path
13239 name: env
13240 required: true
13241 schema:
13242 type: string
13243 - in: header
13244 name: USER_ID
13245 schema:
13246 type: string
13247 responses:
13248 "200":
13249 description: OK
13250 "404":
13251 description: Requested service was not found
13252 "409":
13253 description: Service cannot be distributed due to missing deployment artifacts
13254 "500":
13255 description: Internal Server Error. Please try again later.
13256 servers:
13257 - url: /sdc2/rest
13258 variables: {}
13259 summary: activate distribution
13260 tags:
13261 - SDCE-5 APIs
13262 /v1/catalog/services/{serviceId}/interfaceOperations:
13263 post:
13264 description: Create Interface Operations on Service
13265 operationId: createInterfaceOperationsOnService
13266 parameters:
13267 - description: Service Id
13268 in: path
13269 name: serviceId
13270 required: true
13271 schema:
13272 type: string
13273 - in: header
13274 name: USER_ID
13275 schema:
13276 type: string
13277 requestBody:
13278 content:
13279 application/json:
13280 schema:
13281 type: string
13282 description: Interface Operations to create
13283 required: true
13284 responses:
13285 "201":
13286 description: Create Interface Operations on Service
13287 "400":
13288 description: Invalid content / Missing content
13289 "403":
13290 description: Restricted operation
13291 "404":
13292 description: Service not found
13293 "409":
13294 description: Interface Operation already exist
13295 default:
13296 content:
13297 application/json:
13298 schema:
13299 type: array
13300 items:
13301 $ref: '#/components/schemas/InterfaceDefinition'
13302 servers:
13303 - url: /sdc2/rest
13304 variables: {}
13305 summary: Create Interface Operations on Service
13306 tags:
13307 - SDCE-2 APIs
13308 put:
13309 description: Update Interface Operations on Service
13310 operationId: updateInterfaceOperationsOnService
13311 parameters:
13312 - description: Service Id
13313 in: path
13314 name: serviceId
13315 required: true
13316 schema:
13317 type: string
13318 - in: header
13319 name: USER_ID
13320 schema:
13321 type: string
13322 requestBody:
13323 content:
13324 application/json:
13325 schema:
13326 type: string
13327 description: Interface Operations to update
13328 required: true
13329 responses:
13330 "201":
13331 description: Update Interface Operations on Service
13332 "400":
13333 description: Invalid content / Missing content
13334 "403":
13335 description: Restricted operation
13336 "404":
13337 description: Service not found
13338 default:
13339 content:
13340 application/json:
13341 schema:
13342 type: array
13343 items:
13344 $ref: '#/components/schemas/InterfaceDefinition'
13345 servers:
13346 - url: /sdc2/rest
13347 variables: {}
13348 summary: Update Interface Operations on Service
13349 tags:
13350 - SDCE-2 APIs
13351 /v1/catalog/services/{serviceId}/interfaces/{interfaceId}/operations/{operationId}:
13352 delete:
13353 description: Delete Interface Operation from Service
13354 operationId: deleteInterfaceOperationsFromService
13355 parameters:
13356 - description: Service Id
13357 in: path
13358 name: serviceId
13359 required: true
13360 schema:
13361 type: string
13362 - description: Interface Id
13363 in: path
13364 name: interfaceId
13365 required: true
13366 schema:
13367 type: string
13368 - description: Operation Id
13369 in: path
13370 name: operationId
13371 required: true
13372 schema:
13373 type: string
13374 - in: header
13375 name: USER_ID
13376 schema:
13377 type: string
13378 responses:
13379 "201":
13380 description: Delete Interface Operation from Service
13381 "400":
13382 description: Invalid content / Missing content
13383 "403":
13384 description: Restricted operation
13385 "404":
13386 description: Service not found
13387 default:
13388 content:
13389 application/json:
13390 schema:
13391 type: array
13392 items:
13393 $ref: '#/components/schemas/InterfaceDefinition'
13394 servers:
13395 - url: /sdc2/rest
13396 variables: {}
13397 summary: Delete Interface Operation from Service
13398 tags:
13399 - SDCE-2 APIs
13400 get:
13401 description: Get Interface Operation from Service
13402 operationId: getInterfaceOperationsFromService
13403 parameters:
13404 - description: Service Id
13405 in: path
13406 name: serviceId
13407 required: true
13408 schema:
13409 type: string
13410 - description: Interface Id
13411 in: path
13412 name: interfaceId
13413 required: true
13414 schema:
13415 type: string
13416 - description: Operation Id
13417 in: path
13418 name: operationId
13419 required: true
13420 schema:
13421 type: string
13422 - in: header
13423 name: USER_ID
13424 schema:
13425 type: string
13426 responses:
13427 "201":
13428 description: Get Interface Operation from Service
13429 "400":
13430 description: Invalid content / Missing content
13431 "403":
13432 description: Restricted operation
13433 "404":
13434 description: Service not found
13435 default:
13436 content:
13437 application/json:
13438 schema:
13439 type: array
13440 items:
13441 $ref: '#/components/schemas/InterfaceDefinition'
13442 servers:
13443 - url: /sdc2/rest
13444 variables: {}
13445 summary: GET Interface Operation from Service
13446 tags:
13447 - SDCE-2 APIs
13448 /v1/catalog/services/{serviceId}/linksMap:
13449 get:
13450 description: Retrieve Service component relations map
13451 operationId: getServiceComponentRelationMap
13452 parameters:
13453 - in: path
13454 name: serviceId
13455 required: true
13456 schema:
13457 type: string
13458 - in: header
13459 name: USER_ID
13460 schema:
13461 type: string
13462 responses:
13463 "200":
13464 description: Service found
13465 "403":
13466 description: Restricted operation
13467 "404":
13468 description: Service not found
13469 default:
13470 content:
13471 application/json:
13472 schema:
13473 type: array
13474 items:
13475 $ref: '#/components/schemas/ServiceRelations'
13476 servers:
13477 - url: /sdc2/rest
13478 variables: {}
13479 summary: Returns service components relations
13480 tags:
13481 - SDCE-2 APIs
13482 /v1/catalog/services/{serviceId}/metadata:
13483 put:
13484 description: Update Service Metadata
13485 operationId: updateServiceMetadata
13486 parameters:
13487 - in: path
13488 name: serviceId
13489 required: true
13490 schema:
13491 type: string
13492 - in: header
13493 name: USER_ID
13494 schema:
13495 type: string
13496 requestBody:
13497 content:
13498 application/json:
13499 schema:
13500 type: string
13501 description: Service object to be Updated
13502 required: true
13503 responses:
13504 "200":
13505 description: Service Updated
13506 "400":
13507 description: Invalid content / Missing content
13508 "403":
13509 description: Restricted operation
13510 default:
13511 content:
13512 application/json:
13513 schema:
13514 type: array
13515 items:
13516 $ref: '#/components/schemas/Service'
13517 servers:
13518 - url: /sdc2/rest
13519 variables: {}
13520 summary: Returns updated service
13521 tags:
13522 - SDCE-2 APIs
13523 /v1/catalog/services/{serviceId}/paths:
13524 post:
13525 description: Create Forwarding Path
13526 operationId: createForwardingPath
13527 parameters:
13528 - description: Service Id
13529 in: path
13530 name: serviceId
13531 required: true
13532 schema:
13533 type: string
13534 - in: header
13535 name: USER_ID
13536 schema:
13537 type: string
13538 requestBody:
13539 content:
13540 application/json:
13541 schema:
13542 type: string
13543 description: Forwarding Path to create
13544 required: true
13545 responses:
13546 "201":
13547 description: Create Forwarding Path
13548 "400":
13549 description: Invalid content / Missing content
13550 "403":
13551 description: Restricted operation
13552 "409":
13553 description: Forwarding Path already exist
13554 default:
13555 content:
13556 application/json:
13557 schema:
13558 type: array
13559 items:
13560 $ref: '#/components/schemas/Service'
13561 servers:
13562 - url: /sdc2/rest
13563 variables: {}
13564 summary: Create Forwarding Path
13565 tags:
13566 - SDCE-2 APIs
13567 put:
13568 description: Update Forwarding Path
13569 operationId: updateForwardingPath
13570 parameters:
13571 - description: Service Id
13572 in: path
13573 name: serviceId
13574 required: true
13575 schema:
13576 type: string
13577 - in: header
13578 name: USER_ID
13579 schema:
13580 type: string
13581 requestBody:
13582 content:
13583 application/json:
13584 schema:
13585 type: string
13586 description: Update Path to create
13587 required: true
13588 responses:
13589 "201":
13590 description: Update Forwarding Path
13591 "400":
13592 description: Invalid content / Missing content
13593 "403":
13594 description: Restricted operation
13595 "409":
13596 description: Forwarding Path already exist
13597 default:
13598 content:
13599 application/json:
13600 schema:
13601 type: array
13602 items:
13603 $ref: '#/components/schemas/Service'
13604 servers:
13605 - url: /sdc2/rest
13606 variables: {}
13607 summary: Update Forwarding Path
13608 tags:
13609 - SDCE-2 APIs
13610 /v1/catalog/services/{serviceId}/paths/{forwardingPathId}:
13611 delete:
13612 description: Delete Forwarding Path
13613 operationId: deleteForwardingPath
13614 parameters:
13615 - description: Forwarding Path Id
13616 in: path
13617 name: forwardingPathId
13618 required: true
13619 schema:
13620 type: string
13621 - description: Service Id
13622 in: path
13623 name: serviceId
13624 required: true
13625 schema:
13626 type: string
13627 - in: header
13628 name: USER_ID
13629 schema:
13630 type: string
13631 responses:
13632 "201":
13633 description: Delete Forwarding Path
13634 "400":
13635 description: Invalid content / Missing content
13636 "403":
13637 description: Restricted operation
13638 "409":
13639 description: Forwarding Path already exist
13640 default:
13641 content:
13642 application/json:
13643 schema:
13644 type: array
13645 items:
13646 $ref: '#/components/schemas/Service'
13647 servers:
13648 - url: /sdc2/rest
13649 variables: {}
13650 summary: Delete Forwarding Path
13651 tags:
13652 - SDCE-2 APIs
13653 get:
13654 description: Get Forwarding Path
13655 operationId: getForwardingPath
13656 parameters:
13657 - description: Service Id
13658 in: path
13659 name: serviceId
13660 required: true
13661 schema:
13662 type: string
13663 - description: Forwarding Path Id
13664 in: path
13665 name: forwardingPathId
13666 required: true
13667 schema:
13668 type: string
13669 - in: header
13670 name: USER_ID
13671 schema:
13672 type: string
13673 requestBody:
13674 content:
13675 application/json:
13676 schema:
13677 type: string
13678 description: Forwarding Path to create
13679 required: true
13680 responses:
13681 "201":
13682 description: Get Forwarding Path
13683 "400":
13684 description: Invalid content / Missing content
13685 "403":
13686 description: Restricted operation
13687 "409":
13688 description: Forwarding Path already exist
13689 default:
13690 content:
13691 application/json:
13692 schema:
13693 type: array
13694 items:
13695 $ref: '#/components/schemas/ForwardingPathDataDefinition'
13696 servers:
13697 - url: /sdc2/rest
13698 variables: {}
13699 summary: GET Forwarding Path
13700 tags:
13701 - SDCE-2 APIs
13702 /v1/catalog/services/{serviceId}/properties:
13703 get:
13704 description: Get Service Property
13705 operationId: getPropertyListInService
13706 parameters:
13707 - description: service id of property
13708 in: path
13709 name: serviceId
13710 required: true
13711 schema:
13712 type: string
13713 - in: header
13714 name: USER_ID
13715 schema:
13716 type: string
13717 responses:
13718 "200":
13719 description: property
13720 "400":
13721 description: Invalid content / Missing content
13722 "403":
13723 description: Restricted operation
13724 "404":
13725 description: Service property not found
13726 default:
13727 content:
13728 application/json:
13729 schema:
13730 type: array
13731 items:
13732 type: object
13733 properties:
13734 allowedMethods:
13735 type: array
13736 items:
13737 type: string
13738 uniqueItems: true
13739 cookies:
13740 type: object
13741 additionalProperties:
13742 type: object
13743 properties:
13744 comment:
13745 type: string
13746 domain:
13747 type: string
13748 expiry:
13749 type: string
13750 format: date-time
13751 httpOnly:
13752 type: boolean
13753 maxAge:
13754 type: integer
13755 format: int32
13756 name:
13757 type: string
13758 path:
13759 type: string
13760 secure:
13761 type: boolean
13762 value:
13763 type: string
13764 version:
13765 type: integer
13766 format: int32
13767 date:
13768 type: string
13769 format: date-time
13770 entity:
13771 type: object
13772 entityTag:
13773 type: object
13774 properties:
13775 value:
13776 type: string
13777 weak:
13778 type: boolean
13779 headers:
13780 type: object
13781 additionalProperties:
13782 type: array
13783 items:
13784 type: object
13785 language:
13786 type: object
13787 properties:
13788 country:
13789 type: string
13790 displayCountry:
13791 type: string
13792 displayLanguage:
13793 type: string
13794 displayName:
13795 type: string
13796 displayScript:
13797 type: string
13798 displayVariant:
13799 type: string
13800 extensionKeys:
13801 type: array
13802 items:
13803 type: string
13804 uniqueItems: true
13805 iso3Country:
13806 type: string
13807 iso3Language:
13808 type: string
13809 language:
13810 type: string
13811 script:
13812 type: string
13813 unicodeLocaleAttributes:
13814 type: array
13815 items:
13816 type: string
13817 uniqueItems: true
13818 unicodeLocaleKeys:
13819 type: array
13820 items:
13821 type: string
13822 uniqueItems: true
13823 variant:
13824 type: string
13825 lastModified:
13826 type: string
13827 format: date-time
13828 length:
13829 type: integer
13830 format: int32
13831 links:
13832 type: array
13833 items:
13834 type: object
13835 properties:
13836 params:
13837 type: object
13838 additionalProperties:
13839 type: string
13840 rel:
13841 type: string
13842 rels:
13843 type: array
13844 items:
13845 type: string
13846 title:
13847 type: string
13848 type:
13849 type: string
13850 uri:
13851 type: string
13852 format: uri
13853 uriBuilder:
13854 type: object
13855 uniqueItems: true
13856 location:
13857 type: string
13858 format: uri
13859 mediaType:
13860 type: object
13861 properties:
13862 parameters:
13863 type: object
13864 additionalProperties:
13865 type: string
13866 subtype:
13867 type: string
13868 type:
13869 type: string
13870 wildcardSubtype:
13871 type: boolean
13872 wildcardType:
13873 type: boolean
13874 metadata:
13875 type: object
13876 additionalProperties:
13877 type: array
13878 items:
13879 type: object
13880 status:
13881 type: integer
13882 format: int32
13883 statusInfo:
13884 type: object
13885 properties:
13886 family:
13887 type: string
13888 enum:
13889 - INFORMATIONAL
13890 - SUCCESSFUL
13891 - REDIRECTION
13892 - CLIENT_ERROR
13893 - SERVER_ERROR
13894 - OTHER
13895 reasonPhrase:
13896 type: string
13897 statusCode:
13898 type: integer
13899 format: int32
13900 stringHeaders:
13901 type: object
13902 additionalProperties:
13903 type: array
13904 items:
13905 type: string
13906 servers:
13907 - url: /sdc2/rest
13908 variables: {}
13909 summary: Returns property list of service
13910 tags:
13911 - SDCE-2 APIs
13912 post:
13913 description: Create Service Property
13914 operationId: createPropertyInService
13915 parameters:
13916 - description: service id to update with new property
13917 in: path
13918 name: serviceId
13919 required: true
13920 schema:
13921 type: string
13922 - in: header
13923 name: USER_ID
13924 schema:
13925 type: string
13926 requestBody:
13927 content:
13928 application/json:
13929 schema:
13930 type: string
13931 description: Service property to be created
13932 required: true
13933 responses:
13934 "201":
13935 description: Service property created
13936 "400":
13937 description: Invalid content / Missing content
13938 "403":
13939 description: Restricted operation
13940 "409":
13941 description: Service property already exist
13942 default:
13943 content:
13944 application/json:
13945 schema:
13946 type: array
13947 items:
13948 type: object
13949 properties:
13950 allowedMethods:
13951 type: array
13952 items:
13953 type: string
13954 uniqueItems: true
13955 cookies:
13956 type: object
13957 additionalProperties:
13958 type: object
13959 properties:
13960 comment:
13961 type: string
13962 domain:
13963 type: string
13964 expiry:
13965 type: string
13966 format: date-time
13967 httpOnly:
13968 type: boolean
13969 maxAge:
13970 type: integer
13971 format: int32
13972 name:
13973 type: string
13974 path:
13975 type: string
13976 secure:
13977 type: boolean
13978 value:
13979 type: string
13980 version:
13981 type: integer
13982 format: int32
13983 date:
13984 type: string
13985 format: date-time
13986 entity:
13987 type: object
13988 entityTag:
13989 type: object
13990 properties:
13991 value:
13992 type: string
13993 weak:
13994 type: boolean
13995 headers:
13996 type: object
13997 additionalProperties:
13998 type: array
13999 items:
14000 type: object
14001 language:
14002 type: object
14003 properties:
14004 country:
14005 type: string
14006 displayCountry:
14007 type: string
14008 displayLanguage:
14009 type: string
14010 displayName:
14011 type: string
14012 displayScript:
14013 type: string
14014 displayVariant:
14015 type: string
14016 extensionKeys:
14017 type: array
14018 items:
14019 type: string
14020 uniqueItems: true
14021 iso3Country:
14022 type: string
14023 iso3Language:
14024 type: string
14025 language:
14026 type: string
14027 script:
14028 type: string
14029 unicodeLocaleAttributes:
14030 type: array
14031 items:
14032 type: string
14033 uniqueItems: true
14034 unicodeLocaleKeys:
14035 type: array
14036 items:
14037 type: string
14038 uniqueItems: true
14039 variant:
14040 type: string
14041 lastModified:
14042 type: string
14043 format: date-time
14044 length:
14045 type: integer
14046 format: int32
14047 links:
14048 type: array
14049 items:
14050 type: object
14051 properties:
14052 params:
14053 type: object
14054 additionalProperties:
14055 type: string
14056 rel:
14057 type: string
14058 rels:
14059 type: array
14060 items:
14061 type: string
14062 title:
14063 type: string
14064 type:
14065 type: string
14066 uri:
14067 type: string
14068 format: uri
14069 uriBuilder:
14070 type: object
14071 uniqueItems: true
14072 location:
14073 type: string
14074 format: uri
14075 mediaType:
14076 type: object
14077 properties:
14078 parameters:
14079 type: object
14080 additionalProperties:
14081 type: string
14082 subtype:
14083 type: string
14084 type:
14085 type: string
14086 wildcardSubtype:
14087 type: boolean
14088 wildcardType:
14089 type: boolean
14090 metadata:
14091 type: object
14092 additionalProperties:
14093 type: array
14094 items:
14095 type: object
14096 status:
14097 type: integer
14098 format: int32
14099 statusInfo:
14100 type: object
14101 properties:
14102 family:
14103 type: string
14104 enum:
14105 - INFORMATIONAL
14106 - SUCCESSFUL
14107 - REDIRECTION
14108 - CLIENT_ERROR
14109 - SERVER_ERROR
14110 - OTHER
14111 reasonPhrase:
14112 type: string
14113 statusCode:
14114 type: integer
14115 format: int32
14116 stringHeaders:
14117 type: object
14118 additionalProperties:
14119 type: array
14120 items:
14121 type: string
14122 servers:
14123 - url: /sdc2/rest
14124 variables: {}
14125 summary: Returns created service property
14126 tags:
14127 - SDCE-2 APIs
14128 put:
14129 description: Update Service Property
14130 operationId: updatePropertyInService
14131 parameters:
14132 - description: service id to update with new property
14133 in: path
14134 name: serviceId
14135 required: true
14136 schema:
14137 type: string
14138 - in: header
14139 name: USER_ID
14140 schema:
14141 type: string
14142 requestBody:
14143 content:
14144 application/json:
14145 schema:
14146 type: string
14147 description: Service property to update
14148 required: true
14149 responses:
14150 "200":
14151 description: Service property updated
14152 "400":
14153 description: Invalid content / Missing content
14154 "403":
14155 description: Restricted operation
14156 default:
14157 content:
14158 application/json:
14159 schema:
14160 type: array
14161 items:
14162 type: object
14163 properties:
14164 allowedMethods:
14165 type: array
14166 items:
14167 type: string
14168 uniqueItems: true
14169 cookies:
14170 type: object
14171 additionalProperties:
14172 type: object
14173 properties:
14174 comment:
14175 type: string
14176 domain:
14177 type: string
14178 expiry:
14179 type: string
14180 format: date-time
14181 httpOnly:
14182 type: boolean
14183 maxAge:
14184 type: integer
14185 format: int32
14186 name:
14187 type: string
14188 path:
14189 type: string
14190 secure:
14191 type: boolean
14192 value:
14193 type: string
14194 version:
14195 type: integer
14196 format: int32
14197 date:
14198 type: string
14199 format: date-time
14200 entity:
14201 type: object
14202 entityTag:
14203 type: object
14204 properties:
14205 value:
14206 type: string
14207 weak:
14208 type: boolean
14209 headers:
14210 type: object
14211 additionalProperties:
14212 type: array
14213 items:
14214 type: object
14215 language:
14216 type: object
14217 properties:
14218 country:
14219 type: string
14220 displayCountry:
14221 type: string
14222 displayLanguage:
14223 type: string
14224 displayName:
14225 type: string
14226 displayScript:
14227 type: string
14228 displayVariant:
14229 type: string
14230 extensionKeys:
14231 type: array
14232 items:
14233 type: string
14234 uniqueItems: true
14235 iso3Country:
14236 type: string
14237 iso3Language:
14238 type: string
14239 language:
14240 type: string
14241 script:
14242 type: string
14243 unicodeLocaleAttributes:
14244 type: array
14245 items:
14246 type: string
14247 uniqueItems: true
14248 unicodeLocaleKeys:
14249 type: array
14250 items:
14251 type: string
14252 uniqueItems: true
14253 variant:
14254 type: string
14255 lastModified:
14256 type: string
14257 format: date-time
14258 length:
14259 type: integer
14260 format: int32
14261 links:
14262 type: array
14263 items:
14264 type: object
14265 properties:
14266 params:
14267 type: object
14268 additionalProperties:
14269 type: string
14270 rel:
14271 type: string
14272 rels:
14273 type: array
14274 items:
14275 type: string
14276 title:
14277 type: string
14278 type:
14279 type: string
14280 uri:
14281 type: string
14282 format: uri
14283 uriBuilder:
14284 type: object
14285 uniqueItems: true
14286 location:
14287 type: string
14288 format: uri
14289 mediaType:
14290 type: object
14291 properties:
14292 parameters:
14293 type: object
14294 additionalProperties:
14295 type: string
14296 subtype:
14297 type: string
14298 type:
14299 type: string
14300 wildcardSubtype:
14301 type: boolean
14302 wildcardType:
14303 type: boolean
14304 metadata:
14305 type: object
14306 additionalProperties:
14307 type: array
14308 items:
14309 type: object
14310 status:
14311 type: integer
14312 format: int32
14313 statusInfo:
14314 type: object
14315 properties:
14316 family:
14317 type: string
14318 enum:
14319 - INFORMATIONAL
14320 - SUCCESSFUL
14321 - REDIRECTION
14322 - CLIENT_ERROR
14323 - SERVER_ERROR
14324 - OTHER
14325 reasonPhrase:
14326 type: string
14327 statusCode:
14328 type: integer
14329 format: int32
14330 stringHeaders:
14331 type: object
14332 additionalProperties:
14333 type: array
14334 items:
14335 type: string
14336 servers:
14337 - url: /sdc2/rest
14338 variables: {}
14339 summary: Returns updated property
14340 tags:
14341 - SDCE-2 APIs
14342 /v1/catalog/services/{serviceId}/properties/{propertyId}:
14343 delete:
14344 description: Delete Service Property
14345 operationId: deletePropertyInService
14346 parameters:
14347 - description: service id of property
14348 in: path
14349 name: serviceId
14350 required: true
14351 schema:
14352 type: string
14353 - description: Property id to delete
14354 in: path
14355 name: propertyId
14356 required: true
14357 schema:
14358 type: string
14359 - in: header
14360 name: USER_ID
14361 schema:
14362 type: string
14363 responses:
14364 "204":
14365 description: deleted property
14366 "400":
14367 description: Invalid content / Missing content
14368 "403":
14369 description: Restricted operation
14370 "404":
14371 description: Service property not found
14372 default:
14373 content:
14374 application/json:
14375 schema:
14376 type: array
14377 items:
14378 type: object
14379 properties:
14380 allowedMethods:
14381 type: array
14382 items:
14383 type: string
14384 uniqueItems: true
14385 cookies:
14386 type: object
14387 additionalProperties:
14388 type: object
14389 properties:
14390 comment:
14391 type: string
14392 domain:
14393 type: string
14394 expiry:
14395 type: string
14396 format: date-time
14397 httpOnly:
14398 type: boolean
14399 maxAge:
14400 type: integer
14401 format: int32
14402 name:
14403 type: string
14404 path:
14405 type: string
14406 secure:
14407 type: boolean
14408 value:
14409 type: string
14410 version:
14411 type: integer
14412 format: int32
14413 date:
14414 type: string
14415 format: date-time
14416 entity:
14417 type: object
14418 entityTag:
14419 type: object
14420 properties:
14421 value:
14422 type: string
14423 weak:
14424 type: boolean
14425 headers:
14426 type: object
14427 additionalProperties:
14428 type: array
14429 items:
14430 type: object
14431 language:
14432 type: object
14433 properties:
14434 country:
14435 type: string
14436 displayCountry:
14437 type: string
14438 displayLanguage:
14439 type: string
14440 displayName:
14441 type: string
14442 displayScript:
14443 type: string
14444 displayVariant:
14445 type: string
14446 extensionKeys:
14447 type: array
14448 items:
14449 type: string
14450 uniqueItems: true
14451 iso3Country:
14452 type: string
14453 iso3Language:
14454 type: string
14455 language:
14456 type: string
14457 script:
14458 type: string
14459 unicodeLocaleAttributes:
14460 type: array
14461 items:
14462 type: string
14463 uniqueItems: true
14464 unicodeLocaleKeys:
14465 type: array
14466 items:
14467 type: string
14468 uniqueItems: true
14469 variant:
14470 type: string
14471 lastModified:
14472 type: string
14473 format: date-time
14474 length:
14475 type: integer
14476 format: int32
14477 links:
14478 type: array
14479 items:
14480 type: object
14481 properties:
14482 params:
14483 type: object
14484 additionalProperties:
14485 type: string
14486 rel:
14487 type: string
14488 rels:
14489 type: array
14490 items:
14491 type: string
14492 title:
14493 type: string
14494 type:
14495 type: string
14496 uri:
14497 type: string
14498 format: uri
14499 uriBuilder:
14500 type: object
14501 uniqueItems: true
14502 location:
14503 type: string
14504 format: uri
14505 mediaType:
14506 type: object
14507 properties:
14508 parameters:
14509 type: object
14510 additionalProperties:
14511 type: string
14512 subtype:
14513 type: string
14514 type:
14515 type: string
14516 wildcardSubtype:
14517 type: boolean
14518 wildcardType:
14519 type: boolean
14520 metadata:
14521 type: object
14522 additionalProperties:
14523 type: array
14524 items:
14525 type: object
14526 status:
14527 type: integer
14528 format: int32
14529 statusInfo:
14530 type: object
14531 properties:
14532 family:
14533 type: string
14534 enum:
14535 - INFORMATIONAL
14536 - SUCCESSFUL
14537 - REDIRECTION
14538 - CLIENT_ERROR
14539 - SERVER_ERROR
14540 - OTHER
14541 reasonPhrase:
14542 type: string
14543 statusCode:
14544 type: integer
14545 format: int32
14546 stringHeaders:
14547 type: object
14548 additionalProperties:
14549 type: array
14550 items:
14551 type: string
14552 servers:
14553 - url: /sdc2/rest
14554 variables: {}
14555 summary: Returns deleted property
14556 tags:
14557 - SDCE-2 APIs
14558 get:
14559 description: Get Service Property
14560 operationId: getPropertyInService
14561 parameters:
14562 - description: service id of property
14563 in: path
14564 name: serviceId
14565 required: true
14566 schema:
14567 type: string
14568 - description: property id to get
14569 in: path
14570 name: propertyId
14571 required: true
14572 schema:
14573 type: string
14574 - in: header
14575 name: USER_ID
14576 schema:
14577 type: string
14578 responses:
14579 "200":
14580 description: property
14581 "400":
14582 description: Invalid content / Missing content
14583 "403":
14584 description: Restricted operation
14585 "404":
14586 description: Service property not found
14587 default:
14588 content:
14589 application/json:
14590 schema:
14591 type: array
14592 items:
14593 type: object
14594 properties:
14595 allowedMethods:
14596 type: array
14597 items:
14598 type: string
14599 uniqueItems: true
14600 cookies:
14601 type: object
14602 additionalProperties:
14603 type: object
14604 properties:
14605 comment:
14606 type: string
14607 domain:
14608 type: string
14609 expiry:
14610 type: string
14611 format: date-time
14612 httpOnly:
14613 type: boolean
14614 maxAge:
14615 type: integer
14616 format: int32
14617 name:
14618 type: string
14619 path:
14620 type: string
14621 secure:
14622 type: boolean
14623 value:
14624 type: string
14625 version:
14626 type: integer
14627 format: int32
14628 date:
14629 type: string
14630 format: date-time
14631 entity:
14632 type: object
14633 entityTag:
14634 type: object
14635 properties:
14636 value:
14637 type: string
14638 weak:
14639 type: boolean
14640 headers:
14641 type: object
14642 additionalProperties:
14643 type: array
14644 items:
14645 type: object
14646 language:
14647 type: object
14648 properties:
14649 country:
14650 type: string
14651 displayCountry:
14652 type: string
14653 displayLanguage:
14654 type: string
14655 displayName:
14656 type: string
14657 displayScript:
14658 type: string
14659 displayVariant:
14660 type: string
14661 extensionKeys:
14662 type: array
14663 items:
14664 type: string
14665 uniqueItems: true
14666 iso3Country:
14667 type: string
14668 iso3Language:
14669 type: string
14670 language:
14671 type: string
14672 script:
14673 type: string
14674 unicodeLocaleAttributes:
14675 type: array
14676 items:
14677 type: string
14678 uniqueItems: true
14679 unicodeLocaleKeys:
14680 type: array
14681 items:
14682 type: string
14683 uniqueItems: true
14684 variant:
14685 type: string
14686 lastModified:
14687 type: string
14688 format: date-time
14689 length:
14690 type: integer
14691 format: int32
14692 links:
14693 type: array
14694 items:
14695 type: object
14696 properties:
14697 params:
14698 type: object
14699 additionalProperties:
14700 type: string
14701 rel:
14702 type: string
14703 rels:
14704 type: array
14705 items:
14706 type: string
14707 title:
14708 type: string
14709 type:
14710 type: string
14711 uri:
14712 type: string
14713 format: uri
14714 uriBuilder:
14715 type: object
14716 uniqueItems: true
14717 location:
14718 type: string
14719 format: uri
14720 mediaType:
14721 type: object
14722 properties:
14723 parameters:
14724 type: object
14725 additionalProperties:
14726 type: string
14727 subtype:
14728 type: string
14729 type:
14730 type: string
14731 wildcardSubtype:
14732 type: boolean
14733 wildcardType:
14734 type: boolean
14735 metadata:
14736 type: object
14737 additionalProperties:
14738 type: array
14739 items:
14740 type: object
14741 status:
14742 type: integer
14743 format: int32
14744 statusInfo:
14745 type: object
14746 properties:
14747 family:
14748 type: string
14749 enum:
14750 - INFORMATIONAL
14751 - SUCCESSFUL
14752 - REDIRECTION
14753 - CLIENT_ERROR
14754 - SERVER_ERROR
14755 - OTHER
14756 reasonPhrase:
14757 type: string
14758 statusCode:
14759 type: integer
14760 format: int32
14761 stringHeaders:
14762 type: object
14763 additionalProperties:
14764 type: array
14765 items:
14766 type: string
14767 servers:
14768 - url: /sdc2/rest
14769 variables: {}
14770 summary: Returns property of service
14771 tags:
14772 - SDCE-2 APIs
14773 /v1/catalog/services/{serviceId}/requirements:
14774 post:
14775 description: Create requirements on service
14776 operationId: createRequirementsOnService
14777 parameters:
14778 - description: Service Id
14779 in: path
14780 name: serviceId
14781 required: true
14782 schema:
14783 type: string
14784 - in: header
14785 name: USER_ID
14786 schema:
14787 type: string
14788 requestBody:
14789 content:
14790 application/json:
14791 schema:
14792 type: string
14793 description: Requirements to create
14794 required: true
14795 responses:
14796 "201":
14797 description: Create Requirements
14798 "400":
14799 description: Invalid content / Missing content
14800 "403":
14801 description: Restricted operation
14802 "409":
14803 description: Requirement already exist
14804 default:
14805 content:
14806 application/json:
14807 schema:
14808 type: array
14809 items:
14810 type: object
14811 properties:
14812 allowedMethods:
14813 type: array
14814 items:
14815 type: string
14816 uniqueItems: true
14817 cookies:
14818 type: object
14819 additionalProperties:
14820 type: object
14821 properties:
14822 comment:
14823 type: string
14824 domain:
14825 type: string
14826 expiry:
14827 type: string
14828 format: date-time
14829 httpOnly:
14830 type: boolean
14831 maxAge:
14832 type: integer
14833 format: int32
14834 name:
14835 type: string
14836 path:
14837 type: string
14838 secure:
14839 type: boolean
14840 value:
14841 type: string
14842 version:
14843 type: integer
14844 format: int32
14845 date:
14846 type: string
14847 format: date-time
14848 entity:
14849 type: object
14850 entityTag:
14851 type: object
14852 properties:
14853 value:
14854 type: string
14855 weak:
14856 type: boolean
14857 headers:
14858 type: object
14859 additionalProperties:
14860 type: array
14861 items:
14862 type: object
14863 language:
14864 type: object
14865 properties:
14866 country:
14867 type: string
14868 displayCountry:
14869 type: string
14870 displayLanguage:
14871 type: string
14872 displayName:
14873 type: string
14874 displayScript:
14875 type: string
14876 displayVariant:
14877 type: string
14878 extensionKeys:
14879 type: array
14880 items:
14881 type: string
14882 uniqueItems: true
14883 iso3Country:
14884 type: string
14885 iso3Language:
14886 type: string
14887 language:
14888 type: string
14889 script:
14890 type: string
14891 unicodeLocaleAttributes:
14892 type: array
14893 items:
14894 type: string
14895 uniqueItems: true
14896 unicodeLocaleKeys:
14897 type: array
14898 items:
14899 type: string
14900 uniqueItems: true
14901 variant:
14902 type: string
14903 lastModified:
14904 type: string
14905 format: date-time
14906 length:
14907 type: integer
14908 format: int32
14909 links:
14910 type: array
14911 items:
14912 type: object
14913 properties:
14914 params:
14915 type: object
14916 additionalProperties:
14917 type: string
14918 rel:
14919 type: string
14920 rels:
14921 type: array
14922 items:
14923 type: string
14924 title:
14925 type: string
14926 type:
14927 type: string
14928 uri:
14929 type: string
14930 format: uri
14931 uriBuilder:
14932 type: object
14933 uniqueItems: true
14934 location:
14935 type: string
14936 format: uri
14937 mediaType:
14938 type: object
14939 properties:
14940 parameters:
14941 type: object
14942 additionalProperties:
14943 type: string
14944 subtype:
14945 type: string
14946 type:
14947 type: string
14948 wildcardSubtype:
14949 type: boolean
14950 wildcardType:
14951 type: boolean
14952 metadata:
14953 type: object
14954 additionalProperties:
14955 type: array
14956 items:
14957 type: object
14958 status:
14959 type: integer
14960 format: int32
14961 statusInfo:
14962 type: object
14963 properties:
14964 family:
14965 type: string
14966 enum:
14967 - INFORMATIONAL
14968 - SUCCESSFUL
14969 - REDIRECTION
14970 - CLIENT_ERROR
14971 - SERVER_ERROR
14972 - OTHER
14973 reasonPhrase:
14974 type: string
14975 statusCode:
14976 type: integer
14977 format: int32
14978 stringHeaders:
14979 type: object
14980 additionalProperties:
14981 type: array
14982 items:
14983 type: string
14984 servers:
14985 - url: /sdc2/rest
14986 variables: {}
14987 summary: Create requirements on service
14988 tags:
14989 - SDCE-2 APIs
14990 put:
14991 description: Update requirements on service
14992 operationId: updateRequirementsOnService
14993 parameters:
14994 - description: Component Id
14995 in: path
14996 name: serviceId
14997 required: true
14998 schema:
14999 type: string
15000 - in: header
15001 name: USER_ID
15002 schema:
15003 type: string
15004 requestBody:
15005 content:
15006 application/json:
15007 schema:
15008 type: string
15009 description: Requirements to update
15010 required: true
15011 responses:
15012 "201":
15013 description: Update requirements
15014 "400":
15015 description: Invalid content / Missing content
15016 "403":
15017 description: Restricted operation
15018 default:
15019 content:
15020 application/json:
15021 schema:
15022 type: array
15023 items:
15024 $ref: '#/components/schemas/RequirementDefinition'
15025 servers:
15026 - url: /sdc2/rest
15027 variables: {}
15028 summary: Update requirements on service
15029 tags:
15030 - SDCE-2 APIs
15031 /v1/catalog/services/{serviceId}/requirements/{requirementId}:
15032 delete:
15033 description: Delete requirement from service
15034 operationId: deleteRequirementsOnService
15035 parameters:
15036 - description: Service Id
15037 in: path
15038 name: serviceId
15039 required: true
15040 schema:
15041 type: string
15042 - description: Requirement Id
15043 in: path
15044 name: requirementId
15045 required: true
15046 schema:
15047 type: string
15048 - in: header
15049 name: USER_ID
15050 schema:
15051 type: string
15052 responses:
15053 "201":
15054 description: Delete Requirements
15055 "400":
15056 description: Invalid content / Missing content
15057 "403":
15058 description: Restricted operation
15059 default:
15060 content:
15061 application/json:
15062 schema:
15063 type: array
15064 items:
15065 $ref: '#/components/schemas/RequirementDefinition'
15066 servers:
15067 - url: /sdc2/rest
15068 variables: {}
15069 summary: Delete requirement from service
15070 tags:
15071 - SDCE-2 APIs
15072 get:
15073 description: Get requirement from service
15074 operationId: getRequirementsOnService
15075 parameters:
15076 - description: Service Id
15077 in: path
15078 name: serviceId
15079 required: true
15080 schema:
15081 type: string
15082 - description: Requirement Id
15083 in: path
15084 name: requirementId
15085 required: true
15086 schema:
15087 type: string
15088 - in: header
15089 name: USER_ID
15090 schema:
15091 type: string
15092 responses:
15093 "201":
15094 description: GET Requirements
15095 "400":
15096 description: Invalid content / Missing content
15097 "403":
15098 description: Restricted operation
15099 default:
15100 content:
15101 application/json:
15102 schema:
15103 type: array
15104 items:
15105 $ref: '#/components/schemas/RequirementDefinition'
15106 servers:
15107 - url: /sdc2/rest
15108 variables: {}
15109 summary: GET requirement from service
15110 tags:
15111 - SDCE-2 APIs
15112 /v1/catalog/services/{serviceId}/tempUrlToBeDeleted:
15113 post:
15114 operationId: tempUrlToBeDeleted
15115 parameters:
15116 - in: path
15117 name: serviceId
15118 required: true
15119 schema:
15120 type: string
15121 - in: header
15122 name: USER_ID
15123 schema:
15124 type: string
15125 responses:
15126 "200":
15127 description: OK
15128 "500":
15129 description: Internal Server Error. Please try again later.
15130 servers:
15131 - url: /sdc2/rest
15132 variables: {}
15133 tags:
15134 - SDCE-2 APIs
15135 /v1/catalog/services/{serviceName}/{version}:
15136 delete:
15137 description: Delete Service By Name And Version
15138 operationId: deleteServiceByNameAndVersion
15139 parameters:
15140 - in: path
15141 name: serviceName
15142 required: true
15143 schema:
15144 type: string
15145 - in: path
15146 name: version
15147 required: true
15148 schema:
15149 type: string
15150 responses:
15151 "204":
15152 description: Service deleted
15153 "400":
15154 description: Invalid content / Missing content
15155 "403":
15156 description: Restricted operation
15157 "404":
15158 description: Service not found
15159 default:
15160 content:
15161 '*/*':
15162 schema:
15163 type: array
15164 items:
15165 $ref: '#/components/schemas/Resource'
15166 servers:
15167 - url: /sdc2/rest
15168 variables: {}
15169 summary: Returns no content
15170 tags:
15171 - SDCE-2 APIs
15172 /v1/catalog/services/{serviceUUID}/distribution:
15173 get:
15174 description: Retrieve Distributions
15175 operationId: getServiceById
15176 parameters:
15177 - in: path
15178 name: serviceUUID
15179 required: true
15180 schema:
15181 type: string
15182 - in: header
15183 name: USER_ID
15184 schema:
15185 type: string
15186 responses:
15187 "200":
15188 description: Service found
15189 "403":
15190 description: Restricted operation
15191 "404":
15192 description: Service not found
15193 default:
15194 content:
15195 application/json:
15196 schema:
15197 type: array
15198 items:
15199 $ref: '#/components/schemas/DistributionStatusListResponse'
15200 servers:
15201 - url: /sdc2/rest
15202 variables: {}
15203 summary: Returns list bases on the information extracted from Auditing Records
15204 according to service uuid
15205 tags:
15206 - SDCE-5 APIs
15207 /v1/catalog/toggle:
15208 get:
15209 description: Get all Toggleable features
15210 operationId: getAllFeatures
15211 responses:
15212 "200":
15213 description: Success
15214 "400":
15215 description: Invalid content / Missing content
15216 "403":
15217 description: Restricted operation
15218 "404":
15219 description: Toggleable features not found
15220 default:
15221 content:
15222 application/json:
15223 schema:
15224 type: array
15225 items:
15226 type: object
15227 properties:
15228 allowedMethods:
15229 type: array
15230 items:
15231 type: string
15232 uniqueItems: true
15233 cookies:
15234 type: object
15235 additionalProperties:
15236 type: object
15237 properties:
15238 comment:
15239 type: string
15240 domain:
15241 type: string
15242 expiry:
15243 type: string
15244 format: date-time
15245 httpOnly:
15246 type: boolean
15247 maxAge:
15248 type: integer
15249 format: int32
15250 name:
15251 type: string
15252 path:
15253 type: string
15254 secure:
15255 type: boolean
15256 value:
15257 type: string
15258 version:
15259 type: integer
15260 format: int32
15261 date:
15262 type: string
15263 format: date-time
15264 entity:
15265 type: object
15266 entityTag:
15267 type: object
15268 properties:
15269 value:
15270 type: string
15271 weak:
15272 type: boolean
15273 headers:
15274 type: object
15275 additionalProperties:
15276 type: array
15277 items:
15278 type: object
15279 language:
15280 type: object
15281 properties:
15282 country:
15283 type: string
15284 displayCountry:
15285 type: string
15286 displayLanguage:
15287 type: string
15288 displayName:
15289 type: string
15290 displayScript:
15291 type: string
15292 displayVariant:
15293 type: string
15294 extensionKeys:
15295 type: array
15296 items:
15297 type: string
15298 uniqueItems: true
15299 iso3Country:
15300 type: string
15301 iso3Language:
15302 type: string
15303 language:
15304 type: string
15305 script:
15306 type: string
15307 unicodeLocaleAttributes:
15308 type: array
15309 items:
15310 type: string
15311 uniqueItems: true
15312 unicodeLocaleKeys:
15313 type: array
15314 items:
15315 type: string
15316 uniqueItems: true
15317 variant:
15318 type: string
15319 lastModified:
15320 type: string
15321 format: date-time
15322 length:
15323 type: integer
15324 format: int32
15325 links:
15326 type: array
15327 items:
15328 type: object
15329 properties:
15330 params:
15331 type: object
15332 additionalProperties:
15333 type: string
15334 rel:
15335 type: string
15336 rels:
15337 type: array
15338 items:
15339 type: string
15340 title:
15341 type: string
15342 type:
15343 type: string
15344 uri:
15345 type: string
15346 format: uri
15347 uriBuilder:
15348 type: object
15349 uniqueItems: true
15350 location:
15351 type: string
15352 format: uri
15353 mediaType:
15354 type: object
15355 properties:
15356 parameters:
15357 type: object
15358 additionalProperties:
15359 type: string
15360 subtype:
15361 type: string
15362 type:
15363 type: string
15364 wildcardSubtype:
15365 type: boolean
15366 wildcardType:
15367 type: boolean
15368 metadata:
15369 type: object
15370 additionalProperties:
15371 type: array
15372 items:
15373 type: object
15374 status:
15375 type: integer
15376 format: int32
15377 statusInfo:
15378 type: object
15379 properties:
15380 family:
15381 type: string
15382 enum:
15383 - INFORMATIONAL
15384 - SUCCESSFUL
15385 - REDIRECTION
15386 - CLIENT_ERROR
15387 - SERVER_ERROR
15388 - OTHER
15389 reasonPhrase:
15390 type: string
15391 statusCode:
15392 type: integer
15393 format: int32
15394 stringHeaders:
15395 type: object
15396 additionalProperties:
15397 type: array
15398 items:
15399 type: string
15400 servers:
15401 - url: /sdc2/rest
15402 variables: {}
15403 summary: Returns list of toggleable features
15404 tags:
15405 - SDCE-2 APIs
15406 /v1/catalog/toggle/state/{state}:
15407 put:
15408 description: Update all feature toggle state
15409 operationId: setAllFeatures
15410 parameters:
15411 - in: path
15412 name: state
15413 required: true
15414 schema:
15415 type: boolean
15416 responses:
15417 "200":
15418 description: Success
15419 "400":
15420 description: Invalid content / Missing content
15421 "403":
15422 description: Restricted operation
15423 "404":
15424 description: Toggleable features not found
15425 default:
15426 content:
15427 application/json:
15428 schema:
15429 type: array
15430 items:
15431 type: object
15432 properties:
15433 allowedMethods:
15434 type: array
15435 items:
15436 type: string
15437 uniqueItems: true
15438 cookies:
15439 type: object
15440 additionalProperties:
15441 type: object
15442 properties:
15443 comment:
15444 type: string
15445 domain:
15446 type: string
15447 expiry:
15448 type: string
15449 format: date-time
15450 httpOnly:
15451 type: boolean
15452 maxAge:
15453 type: integer
15454 format: int32
15455 name:
15456 type: string
15457 path:
15458 type: string
15459 secure:
15460 type: boolean
15461 value:
15462 type: string
15463 version:
15464 type: integer
15465 format: int32
15466 date:
15467 type: string
15468 format: date-time
15469 entity:
15470 type: object
15471 entityTag:
15472 type: object
15473 properties:
15474 value:
15475 type: string
15476 weak:
15477 type: boolean
15478 headers:
15479 type: object
15480 additionalProperties:
15481 type: array
15482 items:
15483 type: object
15484 language:
15485 type: object
15486 properties:
15487 country:
15488 type: string
15489 displayCountry:
15490 type: string
15491 displayLanguage:
15492 type: string
15493 displayName:
15494 type: string
15495 displayScript:
15496 type: string
15497 displayVariant:
15498 type: string
15499 extensionKeys:
15500 type: array
15501 items:
15502 type: string
15503 uniqueItems: true
15504 iso3Country:
15505 type: string
15506 iso3Language:
15507 type: string
15508 language:
15509 type: string
15510 script:
15511 type: string
15512 unicodeLocaleAttributes:
15513 type: array
15514 items:
15515 type: string
15516 uniqueItems: true
15517 unicodeLocaleKeys:
15518 type: array
15519 items:
15520 type: string
15521 uniqueItems: true
15522 variant:
15523 type: string
15524 lastModified:
15525 type: string
15526 format: date-time
15527 length:
15528 type: integer
15529 format: int32
15530 links:
15531 type: array
15532 items:
15533 type: object
15534 properties:
15535 params:
15536 type: object
15537 additionalProperties:
15538 type: string
15539 rel:
15540 type: string
15541 rels:
15542 type: array
15543 items:
15544 type: string
15545 title:
15546 type: string
15547 type:
15548 type: string
15549 uri:
15550 type: string
15551 format: uri
15552 uriBuilder:
15553 type: object
15554 uniqueItems: true
15555 location:
15556 type: string
15557 format: uri
15558 mediaType:
15559 type: object
15560 properties:
15561 parameters:
15562 type: object
15563 additionalProperties:
15564 type: string
15565 subtype:
15566 type: string
15567 type:
15568 type: string
15569 wildcardSubtype:
15570 type: boolean
15571 wildcardType:
15572 type: boolean
15573 metadata:
15574 type: object
15575 additionalProperties:
15576 type: array
15577 items:
15578 type: object
15579 status:
15580 type: integer
15581 format: int32
15582 statusInfo:
15583 type: object
15584 properties:
15585 family:
15586 type: string
15587 enum:
15588 - INFORMATIONAL
15589 - SUCCESSFUL
15590 - REDIRECTION
15591 - CLIENT_ERROR
15592 - SERVER_ERROR
15593 - OTHER
15594 reasonPhrase:
15595 type: string
15596 statusCode:
15597 type: integer
15598 format: int32
15599 stringHeaders:
15600 type: object
15601 additionalProperties:
15602 type: array
15603 items:
15604 type: string
15605 servers:
15606 - url: /sdc2/rest
15607 variables: {}
15608 summary: Update all feature status
15609 tags:
15610 - SDCE-2 APIs
15611 /v1/catalog/toggle/{featureName}/state:
15612 get:
15613 description: Get Toggleable feature state
15614 operationId: getToggleableFeature
15615 parameters:
15616 - in: path
15617 name: featureName
15618 required: true
15619 schema:
15620 type: string
15621 responses:
15622 "200":
15623 description: Success
15624 "400":
15625 description: Invalid content / Missing content
15626 "403":
15627 description: Restricted operation
15628 "404":
15629 description: Toggleable feature not found
15630 default:
15631 content:
15632 application/json:
15633 schema:
15634 type: array
15635 items:
15636 type: object
15637 properties:
15638 allowedMethods:
15639 type: array
15640 items:
15641 type: string
15642 uniqueItems: true
15643 cookies:
15644 type: object
15645 additionalProperties:
15646 type: object
15647 properties:
15648 comment:
15649 type: string
15650 domain:
15651 type: string
15652 expiry:
15653 type: string
15654 format: date-time
15655 httpOnly:
15656 type: boolean
15657 maxAge:
15658 type: integer
15659 format: int32
15660 name:
15661 type: string
15662 path:
15663 type: string
15664 secure:
15665 type: boolean
15666 value:
15667 type: string
15668 version:
15669 type: integer
15670 format: int32
15671 date:
15672 type: string
15673 format: date-time
15674 entity:
15675 type: object
15676 entityTag:
15677 type: object
15678 properties:
15679 value:
15680 type: string
15681 weak:
15682 type: boolean
15683 headers:
15684 type: object
15685 additionalProperties:
15686 type: array
15687 items:
15688 type: object
15689 language:
15690 type: object
15691 properties:
15692 country:
15693 type: string
15694 displayCountry:
15695 type: string
15696 displayLanguage:
15697 type: string
15698 displayName:
15699 type: string
15700 displayScript:
15701 type: string
15702 displayVariant:
15703 type: string
15704 extensionKeys:
15705 type: array
15706 items:
15707 type: string
15708 uniqueItems: true
15709 iso3Country:
15710 type: string
15711 iso3Language:
15712 type: string
15713 language:
15714 type: string
15715 script:
15716 type: string
15717 unicodeLocaleAttributes:
15718 type: array
15719 items:
15720 type: string
15721 uniqueItems: true
15722 unicodeLocaleKeys:
15723 type: array
15724 items:
15725 type: string
15726 uniqueItems: true
15727 variant:
15728 type: string
15729 lastModified:
15730 type: string
15731 format: date-time
15732 length:
15733 type: integer
15734 format: int32
15735 links:
15736 type: array
15737 items:
15738 type: object
15739 properties:
15740 params:
15741 type: object
15742 additionalProperties:
15743 type: string
15744 rel:
15745 type: string
15746 rels:
15747 type: array
15748 items:
15749 type: string
15750 title:
15751 type: string
15752 type:
15753 type: string
15754 uri:
15755 type: string
15756 format: uri
15757 uriBuilder:
15758 type: object
15759 uniqueItems: true
15760 location:
15761 type: string
15762 format: uri
15763 mediaType:
15764 type: object
15765 properties:
15766 parameters:
15767 type: object
15768 additionalProperties:
15769 type: string
15770 subtype:
15771 type: string
15772 type:
15773 type: string
15774 wildcardSubtype:
15775 type: boolean
15776 wildcardType:
15777 type: boolean
15778 metadata:
15779 type: object
15780 additionalProperties:
15781 type: array
15782 items:
15783 type: object
15784 status:
15785 type: integer
15786 format: int32
15787 statusInfo:
15788 type: object
15789 properties:
15790 family:
15791 type: string
15792 enum:
15793 - INFORMATIONAL
15794 - SUCCESSFUL
15795 - REDIRECTION
15796 - CLIENT_ERROR
15797 - SERVER_ERROR
15798 - OTHER
15799 reasonPhrase:
15800 type: string
15801 statusCode:
15802 type: integer
15803 format: int32
15804 stringHeaders:
15805 type: object
15806 additionalProperties:
15807 type: array
15808 items:
15809 type: string
15810 servers:
15811 - url: /sdc2/rest
15812 variables: {}
15813 summary: Returns one toggleable feature state
15814 tags:
15815 - SDCE-2 APIs
15816 /v1/catalog/toggle/{featureName}/state/{state}:
15817 put:
15818 description: Update feature toggle state
15819 operationId: updateFeatureState
15820 parameters:
15821 - in: path
15822 name: featureName
15823 required: true
15824 schema:
15825 type: string
15826 - in: path
15827 name: state
15828 required: true
15829 schema:
15830 type: boolean
15831 responses:
15832 "200":
15833 description: Success
15834 "400":
15835 description: Invalid content / Missing content
15836 "403":
15837 description: Restricted operation
15838 "404":
15839 description: Toggleable features not found
15840 default:
15841 content:
15842 application/json:
15843 schema:
15844 type: array
15845 items:
15846 type: object
15847 properties:
15848 allowedMethods:
15849 type: array
15850 items:
15851 type: string
15852 uniqueItems: true
15853 cookies:
15854 type: object
15855 additionalProperties:
15856 type: object
15857 properties:
15858 comment:
15859 type: string
15860 domain:
15861 type: string
15862 expiry:
15863 type: string
15864 format: date-time
15865 httpOnly:
15866 type: boolean
15867 maxAge:
15868 type: integer
15869 format: int32
15870 name:
15871 type: string
15872 path:
15873 type: string
15874 secure:
15875 type: boolean
15876 value:
15877 type: string
15878 version:
15879 type: integer
15880 format: int32
15881 date:
15882 type: string
15883 format: date-time
15884 entity:
15885 type: object
15886 entityTag:
15887 type: object
15888 properties:
15889 value:
15890 type: string
15891 weak:
15892 type: boolean
15893 headers:
15894 type: object
15895 additionalProperties:
15896 type: array
15897 items:
15898 type: object
15899 language:
15900 type: object
15901 properties:
15902 country:
15903 type: string
15904 displayCountry:
15905 type: string
15906 displayLanguage:
15907 type: string
15908 displayName:
15909 type: string
15910 displayScript:
15911 type: string
15912 displayVariant:
15913 type: string
15914 extensionKeys:
15915 type: array
15916 items:
15917 type: string
15918 uniqueItems: true
15919 iso3Country:
15920 type: string
15921 iso3Language:
15922 type: string
15923 language:
15924 type: string
15925 script:
15926 type: string
15927 unicodeLocaleAttributes:
15928 type: array
15929 items:
15930 type: string
15931 uniqueItems: true
15932 unicodeLocaleKeys:
15933 type: array
15934 items:
15935 type: string
15936 uniqueItems: true
15937 variant:
15938 type: string
15939 lastModified:
15940 type: string
15941 format: date-time
15942 length:
15943 type: integer
15944 format: int32
15945 links:
15946 type: array
15947 items:
15948 type: object
15949 properties:
15950 params:
15951 type: object
15952 additionalProperties:
15953 type: string
15954 rel:
15955 type: string
15956 rels:
15957 type: array
15958 items:
15959 type: string
15960 title:
15961 type: string
15962 type:
15963 type: string
15964 uri:
15965 type: string
15966 format: uri
15967 uriBuilder:
15968 type: object
15969 uniqueItems: true
15970 location:
15971 type: string
15972 format: uri
15973 mediaType:
15974 type: object
15975 properties:
15976 parameters:
15977 type: object
15978 additionalProperties:
15979 type: string
15980 subtype:
15981 type: string
15982 type:
15983 type: string
15984 wildcardSubtype:
15985 type: boolean
15986 wildcardType:
15987 type: boolean
15988 metadata:
15989 type: object
15990 additionalProperties:
15991 type: array
15992 items:
15993 type: object
15994 status:
15995 type: integer
15996 format: int32
15997 statusInfo:
15998 type: object
15999 properties:
16000 family:
16001 type: string
16002 enum:
16003 - INFORMATIONAL
16004 - SUCCESSFUL
16005 - REDIRECTION
16006 - CLIENT_ERROR
16007 - SERVER_ERROR
16008 - OTHER
16009 reasonPhrase:
16010 type: string
16011 statusCode:
16012 type: integer
16013 format: int32
16014 stringHeaders:
16015 type: object
16016 additionalProperties:
16017 type: array
16018 items:
16019 type: string
16020 servers:
16021 - url: /sdc2/rest
16022 variables: {}
16023 summary: Update feature status
16024 tags:
16025 - SDCE-2 APIs
16026 /v1/catalog/upload/resource/import:
16027 post:
16028 description: "Import node types from a TOSCA yaml, along with the types metadata"
16029 operationId: bulkImport
16030 parameters:
16031 - in: header
16032 name: USER_ID
16033 schema:
16034 type: string
16035 requestBody:
16036 content:
16037 multipart/form-data:
16038 schema:
16039 type: object
16040 properties:
16041 createNewVersion:
16042 type: boolean
16043 default: true
16044 description: The model name to associate the node types to
16045 nodeTypeMetadataJson:
16046 $ref: '#/components/schemas/NodeTypesMetadataList'
16047 nodeTypesYaml:
16048 type: object
16049 description: The node types TOSCA definition yaml
16050 required:
16051 - nodeTypeMetadataJson
16052 - nodeTypesYaml
16053 responses:
16054 "201":
16055 description: Resources created
16056 "400":
16057 description: Invalid content / Missing content
16058 "403":
16059 description: Restricted operation
16060 "409":
16061 description: One of the resources already exists
16062 default:
16063 content:
16064 application/json:
16065 schema:
16066 type: array
16067 items:
16068 type: object
16069 properties:
16070 allowedMethods:
16071 type: array
16072 items:
16073 type: string
16074 uniqueItems: true
16075 cookies:
16076 type: object
16077 additionalProperties:
16078 type: object
16079 properties:
16080 comment:
16081 type: string
16082 domain:
16083 type: string
16084 expiry:
16085 type: string
16086 format: date-time
16087 httpOnly:
16088 type: boolean
16089 maxAge:
16090 type: integer
16091 format: int32
16092 name:
16093 type: string
16094 path:
16095 type: string
16096 secure:
16097 type: boolean
16098 value:
16099 type: string
16100 version:
16101 type: integer
16102 format: int32
16103 date:
16104 type: string
16105 format: date-time
16106 entity:
16107 type: object
16108 entityTag:
16109 type: object
16110 properties:
16111 value:
16112 type: string
16113 weak:
16114 type: boolean
16115 headers:
16116 type: object
16117 additionalProperties:
16118 type: array
16119 items:
16120 type: object
16121 language:
16122 type: object
16123 properties:
16124 country:
16125 type: string
16126 displayCountry:
16127 type: string
16128 displayLanguage:
16129 type: string
16130 displayName:
16131 type: string
16132 displayScript:
16133 type: string
16134 displayVariant:
16135 type: string
16136 extensionKeys:
16137 type: array
16138 items:
16139 type: string
16140 uniqueItems: true
16141 iso3Country:
16142 type: string
16143 iso3Language:
16144 type: string
16145 language:
16146 type: string
16147 script:
16148 type: string
16149 unicodeLocaleAttributes:
16150 type: array
16151 items:
16152 type: string
16153 uniqueItems: true
16154 unicodeLocaleKeys:
16155 type: array
16156 items:
16157 type: string
16158 uniqueItems: true
16159 variant:
16160 type: string
16161 lastModified:
16162 type: string
16163 format: date-time
16164 length:
16165 type: integer
16166 format: int32
16167 links:
16168 type: array
16169 items:
16170 type: object
16171 properties:
16172 params:
16173 type: object
16174 additionalProperties:
16175 type: string
16176 rel:
16177 type: string
16178 rels:
16179 type: array
16180 items:
16181 type: string
16182 title:
16183 type: string
16184 type:
16185 type: string
16186 uri:
16187 type: string
16188 format: uri
16189 uriBuilder:
16190 type: object
16191 uniqueItems: true
16192 location:
16193 type: string
16194 format: uri
16195 mediaType:
16196 type: object
16197 properties:
16198 parameters:
16199 type: object
16200 additionalProperties:
16201 type: string
16202 subtype:
16203 type: string
16204 type:
16205 type: string
16206 wildcardSubtype:
16207 type: boolean
16208 wildcardType:
16209 type: boolean
16210 metadata:
16211 type: object
16212 additionalProperties:
16213 type: array
16214 items:
16215 type: object
16216 status:
16217 type: integer
16218 format: int32
16219 statusInfo:
16220 type: object
16221 properties:
16222 family:
16223 type: string
16224 enum:
16225 - INFORMATIONAL
16226 - SUCCESSFUL
16227 - REDIRECTION
16228 - CLIENT_ERROR
16229 - SERVER_ERROR
16230 - OTHER
16231 reasonPhrase:
16232 type: string
16233 statusCode:
16234 type: integer
16235 format: int32
16236 stringHeaders:
16237 type: object
16238 additionalProperties:
16239 type: array
16240 items:
16241 type: string
16242 servers:
16243 - url: /sdc2/rest
16244 variables: {}
16245 summary: Creates node types from a TOSCA yaml file
16246 tags:
16247 - SDCE-2 APIs
16248 /v1/catalog/upload/{resourceAuthority}:
16249 post:
16250 description: Create Resource from yaml
16251 operationId: uploadMultipart
16252 parameters:
16253 - description: "validValues: normative-resource / user-resource"
16254 in: path
16255 name: resourceAuthority
16256 required: true
16257 schema:
16258 type: string
16259 enum:
16260 - multipart
16261 - user-resource
16262 - user-resource-ui-import
16263 - in: header
16264 name: USER_ID
16265 schema:
16266 type: string
16267 - in: query
16268 name: createNewVersion
16269 schema:
16270 type: boolean
16271 default: true
16272 requestBody:
16273 content:
16274 multipart/form-data:
16275 schema:
16276 type: object
16277 properties:
16278 resourceMetadata:
16279 type: string
16280 description: resourceMetadata
16281 resourceZip:
16282 $ref: '#/components/schemas/FormDataContentDisposition'
16283 responses:
16284 "201":
16285 description: Resource created
16286 "400":
16287 description: Invalid content / Missing content
16288 "403":
16289 description: Restricted operation
16290 "409":
16291 description: Resource already exist
16292 default:
16293 content:
16294 application/json:
16295 schema:
16296 type: array
16297 items:
16298 type: object
16299 properties:
16300 allowedMethods:
16301 type: array
16302 items:
16303 type: string
16304 uniqueItems: true
16305 cookies:
16306 type: object
16307 additionalProperties:
16308 type: object
16309 properties:
16310 comment:
16311 type: string
16312 domain:
16313 type: string
16314 expiry:
16315 type: string
16316 format: date-time
16317 httpOnly:
16318 type: boolean
16319 maxAge:
16320 type: integer
16321 format: int32
16322 name:
16323 type: string
16324 path:
16325 type: string
16326 secure:
16327 type: boolean
16328 value:
16329 type: string
16330 version:
16331 type: integer
16332 format: int32
16333 date:
16334 type: string
16335 format: date-time
16336 entity:
16337 type: object
16338 entityTag:
16339 type: object
16340 properties:
16341 value:
16342 type: string
16343 weak:
16344 type: boolean
16345 headers:
16346 type: object
16347 additionalProperties:
16348 type: array
16349 items:
16350 type: object
16351 language:
16352 type: object
16353 properties:
16354 country:
16355 type: string
16356 displayCountry:
16357 type: string
16358 displayLanguage:
16359 type: string
16360 displayName:
16361 type: string
16362 displayScript:
16363 type: string
16364 displayVariant:
16365 type: string
16366 extensionKeys:
16367 type: array
16368 items:
16369 type: string
16370 uniqueItems: true
16371 iso3Country:
16372 type: string
16373 iso3Language:
16374 type: string
16375 language:
16376 type: string
16377 script:
16378 type: string
16379 unicodeLocaleAttributes:
16380 type: array
16381 items:
16382 type: string
16383 uniqueItems: true
16384 unicodeLocaleKeys:
16385 type: array
16386 items:
16387 type: string
16388 uniqueItems: true
16389 variant:
16390 type: string
16391 lastModified:
16392 type: string
16393 format: date-time
16394 length:
16395 type: integer
16396 format: int32
16397 links:
16398 type: array
16399 items:
16400 type: object
16401 properties:
16402 params:
16403 type: object
16404 additionalProperties:
16405 type: string
16406 rel:
16407 type: string
16408 rels:
16409 type: array
16410 items:
16411 type: string
16412 title:
16413 type: string
16414 type:
16415 type: string
16416 uri:
16417 type: string
16418 format: uri
16419 uriBuilder:
16420 type: object
16421 uniqueItems: true
16422 location:
16423 type: string
16424 format: uri
16425 mediaType:
16426 type: object
16427 properties:
16428 parameters:
16429 type: object
16430 additionalProperties:
16431 type: string
16432 subtype:
16433 type: string
16434 type:
16435 type: string
16436 wildcardSubtype:
16437 type: boolean
16438 wildcardType:
16439 type: boolean
16440 metadata:
16441 type: object
16442 additionalProperties:
16443 type: array
16444 items:
16445 type: object
16446 status:
16447 type: integer
16448 format: int32
16449 statusInfo:
16450 type: object
16451 properties:
16452 family:
16453 type: string
16454 enum:
16455 - INFORMATIONAL
16456 - SUCCESSFUL
16457 - REDIRECTION
16458 - CLIENT_ERROR
16459 - SERVER_ERROR
16460 - OTHER
16461 reasonPhrase:
16462 type: string
16463 statusCode:
16464 type: integer
16465 format: int32
16466 stringHeaders:
16467 type: object
16468 additionalProperties:
16469 type: array
16470 items:
16471 type: string
16472 servers:
16473 - url: /sdc2/rest
16474 variables: {}
16475 summary: Returns created resource
16476 tags:
16477 - SDCE-2 APIs
16478 /v1/catalog/uploadType/annotationtypes:
16479 post:
16480 description: Create AnnotationTypes from yaml
16481 operationId: uploadAnnotationTypes
16482 parameters:
16483 - in: header
16484 name: USER_ID
16485 schema:
16486 type: string
16487 requestBody:
16488 content:
16489 multipart/form-data:
16490 schema:
16491 type: object
16492 properties:
16493 annotationTypesZip:
16494 type: string
16495 format: binary
16496 description: FileInputStream
16497 responses:
16498 "201":
16499 description: annotation types created
16500 "400":
16501 description: Invalid content / Missing content
16502 "403":
16503 description: Restricted operation
16504 "409":
16505 description: annotation types already exist
16506 default:
16507 content:
16508 application/json:
16509 schema:
16510 type: array
16511 items:
16512 type: object
16513 properties:
16514 allowedMethods:
16515 type: array
16516 items:
16517 type: string
16518 uniqueItems: true
16519 cookies:
16520 type: object
16521 additionalProperties:
16522 type: object
16523 properties:
16524 comment:
16525 type: string
16526 domain:
16527 type: string
16528 expiry:
16529 type: string
16530 format: date-time
16531 httpOnly:
16532 type: boolean
16533 maxAge:
16534 type: integer
16535 format: int32
16536 name:
16537 type: string
16538 path:
16539 type: string
16540 secure:
16541 type: boolean
16542 value:
16543 type: string
16544 version:
16545 type: integer
16546 format: int32
16547 date:
16548 type: string
16549 format: date-time
16550 entity:
16551 type: object
16552 entityTag:
16553 type: object
16554 properties:
16555 value:
16556 type: string
16557 weak:
16558 type: boolean
16559 headers:
16560 type: object
16561 additionalProperties:
16562 type: array
16563 items:
16564 type: object
16565 language:
16566 type: object
16567 properties:
16568 country:
16569 type: string
16570 displayCountry:
16571 type: string
16572 displayLanguage:
16573 type: string
16574 displayName:
16575 type: string
16576 displayScript:
16577 type: string
16578 displayVariant:
16579 type: string
16580 extensionKeys:
16581 type: array
16582 items:
16583 type: string
16584 uniqueItems: true
16585 iso3Country:
16586 type: string
16587 iso3Language:
16588 type: string
16589 language:
16590 type: string
16591 script:
16592 type: string
16593 unicodeLocaleAttributes:
16594 type: array
16595 items:
16596 type: string
16597 uniqueItems: true
16598 unicodeLocaleKeys:
16599 type: array
16600 items:
16601 type: string
16602 uniqueItems: true
16603 variant:
16604 type: string
16605 lastModified:
16606 type: string
16607 format: date-time
16608 length:
16609 type: integer
16610 format: int32
16611 links:
16612 type: array
16613 items:
16614 type: object
16615 properties:
16616 params:
16617 type: object
16618 additionalProperties:
16619 type: string
16620 rel:
16621 type: string
16622 rels:
16623 type: array
16624 items:
16625 type: string
16626 title:
16627 type: string
16628 type:
16629 type: string
16630 uri:
16631 type: string
16632 format: uri
16633 uriBuilder:
16634 type: object
16635 uniqueItems: true
16636 location:
16637 type: string
16638 format: uri
16639 mediaType:
16640 type: object
16641 properties:
16642 parameters:
16643 type: object
16644 additionalProperties:
16645 type: string
16646 subtype:
16647 type: string
16648 type:
16649 type: string
16650 wildcardSubtype:
16651 type: boolean
16652 wildcardType:
16653 type: boolean
16654 metadata:
16655 type: object
16656 additionalProperties:
16657 type: array
16658 items:
16659 type: object
16660 status:
16661 type: integer
16662 format: int32
16663 statusInfo:
16664 type: object
16665 properties:
16666 family:
16667 type: string
16668 enum:
16669 - INFORMATIONAL
16670 - SUCCESSFUL
16671 - REDIRECTION
16672 - CLIENT_ERROR
16673 - SERVER_ERROR
16674 - OTHER
16675 reasonPhrase:
16676 type: string
16677 statusCode:
16678 type: integer
16679 format: int32
16680 stringHeaders:
16681 type: object
16682 additionalProperties:
16683 type: array
16684 items:
16685 type: string
16686 servers:
16687 - url: /sdc2/rest
16688 variables: {}
16689 summary: Returns created annotation types
16690 tags:
16691 - SDCE-2 APIs
16692 /v1/catalog/uploadType/artifactTypes:
16693 post:
16694 description: Create Tosca Artifact types from yaml
16695 operationId: uploadArtifactTypes
16696 parameters:
16697 - in: header
16698 name: USER_ID
16699 schema:
16700 type: string
16701 requestBody:
16702 content:
16703 multipart/form-data:
16704 schema:
16705 type: object
16706 properties:
16707 artifactsZip:
16708 type: string
16709 format: binary
16710 description: Zip file containing a yaml with the TOSCA artifact
16711 types definition
16712 includeToModelImport:
16713 type: boolean
16714 description: A flag to add types to the default imports
16715 model:
16716 type: string
16717 description: model name
16718 responses:
16719 "201":
16720 description: Tosca Artifact types created
16721 "400":
16722 description: Invalid content / Missing content
16723 "403":
16724 description: Restricted operation
16725 "409":
16726 description: Tosca Artifact Type already exist
16727 default:
16728 content:
16729 application/json:
16730 schema:
16731 type: array
16732 items:
16733 type: object
16734 properties:
16735 allowedMethods:
16736 type: array
16737 items:
16738 type: string
16739 uniqueItems: true
16740 cookies:
16741 type: object
16742 additionalProperties:
16743 type: object
16744 properties:
16745 comment:
16746 type: string
16747 domain:
16748 type: string
16749 expiry:
16750 type: string
16751 format: date-time
16752 httpOnly:
16753 type: boolean
16754 maxAge:
16755 type: integer
16756 format: int32
16757 name:
16758 type: string
16759 path:
16760 type: string
16761 secure:
16762 type: boolean
16763 value:
16764 type: string
16765 version:
16766 type: integer
16767 format: int32
16768 date:
16769 type: string
16770 format: date-time
16771 entity:
16772 type: object
16773 entityTag:
16774 type: object
16775 properties:
16776 value:
16777 type: string
16778 weak:
16779 type: boolean
16780 headers:
16781 type: object
16782 additionalProperties:
16783 type: array
16784 items:
16785 type: object
16786 language:
16787 type: object
16788 properties:
16789 country:
16790 type: string
16791 displayCountry:
16792 type: string
16793 displayLanguage:
16794 type: string
16795 displayName:
16796 type: string
16797 displayScript:
16798 type: string
16799 displayVariant:
16800 type: string
16801 extensionKeys:
16802 type: array
16803 items:
16804 type: string
16805 uniqueItems: true
16806 iso3Country:
16807 type: string
16808 iso3Language:
16809 type: string
16810 language:
16811 type: string
16812 script:
16813 type: string
16814 unicodeLocaleAttributes:
16815 type: array
16816 items:
16817 type: string
16818 uniqueItems: true
16819 unicodeLocaleKeys:
16820 type: array
16821 items:
16822 type: string
16823 uniqueItems: true
16824 variant:
16825 type: string
16826 lastModified:
16827 type: string
16828 format: date-time
16829 length:
16830 type: integer
16831 format: int32
16832 links:
16833 type: array
16834 items:
16835 type: object
16836 properties:
16837 params:
16838 type: object
16839 additionalProperties:
16840 type: string
16841 rel:
16842 type: string
16843 rels:
16844 type: array
16845 items:
16846 type: string
16847 title:
16848 type: string
16849 type:
16850 type: string
16851 uri:
16852 type: string
16853 format: uri
16854 uriBuilder:
16855 type: object
16856 uniqueItems: true
16857 location:
16858 type: string
16859 format: uri
16860 mediaType:
16861 type: object
16862 properties:
16863 parameters:
16864 type: object
16865 additionalProperties:
16866 type: string
16867 subtype:
16868 type: string
16869 type:
16870 type: string
16871 wildcardSubtype:
16872 type: boolean
16873 wildcardType:
16874 type: boolean
16875 metadata:
16876 type: object
16877 additionalProperties:
16878 type: array
16879 items:
16880 type: object
16881 status:
16882 type: integer
16883 format: int32
16884 statusInfo:
16885 type: object
16886 properties:
16887 family:
16888 type: string
16889 enum:
16890 - INFORMATIONAL
16891 - SUCCESSFUL
16892 - REDIRECTION
16893 - CLIENT_ERROR
16894 - SERVER_ERROR
16895 - OTHER
16896 reasonPhrase:
16897 type: string
16898 statusCode:
16899 type: integer
16900 format: int32
16901 stringHeaders:
16902 type: object
16903 additionalProperties:
16904 type: array
16905 items:
16906 type: string
16907 servers:
16908 - url: /sdc2/rest
16909 variables: {}
16910 summary: Returns created Tosca artifact types
16911 tags:
16912 - SDCE-2 APIs
16913 /v1/catalog/uploadType/capability:
16914 post:
16915 description: Create Capability Type from yaml
16916 operationId: uploadCapabilityType
16917 parameters:
16918 - in: header
16919 name: USER_ID
16920 schema:
16921 type: string
16922 requestBody:
16923 content:
16924 multipart/form-data:
16925 schema:
16926 type: object
16927 properties:
16928 capabilityTypeZip:
16929 type: string
16930 format: binary
16931 description: FileInputStream
16932 includeToModelImport:
16933 type: boolean
16934 description: includeToModelImport
16935 model:
16936 type: string
16937 description: model
16938 responses:
16939 "201":
16940 description: Capability Type created
16941 "400":
16942 description: Invalid content / Missing content
16943 "403":
16944 description: Restricted operation
16945 "409":
16946 description: Capability Type already exist
16947 default:
16948 content:
16949 application/json:
16950 schema:
16951 type: array
16952 items:
16953 type: object
16954 properties:
16955 allowedMethods:
16956 type: array
16957 items:
16958 type: string
16959 uniqueItems: true
16960 cookies:
16961 type: object
16962 additionalProperties:
16963 type: object
16964 properties:
16965 comment:
16966 type: string
16967 domain:
16968 type: string
16969 expiry:
16970 type: string
16971 format: date-time
16972 httpOnly:
16973 type: boolean
16974 maxAge:
16975 type: integer
16976 format: int32
16977 name:
16978 type: string
16979 path:
16980 type: string
16981 secure:
16982 type: boolean
16983 value:
16984 type: string
16985 version:
16986 type: integer
16987 format: int32
16988 date:
16989 type: string
16990 format: date-time
16991 entity:
16992 type: object
16993 entityTag:
16994 type: object
16995 properties:
16996 value:
16997 type: string
16998 weak:
16999 type: boolean
17000 headers:
17001 type: object
17002 additionalProperties:
17003 type: array
17004 items:
17005 type: object
17006 language:
17007 type: object
17008 properties:
17009 country:
17010 type: string
17011 displayCountry:
17012 type: string
17013 displayLanguage:
17014 type: string
17015 displayName:
17016 type: string
17017 displayScript:
17018 type: string
17019 displayVariant:
17020 type: string
17021 extensionKeys:
17022 type: array
17023 items:
17024 type: string
17025 uniqueItems: true
17026 iso3Country:
17027 type: string
17028 iso3Language:
17029 type: string
17030 language:
17031 type: string
17032 script:
17033 type: string
17034 unicodeLocaleAttributes:
17035 type: array
17036 items:
17037 type: string
17038 uniqueItems: true
17039 unicodeLocaleKeys:
17040 type: array
17041 items:
17042 type: string
17043 uniqueItems: true
17044 variant:
17045 type: string
17046 lastModified:
17047 type: string
17048 format: date-time
17049 length:
17050 type: integer
17051 format: int32
17052 links:
17053 type: array
17054 items:
17055 type: object
17056 properties:
17057 params:
17058 type: object
17059 additionalProperties:
17060 type: string
17061 rel:
17062 type: string
17063 rels:
17064 type: array
17065 items:
17066 type: string
17067 title:
17068 type: string
17069 type:
17070 type: string
17071 uri:
17072 type: string
17073 format: uri
17074 uriBuilder:
17075 type: object
17076 uniqueItems: true
17077 location:
17078 type: string
17079 format: uri
17080 mediaType:
17081 type: object
17082 properties:
17083 parameters:
17084 type: object
17085 additionalProperties:
17086 type: string
17087 subtype:
17088 type: string
17089 type:
17090 type: string
17091 wildcardSubtype:
17092 type: boolean
17093 wildcardType:
17094 type: boolean
17095 metadata:
17096 type: object
17097 additionalProperties:
17098 type: array
17099 items:
17100 type: object
17101 status:
17102 type: integer
17103 format: int32
17104 statusInfo:
17105 type: object
17106 properties:
17107 family:
17108 type: string
17109 enum:
17110 - INFORMATIONAL
17111 - SUCCESSFUL
17112 - REDIRECTION
17113 - CLIENT_ERROR
17114 - SERVER_ERROR
17115 - OTHER
17116 reasonPhrase:
17117 type: string
17118 statusCode:
17119 type: integer
17120 format: int32
17121 stringHeaders:
17122 type: object
17123 additionalProperties:
17124 type: array
17125 items:
17126 type: string
17127 servers:
17128 - url: /sdc2/rest
17129 variables: {}
17130 summary: Returns created Capability Type
17131 tags:
17132 - SDCE-2 APIs
17133 /v1/catalog/uploadType/categories:
17134 post:
17135 description: Create Categories from yaml
17136 operationId: uploadCategories
17137 parameters:
17138 - in: header
17139 name: USER_ID
17140 schema:
17141 type: string
17142 requestBody:
17143 content:
17144 multipart/form-data:
17145 schema:
17146 type: object
17147 properties:
17148 categoriesZip:
17149 type: string
17150 format: binary
17151 description: FileInputStream
17152 responses:
17153 "201":
17154 description: Categories created
17155 "400":
17156 description: Invalid content / Missing content
17157 "403":
17158 description: Restricted operation
17159 "409":
17160 description: Category already exist
17161 default:
17162 content:
17163 application/json:
17164 schema:
17165 type: array
17166 items:
17167 type: object
17168 properties:
17169 allowedMethods:
17170 type: array
17171 items:
17172 type: string
17173 uniqueItems: true
17174 cookies:
17175 type: object
17176 additionalProperties:
17177 type: object
17178 properties:
17179 comment:
17180 type: string
17181 domain:
17182 type: string
17183 expiry:
17184 type: string
17185 format: date-time
17186 httpOnly:
17187 type: boolean
17188 maxAge:
17189 type: integer
17190 format: int32
17191 name:
17192 type: string
17193 path:
17194 type: string
17195 secure:
17196 type: boolean
17197 value:
17198 type: string
17199 version:
17200 type: integer
17201 format: int32
17202 date:
17203 type: string
17204 format: date-time
17205 entity:
17206 type: object
17207 entityTag:
17208 type: object
17209 properties:
17210 value:
17211 type: string
17212 weak:
17213 type: boolean
17214 headers:
17215 type: object
17216 additionalProperties:
17217 type: array
17218 items:
17219 type: object
17220 language:
17221 type: object
17222 properties:
17223 country:
17224 type: string
17225 displayCountry:
17226 type: string
17227 displayLanguage:
17228 type: string
17229 displayName:
17230 type: string
17231 displayScript:
17232 type: string
17233 displayVariant:
17234 type: string
17235 extensionKeys:
17236 type: array
17237 items:
17238 type: string
17239 uniqueItems: true
17240 iso3Country:
17241 type: string
17242 iso3Language:
17243 type: string
17244 language:
17245 type: string
17246 script:
17247 type: string
17248 unicodeLocaleAttributes:
17249 type: array
17250 items:
17251 type: string
17252 uniqueItems: true
17253 unicodeLocaleKeys:
17254 type: array
17255 items:
17256 type: string
17257 uniqueItems: true
17258 variant:
17259 type: string
17260 lastModified:
17261 type: string
17262 format: date-time
17263 length:
17264 type: integer
17265 format: int32
17266 links:
17267 type: array
17268 items:
17269 type: object
17270 properties:
17271 params:
17272 type: object
17273 additionalProperties:
17274 type: string
17275 rel:
17276 type: string
17277 rels:
17278 type: array
17279 items:
17280 type: string
17281 title:
17282 type: string
17283 type:
17284 type: string
17285 uri:
17286 type: string
17287 format: uri
17288 uriBuilder:
17289 type: object
17290 uniqueItems: true
17291 location:
17292 type: string
17293 format: uri
17294 mediaType:
17295 type: object
17296 properties:
17297 parameters:
17298 type: object
17299 additionalProperties:
17300 type: string
17301 subtype:
17302 type: string
17303 type:
17304 type: string
17305 wildcardSubtype:
17306 type: boolean
17307 wildcardType:
17308 type: boolean
17309 metadata:
17310 type: object
17311 additionalProperties:
17312 type: array
17313 items:
17314 type: object
17315 status:
17316 type: integer
17317 format: int32
17318 statusInfo:
17319 type: object
17320 properties:
17321 family:
17322 type: string
17323 enum:
17324 - INFORMATIONAL
17325 - SUCCESSFUL
17326 - REDIRECTION
17327 - CLIENT_ERROR
17328 - SERVER_ERROR
17329 - OTHER
17330 reasonPhrase:
17331 type: string
17332 statusCode:
17333 type: integer
17334 format: int32
17335 stringHeaders:
17336 type: object
17337 additionalProperties:
17338 type: array
17339 items:
17340 type: string
17341 servers:
17342 - url: /sdc2/rest
17343 variables: {}
17344 summary: Returns created categories
17345 tags:
17346 - SDCE-2 APIs
17347 /v1/catalog/uploadType/datatypes:
17348 post:
17349 description: Create Categories from yaml
17350 operationId: uploadDataTypes
17351 parameters:
17352 - in: header
17353 name: USER_ID
17354 schema:
17355 type: string
17356 requestBody:
17357 content:
17358 multipart/form-data:
17359 schema:
17360 type: object
17361 properties:
17362 dataTypesZip:
17363 type: string
17364 format: binary
17365 description: FileInputStream
17366 includeToModelImport:
17367 type: boolean
17368 description: includeToModelImport
17369 model:
17370 type: string
17371 description: model
17372 responses:
17373 "201":
17374 description: Data types created
17375 "400":
17376 description: Invalid content / Missing content
17377 "403":
17378 description: Restricted operation
17379 "409":
17380 description: Data types already exist
17381 default:
17382 content:
17383 application/json:
17384 schema:
17385 type: array
17386 items:
17387 type: object
17388 properties:
17389 allowedMethods:
17390 type: array
17391 items:
17392 type: string
17393 uniqueItems: true
17394 cookies:
17395 type: object
17396 additionalProperties:
17397 type: object
17398 properties:
17399 comment:
17400 type: string
17401 domain:
17402 type: string
17403 expiry:
17404 type: string
17405 format: date-time
17406 httpOnly:
17407 type: boolean
17408 maxAge:
17409 type: integer
17410 format: int32
17411 name:
17412 type: string
17413 path:
17414 type: string
17415 secure:
17416 type: boolean
17417 value:
17418 type: string
17419 version:
17420 type: integer
17421 format: int32
17422 date:
17423 type: string
17424 format: date-time
17425 entity:
17426 type: object
17427 entityTag:
17428 type: object
17429 properties:
17430 value:
17431 type: string
17432 weak:
17433 type: boolean
17434 headers:
17435 type: object
17436 additionalProperties:
17437 type: array
17438 items:
17439 type: object
17440 language:
17441 type: object
17442 properties:
17443 country:
17444 type: string
17445 displayCountry:
17446 type: string
17447 displayLanguage:
17448 type: string
17449 displayName:
17450 type: string
17451 displayScript:
17452 type: string
17453 displayVariant:
17454 type: string
17455 extensionKeys:
17456 type: array
17457 items:
17458 type: string
17459 uniqueItems: true
17460 iso3Country:
17461 type: string
17462 iso3Language:
17463 type: string
17464 language:
17465 type: string
17466 script:
17467 type: string
17468 unicodeLocaleAttributes:
17469 type: array
17470 items:
17471 type: string
17472 uniqueItems: true
17473 unicodeLocaleKeys:
17474 type: array
17475 items:
17476 type: string
17477 uniqueItems: true
17478 variant:
17479 type: string
17480 lastModified:
17481 type: string
17482 format: date-time
17483 length:
17484 type: integer
17485 format: int32
17486 links:
17487 type: array
17488 items:
17489 type: object
17490 properties:
17491 params:
17492 type: object
17493 additionalProperties:
17494 type: string
17495 rel:
17496 type: string
17497 rels:
17498 type: array
17499 items:
17500 type: string
17501 title:
17502 type: string
17503 type:
17504 type: string
17505 uri:
17506 type: string
17507 format: uri
17508 uriBuilder:
17509 type: object
17510 uniqueItems: true
17511 location:
17512 type: string
17513 format: uri
17514 mediaType:
17515 type: object
17516 properties:
17517 parameters:
17518 type: object
17519 additionalProperties:
17520 type: string
17521 subtype:
17522 type: string
17523 type:
17524 type: string
17525 wildcardSubtype:
17526 type: boolean
17527 wildcardType:
17528 type: boolean
17529 metadata:
17530 type: object
17531 additionalProperties:
17532 type: array
17533 items:
17534 type: object
17535 status:
17536 type: integer
17537 format: int32
17538 statusInfo:
17539 type: object
17540 properties:
17541 family:
17542 type: string
17543 enum:
17544 - INFORMATIONAL
17545 - SUCCESSFUL
17546 - REDIRECTION
17547 - CLIENT_ERROR
17548 - SERVER_ERROR
17549 - OTHER
17550 reasonPhrase:
17551 type: string
17552 statusCode:
17553 type: integer
17554 format: int32
17555 stringHeaders:
17556 type: object
17557 additionalProperties:
17558 type: array
17559 items:
17560 type: string
17561 servers:
17562 - url: /sdc2/rest
17563 variables: {}
17564 summary: Returns created data types
17565 tags:
17566 - SDCE-2 APIs
17567 /v1/catalog/uploadType/grouptypes:
17568 post:
17569 description: Create GroupTypes from yaml
17570 operationId: uploadGroupTypes
17571 parameters:
17572 - in: header
17573 name: USER_ID
17574 schema:
17575 type: string
17576 requestBody:
17577 content:
17578 multipart/form-data:
17579 schema:
17580 type: object
17581 properties:
17582 groupTypesZip:
17583 type: string
17584 format: binary
17585 description: FileInputStream
17586 includeToModelImport:
17587 type: boolean
17588 description: includeToModelImport
17589 model:
17590 type: string
17591 description: model
17592 toscaTypeMetadata:
17593 type: string
17594 description: toscaTypeMetadata
17595 responses:
17596 "201":
17597 description: group types created
17598 "400":
17599 description: Invalid content / Missing content
17600 "403":
17601 description: Restricted operation
17602 "409":
17603 description: group types already exist
17604 default:
17605 content:
17606 application/json:
17607 schema:
17608 type: array
17609 items:
17610 type: object
17611 properties:
17612 allowedMethods:
17613 type: array
17614 items:
17615 type: string
17616 uniqueItems: true
17617 cookies:
17618 type: object
17619 additionalProperties:
17620 type: object
17621 properties:
17622 comment:
17623 type: string
17624 domain:
17625 type: string
17626 expiry:
17627 type: string
17628 format: date-time
17629 httpOnly:
17630 type: boolean
17631 maxAge:
17632 type: integer
17633 format: int32
17634 name:
17635 type: string
17636 path:
17637 type: string
17638 secure:
17639 type: boolean
17640 value:
17641 type: string
17642 version:
17643 type: integer
17644 format: int32
17645 date:
17646 type: string
17647 format: date-time
17648 entity:
17649 type: object
17650 entityTag:
17651 type: object
17652 properties:
17653 value:
17654 type: string
17655 weak:
17656 type: boolean
17657 headers:
17658 type: object
17659 additionalProperties:
17660 type: array
17661 items:
17662 type: object
17663 language:
17664 type: object
17665 properties:
17666 country:
17667 type: string
17668 displayCountry:
17669 type: string
17670 displayLanguage:
17671 type: string
17672 displayName:
17673 type: string
17674 displayScript:
17675 type: string
17676 displayVariant:
17677 type: string
17678 extensionKeys:
17679 type: array
17680 items:
17681 type: string
17682 uniqueItems: true
17683 iso3Country:
17684 type: string
17685 iso3Language:
17686 type: string
17687 language:
17688 type: string
17689 script:
17690 type: string
17691 unicodeLocaleAttributes:
17692 type: array
17693 items:
17694 type: string
17695 uniqueItems: true
17696 unicodeLocaleKeys:
17697 type: array
17698 items:
17699 type: string
17700 uniqueItems: true
17701 variant:
17702 type: string
17703 lastModified:
17704 type: string
17705 format: date-time
17706 length:
17707 type: integer
17708 format: int32
17709 links:
17710 type: array
17711 items:
17712 type: object
17713 properties:
17714 params:
17715 type: object
17716 additionalProperties:
17717 type: string
17718 rel:
17719 type: string
17720 rels:
17721 type: array
17722 items:
17723 type: string
17724 title:
17725 type: string
17726 type:
17727 type: string
17728 uri:
17729 type: string
17730 format: uri
17731 uriBuilder:
17732 type: object
17733 uniqueItems: true
17734 location:
17735 type: string
17736 format: uri
17737 mediaType:
17738 type: object
17739 properties:
17740 parameters:
17741 type: object
17742 additionalProperties:
17743 type: string
17744 subtype:
17745 type: string
17746 type:
17747 type: string
17748 wildcardSubtype:
17749 type: boolean
17750 wildcardType:
17751 type: boolean
17752 metadata:
17753 type: object
17754 additionalProperties:
17755 type: array
17756 items:
17757 type: object
17758 status:
17759 type: integer
17760 format: int32
17761 statusInfo:
17762 type: object
17763 properties:
17764 family:
17765 type: string
17766 enum:
17767 - INFORMATIONAL
17768 - SUCCESSFUL
17769 - REDIRECTION
17770 - CLIENT_ERROR
17771 - SERVER_ERROR
17772 - OTHER
17773 reasonPhrase:
17774 type: string
17775 statusCode:
17776 type: integer
17777 format: int32
17778 stringHeaders:
17779 type: object
17780 additionalProperties:
17781 type: array
17782 items:
17783 type: string
17784 servers:
17785 - url: /sdc2/rest
17786 variables: {}
17787 summary: Returns created group types
17788 tags:
17789 - SDCE-2 APIs
17790 /v1/catalog/uploadType/interfaceLifecycle:
17791 post:
17792 description: Create Interface Lyfecycle Type from yaml
17793 operationId: uploadInterfaceLifecycleType
17794 parameters:
17795 - in: header
17796 name: USER_ID
17797 schema:
17798 type: string
17799 requestBody:
17800 content:
17801 multipart/form-data:
17802 schema:
17803 type: object
17804 properties:
17805 includeToModelImport:
17806 type: boolean
17807 description: includeToModelImport
17808 interfaceLifecycleTypeZip:
17809 type: string
17810 format: binary
17811 description: FileInputStream
17812 model:
17813 type: string
17814 description: model
17815 responses:
17816 "201":
17817 description: Interface Lifecycle Type created
17818 "400":
17819 description: Invalid content / Missing content
17820 "403":
17821 description: Restricted operation
17822 "409":
17823 description: Interface Lifecycle Type already exist
17824 default:
17825 content:
17826 application/json:
17827 schema:
17828 type: array
17829 items:
17830 type: object
17831 properties:
17832 allowedMethods:
17833 type: array
17834 items:
17835 type: string
17836 uniqueItems: true
17837 cookies:
17838 type: object
17839 additionalProperties:
17840 type: object
17841 properties:
17842 comment:
17843 type: string
17844 domain:
17845 type: string
17846 expiry:
17847 type: string
17848 format: date-time
17849 httpOnly:
17850 type: boolean
17851 maxAge:
17852 type: integer
17853 format: int32
17854 name:
17855 type: string
17856 path:
17857 type: string
17858 secure:
17859 type: boolean
17860 value:
17861 type: string
17862 version:
17863 type: integer
17864 format: int32
17865 date:
17866 type: string
17867 format: date-time
17868 entity:
17869 type: object
17870 entityTag:
17871 type: object
17872 properties:
17873 value:
17874 type: string
17875 weak:
17876 type: boolean
17877 headers:
17878 type: object
17879 additionalProperties:
17880 type: array
17881 items:
17882 type: object
17883 language:
17884 type: object
17885 properties:
17886 country:
17887 type: string
17888 displayCountry:
17889 type: string
17890 displayLanguage:
17891 type: string
17892 displayName:
17893 type: string
17894 displayScript:
17895 type: string
17896 displayVariant:
17897 type: string
17898 extensionKeys:
17899 type: array
17900 items:
17901 type: string
17902 uniqueItems: true
17903 iso3Country:
17904 type: string
17905 iso3Language:
17906 type: string
17907 language:
17908 type: string
17909 script:
17910 type: string
17911 unicodeLocaleAttributes:
17912 type: array
17913 items:
17914 type: string
17915 uniqueItems: true
17916 unicodeLocaleKeys:
17917 type: array
17918 items:
17919 type: string
17920 uniqueItems: true
17921 variant:
17922 type: string
17923 lastModified:
17924 type: string
17925 format: date-time
17926 length:
17927 type: integer
17928 format: int32
17929 links:
17930 type: array
17931 items:
17932 type: object
17933 properties:
17934 params:
17935 type: object
17936 additionalProperties:
17937 type: string
17938 rel:
17939 type: string
17940 rels:
17941 type: array
17942 items:
17943 type: string
17944 title:
17945 type: string
17946 type:
17947 type: string
17948 uri:
17949 type: string
17950 format: uri
17951 uriBuilder:
17952 type: object
17953 uniqueItems: true
17954 location:
17955 type: string
17956 format: uri
17957 mediaType:
17958 type: object
17959 properties:
17960 parameters:
17961 type: object
17962 additionalProperties:
17963 type: string
17964 subtype:
17965 type: string
17966 type:
17967 type: string
17968 wildcardSubtype:
17969 type: boolean
17970 wildcardType:
17971 type: boolean
17972 metadata:
17973 type: object
17974 additionalProperties:
17975 type: array
17976 items:
17977 type: object
17978 status:
17979 type: integer
17980 format: int32
17981 statusInfo:
17982 type: object
17983 properties:
17984 family:
17985 type: string
17986 enum:
17987 - INFORMATIONAL
17988 - SUCCESSFUL
17989 - REDIRECTION
17990 - CLIENT_ERROR
17991 - SERVER_ERROR
17992 - OTHER
17993 reasonPhrase:
17994 type: string
17995 statusCode:
17996 type: integer
17997 format: int32
17998 stringHeaders:
17999 type: object
18000 additionalProperties:
18001 type: array
18002 items:
18003 type: string
18004 servers:
18005 - url: /sdc2/rest
18006 variables: {}
18007 summary: Returns created Interface Lifecycle Type
18008 tags:
18009 - SDCE-2 APIs
18010 /v1/catalog/uploadType/policytypes:
18011 post:
18012 description: Create PolicyTypes from yaml
18013 operationId: uploadPolicyTypes
18014 parameters:
18015 - in: header
18016 name: USER_ID
18017 schema:
18018 type: string
18019 requestBody:
18020 content:
18021 multipart/form-data:
18022 schema:
18023 type: object
18024 properties:
18025 includeToModelImport:
18026 type: boolean
18027 description: includeToModelImport
18028 model:
18029 type: string
18030 description: model
18031 policyTypesZip:
18032 type: string
18033 format: binary
18034 description: FileInputStream
18035 toscaTypeMetadata:
18036 type: string
18037 description: toscaTypeMetadata
18038 responses:
18039 "201":
18040 description: policy types created
18041 "400":
18042 description: Invalid content / Missing content
18043 "403":
18044 description: Restricted operation
18045 "409":
18046 description: policy types already exist
18047 default:
18048 content:
18049 application/json:
18050 schema:
18051 type: array
18052 items:
18053 type: object
18054 properties:
18055 allowedMethods:
18056 type: array
18057 items:
18058 type: string
18059 uniqueItems: true
18060 cookies:
18061 type: object
18062 additionalProperties:
18063 type: object
18064 properties:
18065 comment:
18066 type: string
18067 domain:
18068 type: string
18069 expiry:
18070 type: string
18071 format: date-time
18072 httpOnly:
18073 type: boolean
18074 maxAge:
18075 type: integer
18076 format: int32
18077 name:
18078 type: string
18079 path:
18080 type: string
18081 secure:
18082 type: boolean
18083 value:
18084 type: string
18085 version:
18086 type: integer
18087 format: int32
18088 date:
18089 type: string
18090 format: date-time
18091 entity:
18092 type: object
18093 entityTag:
18094 type: object
18095 properties:
18096 value:
18097 type: string
18098 weak:
18099 type: boolean
18100 headers:
18101 type: object
18102 additionalProperties:
18103 type: array
18104 items:
18105 type: object
18106 language:
18107 type: object
18108 properties:
18109 country:
18110 type: string
18111 displayCountry:
18112 type: string
18113 displayLanguage:
18114 type: string
18115 displayName:
18116 type: string
18117 displayScript:
18118 type: string
18119 displayVariant:
18120 type: string
18121 extensionKeys:
18122 type: array
18123 items:
18124 type: string
18125 uniqueItems: true
18126 iso3Country:
18127 type: string
18128 iso3Language:
18129 type: string
18130 language:
18131 type: string
18132 script:
18133 type: string
18134 unicodeLocaleAttributes:
18135 type: array
18136 items:
18137 type: string
18138 uniqueItems: true
18139 unicodeLocaleKeys:
18140 type: array
18141 items:
18142 type: string
18143 uniqueItems: true
18144 variant:
18145 type: string
18146 lastModified:
18147 type: string
18148 format: date-time
18149 length:
18150 type: integer
18151 format: int32
18152 links:
18153 type: array
18154 items:
18155 type: object
18156 properties:
18157 params:
18158 type: object
18159 additionalProperties:
18160 type: string
18161 rel:
18162 type: string
18163 rels:
18164 type: array
18165 items:
18166 type: string
18167 title:
18168 type: string
18169 type:
18170 type: string
18171 uri:
18172 type: string
18173 format: uri
18174 uriBuilder:
18175 type: object
18176 uniqueItems: true
18177 location:
18178 type: string
18179 format: uri
18180 mediaType:
18181 type: object
18182 properties:
18183 parameters:
18184 type: object
18185 additionalProperties:
18186 type: string
18187 subtype:
18188 type: string
18189 type:
18190 type: string
18191 wildcardSubtype:
18192 type: boolean
18193 wildcardType:
18194 type: boolean
18195 metadata:
18196 type: object
18197 additionalProperties:
18198 type: array
18199 items:
18200 type: object
18201 status:
18202 type: integer
18203 format: int32
18204 statusInfo:
18205 type: object
18206 properties:
18207 family:
18208 type: string
18209 enum:
18210 - INFORMATIONAL
18211 - SUCCESSFUL
18212 - REDIRECTION
18213 - CLIENT_ERROR
18214 - SERVER_ERROR
18215 - OTHER
18216 reasonPhrase:
18217 type: string
18218 statusCode:
18219 type: integer
18220 format: int32
18221 stringHeaders:
18222 type: object
18223 additionalProperties:
18224 type: array
18225 items:
18226 type: string
18227 servers:
18228 - url: /sdc2/rest
18229 variables: {}
18230 summary: Returns created policy types
18231 tags:
18232 - SDCE-2 APIs
18233 /v1/catalog/uploadType/relationship:
18234 post:
18235 description: Create Relationship Type from yaml
18236 operationId: uploadRelationshipType
18237 parameters:
18238 - in: header
18239 name: USER_ID
18240 schema:
18241 type: string
18242 requestBody:
18243 content:
18244 multipart/form-data:
18245 schema:
18246 type: object
18247 properties:
18248 includeToModelImport:
18249 type: boolean
18250 description: includeToModelImport
18251 model:
18252 type: string
18253 description: model
18254 relationshipTypeZip:
18255 type: string
18256 format: binary
18257 description: FileInputStream
18258 responses:
18259 "201":
18260 description: Relationship Type created
18261 "400":
18262 description: Invalid content / Missing content
18263 "403":
18264 description: Restricted operation
18265 "409":
18266 description: Relationship Type already exist
18267 default:
18268 content:
18269 application/json:
18270 schema:
18271 type: array
18272 items:
18273 type: object
18274 properties:
18275 allowedMethods:
18276 type: array
18277 items:
18278 type: string
18279 uniqueItems: true
18280 cookies:
18281 type: object
18282 additionalProperties:
18283 type: object
18284 properties:
18285 comment:
18286 type: string
18287 domain:
18288 type: string
18289 expiry:
18290 type: string
18291 format: date-time
18292 httpOnly:
18293 type: boolean
18294 maxAge:
18295 type: integer
18296 format: int32
18297 name:
18298 type: string
18299 path:
18300 type: string
18301 secure:
18302 type: boolean
18303 value:
18304 type: string
18305 version:
18306 type: integer
18307 format: int32
18308 date:
18309 type: string
18310 format: date-time
18311 entity:
18312 type: object
18313 entityTag:
18314 type: object
18315 properties:
18316 value:
18317 type: string
18318 weak:
18319 type: boolean
18320 headers:
18321 type: object
18322 additionalProperties:
18323 type: array
18324 items:
18325 type: object
18326 language:
18327 type: object
18328 properties:
18329 country:
18330 type: string
18331 displayCountry:
18332 type: string
18333 displayLanguage:
18334 type: string
18335 displayName:
18336 type: string
18337 displayScript:
18338 type: string
18339 displayVariant:
18340 type: string
18341 extensionKeys:
18342 type: array
18343 items:
18344 type: string
18345 uniqueItems: true
18346 iso3Country:
18347 type: string
18348 iso3Language:
18349 type: string
18350 language:
18351 type: string
18352 script:
18353 type: string
18354 unicodeLocaleAttributes:
18355 type: array
18356 items:
18357 type: string
18358 uniqueItems: true
18359 unicodeLocaleKeys:
18360 type: array
18361 items:
18362 type: string
18363 uniqueItems: true
18364 variant:
18365 type: string
18366 lastModified:
18367 type: string
18368 format: date-time
18369 length:
18370 type: integer
18371 format: int32
18372 links:
18373 type: array
18374 items:
18375 type: object
18376 properties:
18377 params:
18378 type: object
18379 additionalProperties:
18380 type: string
18381 rel:
18382 type: string
18383 rels:
18384 type: array
18385 items:
18386 type: string
18387 title:
18388 type: string
18389 type:
18390 type: string
18391 uri:
18392 type: string
18393 format: uri
18394 uriBuilder:
18395 type: object
18396 uniqueItems: true
18397 location:
18398 type: string
18399 format: uri
18400 mediaType:
18401 type: object
18402 properties:
18403 parameters:
18404 type: object
18405 additionalProperties:
18406 type: string
18407 subtype:
18408 type: string
18409 type:
18410 type: string
18411 wildcardSubtype:
18412 type: boolean
18413 wildcardType:
18414 type: boolean
18415 metadata:
18416 type: object
18417 additionalProperties:
18418 type: array
18419 items:
18420 type: object
18421 status:
18422 type: integer
18423 format: int32
18424 statusInfo:
18425 type: object
18426 properties:
18427 family:
18428 type: string
18429 enum:
18430 - INFORMATIONAL
18431 - SUCCESSFUL
18432 - REDIRECTION
18433 - CLIENT_ERROR
18434 - SERVER_ERROR
18435 - OTHER
18436 reasonPhrase:
18437 type: string
18438 statusCode:
18439 type: integer
18440 format: int32
18441 stringHeaders:
18442 type: object
18443 additionalProperties:
18444 type: array
18445 items:
18446 type: string
18447 servers:
18448 - url: /sdc2/rest
18449 variables: {}
18450 summary: Returns created Relationship Type
18451 tags:
18452 - SDCE-2 APIs
18453 /v1/catalog/{assetType}/{uuid}/interfaces/{interfaceUUID}/operations/{operationUUID}/artifacts/{artifactUUID}:
18454 post:
18455 description: uploads of artifact to component operation workflow
18456 operationId: uploadInterfaceOperationArtifact
18457 parameters:
18458 - description: Asset type
18459 in: path
18460 name: assetType
18461 required: true
18462 schema:
18463 type: string
18464 - description: The uuid of the asset as published in the metadata
18465 in: path
18466 name: uuid
18467 required: true
18468 schema:
18469 type: string
18470 - description: The uuid of the interface
18471 in: path
18472 name: interfaceUUID
18473 required: true
18474 schema:
18475 type: string
18476 - description: The uuid of the operation
18477 in: path
18478 name: operationUUID
18479 required: true
18480 schema:
18481 type: string
18482 - description: The uuid of the artifact
18483 in: path
18484 name: artifactUUID
18485 required: true
18486 schema:
18487 type: string
18488 - in: header
18489 name: USER_ID
18490 schema:
18491 type: string
18492 - in: header
18493 name: Content-MD5
18494 schema:
18495 type: string
18496 responses:
18497 "200":
18498 content:
18499 application/json:
18500 schema:
18501 type: array
18502 items:
18503 $ref: '#/components/schemas/ArtifactDefinition'
18504 description: Artifact uploaded
18505 "400":
18506 description: Restricted Operation – the user provided does not have role
18507 of Designer or the asset is being used by another designer - SVC4301
18508 "404":
18509 description: Specified resource is not found - SVC4063
18510 servers:
18511 - url: /sdc2/rest
18512 variables: {}
18513 summary: uploads of artifact to component operation workflow
18514 tags:
18515 - SDCE-2 APIs
18516 /v1/catalog/{componentType}/latestversion/notabstract:
18517 get:
18518 description: Get Component Requirments And Capabilities
18519 operationId: getLatestVersionNotAbstractCheckoutComponents
18520 parameters:
18521 - in: path
18522 name: componentType
18523 required: true
18524 schema:
18525 type: string
18526 - in: query
18527 name: internalComponentType
18528 schema:
18529 type: string
18530 - in: query
18531 name: componentUids
18532 schema:
18533 type: array
18534 items:
18535 type: string
18536 - in: header
18537 name: USER_ID
18538 schema:
18539 type: string
18540 responses:
18541 "200":
18542 description: Component found
18543 "403":
18544 description: Restricted operation
18545 "404":
18546 description: Component not found
18547 default:
18548 content:
18549 application/json:
18550 schema:
18551 type: array
18552 items:
18553 $ref: '#/components/schemas/Resource'
18554 servers:
18555 - url: /sdc2/rest
18556 variables: {}
18557 summary: Returns Requirments And Capabilities according to componentId
18558 tags:
18559 - SDCE-2 APIs
18560 post:
18561 description: Get Component Requirments And Capabilities
18562 operationId: getLatestVersionNotAbstractCheckoutComponentsByBody
18563 parameters:
18564 - in: path
18565 name: componentType
18566 required: true
18567 schema:
18568 type: string
18569 - in: query
18570 name: internalComponentType
18571 schema:
18572 type: string
18573 - in: header
18574 name: USER_ID
18575 schema:
18576 type: string
18577 requestBody:
18578 content:
18579 application/json:
18580 schema:
18581 type: array
18582 items:
18583 type: string
18584 description: Consumer Object to be created
18585 required: true
18586 responses:
18587 "200":
18588 description: Component found
18589 "403":
18590 description: Restricted operation
18591 "404":
18592 description: Component not found
18593 default:
18594 content:
18595 application/json:
18596 schema:
18597 type: array
18598 items:
18599 $ref: '#/components/schemas/Resource'
18600 servers:
18601 - url: /sdc2/rest
18602 variables: {}
18603 summary: Returns Requirments And Capabilities according to componentId
18604 tags:
18605 - SDCE-2 APIs
18606 /v1/catalog/{componentType}/latestversion/notabstract/metadata:
18607 get:
18608 description: Get Component uid only
18609 operationId: getLatestVersionNotAbstractCheckoutComponentsIdesOnly
18610 parameters:
18611 - in: path
18612 name: componentType
18613 required: true
18614 schema:
18615 type: string
18616 - in: query
18617 name: internalComponentType
18618 schema:
18619 type: string
18620 - in: query
18621 name: componentModel
18622 schema:
18623 type: string
18624 - in: query
18625 name: includeNormativeExtensionModels
18626 schema:
18627 type: boolean
18628 - in: header
18629 name: USER_ID
18630 schema:
18631 type: string
18632 requestBody:
18633 content:
18634 application/json:
18635 schema:
18636 type: string
18637 description: uid list
18638 required: true
18639 responses:
18640 "200":
18641 description: Component found
18642 "403":
18643 description: Restricted operation
18644 "404":
18645 description: Component not found
18646 default:
18647 content:
18648 application/json:
18649 schema:
18650 type: array
18651 items:
18652 $ref: '#/components/schemas/Resource'
18653 servers:
18654 - url: /sdc2/rest
18655 variables: {}
18656 summary: Returns componentId
18657 tags:
18658 - SDCE-2 APIs
18659 /v1/catalog/{componentType}/{componentId}/automatedupgrade:
18660 post:
18661 description: Autometed upgrade
18662 operationId: autometedUpgrade
18663 parameters:
18664 - in: path
18665 name: componentType
18666 required: true
18667 schema:
18668 type: string
18669 - in: path
18670 name: componentId
18671 required: true
18672 schema:
18673 type: string
18674 - in: header
18675 name: USER_ID
18676 schema:
18677 type: string
18678 requestBody:
18679 content:
18680 application/json:
18681 schema:
18682 type: string
18683 description: json describes upgrade request
18684 required: true
18685 responses:
18686 "200":
18687 description: Component found
18688 "403":
18689 description: Restricted operation
18690 "404":
18691 description: Component not found
18692 default:
18693 content:
18694 application/json:
18695 schema:
18696 type: array
18697 items:
18698 type: object
18699 properties:
18700 allowedMethods:
18701 type: array
18702 items:
18703 type: string
18704 uniqueItems: true
18705 cookies:
18706 type: object
18707 additionalProperties:
18708 type: object
18709 properties:
18710 comment:
18711 type: string
18712 domain:
18713 type: string
18714 expiry:
18715 type: string
18716 format: date-time
18717 httpOnly:
18718 type: boolean
18719 maxAge:
18720 type: integer
18721 format: int32
18722 name:
18723 type: string
18724 path:
18725 type: string
18726 secure:
18727 type: boolean
18728 value:
18729 type: string
18730 version:
18731 type: integer
18732 format: int32
18733 date:
18734 type: string
18735 format: date-time
18736 entity:
18737 type: object
18738 entityTag:
18739 type: object
18740 properties:
18741 value:
18742 type: string
18743 weak:
18744 type: boolean
18745 headers:
18746 type: object
18747 additionalProperties:
18748 type: array
18749 items:
18750 type: object
18751 language:
18752 type: object
18753 properties:
18754 country:
18755 type: string
18756 displayCountry:
18757 type: string
18758 displayLanguage:
18759 type: string
18760 displayName:
18761 type: string
18762 displayScript:
18763 type: string
18764 displayVariant:
18765 type: string
18766 extensionKeys:
18767 type: array
18768 items:
18769 type: string
18770 uniqueItems: true
18771 iso3Country:
18772 type: string
18773 iso3Language:
18774 type: string
18775 language:
18776 type: string
18777 script:
18778 type: string
18779 unicodeLocaleAttributes:
18780 type: array
18781 items:
18782 type: string
18783 uniqueItems: true
18784 unicodeLocaleKeys:
18785 type: array
18786 items:
18787 type: string
18788 uniqueItems: true
18789 variant:
18790 type: string
18791 lastModified:
18792 type: string
18793 format: date-time
18794 length:
18795 type: integer
18796 format: int32
18797 links:
18798 type: array
18799 items:
18800 type: object
18801 properties:
18802 params:
18803 type: object
18804 additionalProperties:
18805 type: string
18806 rel:
18807 type: string
18808 rels:
18809 type: array
18810 items:
18811 type: string
18812 title:
18813 type: string
18814 type:
18815 type: string
18816 uri:
18817 type: string
18818 format: uri
18819 uriBuilder:
18820 type: object
18821 uniqueItems: true
18822 location:
18823 type: string
18824 format: uri
18825 mediaType:
18826 type: object
18827 properties:
18828 parameters:
18829 type: object
18830 additionalProperties:
18831 type: string
18832 subtype:
18833 type: string
18834 type:
18835 type: string
18836 wildcardSubtype:
18837 type: boolean
18838 wildcardType:
18839 type: boolean
18840 metadata:
18841 type: object
18842 additionalProperties:
18843 type: array
18844 items:
18845 type: object
18846 status:
18847 type: integer
18848 format: int32
18849 statusInfo:
18850 type: object
18851 properties:
18852 family:
18853 type: string
18854 enum:
18855 - INFORMATIONAL
18856 - SUCCESSFUL
18857 - REDIRECTION
18858 - CLIENT_ERROR
18859 - SERVER_ERROR
18860 - OTHER
18861 reasonPhrase:
18862 type: string
18863 statusCode:
18864 type: integer
18865 format: int32
18866 stringHeaders:
18867 type: object
18868 additionalProperties:
18869 type: array
18870 items:
18871 type: string
18872 servers:
18873 - url: /sdc2/rest
18874 variables: {}
18875 summary: '....'
18876 tags:
18877 - SDCE-2 APIs
18878 /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/interfaceOperation:
18879 put:
18880 description: Update Interface Operation
18881 operationId: updateComponentInstanceInterfaceOperation
18882 parameters:
18883 - description: "valid values: resources / services"
18884 in: path
18885 name: componentType
18886 required: true
18887 schema:
18888 type: string
18889 enum:
18890 - resources
18891 - services
18892 - description: Component Id
18893 in: path
18894 name: componentId
18895 required: true
18896 schema:
18897 type: string
18898 - description: Component Instance Id
18899 in: path
18900 name: componentInstanceId
18901 required: true
18902 schema:
18903 type: string
18904 - in: header
18905 name: USER_ID
18906 schema:
18907 type: string
18908 responses:
18909 "201":
18910 description: Update Interface Operation
18911 "400":
18912 description: Invalid content / Missing content
18913 "403":
18914 description: Restricted operation
18915 default:
18916 content:
18917 application/json:
18918 schema:
18919 type: array
18920 items:
18921 type: object
18922 properties:
18923 allowedMethods:
18924 type: array
18925 items:
18926 type: string
18927 uniqueItems: true
18928 cookies:
18929 type: object
18930 additionalProperties:
18931 type: object
18932 properties:
18933 comment:
18934 type: string
18935 domain:
18936 type: string
18937 expiry:
18938 type: string
18939 format: date-time
18940 httpOnly:
18941 type: boolean
18942 maxAge:
18943 type: integer
18944 format: int32
18945 name:
18946 type: string
18947 path:
18948 type: string
18949 secure:
18950 type: boolean
18951 value:
18952 type: string
18953 version:
18954 type: integer
18955 format: int32
18956 date:
18957 type: string
18958 format: date-time
18959 entity:
18960 type: object
18961 entityTag:
18962 type: object
18963 properties:
18964 value:
18965 type: string
18966 weak:
18967 type: boolean
18968 headers:
18969 type: object
18970 additionalProperties:
18971 type: array
18972 items:
18973 type: object
18974 language:
18975 type: object
18976 properties:
18977 country:
18978 type: string
18979 displayCountry:
18980 type: string
18981 displayLanguage:
18982 type: string
18983 displayName:
18984 type: string
18985 displayScript:
18986 type: string
18987 displayVariant:
18988 type: string
18989 extensionKeys:
18990 type: array
18991 items:
18992 type: string
18993 uniqueItems: true
18994 iso3Country:
18995 type: string
18996 iso3Language:
18997 type: string
18998 language:
18999 type: string
19000 script:
19001 type: string
19002 unicodeLocaleAttributes:
19003 type: array
19004 items:
19005 type: string
19006 uniqueItems: true
19007 unicodeLocaleKeys:
19008 type: array
19009 items:
19010 type: string
19011 uniqueItems: true
19012 variant:
19013 type: string
19014 lastModified:
19015 type: string
19016 format: date-time
19017 length:
19018 type: integer
19019 format: int32
19020 links:
19021 type: array
19022 items:
19023 type: object
19024 properties:
19025 params:
19026 type: object
19027 additionalProperties:
19028 type: string
19029 rel:
19030 type: string
19031 rels:
19032 type: array
19033 items:
19034 type: string
19035 title:
19036 type: string
19037 type:
19038 type: string
19039 uri:
19040 type: string
19041 format: uri
19042 uriBuilder:
19043 type: object
19044 uniqueItems: true
19045 location:
19046 type: string
19047 format: uri
19048 mediaType:
19049 type: object
19050 properties:
19051 parameters:
19052 type: object
19053 additionalProperties:
19054 type: string
19055 subtype:
19056 type: string
19057 type:
19058 type: string
19059 wildcardSubtype:
19060 type: boolean
19061 wildcardType:
19062 type: boolean
19063 metadata:
19064 type: object
19065 additionalProperties:
19066 type: array
19067 items:
19068 type: object
19069 status:
19070 type: integer
19071 format: int32
19072 statusInfo:
19073 type: object
19074 properties:
19075 family:
19076 type: string
19077 enum:
19078 - INFORMATIONAL
19079 - SUCCESSFUL
19080 - REDIRECTION
19081 - CLIENT_ERROR
19082 - SERVER_ERROR
19083 - OTHER
19084 reasonPhrase:
19085 type: string
19086 statusCode:
19087 type: integer
19088 format: int32
19089 stringHeaders:
19090 type: object
19091 additionalProperties:
19092 type: array
19093 items:
19094 type: string
19095 servers:
19096 - url: /sdc2/rest
19097 variables: {}
19098 summary: Update Interface Operation on ComponentInstance
19099 tags:
19100 - SDCE-2 APIs
19101 /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/{constraintType}/nodeFilter:
19102 post:
19103 description: Add Component Filter Constraint
19104 operationId: addComponentFilterConstraint
19105 parameters:
19106 - description: Component Id
19107 in: path
19108 name: componentId
19109 required: true
19110 schema:
19111 type: string
19112 - description: Component Instance Id
19113 in: path
19114 name: componentInstanceId
19115 required: true
19116 schema:
19117 type: string
19118 - description: "valid values: resources / services"
19119 in: path
19120 name: componentType
19121 required: true
19122 schema:
19123 type: string
19124 enum:
19125 - resources
19126 - services
19127 - description: "Constraint type. Valid values: properties / capabilities"
19128 in: path
19129 name: constraintType
19130 required: true
19131 schema:
19132 type: string
19133 enum:
19134 - properties
19135 - capabilities
19136 - in: header
19137 name: USER_ID
19138 schema:
19139 type: string
19140 requestBody:
19141 content:
19142 application/json:
19143 schema:
19144 type: string
19145 description: UIConstraint data
19146 required: true
19147 responses:
19148 "201":
19149 description: Create Component Filter
19150 "400":
19151 description: Invalid content / Missing content
19152 "403":
19153 description: Restricted operation
19154 default:
19155 content:
19156 application/json:
19157 schema:
19158 type: array
19159 items:
19160 type: object
19161 properties:
19162 allowedMethods:
19163 type: array
19164 items:
19165 type: string
19166 uniqueItems: true
19167 cookies:
19168 type: object
19169 additionalProperties:
19170 type: object
19171 properties:
19172 comment:
19173 type: string
19174 domain:
19175 type: string
19176 expiry:
19177 type: string
19178 format: date-time
19179 httpOnly:
19180 type: boolean
19181 maxAge:
19182 type: integer
19183 format: int32
19184 name:
19185 type: string
19186 path:
19187 type: string
19188 secure:
19189 type: boolean
19190 value:
19191 type: string
19192 version:
19193 type: integer
19194 format: int32
19195 date:
19196 type: string
19197 format: date-time
19198 entity:
19199 type: object
19200 entityTag:
19201 type: object
19202 properties:
19203 value:
19204 type: string
19205 weak:
19206 type: boolean
19207 headers:
19208 type: object
19209 additionalProperties:
19210 type: array
19211 items:
19212 type: object
19213 language:
19214 type: object
19215 properties:
19216 country:
19217 type: string
19218 displayCountry:
19219 type: string
19220 displayLanguage:
19221 type: string
19222 displayName:
19223 type: string
19224 displayScript:
19225 type: string
19226 displayVariant:
19227 type: string
19228 extensionKeys:
19229 type: array
19230 items:
19231 type: string
19232 uniqueItems: true
19233 iso3Country:
19234 type: string
19235 iso3Language:
19236 type: string
19237 language:
19238 type: string
19239 script:
19240 type: string
19241 unicodeLocaleAttributes:
19242 type: array
19243 items:
19244 type: string
19245 uniqueItems: true
19246 unicodeLocaleKeys:
19247 type: array
19248 items:
19249 type: string
19250 uniqueItems: true
19251 variant:
19252 type: string
19253 lastModified:
19254 type: string
19255 format: date-time
19256 length:
19257 type: integer
19258 format: int32
19259 links:
19260 type: array
19261 items:
19262 type: object
19263 properties:
19264 params:
19265 type: object
19266 additionalProperties:
19267 type: string
19268 rel:
19269 type: string
19270 rels:
19271 type: array
19272 items:
19273 type: string
19274 title:
19275 type: string
19276 type:
19277 type: string
19278 uri:
19279 type: string
19280 format: uri
19281 uriBuilder:
19282 type: object
19283 uniqueItems: true
19284 location:
19285 type: string
19286 format: uri
19287 mediaType:
19288 type: object
19289 properties:
19290 parameters:
19291 type: object
19292 additionalProperties:
19293 type: string
19294 subtype:
19295 type: string
19296 type:
19297 type: string
19298 wildcardSubtype:
19299 type: boolean
19300 wildcardType:
19301 type: boolean
19302 metadata:
19303 type: object
19304 additionalProperties:
19305 type: array
19306 items:
19307 type: object
19308 status:
19309 type: integer
19310 format: int32
19311 statusInfo:
19312 type: object
19313 properties:
19314 family:
19315 type: string
19316 enum:
19317 - INFORMATIONAL
19318 - SUCCESSFUL
19319 - REDIRECTION
19320 - CLIENT_ERROR
19321 - SERVER_ERROR
19322 - OTHER
19323 reasonPhrase:
19324 type: string
19325 statusCode:
19326 type: integer
19327 format: int32
19328 stringHeaders:
19329 type: object
19330 additionalProperties:
19331 type: array
19332 items:
19333 type: string
19334 summary: Add Component Filter Constraint
19335 tags:
19336 - SDCE-2 APIs
19337 /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/{constraintType}/{constraintIndex}/nodeFilter:
19338 delete:
19339 description: Delete Component Filter Constraint
19340 operationId: deleteComponentFilterConstraint
19341 parameters:
19342 - description: Component Id
19343 in: path
19344 name: componentId
19345 required: true
19346 schema:
19347 type: string
19348 - description: Component Instance Id
19349 in: path
19350 name: componentInstanceId
19351 required: true
19352 schema:
19353 type: string
19354 - description: Constraint Index
19355 in: path
19356 name: constraintIndex
19357 required: true
19358 schema:
19359 type: integer
19360 format: int32
19361 - description: "valid values: resources / services"
19362 in: path
19363 name: componentType
19364 required: true
19365 schema:
19366 type: string
19367 enum:
19368 - resources
19369 - services
19370 - description: "Constraint type. Valid values: properties / capabilities"
19371 in: path
19372 name: constraintType
19373 required: true
19374 schema:
19375 type: string
19376 enum:
19377 - properties
19378 - capabilities
19379 - in: header
19380 name: USER_ID
19381 schema:
19382 type: string
19383 responses:
19384 "201":
19385 description: Delete Component Filter Constraint
19386 "400":
19387 description: Invalid content / Missing content
19388 "403":
19389 description: Restricted operation
19390 default:
19391 content:
19392 application/json:
19393 schema:
19394 type: array
19395 items:
19396 type: object
19397 properties:
19398 allowedMethods:
19399 type: array
19400 items:
19401 type: string
19402 uniqueItems: true
19403 cookies:
19404 type: object
19405 additionalProperties:
19406 type: object
19407 properties:
19408 comment:
19409 type: string
19410 domain:
19411 type: string
19412 expiry:
19413 type: string
19414 format: date-time
19415 httpOnly:
19416 type: boolean
19417 maxAge:
19418 type: integer
19419 format: int32
19420 name:
19421 type: string
19422 path:
19423 type: string
19424 secure:
19425 type: boolean
19426 value:
19427 type: string
19428 version:
19429 type: integer
19430 format: int32
19431 date:
19432 type: string
19433 format: date-time
19434 entity:
19435 type: object
19436 entityTag:
19437 type: object
19438 properties:
19439 value:
19440 type: string
19441 weak:
19442 type: boolean
19443 headers:
19444 type: object
19445 additionalProperties:
19446 type: array
19447 items:
19448 type: object
19449 language:
19450 type: object
19451 properties:
19452 country:
19453 type: string
19454 displayCountry:
19455 type: string
19456 displayLanguage:
19457 type: string
19458 displayName:
19459 type: string
19460 displayScript:
19461 type: string
19462 displayVariant:
19463 type: string
19464 extensionKeys:
19465 type: array
19466 items:
19467 type: string
19468 uniqueItems: true
19469 iso3Country:
19470 type: string
19471 iso3Language:
19472 type: string
19473 language:
19474 type: string
19475 script:
19476 type: string
19477 unicodeLocaleAttributes:
19478 type: array
19479 items:
19480 type: string
19481 uniqueItems: true
19482 unicodeLocaleKeys:
19483 type: array
19484 items:
19485 type: string
19486 uniqueItems: true
19487 variant:
19488 type: string
19489 lastModified:
19490 type: string
19491 format: date-time
19492 length:
19493 type: integer
19494 format: int32
19495 links:
19496 type: array
19497 items:
19498 type: object
19499 properties:
19500 params:
19501 type: object
19502 additionalProperties:
19503 type: string
19504 rel:
19505 type: string
19506 rels:
19507 type: array
19508 items:
19509 type: string
19510 title:
19511 type: string
19512 type:
19513 type: string
19514 uri:
19515 type: string
19516 format: uri
19517 uriBuilder:
19518 type: object
19519 uniqueItems: true
19520 location:
19521 type: string
19522 format: uri
19523 mediaType:
19524 type: object
19525 properties:
19526 parameters:
19527 type: object
19528 additionalProperties:
19529 type: string
19530 subtype:
19531 type: string
19532 type:
19533 type: string
19534 wildcardSubtype:
19535 type: boolean
19536 wildcardType:
19537 type: boolean
19538 metadata:
19539 type: object
19540 additionalProperties:
19541 type: array
19542 items:
19543 type: object
19544 status:
19545 type: integer
19546 format: int32
19547 statusInfo:
19548 type: object
19549 properties:
19550 family:
19551 type: string
19552 enum:
19553 - INFORMATIONAL
19554 - SUCCESSFUL
19555 - REDIRECTION
19556 - CLIENT_ERROR
19557 - SERVER_ERROR
19558 - OTHER
19559 reasonPhrase:
19560 type: string
19561 statusCode:
19562 type: integer
19563 format: int32
19564 stringHeaders:
19565 type: object
19566 additionalProperties:
19567 type: array
19568 items:
19569 type: string
19570 summary: Delete Component Filter Constraint
19571 tags:
19572 - SDCE-2 APIs
19573 put:
19574 description: Update Component Filter Constraint
19575 operationId: updateComponentFilterConstraint
19576 parameters:
19577 - description: Component Id
19578 in: path
19579 name: componentId
19580 required: true
19581 schema:
19582 type: string
19583 - description: Component Instance Id
19584 in: path
19585 name: componentInstanceId
19586 required: true
19587 schema:
19588 type: string
19589 - description: "valid values: resources / services"
19590 in: path
19591 name: componentType
19592 required: true
19593 schema:
19594 type: string
19595 enum:
19596 - resources
19597 - services
19598 - description: "Constraint type. Valid values: properties / capabilities"
19599 in: path
19600 name: constraintType
19601 required: true
19602 schema:
19603 type: string
19604 enum:
19605 - properties
19606 - capabilities
19607 - description: Constraint Index
19608 in: path
19609 name: constraintIndex
19610 required: true
19611 schema:
19612 type: integer
19613 format: int32
19614 - in: header
19615 name: USER_ID
19616 schema:
19617 type: string
19618 requestBody:
19619 content:
19620 application/json:
19621 schema:
19622 type: string
19623 description: UIConstraint data
19624 required: true
19625 responses:
19626 "201":
19627 description: Create Component Filter
19628 "400":
19629 description: Invalid content / Missing content
19630 "403":
19631 description: Restricted operation
19632 default:
19633 content:
19634 application/json:
19635 schema:
19636 type: array
19637 items:
19638 type: object
19639 properties:
19640 allowedMethods:
19641 type: array
19642 items:
19643 type: string
19644 uniqueItems: true
19645 cookies:
19646 type: object
19647 additionalProperties:
19648 type: object
19649 properties:
19650 comment:
19651 type: string
19652 domain:
19653 type: string
19654 expiry:
19655 type: string
19656 format: date-time
19657 httpOnly:
19658 type: boolean
19659 maxAge:
19660 type: integer
19661 format: int32
19662 name:
19663 type: string
19664 path:
19665 type: string
19666 secure:
19667 type: boolean
19668 value:
19669 type: string
19670 version:
19671 type: integer
19672 format: int32
19673 date:
19674 type: string
19675 format: date-time
19676 entity:
19677 type: object
19678 entityTag:
19679 type: object
19680 properties:
19681 value:
19682 type: string
19683 weak:
19684 type: boolean
19685 headers:
19686 type: object
19687 additionalProperties:
19688 type: array
19689 items:
19690 type: object
19691 language:
19692 type: object
19693 properties:
19694 country:
19695 type: string
19696 displayCountry:
19697 type: string
19698 displayLanguage:
19699 type: string
19700 displayName:
19701 type: string
19702 displayScript:
19703 type: string
19704 displayVariant:
19705 type: string
19706 extensionKeys:
19707 type: array
19708 items:
19709 type: string
19710 uniqueItems: true
19711 iso3Country:
19712 type: string
19713 iso3Language:
19714 type: string
19715 language:
19716 type: string
19717 script:
19718 type: string
19719 unicodeLocaleAttributes:
19720 type: array
19721 items:
19722 type: string
19723 uniqueItems: true
19724 unicodeLocaleKeys:
19725 type: array
19726 items:
19727 type: string
19728 uniqueItems: true
19729 variant:
19730 type: string
19731 lastModified:
19732 type: string
19733 format: date-time
19734 length:
19735 type: integer
19736 format: int32
19737 links:
19738 type: array
19739 items:
19740 type: object
19741 properties:
19742 params:
19743 type: object
19744 additionalProperties:
19745 type: string
19746 rel:
19747 type: string
19748 rels:
19749 type: array
19750 items:
19751 type: string
19752 title:
19753 type: string
19754 type:
19755 type: string
19756 uri:
19757 type: string
19758 format: uri
19759 uriBuilder:
19760 type: object
19761 uniqueItems: true
19762 location:
19763 type: string
19764 format: uri
19765 mediaType:
19766 type: object
19767 properties:
19768 parameters:
19769 type: object
19770 additionalProperties:
19771 type: string
19772 subtype:
19773 type: string
19774 type:
19775 type: string
19776 wildcardSubtype:
19777 type: boolean
19778 wildcardType:
19779 type: boolean
19780 metadata:
19781 type: object
19782 additionalProperties:
19783 type: array
19784 items:
19785 type: object
19786 status:
19787 type: integer
19788 format: int32
19789 statusInfo:
19790 type: object
19791 properties:
19792 family:
19793 type: string
19794 enum:
19795 - INFORMATIONAL
19796 - SUCCESSFUL
19797 - REDIRECTION
19798 - CLIENT_ERROR
19799 - SERVER_ERROR
19800 - OTHER
19801 reasonPhrase:
19802 type: string
19803 statusCode:
19804 type: integer
19805 format: int32
19806 stringHeaders:
19807 type: object
19808 additionalProperties:
19809 type: array
19810 items:
19811 type: string
19812 summary: Update Component Filter Constraint
19813 tags:
19814 - SDCE-2 APIs
19815 /v1/catalog/{componentType}/{componentId}/componentInstances:
19816 get:
19817 description: Get Component instances
19818 operationId: getComponentInstancesFilteredByPropertiesAndInputs
19819 parameters:
19820 - in: path
19821 name: componentType
19822 required: true
19823 schema:
19824 type: string
19825 - in: path
19826 name: componentId
19827 required: true
19828 schema:
19829 type: string
19830 - in: query
19831 name: searchText
19832 schema:
19833 type: string
19834 - in: header
19835 name: USER_ID
19836 schema:
19837 type: string
19838 requestBody:
19839 content:
19840 application/json:
19841 schema:
19842 type: string
19843 description: uid list
19844 required: true
19845 responses:
19846 "200":
19847 description: Component found
19848 "403":
19849 description: Restricted operation
19850 "404":
19851 description: Component not found
19852 default:
19853 content:
19854 application/json:
19855 schema:
19856 type: array
19857 items:
19858 $ref: '#/components/schemas/Resource'
19859 servers:
19860 - url: /sdc2/rest
19861 variables: {}
19862 summary: Returns component instances
19863 tags:
19864 - SDCE-2 APIs
19865 /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{inputId}/properties:
19866 get:
19867 description: Get properties
19868 operationId: getInputPropertiesForComponentInstance
19869 parameters:
19870 - in: path
19871 name: componentType
19872 required: true
19873 schema:
19874 type: string
19875 - in: path
19876 name: componentId
19877 required: true
19878 schema:
19879 type: string
19880 - in: path
19881 name: instanceId
19882 required: true
19883 schema:
19884 type: string
19885 - in: path
19886 name: inputId
19887 required: true
19888 schema:
19889 type: string
19890 - in: header
19891 name: USER_ID
19892 schema:
19893 type: string
19894 responses:
19895 "200":
19896 description: Component found
19897 "403":
19898 description: Restricted operation
19899 "404":
19900 description: Component not found
19901 default:
19902 content:
19903 application/json:
19904 schema:
19905 type: array
19906 items:
19907 $ref: '#/components/schemas/Resource'
19908 servers:
19909 - url: /sdc2/rest
19910 variables: {}
19911 summary: Returns properties list
19912 tags:
19913 - SDCE-2 APIs
19914 /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/inputs:
19915 get:
19916 description: Get Inputs only
19917 operationId: getComponentInstanceInputs
19918 parameters:
19919 - in: path
19920 name: componentType
19921 required: true
19922 schema:
19923 type: string
19924 - in: path
19925 name: componentId
19926 required: true
19927 schema:
19928 type: string
19929 - in: path
19930 name: instanceId
19931 required: true
19932 schema:
19933 type: string
19934 - in: path
19935 name: originComponentUid
19936 required: true
19937 schema:
19938 type: string
19939 - in: header
19940 name: USER_ID
19941 schema:
19942 type: string
19943 responses:
19944 "200":
19945 description: Component found
19946 "403":
19947 description: Restricted operation
19948 "404":
19949 description: Component not found
19950 default:
19951 content:
19952 application/json:
19953 schema:
19954 type: array
19955 items:
19956 $ref: '#/components/schemas/Resource'
19957 servers:
19958 - url: /sdc2/rest
19959 variables: {}
19960 summary: Returns Inputs list
19961 tags:
19962 - SDCE-2 APIs
19963 /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/outputs:
19964 get:
19965 description: Get Outputs only
19966 operationId: getComponentInstanceOutputs
19967 parameters:
19968 - in: path
19969 name: componentType
19970 required: true
19971 schema:
19972 type: string
19973 - in: path
19974 name: componentId
19975 required: true
19976 schema:
19977 type: string
19978 - in: path
19979 name: instanceId
19980 required: true
19981 schema:
19982 type: string
19983 - in: path
19984 name: originComponentUid
19985 required: true
19986 schema:
19987 type: string
19988 - in: header
19989 name: USER_ID
19990 schema:
19991 type: string
19992 responses:
19993 "200":
19994 description: Component found
19995 "403":
19996 description: Restricted operation
19997 "404":
19998 description: Component not found
19999 default:
20000 content:
20001 application/json:
20002 schema:
20003 type: array
20004 items:
20005 $ref: '#/components/schemas/Resource'
20006 servers:
20007 - url: /sdc2/rest
20008 variables: {}
20009 summary: Returns Outputs list
20010 tags:
20011 - SDCE-2 APIs
20012 /v1/catalog/{componentType}/{componentId}/create/input:
20013 post:
20014 description: Create inputs on service
20015 operationId: createInput
20016 parameters:
20017 - in: path
20018 name: componentType
20019 required: true
20020 schema:
20021 type: string
20022 - in: path
20023 name: componentId
20024 required: true
20025 schema:
20026 type: string
20027 - in: header
20028 name: USER_ID
20029 schema:
20030 type: string
20031 requestBody:
20032 content:
20033 application/json:
20034 schema:
20035 type: string
20036 description: ComponentIns Inputs Object to be created
20037 required: true
20038 responses:
20039 "200":
20040 description: Component found
20041 "403":
20042 description: Restricted operation
20043 "404":
20044 description: Component not found
20045 default:
20046 content:
20047 application/json:
20048 schema:
20049 type: array
20050 items:
20051 $ref: '#/components/schemas/Resource'
20052 servers:
20053 - url: /sdc2/rest
20054 variables: {}
20055 summary: Return inputs list
20056 tags:
20057 - SDCE-2 APIs
20058 /v1/catalog/{componentType}/{componentId}/create/inputs:
20059 post:
20060 description: Create inputs on service
20061 operationId: createMultipleInputs
20062 parameters:
20063 - in: path
20064 name: componentType
20065 required: true
20066 schema:
20067 type: string
20068 - in: path
20069 name: componentId
20070 required: true
20071 schema:
20072 type: string
20073 - in: header
20074 name: USER_ID
20075 schema:
20076 type: string
20077 requestBody:
20078 content:
20079 application/json:
20080 schema:
20081 type: string
20082 description: ComponentIns Inputs Object to be created
20083 required: true
20084 responses:
20085 "200":
20086 description: Component found
20087 "403":
20088 description: Restricted operation
20089 "404":
20090 description: Component not found
20091 default:
20092 content:
20093 application/json:
20094 schema:
20095 type: array
20096 items:
20097 $ref: '#/components/schemas/Resource'
20098 servers:
20099 - url: /sdc2/rest
20100 variables: {}
20101 summary: Return inputs list
20102 tags:
20103 - SDCE-2 APIs
20104 /v1/catalog/{componentType}/{componentId}/create/listInput:
20105 post:
20106 description: Create a list input on service
20107 operationId: createListInput
20108 parameters:
20109 - in: path
20110 name: componentType
20111 required: true
20112 schema:
20113 type: string
20114 - in: path
20115 name: componentId
20116 required: true
20117 schema:
20118 type: string
20119 - in: header
20120 name: USER_ID
20121 schema:
20122 type: string
20123 requestBody:
20124 content:
20125 application/json:
20126 schema:
20127 type: string
20128 description: ComponentIns Inputs Object to be created
20129 required: true
20130 responses:
20131 "200":
20132 description: Component found
20133 "403":
20134 description: Restricted operation
20135 "404":
20136 description: Component not found
20137 default:
20138 content:
20139 application/json:
20140 schema:
20141 type: array
20142 items:
20143 $ref: '#/components/schemas/Resource'
20144 servers:
20145 - url: /sdc2/rest
20146 variables: {}
20147 summary: Return input
20148 tags:
20149 - SDCE-2 APIs
20150 /v1/catalog/{componentType}/{componentId}/create/outputs:
20151 post:
20152 description: Create outputs on service
20153 operationId: createMultipleOutputs
20154 parameters:
20155 - in: path
20156 name: componentType
20157 required: true
20158 schema:
20159 type: string
20160 - in: path
20161 name: componentId
20162 required: true
20163 schema:
20164 type: string
20165 - in: header
20166 name: USER_ID
20167 schema:
20168 type: string
20169 requestBody:
20170 content:
20171 application/json:
20172 schema:
20173 type: string
20174 description: ComponentIns Outputs Object to be created
20175 required: true
20176 responses:
20177 "200":
20178 description: Component found
20179 "403":
20180 description: Restricted operation
20181 "404":
20182 description: Component not found
20183 default:
20184 content:
20185 application/json:
20186 schema:
20187 type: array
20188 items:
20189 $ref: '#/components/schemas/Resource'
20190 servers:
20191 - url: /sdc2/rest
20192 variables: {}
20193 summary: Return outputs list
20194 tags:
20195 - SDCE-2 APIs
20196 /v1/catalog/{componentType}/{componentId}/create/policies:
20197 post:
20198 description: Create policies on service
20199 operationId: declareProperties
20200 parameters:
20201 - in: path
20202 name: componentType
20203 required: true
20204 schema:
20205 type: string
20206 - in: path
20207 name: componentId
20208 required: true
20209 schema:
20210 type: string
20211 - in: header
20212 name: USER_ID
20213 schema:
20214 type: string
20215 requestBody:
20216 content:
20217 application/json:
20218 schema:
20219 type: string
20220 description: ComponentIns policies Object to be created
20221 required: true
20222 responses:
20223 "200":
20224 description: Component found
20225 "403":
20226 description: Restricted operation
20227 "404":
20228 description: Component not found
20229 default:
20230 content:
20231 application/json:
20232 schema:
20233 type: array
20234 items:
20235 $ref: '#/components/schemas/Resource'
20236 servers:
20237 - url: /sdc2/rest
20238 variables: {}
20239 summary: Return policies list
20240 tags:
20241 - SDCE-2 APIs
20242 /v1/catalog/{componentType}/{componentId}/dataType/{dataTypeName}:
20243 delete:
20244 description: Delete data type from service
20245 operationId: deleteDataType
20246 parameters:
20247 - in: path
20248 name: componentType
20249 required: true
20250 schema:
20251 type: string
20252 - in: path
20253 name: componentId
20254 required: true
20255 schema:
20256 type: string
20257 - in: path
20258 name: dataTypeName
20259 required: true
20260 schema:
20261 type: string
20262 responses:
20263 "200":
20264 description: Data type deleted
20265 "403":
20266 description: Restricted operation
20267 "404":
20268 description: Data type not found
20269 default:
20270 content:
20271 application/json:
20272 schema:
20273 type: array
20274 items:
20275 $ref: '#/components/schemas/Resource'
20276 servers:
20277 - url: /sdc2/rest
20278 variables: {}
20279 summary: Delete service input
20280 tags:
20281 - SDCE-2 APIs
20282 get:
20283 description: Get data type in service
20284 operationId: getDataType
20285 parameters:
20286 - in: path
20287 name: componentType
20288 required: true
20289 schema:
20290 type: string
20291 - in: path
20292 name: componentId
20293 required: true
20294 schema:
20295 type: string
20296 - in: path
20297 name: dataTypeName
20298 required: true
20299 schema:
20300 type: string
20301 responses:
20302 "200":
20303 description: Data type found
20304 "403":
20305 description: Restricted operation
20306 "404":
20307 description: Data type not found
20308 default:
20309 content:
20310 application/json:
20311 schema:
20312 type: array
20313 items:
20314 $ref: '#/components/schemas/DataTypeDefinition'
20315 servers:
20316 - url: /sdc2/rest
20317 variables: {}
20318 summary: Get data type in service
20319 tags:
20320 - SDCE-2 APIs
20321 /v1/catalog/{componentType}/{componentId}/dataTypes:
20322 get:
20323 description: Get data types that service has
20324 operationId: getDataTypes
20325 parameters:
20326 - in: path
20327 name: componentType
20328 required: true
20329 schema:
20330 type: string
20331 - in: path
20332 name: componentId
20333 required: true
20334 schema:
20335 type: string
20336 responses:
20337 "200":
20338 description: Data type found
20339 "403":
20340 description: Restricted operation
20341 "404":
20342 description: Component not found
20343 default:
20344 content:
20345 application/json:
20346 schema:
20347 type: array
20348 items:
20349 $ref: '#/components/schemas/Resource'
20350 servers:
20351 - url: /sdc2/rest
20352 variables: {}
20353 summary: Get data types in service
20354 tags:
20355 - SDCE-2 APIs
20356 /v1/catalog/{componentType}/{componentId}/delete/{inputId}/input:
20357 delete:
20358 description: Delete input from service
20359 operationId: deleteInput
20360 parameters:
20361 - in: path
20362 name: componentType
20363 required: true
20364 schema:
20365 type: string
20366 - in: path
20367 name: componentId
20368 required: true
20369 schema:
20370 type: string
20371 - in: path
20372 name: inputId
20373 required: true
20374 schema:
20375 type: string
20376 - in: header
20377 name: USER_ID
20378 schema:
20379 type: string
20380 requestBody:
20381 content:
20382 application/json:
20383 schema:
20384 type: string
20385 description: Service Input to be deleted
20386 required: true
20387 responses:
20388 "200":
20389 description: Input deleted
20390 "403":
20391 description: Restricted operation
20392 "404":
20393 description: Input not found
20394 default:
20395 content:
20396 application/json:
20397 schema:
20398 type: array
20399 items:
20400 $ref: '#/components/schemas/Resource'
20401 servers:
20402 - url: /sdc2/rest
20403 variables: {}
20404 summary: Delete service input
20405 tags:
20406 - SDCE-2 APIs
20407 /v1/catalog/{componentType}/{componentId}/delete/{outputId}/output:
20408 delete:
20409 description: Delete output from service
20410 operationId: deleteOutput
20411 parameters:
20412 - in: path
20413 name: componentType
20414 required: true
20415 schema:
20416 type: string
20417 - in: path
20418 name: componentId
20419 required: true
20420 schema:
20421 type: string
20422 - in: path
20423 name: outputId
20424 required: true
20425 schema:
20426 type: string
20427 - in: header
20428 name: USER_ID
20429 schema:
20430 type: string
20431 requestBody:
20432 content:
20433 application/json:
20434 schema:
20435 type: string
20436 description: Service Output to be deleted
20437 required: true
20438 responses:
20439 "200":
20440 description: Output deleted
20441 "403":
20442 description: Restricted operation
20443 "404":
20444 description: Output not found
20445 default:
20446 content:
20447 application/json:
20448 schema:
20449 type: array
20450 items:
20451 $ref: '#/components/schemas/Resource'
20452 servers:
20453 - url: /sdc2/rest
20454 variables: {}
20455 summary: Delete service output
20456 tags:
20457 - SDCE-2 APIs
20458 /v1/catalog/{componentType}/{componentId}/dependencies:
20459 get:
20460 description: Autometed upgrade
20461 operationId: getComponentDependencies
20462 parameters:
20463 - in: path
20464 name: componentType
20465 required: true
20466 schema:
20467 type: string
20468 - in: path
20469 name: componentId
20470 required: true
20471 schema:
20472 type: string
20473 - in: header
20474 name: USER_ID
20475 schema:
20476 type: string
20477 requestBody:
20478 content:
20479 application/json:
20480 schema:
20481 type: array
20482 items:
20483 type: string
20484 description: Consumer Object to be created
20485 required: true
20486 responses:
20487 "200":
20488 description: Component found
20489 "403":
20490 description: Restricted operation
20491 "404":
20492 description: Component not found
20493 default:
20494 content:
20495 application/json:
20496 schema:
20497 type: array
20498 items:
20499 type: object
20500 properties:
20501 allowedMethods:
20502 type: array
20503 items:
20504 type: string
20505 uniqueItems: true
20506 cookies:
20507 type: object
20508 additionalProperties:
20509 type: object
20510 properties:
20511 comment:
20512 type: string
20513 domain:
20514 type: string
20515 expiry:
20516 type: string
20517 format: date-time
20518 httpOnly:
20519 type: boolean
20520 maxAge:
20521 type: integer
20522 format: int32
20523 name:
20524 type: string
20525 path:
20526 type: string
20527 secure:
20528 type: boolean
20529 value:
20530 type: string
20531 version:
20532 type: integer
20533 format: int32
20534 date:
20535 type: string
20536 format: date-time
20537 entity:
20538 type: object
20539 entityTag:
20540 type: object
20541 properties:
20542 value:
20543 type: string
20544 weak:
20545 type: boolean
20546 headers:
20547 type: object
20548 additionalProperties:
20549 type: array
20550 items:
20551 type: object
20552 language:
20553 type: object
20554 properties:
20555 country:
20556 type: string
20557 displayCountry:
20558 type: string
20559 displayLanguage:
20560 type: string
20561 displayName:
20562 type: string
20563 displayScript:
20564 type: string
20565 displayVariant:
20566 type: string
20567 extensionKeys:
20568 type: array
20569 items:
20570 type: string
20571 uniqueItems: true
20572 iso3Country:
20573 type: string
20574 iso3Language:
20575 type: string
20576 language:
20577 type: string
20578 script:
20579 type: string
20580 unicodeLocaleAttributes:
20581 type: array
20582 items:
20583 type: string
20584 uniqueItems: true
20585 unicodeLocaleKeys:
20586 type: array
20587 items:
20588 type: string
20589 uniqueItems: true
20590 variant:
20591 type: string
20592 lastModified:
20593 type: string
20594 format: date-time
20595 length:
20596 type: integer
20597 format: int32
20598 links:
20599 type: array
20600 items:
20601 type: object
20602 properties:
20603 params:
20604 type: object
20605 additionalProperties:
20606 type: string
20607 rel:
20608 type: string
20609 rels:
20610 type: array
20611 items:
20612 type: string
20613 title:
20614 type: string
20615 type:
20616 type: string
20617 uri:
20618 type: string
20619 format: uri
20620 uriBuilder:
20621 type: object
20622 uniqueItems: true
20623 location:
20624 type: string
20625 format: uri
20626 mediaType:
20627 type: object
20628 properties:
20629 parameters:
20630 type: object
20631 additionalProperties:
20632 type: string
20633 subtype:
20634 type: string
20635 type:
20636 type: string
20637 wildcardSubtype:
20638 type: boolean
20639 wildcardType:
20640 type: boolean
20641 metadata:
20642 type: object
20643 additionalProperties:
20644 type: array
20645 items:
20646 type: object
20647 status:
20648 type: integer
20649 format: int32
20650 statusInfo:
20651 type: object
20652 properties:
20653 family:
20654 type: string
20655 enum:
20656 - INFORMATIONAL
20657 - SUCCESSFUL
20658 - REDIRECTION
20659 - CLIENT_ERROR
20660 - SERVER_ERROR
20661 - OTHER
20662 reasonPhrase:
20663 type: string
20664 statusCode:
20665 type: integer
20666 format: int32
20667 stringHeaders:
20668 type: object
20669 additionalProperties:
20670 type: array
20671 items:
20672 type: string
20673 servers:
20674 - url: /sdc2/rest
20675 variables: {}
20676 summary: '....'
20677 tags:
20678 - SDCE-2 APIs
20679 /v1/catalog/{componentType}/{componentId}/filteredDataByParams:
20680 get:
20681 description: Retrieve Resource
20682 operationId: getComponentDataFilteredByParams
20683 parameters:
20684 - in: path
20685 name: componentType
20686 required: true
20687 schema:
20688 type: string
20689 - in: path
20690 name: componentId
20691 required: true
20692 schema:
20693 type: string
20694 - in: query
20695 name: include
20696 schema:
20697 type: array
20698 items:
20699 type: string
20700 - in: header
20701 name: USER_ID
20702 schema:
20703 type: string
20704 responses:
20705 "200":
20706 description: Resource found
20707 "403":
20708 description: Restricted operation
20709 "404":
20710 description: Resource not found
20711 default:
20712 content:
20713 application/json:
20714 schema:
20715 type: array
20716 items:
20717 $ref: '#/components/schemas/Resource'
20718 servers:
20719 - url: /sdc2/rest
20720 variables: {}
20721 summary: Returns resource according to resourceId
20722 tags:
20723 - SDCE-2 APIs
20724 /v1/catalog/{componentType}/{componentId}/filteredproperties/{propertyNameFragment}:
20725 get:
20726 description: Retrieve properties belonging to component instances of specific
20727 component by name and optionally resource type
20728 operationId: getFilteredComponentInstanceProperties
20729 parameters:
20730 - in: path
20731 name: componentType
20732 required: true
20733 schema:
20734 type: string
20735 - in: path
20736 name: componentId
20737 required: true
20738 schema:
20739 type: string
20740 - in: path
20741 name: propertyNameFragment
20742 required: true
20743 schema:
20744 type: string
20745 - in: query
20746 name: resourceType
20747 schema:
20748 type: array
20749 items:
20750 type: string
20751 - in: header
20752 name: USER_ID
20753 schema:
20754 type: string
20755 responses:
20756 "200":
20757 description: Component found
20758 "403":
20759 description: Restricted operation
20760 "404":
20761 description: Component not found
20762 default:
20763 content:
20764 application/json:
20765 schema:
20766 type: array
20767 items:
20768 type: string
20769 servers:
20770 - url: /sdc2/rest
20771 variables: {}
20772 summary: Returns properties belonging to component instances of specific component
20773 by name and optionally resource type
20774 tags:
20775 - SDCE-2 APIs
20776 /v1/catalog/{componentType}/{componentId}/inputs/{inputId}:
20777 get:
20778 description: Get inputs
20779 operationId: getInputsAndPropertiesForComponentInput
20780 parameters:
20781 - in: path
20782 name: componentType
20783 required: true
20784 schema:
20785 type: string
20786 - in: path
20787 name: componentId
20788 required: true
20789 schema:
20790 type: string
20791 - in: path
20792 name: inputId
20793 required: true
20794 schema:
20795 type: string
20796 - in: header
20797 name: USER_ID
20798 schema:
20799 type: string
20800 responses:
20801 "200":
20802 description: Component found
20803 "403":
20804 description: Restricted operation
20805 "404":
20806 description: Component not found
20807 default:
20808 content:
20809 application/json:
20810 schema:
20811 type: array
20812 items:
20813 $ref: '#/components/schemas/Resource'
20814 servers:
20815 - url: /sdc2/rest
20816 variables: {}
20817 summary: Returns inputs list
20818 tags:
20819 - SDCE-2 APIs
20820 /v1/catalog/{componentType}/{componentId}/inputs/{inputId}/inputs:
20821 get:
20822 description: Get inputs
20823 operationId: getInputsForComponentInput
20824 parameters:
20825 - in: path
20826 name: componentType
20827 required: true
20828 schema:
20829 type: string
20830 - in: path
20831 name: componentId
20832 required: true
20833 schema:
20834 type: string
20835 - in: path
20836 name: inputId
20837 required: true
20838 schema:
20839 type: string
20840 - in: header
20841 name: USER_ID
20842 schema:
20843 type: string
20844 responses:
20845 "200":
20846 description: Component found
20847 "403":
20848 description: Restricted operation
20849 "404":
20850 description: Component not found
20851 default:
20852 content:
20853 application/json:
20854 schema:
20855 type: array
20856 items:
20857 $ref: '#/components/schemas/Resource'
20858 servers:
20859 - url: /sdc2/rest
20860 variables: {}
20861 summary: Returns inputs list
20862 tags:
20863 - SDCE-2 APIs
20864 /v1/catalog/{componentType}/{componentId}/requirmentsCapabilities:
20865 get:
20866 description: Get Component Requirments And Capabilities
20867 operationId: getRequirementAndCapabilities
20868 parameters:
20869 - in: path
20870 name: componentType
20871 required: true
20872 schema:
20873 type: string
20874 - in: path
20875 name: componentId
20876 required: true
20877 schema:
20878 type: string
20879 - in: header
20880 name: USER_ID
20881 schema:
20882 type: string
20883 responses:
20884 "200":
20885 description: Component found
20886 "403":
20887 description: Restricted operation
20888 "404":
20889 description: Component not found
20890 default:
20891 content:
20892 application/json:
20893 schema:
20894 type: array
20895 items:
20896 $ref: '#/components/schemas/Resource'
20897 servers:
20898 - url: /sdc2/rest
20899 variables: {}
20900 summary: Returns Requirements And Capabilities according to componentId
20901 tags:
20902 - SDCE-2 APIs
20903 /v1/catalog/{componentType}/{componentId}/resource/interfaceOperation:
20904 post:
20905 description: Create Interface Operation
20906 operationId: createInterfaceOperationInResource
20907 parameters:
20908 - description: "valid values: resources"
20909 in: path
20910 name: componentType
20911 required: true
20912 schema:
20913 type: string
20914 enum:
20915 - resources
20916 - description: Component Id
20917 in: path
20918 name: componentId
20919 required: true
20920 schema:
20921 type: string
20922 - in: header
20923 name: USER_ID
20924 schema:
20925 type: string
20926 responses:
20927 "201":
20928 description: Create Interface Operation
20929 "400":
20930 description: Invalid content / Missing content
20931 "403":
20932 description: Restricted operation
20933 default:
20934 content:
20935 application/json:
20936 schema:
20937 type: array
20938 items:
20939 type: object
20940 properties:
20941 allowedMethods:
20942 type: array
20943 items:
20944 type: string
20945 uniqueItems: true
20946 cookies:
20947 type: object
20948 additionalProperties:
20949 type: object
20950 properties:
20951 comment:
20952 type: string
20953 domain:
20954 type: string
20955 expiry:
20956 type: string
20957 format: date-time
20958 httpOnly:
20959 type: boolean
20960 maxAge:
20961 type: integer
20962 format: int32
20963 name:
20964 type: string
20965 path:
20966 type: string
20967 secure:
20968 type: boolean
20969 value:
20970 type: string
20971 version:
20972 type: integer
20973 format: int32
20974 date:
20975 type: string
20976 format: date-time
20977 entity:
20978 type: object
20979 entityTag:
20980 type: object
20981 properties:
20982 value:
20983 type: string
20984 weak:
20985 type: boolean
20986 headers:
20987 type: object
20988 additionalProperties:
20989 type: array
20990 items:
20991 type: object
20992 language:
20993 type: object
20994 properties:
20995 country:
20996 type: string
20997 displayCountry:
20998 type: string
20999 displayLanguage:
21000 type: string
21001 displayName:
21002 type: string
21003 displayScript:
21004 type: string
21005 displayVariant:
21006 type: string
21007 extensionKeys:
21008 type: array
21009 items:
21010 type: string
21011 uniqueItems: true
21012 iso3Country:
21013 type: string
21014 iso3Language:
21015 type: string
21016 language:
21017 type: string
21018 script:
21019 type: string
21020 unicodeLocaleAttributes:
21021 type: array
21022 items:
21023 type: string
21024 uniqueItems: true
21025 unicodeLocaleKeys:
21026 type: array
21027 items:
21028 type: string
21029 uniqueItems: true
21030 variant:
21031 type: string
21032 lastModified:
21033 type: string
21034 format: date-time
21035 length:
21036 type: integer
21037 format: int32
21038 links:
21039 type: array
21040 items:
21041 type: object
21042 properties:
21043 params:
21044 type: object
21045 additionalProperties:
21046 type: string
21047 rel:
21048 type: string
21049 rels:
21050 type: array
21051 items:
21052 type: string
21053 title:
21054 type: string
21055 type:
21056 type: string
21057 uri:
21058 type: string
21059 format: uri
21060 uriBuilder:
21061 type: object
21062 uniqueItems: true
21063 location:
21064 type: string
21065 format: uri
21066 mediaType:
21067 type: object
21068 properties:
21069 parameters:
21070 type: object
21071 additionalProperties:
21072 type: string
21073 subtype:
21074 type: string
21075 type:
21076 type: string
21077 wildcardSubtype:
21078 type: boolean
21079 wildcardType:
21080 type: boolean
21081 metadata:
21082 type: object
21083 additionalProperties:
21084 type: array
21085 items:
21086 type: object
21087 status:
21088 type: integer
21089 format: int32
21090 statusInfo:
21091 type: object
21092 properties:
21093 family:
21094 type: string
21095 enum:
21096 - INFORMATIONAL
21097 - SUCCESSFUL
21098 - REDIRECTION
21099 - CLIENT_ERROR
21100 - SERVER_ERROR
21101 - OTHER
21102 reasonPhrase:
21103 type: string
21104 statusCode:
21105 type: integer
21106 format: int32
21107 stringHeaders:
21108 type: object
21109 additionalProperties:
21110 type: array
21111 items:
21112 type: string
21113 servers:
21114 - url: /sdc2/rest
21115 variables: {}
21116 summary: Create Interface Operation on ComponentInstance
21117 tags:
21118 - SDCE-2 APIs
21119 /v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}:
21120 post:
21121 description: Add Component Substitution Filter Constraint
21122 operationId: addSubstitutionFilter
21123 parameters:
21124 - description: Component Id
21125 in: path
21126 name: componentId
21127 required: true
21128 schema:
21129 type: string
21130 - description: "valid value: resources / services"
21131 in: path
21132 name: componentType
21133 required: true
21134 schema:
21135 type: string
21136 enum:
21137 - services
21138 - services
21139 - description: "Constraint type. Valid values: properties / capabilities"
21140 in: path
21141 name: constraintType
21142 required: true
21143 schema:
21144 type: string
21145 enum:
21146 - properties
21147 - capabilities
21148 - in: header
21149 name: USER_ID
21150 schema:
21151 type: string
21152 requestBody:
21153 content:
21154 application/json:
21155 schema:
21156 type: string
21157 description: UIConstraint data
21158 required: true
21159 responses:
21160 "201":
21161 description: Add Substitution Filter Constraint
21162 "400":
21163 description: Invalid content / Missing content
21164 "403":
21165 description: Restricted operation
21166 default:
21167 content:
21168 application/json:
21169 schema:
21170 type: array
21171 items:
21172 type: object
21173 properties:
21174 allowedMethods:
21175 type: array
21176 items:
21177 type: string
21178 uniqueItems: true
21179 cookies:
21180 type: object
21181 additionalProperties:
21182 type: object
21183 properties:
21184 comment:
21185 type: string
21186 domain:
21187 type: string
21188 expiry:
21189 type: string
21190 format: date-time
21191 httpOnly:
21192 type: boolean
21193 maxAge:
21194 type: integer
21195 format: int32
21196 name:
21197 type: string
21198 path:
21199 type: string
21200 secure:
21201 type: boolean
21202 value:
21203 type: string
21204 version:
21205 type: integer
21206 format: int32
21207 date:
21208 type: string
21209 format: date-time
21210 entity:
21211 type: object
21212 entityTag:
21213 type: object
21214 properties:
21215 value:
21216 type: string
21217 weak:
21218 type: boolean
21219 headers:
21220 type: object
21221 additionalProperties:
21222 type: array
21223 items:
21224 type: object
21225 language:
21226 type: object
21227 properties:
21228 country:
21229 type: string
21230 displayCountry:
21231 type: string
21232 displayLanguage:
21233 type: string
21234 displayName:
21235 type: string
21236 displayScript:
21237 type: string
21238 displayVariant:
21239 type: string
21240 extensionKeys:
21241 type: array
21242 items:
21243 type: string
21244 uniqueItems: true
21245 iso3Country:
21246 type: string
21247 iso3Language:
21248 type: string
21249 language:
21250 type: string
21251 script:
21252 type: string
21253 unicodeLocaleAttributes:
21254 type: array
21255 items:
21256 type: string
21257 uniqueItems: true
21258 unicodeLocaleKeys:
21259 type: array
21260 items:
21261 type: string
21262 uniqueItems: true
21263 variant:
21264 type: string
21265 lastModified:
21266 type: string
21267 format: date-time
21268 length:
21269 type: integer
21270 format: int32
21271 links:
21272 type: array
21273 items:
21274 type: object
21275 properties:
21276 params:
21277 type: object
21278 additionalProperties:
21279 type: string
21280 rel:
21281 type: string
21282 rels:
21283 type: array
21284 items:
21285 type: string
21286 title:
21287 type: string
21288 type:
21289 type: string
21290 uri:
21291 type: string
21292 format: uri
21293 uriBuilder:
21294 type: object
21295 uniqueItems: true
21296 location:
21297 type: string
21298 format: uri
21299 mediaType:
21300 type: object
21301 properties:
21302 parameters:
21303 type: object
21304 additionalProperties:
21305 type: string
21306 subtype:
21307 type: string
21308 type:
21309 type: string
21310 wildcardSubtype:
21311 type: boolean
21312 wildcardType:
21313 type: boolean
21314 metadata:
21315 type: object
21316 additionalProperties:
21317 type: array
21318 items:
21319 type: object
21320 status:
21321 type: integer
21322 format: int32
21323 statusInfo:
21324 type: object
21325 properties:
21326 family:
21327 type: string
21328 enum:
21329 - INFORMATIONAL
21330 - SUCCESSFUL
21331 - REDIRECTION
21332 - CLIENT_ERROR
21333 - SERVER_ERROR
21334 - OTHER
21335 reasonPhrase:
21336 type: string
21337 statusCode:
21338 type: integer
21339 format: int32
21340 stringHeaders:
21341 type: object
21342 additionalProperties:
21343 type: array
21344 items:
21345 type: string
21346 summary: Add Component Substitution Filter Constraint
21347 tags:
21348 - SDCE-2 APIs
21349 put:
21350 description: Update Component Substitution Filter Constraint
21351 operationId: updateSubstitutionFilters
21352 parameters:
21353 - description: Component Id
21354 in: path
21355 name: componentId
21356 required: true
21357 schema:
21358 type: string
21359 - description: "valid value: resources / services"
21360 in: path
21361 name: componentType
21362 required: true
21363 schema:
21364 type: string
21365 enum:
21366 - services
21367 - services
21368 - description: "Constraint type. Valid values: properties / capabilities"
21369 in: path
21370 name: constraintType
21371 required: true
21372 schema:
21373 type: string
21374 enum:
21375 - properties
21376 - capabilities
21377 - in: header
21378 name: USER_ID
21379 schema:
21380 type: string
21381 requestBody:
21382 content:
21383 application/json:
21384 schema:
21385 type: string
21386 description: UIConstraint data
21387 required: true
21388 responses:
21389 "201":
21390 description: Update Substitution Filter Constraint
21391 "400":
21392 description: Invalid content / Missing content
21393 "403":
21394 description: Restricted operation
21395 default:
21396 content:
21397 application/json:
21398 schema:
21399 type: array
21400 items:
21401 type: object
21402 properties:
21403 allowedMethods:
21404 type: array
21405 items:
21406 type: string
21407 uniqueItems: true
21408 cookies:
21409 type: object
21410 additionalProperties:
21411 type: object
21412 properties:
21413 comment:
21414 type: string
21415 domain:
21416 type: string
21417 expiry:
21418 type: string
21419 format: date-time
21420 httpOnly:
21421 type: boolean
21422 maxAge:
21423 type: integer
21424 format: int32
21425 name:
21426 type: string
21427 path:
21428 type: string
21429 secure:
21430 type: boolean
21431 value:
21432 type: string
21433 version:
21434 type: integer
21435 format: int32
21436 date:
21437 type: string
21438 format: date-time
21439 entity:
21440 type: object
21441 entityTag:
21442 type: object
21443 properties:
21444 value:
21445 type: string
21446 weak:
21447 type: boolean
21448 headers:
21449 type: object
21450 additionalProperties:
21451 type: array
21452 items:
21453 type: object
21454 language:
21455 type: object
21456 properties:
21457 country:
21458 type: string
21459 displayCountry:
21460 type: string
21461 displayLanguage:
21462 type: string
21463 displayName:
21464 type: string
21465 displayScript:
21466 type: string
21467 displayVariant:
21468 type: string
21469 extensionKeys:
21470 type: array
21471 items:
21472 type: string
21473 uniqueItems: true
21474 iso3Country:
21475 type: string
21476 iso3Language:
21477 type: string
21478 language:
21479 type: string
21480 script:
21481 type: string
21482 unicodeLocaleAttributes:
21483 type: array
21484 items:
21485 type: string
21486 uniqueItems: true
21487 unicodeLocaleKeys:
21488 type: array
21489 items:
21490 type: string
21491 uniqueItems: true
21492 variant:
21493 type: string
21494 lastModified:
21495 type: string
21496 format: date-time
21497 length:
21498 type: integer
21499 format: int32
21500 links:
21501 type: array
21502 items:
21503 type: object
21504 properties:
21505 params:
21506 type: object
21507 additionalProperties:
21508 type: string
21509 rel:
21510 type: string
21511 rels:
21512 type: array
21513 items:
21514 type: string
21515 title:
21516 type: string
21517 type:
21518 type: string
21519 uri:
21520 type: string
21521 format: uri
21522 uriBuilder:
21523 type: object
21524 uniqueItems: true
21525 location:
21526 type: string
21527 format: uri
21528 mediaType:
21529 type: object
21530 properties:
21531 parameters:
21532 type: object
21533 additionalProperties:
21534 type: string
21535 subtype:
21536 type: string
21537 type:
21538 type: string
21539 wildcardSubtype:
21540 type: boolean
21541 wildcardType:
21542 type: boolean
21543 metadata:
21544 type: object
21545 additionalProperties:
21546 type: array
21547 items:
21548 type: object
21549 status:
21550 type: integer
21551 format: int32
21552 statusInfo:
21553 type: object
21554 properties:
21555 family:
21556 type: string
21557 enum:
21558 - INFORMATIONAL
21559 - SUCCESSFUL
21560 - REDIRECTION
21561 - CLIENT_ERROR
21562 - SERVER_ERROR
21563 - OTHER
21564 reasonPhrase:
21565 type: string
21566 statusCode:
21567 type: integer
21568 format: int32
21569 stringHeaders:
21570 type: object
21571 additionalProperties:
21572 type: array
21573 items:
21574 type: string
21575 summary: Update Component Substitution Filter Constraint
21576 tags:
21577 - SDCE-2 APIs
21578 /v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}/{constraintIndex}:
21579 delete:
21580 description: Delete Component Substitution Filter Constraint
21581 operationId: deleteSubstitutionFilterConstraint
21582 parameters:
21583 - description: Component Id
21584 in: path
21585 name: componentId
21586 required: true
21587 schema:
21588 type: string
21589 - description: Constraint Index
21590 in: path
21591 name: constraintIndex
21592 required: true
21593 schema:
21594 type: integer
21595 format: int32
21596 - description: "valid value: resources / services"
21597 in: path
21598 name: componentType
21599 required: true
21600 schema:
21601 type: string
21602 enum:
21603 - services
21604 - services
21605 - description: "Constraint type. Valid values: properties / capabilities"
21606 in: path
21607 name: constraintType
21608 required: true
21609 schema:
21610 type: string
21611 enum:
21612 - properties
21613 - capabilities
21614 - in: header
21615 name: USER_ID
21616 schema:
21617 type: string
21618 responses:
21619 "201":
21620 description: Delete Substitution Filter Constraint
21621 "400":
21622 description: Invalid content / Missing content
21623 "403":
21624 description: Restricted operation
21625 default:
21626 content:
21627 application/json:
21628 schema:
21629 type: array
21630 items:
21631 type: object
21632 properties:
21633 allowedMethods:
21634 type: array
21635 items:
21636 type: string
21637 uniqueItems: true
21638 cookies:
21639 type: object
21640 additionalProperties:
21641 type: object
21642 properties:
21643 comment:
21644 type: string
21645 domain:
21646 type: string
21647 expiry:
21648 type: string
21649 format: date-time
21650 httpOnly:
21651 type: boolean
21652 maxAge:
21653 type: integer
21654 format: int32
21655 name:
21656 type: string
21657 path:
21658 type: string
21659 secure:
21660 type: boolean
21661 value:
21662 type: string
21663 version:
21664 type: integer
21665 format: int32
21666 date:
21667 type: string
21668 format: date-time
21669 entity:
21670 type: object
21671 entityTag:
21672 type: object
21673 properties:
21674 value:
21675 type: string
21676 weak:
21677 type: boolean
21678 headers:
21679 type: object
21680 additionalProperties:
21681 type: array
21682 items:
21683 type: object
21684 language:
21685 type: object
21686 properties:
21687 country:
21688 type: string
21689 displayCountry:
21690 type: string
21691 displayLanguage:
21692 type: string
21693 displayName:
21694 type: string
21695 displayScript:
21696 type: string
21697 displayVariant:
21698 type: string
21699 extensionKeys:
21700 type: array
21701 items:
21702 type: string
21703 uniqueItems: true
21704 iso3Country:
21705 type: string
21706 iso3Language:
21707 type: string
21708 language:
21709 type: string
21710 script:
21711 type: string
21712 unicodeLocaleAttributes:
21713 type: array
21714 items:
21715 type: string
21716 uniqueItems: true
21717 unicodeLocaleKeys:
21718 type: array
21719 items:
21720 type: string
21721 uniqueItems: true
21722 variant:
21723 type: string
21724 lastModified:
21725 type: string
21726 format: date-time
21727 length:
21728 type: integer
21729 format: int32
21730 links:
21731 type: array
21732 items:
21733 type: object
21734 properties:
21735 params:
21736 type: object
21737 additionalProperties:
21738 type: string
21739 rel:
21740 type: string
21741 rels:
21742 type: array
21743 items:
21744 type: string
21745 title:
21746 type: string
21747 type:
21748 type: string
21749 uri:
21750 type: string
21751 format: uri
21752 uriBuilder:
21753 type: object
21754 uniqueItems: true
21755 location:
21756 type: string
21757 format: uri
21758 mediaType:
21759 type: object
21760 properties:
21761 parameters:
21762 type: object
21763 additionalProperties:
21764 type: string
21765 subtype:
21766 type: string
21767 type:
21768 type: string
21769 wildcardSubtype:
21770 type: boolean
21771 wildcardType:
21772 type: boolean
21773 metadata:
21774 type: object
21775 additionalProperties:
21776 type: array
21777 items:
21778 type: object
21779 status:
21780 type: integer
21781 format: int32
21782 statusInfo:
21783 type: object
21784 properties:
21785 family:
21786 type: string
21787 enum:
21788 - INFORMATIONAL
21789 - SUCCESSFUL
21790 - REDIRECTION
21791 - CLIENT_ERROR
21792 - SERVER_ERROR
21793 - OTHER
21794 reasonPhrase:
21795 type: string
21796 statusCode:
21797 type: integer
21798 format: int32
21799 stringHeaders:
21800 type: object
21801 additionalProperties:
21802 type: array
21803 items:
21804 type: string
21805 summary: Delete Component Substitution Filter Constraint
21806 tags:
21807 - SDCE-2 APIs
21808 put:
21809 description: Update Component Substitution Filter Constraint
21810 operationId: updateSubstitutionFilter
21811 parameters:
21812 - description: Constraint Index
21813 in: path
21814 name: constraintIndex
21815 required: true
21816 schema:
21817 type: integer
21818 format: int32
21819 - description: Component Id
21820 in: path
21821 name: componentId
21822 required: true
21823 schema:
21824 type: string
21825 - description: The component type
21826 in: path
21827 name: componentType
21828 required: true
21829 schema:
21830 type: string
21831 enum:
21832 - services
21833 - resources
21834 - description: "Constraint type. Valid values: properties / capabilities"
21835 in: path
21836 name: constraintType
21837 required: true
21838 schema:
21839 type: string
21840 enum:
21841 - properties
21842 - capabilities
21843 - in: header
21844 name: USER_ID
21845 schema:
21846 type: string
21847 requestBody:
21848 content:
21849 application/json:
21850 schema:
21851 $ref: '#/components/schemas/UIConstraint'
21852 description: Filter constraint information
21853 required: true
21854 responses:
21855 "201":
21856 description: Update Substitution Filter Constraint
21857 "400":
21858 description: Invalid content / Missing content
21859 "403":
21860 description: Restricted operation
21861 default:
21862 content:
21863 application/json:
21864 schema:
21865 type: array
21866 items:
21867 type: object
21868 properties:
21869 allowedMethods:
21870 type: array
21871 items:
21872 type: string
21873 uniqueItems: true
21874 cookies:
21875 type: object
21876 additionalProperties:
21877 type: object
21878 properties:
21879 comment:
21880 type: string
21881 domain:
21882 type: string
21883 expiry:
21884 type: string
21885 format: date-time
21886 httpOnly:
21887 type: boolean
21888 maxAge:
21889 type: integer
21890 format: int32
21891 name:
21892 type: string
21893 path:
21894 type: string
21895 secure:
21896 type: boolean
21897 value:
21898 type: string
21899 version:
21900 type: integer
21901 format: int32
21902 date:
21903 type: string
21904 format: date-time
21905 entity:
21906 type: object
21907 entityTag:
21908 type: object
21909 properties:
21910 value:
21911 type: string
21912 weak:
21913 type: boolean
21914 headers:
21915 type: object
21916 additionalProperties:
21917 type: array
21918 items:
21919 type: object
21920 language:
21921 type: object
21922 properties:
21923 country:
21924 type: string
21925 displayCountry:
21926 type: string
21927 displayLanguage:
21928 type: string
21929 displayName:
21930 type: string
21931 displayScript:
21932 type: string
21933 displayVariant:
21934 type: string
21935 extensionKeys:
21936 type: array
21937 items:
21938 type: string
21939 uniqueItems: true
21940 iso3Country:
21941 type: string
21942 iso3Language:
21943 type: string
21944 language:
21945 type: string
21946 script:
21947 type: string
21948 unicodeLocaleAttributes:
21949 type: array
21950 items:
21951 type: string
21952 uniqueItems: true
21953 unicodeLocaleKeys:
21954 type: array
21955 items:
21956 type: string
21957 uniqueItems: true
21958 variant:
21959 type: string
21960 lastModified:
21961 type: string
21962 format: date-time
21963 length:
21964 type: integer
21965 format: int32
21966 links:
21967 type: array
21968 items:
21969 type: object
21970 properties:
21971 params:
21972 type: object
21973 additionalProperties:
21974 type: string
21975 rel:
21976 type: string
21977 rels:
21978 type: array
21979 items:
21980 type: string
21981 title:
21982 type: string
21983 type:
21984 type: string
21985 uri:
21986 type: string
21987 format: uri
21988 uriBuilder:
21989 type: object
21990 uniqueItems: true
21991 location:
21992 type: string
21993 format: uri
21994 mediaType:
21995 type: object
21996 properties:
21997 parameters:
21998 type: object
21999 additionalProperties:
22000 type: string
22001 subtype:
22002 type: string
22003 type:
22004 type: string
22005 wildcardSubtype:
22006 type: boolean
22007 wildcardType:
22008 type: boolean
22009 metadata:
22010 type: object
22011 additionalProperties:
22012 type: array
22013 items:
22014 type: object
22015 status:
22016 type: integer
22017 format: int32
22018 statusInfo:
22019 type: object
22020 properties:
22021 family:
22022 type: string
22023 enum:
22024 - INFORMATIONAL
22025 - SUCCESSFUL
22026 - REDIRECTION
22027 - CLIENT_ERROR
22028 - SERVER_ERROR
22029 - OTHER
22030 reasonPhrase:
22031 type: string
22032 statusCode:
22033 type: integer
22034 format: int32
22035 stringHeaders:
22036 type: object
22037 additionalProperties:
22038 type: array
22039 items:
22040 type: string
22041 summary: Update Component Substitution Filter Constraint
22042 tags:
22043 - SDCE-2 APIs
22044 /v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation:
22045 get:
22046 description: Validate Component Conformance Level
22047 operationId: conformanceLevelValidation
22048 parameters:
22049 - in: path
22050 name: componentType
22051 required: true
22052 schema:
22053 type: string
22054 - in: path
22055 name: componentUuid
22056 required: true
22057 schema:
22058 type: string
22059 - in: header
22060 name: USER_ID
22061 schema:
22062 type: string
22063 responses:
22064 "200":
22065 description: Component found
22066 "403":
22067 description: Restricted operation
22068 "404":
22069 description: Component not found
22070 default:
22071 content:
22072 application/json:
22073 schema:
22074 type: array
22075 items:
22076 $ref: '#/components/schemas/Resource'
22077 servers:
22078 - url: /sdc2/rest
22079 variables: {}
22080 summary: Returns the result according to conformance level in BE config
22081 tags:
22082 - SDCE-2 APIs
22083 /v1/catalog/{containerComponentType}/{componentId}/artifactsByType/{artifactGroupType}:
22084 get:
22085 description: Get component Artifacts
22086 operationId: getComponentArtifacts
22087 parameters:
22088 - description: "valid values: resources / services"
22089 in: path
22090 name: containerComponentType
22091 required: true
22092 schema:
22093 type: string
22094 enum:
22095 - resources
22096 - services
22097 - in: path
22098 name: componentId
22099 required: true
22100 schema:
22101 type: string
22102 - in: path
22103 name: artifactGroupType
22104 required: true
22105 schema:
22106 type: string
22107 responses:
22108 "200":
22109 description: Component artifacts
22110 "404":
22111 description: Resource/Artifact not found
22112 default:
22113 content:
22114 application/json:
22115 schema:
22116 type: array
22117 items:
22118 type: object
22119 properties:
22120 allowedMethods:
22121 type: array
22122 items:
22123 type: string
22124 uniqueItems: true
22125 cookies:
22126 type: object
22127 additionalProperties:
22128 type: object
22129 properties:
22130 comment:
22131 type: string
22132 domain:
22133 type: string
22134 expiry:
22135 type: string
22136 format: date-time
22137 httpOnly:
22138 type: boolean
22139 maxAge:
22140 type: integer
22141 format: int32
22142 name:
22143 type: string
22144 path:
22145 type: string
22146 secure:
22147 type: boolean
22148 value:
22149 type: string
22150 version:
22151 type: integer
22152 format: int32
22153 date:
22154 type: string
22155 format: date-time
22156 entity:
22157 type: object
22158 entityTag:
22159 type: object
22160 properties:
22161 value:
22162 type: string
22163 weak:
22164 type: boolean
22165 headers:
22166 type: object
22167 additionalProperties:
22168 type: array
22169 items:
22170 type: object
22171 language:
22172 type: object
22173 properties:
22174 country:
22175 type: string
22176 displayCountry:
22177 type: string
22178 displayLanguage:
22179 type: string
22180 displayName:
22181 type: string
22182 displayScript:
22183 type: string
22184 displayVariant:
22185 type: string
22186 extensionKeys:
22187 type: array
22188 items:
22189 type: string
22190 uniqueItems: true
22191 iso3Country:
22192 type: string
22193 iso3Language:
22194 type: string
22195 language:
22196 type: string
22197 script:
22198 type: string
22199 unicodeLocaleAttributes:
22200 type: array
22201 items:
22202 type: string
22203 uniqueItems: true
22204 unicodeLocaleKeys:
22205 type: array
22206 items:
22207 type: string
22208 uniqueItems: true
22209 variant:
22210 type: string
22211 lastModified:
22212 type: string
22213 format: date-time
22214 length:
22215 type: integer
22216 format: int32
22217 links:
22218 type: array
22219 items:
22220 type: object
22221 properties:
22222 params:
22223 type: object
22224 additionalProperties:
22225 type: string
22226 rel:
22227 type: string
22228 rels:
22229 type: array
22230 items:
22231 type: string
22232 title:
22233 type: string
22234 type:
22235 type: string
22236 uri:
22237 type: string
22238 format: uri
22239 uriBuilder:
22240 type: object
22241 uniqueItems: true
22242 location:
22243 type: string
22244 format: uri
22245 mediaType:
22246 type: object
22247 properties:
22248 parameters:
22249 type: object
22250 additionalProperties:
22251 type: string
22252 subtype:
22253 type: string
22254 type:
22255 type: string
22256 wildcardSubtype:
22257 type: boolean
22258 wildcardType:
22259 type: boolean
22260 metadata:
22261 type: object
22262 additionalProperties:
22263 type: array
22264 items:
22265 type: object
22266 status:
22267 type: integer
22268 format: int32
22269 statusInfo:
22270 type: object
22271 properties:
22272 family:
22273 type: string
22274 enum:
22275 - INFORMATIONAL
22276 - SUCCESSFUL
22277 - REDIRECTION
22278 - CLIENT_ERROR
22279 - SERVER_ERROR
22280 - OTHER
22281 reasonPhrase:
22282 type: string
22283 statusCode:
22284 type: integer
22285 format: int32
22286 stringHeaders:
22287 type: object
22288 additionalProperties:
22289 type: array
22290 items:
22291 type: string
22292 servers:
22293 - url: /sdc2/rest
22294 variables: {}
22295 summary: Returns artifacts
22296 tags:
22297 - SDCE-2 APIs
22298 /v1/catalog/{containerComponentType}/{componentId}/batchDeleteResourceInstances:
22299 post:
22300 description: Batch Delete ResourceInstances
22301 operationId: batchDeleteResourceInstances
22302 parameters:
22303 - description: "valid values: resources / services / products"
22304 in: path
22305 name: containerComponentType
22306 required: true
22307 schema:
22308 type: string
22309 enum:
22310 - resources
22311 - services
22312 - products
22313 - in: path
22314 name: componentId
22315 required: true
22316 schema:
22317 type: string
22318 requestBody:
22319 content:
22320 application/json:
22321 schema:
22322 type: string
22323 description: Component Instance Id List
22324 required: true
22325 responses:
22326 "203":
22327 description: ResourceInstances deleted
22328 "400":
22329 description: Invalid Content / Missing Content
22330 "403":
22331 description: Restricted Operation
22332 servers:
22333 - url: /sdc2/rest
22334 variables: {}
22335 tags:
22336 - SDCE-2 APIs
22337 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupId}:
22338 get:
22339 description: 'Get group artifacts '
22340 operationId: getGroupById
22341 parameters:
22342 - in: path
22343 name: containerComponentType
22344 required: true
22345 schema:
22346 type: string
22347 - in: path
22348 name: componentId
22349 required: true
22350 schema:
22351 type: string
22352 - in: path
22353 name: groupId
22354 required: true
22355 schema:
22356 type: string
22357 - in: header
22358 name: USER_ID
22359 schema:
22360 type: string
22361 responses:
22362 "200":
22363 description: group found
22364 "403":
22365 description: Restricted operation
22366 "404":
22367 description: Group not found
22368 default:
22369 content:
22370 application/json:
22371 schema:
22372 type: array
22373 items:
22374 $ref: '#/components/schemas/Resource'
22375 servers:
22376 - url: /sdc2/rest
22377 variables: {}
22378 summary: Returns artifacts metadata according to groupId
22379 tags:
22380 - SDCE-2 APIs
22381 put:
22382 description: Update Group metadata
22383 operationId: updateGroup
22384 parameters:
22385 - in: path
22386 name: containerComponentType
22387 required: true
22388 schema:
22389 type: string
22390 - in: path
22391 name: componentId
22392 required: true
22393 schema:
22394 type: string
22395 - in: path
22396 name: groupId
22397 required: true
22398 schema:
22399 type: string
22400 - in: header
22401 name: USER_ID
22402 schema:
22403 type: string
22404 requestBody:
22405 content:
22406 application/json:
22407 schema:
22408 $ref: '#/components/schemas/GroupDefinition'
22409 description: GroupDefinition
22410 required: true
22411 responses:
22412 "200":
22413 description: Group updated
22414 "400":
22415 description: Invalid content / Missing content
22416 "403":
22417 description: Restricted operation
22418 "404":
22419 description: component / group Not found
22420 default:
22421 content:
22422 application/json:
22423 schema:
22424 type: array
22425 items:
22426 type: object
22427 properties:
22428 allowedMethods:
22429 type: array
22430 items:
22431 type: string
22432 uniqueItems: true
22433 cookies:
22434 type: object
22435 additionalProperties:
22436 type: object
22437 properties:
22438 comment:
22439 type: string
22440 domain:
22441 type: string
22442 expiry:
22443 type: string
22444 format: date-time
22445 httpOnly:
22446 type: boolean
22447 maxAge:
22448 type: integer
22449 format: int32
22450 name:
22451 type: string
22452 path:
22453 type: string
22454 secure:
22455 type: boolean
22456 value:
22457 type: string
22458 version:
22459 type: integer
22460 format: int32
22461 date:
22462 type: string
22463 format: date-time
22464 entity:
22465 type: object
22466 entityTag:
22467 type: object
22468 properties:
22469 value:
22470 type: string
22471 weak:
22472 type: boolean
22473 headers:
22474 type: object
22475 additionalProperties:
22476 type: array
22477 items:
22478 type: object
22479 language:
22480 type: object
22481 properties:
22482 country:
22483 type: string
22484 displayCountry:
22485 type: string
22486 displayLanguage:
22487 type: string
22488 displayName:
22489 type: string
22490 displayScript:
22491 type: string
22492 displayVariant:
22493 type: string
22494 extensionKeys:
22495 type: array
22496 items:
22497 type: string
22498 uniqueItems: true
22499 iso3Country:
22500 type: string
22501 iso3Language:
22502 type: string
22503 language:
22504 type: string
22505 script:
22506 type: string
22507 unicodeLocaleAttributes:
22508 type: array
22509 items:
22510 type: string
22511 uniqueItems: true
22512 unicodeLocaleKeys:
22513 type: array
22514 items:
22515 type: string
22516 uniqueItems: true
22517 variant:
22518 type: string
22519 lastModified:
22520 type: string
22521 format: date-time
22522 length:
22523 type: integer
22524 format: int32
22525 links:
22526 type: array
22527 items:
22528 type: object
22529 properties:
22530 params:
22531 type: object
22532 additionalProperties:
22533 type: string
22534 rel:
22535 type: string
22536 rels:
22537 type: array
22538 items:
22539 type: string
22540 title:
22541 type: string
22542 type:
22543 type: string
22544 uri:
22545 type: string
22546 format: uri
22547 uriBuilder:
22548 type: object
22549 uniqueItems: true
22550 location:
22551 type: string
22552 format: uri
22553 mediaType:
22554 type: object
22555 properties:
22556 parameters:
22557 type: object
22558 additionalProperties:
22559 type: string
22560 subtype:
22561 type: string
22562 type:
22563 type: string
22564 wildcardSubtype:
22565 type: boolean
22566 wildcardType:
22567 type: boolean
22568 metadata:
22569 type: object
22570 additionalProperties:
22571 type: array
22572 items:
22573 type: object
22574 status:
22575 type: integer
22576 format: int32
22577 statusInfo:
22578 type: object
22579 properties:
22580 family:
22581 type: string
22582 enum:
22583 - INFORMATIONAL
22584 - SUCCESSFUL
22585 - REDIRECTION
22586 - CLIENT_ERROR
22587 - SERVER_ERROR
22588 - OTHER
22589 reasonPhrase:
22590 type: string
22591 statusCode:
22592 type: integer
22593 format: int32
22594 stringHeaders:
22595 type: object
22596 additionalProperties:
22597 type: array
22598 items:
22599 type: string
22600 servers:
22601 - url: /sdc2/rest
22602 variables: {}
22603 summary: Returns updated Group
22604 tags:
22605 - SDCE-2 APIs
22606 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupType}:
22607 post:
22608 description: 'Create group '
22609 operationId: createGroup
22610 parameters:
22611 - in: path
22612 name: containerComponentType
22613 required: true
22614 schema:
22615 type: string
22616 - in: path
22617 name: componentId
22618 required: true
22619 schema:
22620 type: string
22621 - in: path
22622 name: groupType
22623 required: true
22624 schema:
22625 type: string
22626 - in: header
22627 name: USER_ID
22628 schema:
22629 type: string
22630 responses:
22631 "201":
22632 description: Group created
22633 "400":
22634 description: "field name invalid type/length, characters; mandatory field\
22635 \ is absent, already exists (name)"
22636 "403":
22637 description: Restricted operation
22638 "404":
22639 description: Component not found
22640 "500":
22641 description: Internal Error
22642 default:
22643 content:
22644 application/json:
22645 schema:
22646 type: array
22647 items:
22648 $ref: '#/components/schemas/GroupDefinition'
22649 servers:
22650 - url: /sdc2/rest
22651 variables: {}
22652 summary: Creates new group in component and returns it
22653 tags:
22654 - SDCE-2 APIs
22655 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}:
22656 delete:
22657 description: Delete Group
22658 operationId: deleteGroup
22659 parameters:
22660 - in: path
22661 name: containerComponentType
22662 required: true
22663 schema:
22664 type: string
22665 - in: path
22666 name: componentId
22667 required: true
22668 schema:
22669 type: string
22670 - in: path
22671 name: groupUniqueId
22672 required: true
22673 schema:
22674 type: string
22675 - in: header
22676 name: USER_ID
22677 schema:
22678 type: string
22679 responses:
22680 "201":
22681 description: ResourceInstance deleted
22682 "400":
22683 description: "field name invalid type/length, characters; mandatory field\
22684 \ is absent, already exists (name)"
22685 "403":
22686 description: Restricted operation
22687 "404":
22688 description: Component not found
22689 "500":
22690 description: Internal Error
22691 default:
22692 content:
22693 application/json:
22694 schema:
22695 type: array
22696 items:
22697 type: object
22698 properties:
22699 allowedMethods:
22700 type: array
22701 items:
22702 type: string
22703 uniqueItems: true
22704 cookies:
22705 type: object
22706 additionalProperties:
22707 type: object
22708 properties:
22709 comment:
22710 type: string
22711 domain:
22712 type: string
22713 expiry:
22714 type: string
22715 format: date-time
22716 httpOnly:
22717 type: boolean
22718 maxAge:
22719 type: integer
22720 format: int32
22721 name:
22722 type: string
22723 path:
22724 type: string
22725 secure:
22726 type: boolean
22727 value:
22728 type: string
22729 version:
22730 type: integer
22731 format: int32
22732 date:
22733 type: string
22734 format: date-time
22735 entity:
22736 type: object
22737 entityTag:
22738 type: object
22739 properties:
22740 value:
22741 type: string
22742 weak:
22743 type: boolean
22744 headers:
22745 type: object
22746 additionalProperties:
22747 type: array
22748 items:
22749 type: object
22750 language:
22751 type: object
22752 properties:
22753 country:
22754 type: string
22755 displayCountry:
22756 type: string
22757 displayLanguage:
22758 type: string
22759 displayName:
22760 type: string
22761 displayScript:
22762 type: string
22763 displayVariant:
22764 type: string
22765 extensionKeys:
22766 type: array
22767 items:
22768 type: string
22769 uniqueItems: true
22770 iso3Country:
22771 type: string
22772 iso3Language:
22773 type: string
22774 language:
22775 type: string
22776 script:
22777 type: string
22778 unicodeLocaleAttributes:
22779 type: array
22780 items:
22781 type: string
22782 uniqueItems: true
22783 unicodeLocaleKeys:
22784 type: array
22785 items:
22786 type: string
22787 uniqueItems: true
22788 variant:
22789 type: string
22790 lastModified:
22791 type: string
22792 format: date-time
22793 length:
22794 type: integer
22795 format: int32
22796 links:
22797 type: array
22798 items:
22799 type: object
22800 properties:
22801 params:
22802 type: object
22803 additionalProperties:
22804 type: string
22805 rel:
22806 type: string
22807 rels:
22808 type: array
22809 items:
22810 type: string
22811 title:
22812 type: string
22813 type:
22814 type: string
22815 uri:
22816 type: string
22817 format: uri
22818 uriBuilder:
22819 type: object
22820 uniqueItems: true
22821 location:
22822 type: string
22823 format: uri
22824 mediaType:
22825 type: object
22826 properties:
22827 parameters:
22828 type: object
22829 additionalProperties:
22830 type: string
22831 subtype:
22832 type: string
22833 type:
22834 type: string
22835 wildcardSubtype:
22836 type: boolean
22837 wildcardType:
22838 type: boolean
22839 metadata:
22840 type: object
22841 additionalProperties:
22842 type: array
22843 items:
22844 type: object
22845 status:
22846 type: integer
22847 format: int32
22848 statusInfo:
22849 type: object
22850 properties:
22851 family:
22852 type: string
22853 enum:
22854 - INFORMATIONAL
22855 - SUCCESSFUL
22856 - REDIRECTION
22857 - CLIENT_ERROR
22858 - SERVER_ERROR
22859 - OTHER
22860 reasonPhrase:
22861 type: string
22862 statusCode:
22863 type: integer
22864 format: int32
22865 stringHeaders:
22866 type: object
22867 additionalProperties:
22868 type: array
22869 items:
22870 type: string
22871 servers:
22872 - url: /sdc2/rest
22873 variables: {}
22874 summary: Returns deleted group id
22875 tags:
22876 - SDCE-2 APIs
22877 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/members:
22878 post:
22879 description: 'Update group members '
22880 operationId: updateGroupMembers
22881 parameters:
22882 - in: path
22883 name: containerComponentType
22884 required: true
22885 schema:
22886 type: string
22887 - in: path
22888 name: componentId
22889 required: true
22890 schema:
22891 type: string
22892 - in: path
22893 name: groupUniqueId
22894 required: true
22895 schema:
22896 type: string
22897 - in: header
22898 name: USER_ID
22899 schema:
22900 type: string
22901 requestBody:
22902 content:
22903 application/json:
22904 schema:
22905 type: array
22906 items:
22907 type: string
22908 description: List of members unique ids
22909 required: true
22910 responses:
22911 "200":
22912 description: Group members updated
22913 "400":
22914 description: "field name invalid type/length, characters; mandatory field\
22915 \ is absent, already exists (name)"
22916 "403":
22917 description: Restricted operation
22918 "404":
22919 description: Component not found
22920 "500":
22921 description: Internal Error
22922 default:
22923 content:
22924 application/json:
22925 schema:
22926 type: array
22927 items:
22928 type: string
22929 servers:
22930 - url: /sdc2/rest
22931 variables: {}
22932 summary: Updates list of members and returns it
22933 tags:
22934 - SDCE-2 APIs
22935 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/metadata:
22936 put:
22937 description: Update Group Metadata
22938 operationId: updateGroupMetadata
22939 parameters:
22940 - in: path
22941 name: containerComponentType
22942 required: true
22943 schema:
22944 type: string
22945 - in: path
22946 name: componentId
22947 required: true
22948 schema:
22949 type: string
22950 - in: path
22951 name: groupUniqueId
22952 required: true
22953 schema:
22954 type: string
22955 - in: header
22956 name: USER_ID
22957 schema:
22958 type: string
22959 requestBody:
22960 content:
22961 application/json:
22962 schema:
22963 type: string
22964 description: Service object to be Updated
22965 required: true
22966 responses:
22967 "200":
22968 description: Group Updated
22969 "400":
22970 description: Invalid content / Missing content
22971 "403":
22972 description: Restricted operation
22973 default:
22974 content:
22975 application/json:
22976 schema:
22977 type: array
22978 items:
22979 $ref: '#/components/schemas/GroupDefinition'
22980 servers:
22981 - url: /sdc2/rest
22982 variables: {}
22983 summary: Returns updated group definition
22984 tags:
22985 - SDCE-2 APIs
22986 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties:
22987 get:
22988 description: Get List of properties on a group
22989 operationId: getGroupProperties
22990 parameters:
22991 - in: path
22992 name: containerComponentType
22993 required: true
22994 schema:
22995 type: string
22996 - in: path
22997 name: componentId
22998 required: true
22999 schema:
23000 type: string
23001 - in: path
23002 name: groupUniqueId
23003 required: true
23004 schema:
23005 type: string
23006 - in: header
23007 name: USER_ID
23008 schema:
23009 type: string
23010 responses:
23011 "200":
23012 description: Group Updated
23013 "400":
23014 description: Invalid content / Missing content
23015 "403":
23016 description: Restricted operation
23017 default:
23018 content:
23019 application/json:
23020 schema:
23021 type: array
23022 items:
23023 $ref: '#/components/schemas/GroupProperty'
23024 servers:
23025 - url: /sdc2/rest
23026 variables: {}
23027 summary: Returns list of properties
23028 tags:
23029 - SDCE-2 APIs
23030 put:
23031 description: Updates List of properties on a group (only values)
23032 operationId: updateGroupProperties
23033 parameters:
23034 - in: path
23035 name: containerComponentType
23036 required: true
23037 schema:
23038 type: string
23039 - in: path
23040 name: componentId
23041 required: true
23042 schema:
23043 type: string
23044 - in: path
23045 name: groupUniqueId
23046 required: true
23047 schema:
23048 type: string
23049 - in: header
23050 name: USER_ID
23051 schema:
23052 type: string
23053 requestBody:
23054 content:
23055 application/json:
23056 schema:
23057 type: array
23058 items:
23059 $ref: '#/components/schemas/GroupProperty'
23060 description: Group Properties to be Updated
23061 required: true
23062 responses:
23063 "200":
23064 description: Group Updated
23065 "400":
23066 description: Invalid content / Missing content
23067 "403":
23068 description: Restricted operation
23069 default:
23070 content:
23071 application/json:
23072 schema:
23073 type: array
23074 items:
23075 $ref: '#/components/schemas/GroupProperty'
23076 servers:
23077 - url: /sdc2/rest
23078 variables: {}
23079 summary: Returns updated list of properties
23080 tags:
23081 - SDCE-2 APIs
23082 /v1/catalog/{containerComponentType}/{componentId}/paths-to-delete:
23083 get:
23084 description: Check if forwarding path to delete on version change
23085 operationId: changeResourceInstanceVersion_1
23086 parameters:
23087 - in: path
23088 name: componentId
23089 required: true
23090 schema:
23091 type: string
23092 - in: query
23093 name: componentInstanceId
23094 schema:
23095 type: string
23096 - in: query
23097 name: newComponentInstanceId
23098 schema:
23099 type: string
23100 - description: "valid values: resources / services"
23101 in: path
23102 name: containerComponentType
23103 required: true
23104 schema:
23105 type: string
23106 enum:
23107 - resources
23108 - services
23109 responses:
23110 default:
23111 content:
23112 application/json:
23113 schema:
23114 type: array
23115 items:
23116 type: object
23117 properties:
23118 allowedMethods:
23119 type: array
23120 items:
23121 type: string
23122 uniqueItems: true
23123 cookies:
23124 type: object
23125 additionalProperties:
23126 type: object
23127 properties:
23128 comment:
23129 type: string
23130 domain:
23131 type: string
23132 expiry:
23133 type: string
23134 format: date-time
23135 httpOnly:
23136 type: boolean
23137 maxAge:
23138 type: integer
23139 format: int32
23140 name:
23141 type: string
23142 path:
23143 type: string
23144 secure:
23145 type: boolean
23146 value:
23147 type: string
23148 version:
23149 type: integer
23150 format: int32
23151 date:
23152 type: string
23153 format: date-time
23154 entity:
23155 type: object
23156 entityTag:
23157 type: object
23158 properties:
23159 value:
23160 type: string
23161 weak:
23162 type: boolean
23163 headers:
23164 type: object
23165 additionalProperties:
23166 type: array
23167 items:
23168 type: object
23169 language:
23170 type: object
23171 properties:
23172 country:
23173 type: string
23174 displayCountry:
23175 type: string
23176 displayLanguage:
23177 type: string
23178 displayName:
23179 type: string
23180 displayScript:
23181 type: string
23182 displayVariant:
23183 type: string
23184 extensionKeys:
23185 type: array
23186 items:
23187 type: string
23188 uniqueItems: true
23189 iso3Country:
23190 type: string
23191 iso3Language:
23192 type: string
23193 language:
23194 type: string
23195 script:
23196 type: string
23197 unicodeLocaleAttributes:
23198 type: array
23199 items:
23200 type: string
23201 uniqueItems: true
23202 unicodeLocaleKeys:
23203 type: array
23204 items:
23205 type: string
23206 uniqueItems: true
23207 variant:
23208 type: string
23209 lastModified:
23210 type: string
23211 format: date-time
23212 length:
23213 type: integer
23214 format: int32
23215 links:
23216 type: array
23217 items:
23218 type: object
23219 properties:
23220 params:
23221 type: object
23222 additionalProperties:
23223 type: string
23224 rel:
23225 type: string
23226 rels:
23227 type: array
23228 items:
23229 type: string
23230 title:
23231 type: string
23232 type:
23233 type: string
23234 uri:
23235 type: string
23236 format: uri
23237 uriBuilder:
23238 type: object
23239 uniqueItems: true
23240 location:
23241 type: string
23242 format: uri
23243 mediaType:
23244 type: object
23245 properties:
23246 parameters:
23247 type: object
23248 additionalProperties:
23249 type: string
23250 subtype:
23251 type: string
23252 type:
23253 type: string
23254 wildcardSubtype:
23255 type: boolean
23256 wildcardType:
23257 type: boolean
23258 metadata:
23259 type: object
23260 additionalProperties:
23261 type: array
23262 items:
23263 type: object
23264 status:
23265 type: integer
23266 format: int32
23267 statusInfo:
23268 type: object
23269 properties:
23270 family:
23271 type: string
23272 enum:
23273 - INFORMATIONAL
23274 - SUCCESSFUL
23275 - REDIRECTION
23276 - CLIENT_ERROR
23277 - SERVER_ERROR
23278 - OTHER
23279 reasonPhrase:
23280 type: string
23281 statusCode:
23282 type: integer
23283 format: int32
23284 stringHeaders:
23285 type: object
23286 additionalProperties:
23287 type: array
23288 items:
23289 type: string
23290 servers:
23291 - url: /sdc2/rest
23292 variables: {}
23293 summary: Returns forwarding paths to delete
23294 tags:
23295 - SDCE-2 APIs
23296 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}:
23297 delete:
23298 description: Delete Policy
23299 operationId: deletePolicy
23300 parameters:
23301 - in: path
23302 name: componentId
23303 required: true
23304 schema:
23305 type: string
23306 - description: "valid values: resources / services"
23307 in: path
23308 name: containerComponentType
23309 required: true
23310 schema:
23311 type: string
23312 enum:
23313 - resources
23314 - services
23315 - in: path
23316 name: policyId
23317 required: true
23318 schema:
23319 type: string
23320 - description: USER_ID of modifier user
23321 in: header
23322 name: USER_ID
23323 required: true
23324 schema:
23325 type: string
23326 responses:
23327 "204":
23328 description: Policy was deleted
23329 "400":
23330 description: Invalid content / Missing content
23331 "403":
23332 description: Restricted operation
23333 "404":
23334 description: component / policy Not found
23335 default:
23336 content:
23337 application/json:
23338 schema:
23339 type: array
23340 items:
23341 type: object
23342 properties:
23343 allowedMethods:
23344 type: array
23345 items:
23346 type: string
23347 uniqueItems: true
23348 cookies:
23349 type: object
23350 additionalProperties:
23351 type: object
23352 properties:
23353 comment:
23354 type: string
23355 domain:
23356 type: string
23357 expiry:
23358 type: string
23359 format: date-time
23360 httpOnly:
23361 type: boolean
23362 maxAge:
23363 type: integer
23364 format: int32
23365 name:
23366 type: string
23367 path:
23368 type: string
23369 secure:
23370 type: boolean
23371 value:
23372 type: string
23373 version:
23374 type: integer
23375 format: int32
23376 date:
23377 type: string
23378 format: date-time
23379 entity:
23380 type: object
23381 entityTag:
23382 type: object
23383 properties:
23384 value:
23385 type: string
23386 weak:
23387 type: boolean
23388 headers:
23389 type: object
23390 additionalProperties:
23391 type: array
23392 items:
23393 type: object
23394 language:
23395 type: object
23396 properties:
23397 country:
23398 type: string
23399 displayCountry:
23400 type: string
23401 displayLanguage:
23402 type: string
23403 displayName:
23404 type: string
23405 displayScript:
23406 type: string
23407 displayVariant:
23408 type: string
23409 extensionKeys:
23410 type: array
23411 items:
23412 type: string
23413 uniqueItems: true
23414 iso3Country:
23415 type: string
23416 iso3Language:
23417 type: string
23418 language:
23419 type: string
23420 script:
23421 type: string
23422 unicodeLocaleAttributes:
23423 type: array
23424 items:
23425 type: string
23426 uniqueItems: true
23427 unicodeLocaleKeys:
23428 type: array
23429 items:
23430 type: string
23431 uniqueItems: true
23432 variant:
23433 type: string
23434 lastModified:
23435 type: string
23436 format: date-time
23437 length:
23438 type: integer
23439 format: int32
23440 links:
23441 type: array
23442 items:
23443 type: object
23444 properties:
23445 params:
23446 type: object
23447 additionalProperties:
23448 type: string
23449 rel:
23450 type: string
23451 rels:
23452 type: array
23453 items:
23454 type: string
23455 title:
23456 type: string
23457 type:
23458 type: string
23459 uri:
23460 type: string
23461 format: uri
23462 uriBuilder:
23463 type: object
23464 uniqueItems: true
23465 location:
23466 type: string
23467 format: uri
23468 mediaType:
23469 type: object
23470 properties:
23471 parameters:
23472 type: object
23473 additionalProperties:
23474 type: string
23475 subtype:
23476 type: string
23477 type:
23478 type: string
23479 wildcardSubtype:
23480 type: boolean
23481 wildcardType:
23482 type: boolean
23483 metadata:
23484 type: object
23485 additionalProperties:
23486 type: array
23487 items:
23488 type: object
23489 status:
23490 type: integer
23491 format: int32
23492 statusInfo:
23493 type: object
23494 properties:
23495 family:
23496 type: string
23497 enum:
23498 - INFORMATIONAL
23499 - SUCCESSFUL
23500 - REDIRECTION
23501 - CLIENT_ERROR
23502 - SERVER_ERROR
23503 - OTHER
23504 reasonPhrase:
23505 type: string
23506 statusCode:
23507 type: integer
23508 format: int32
23509 stringHeaders:
23510 type: object
23511 additionalProperties:
23512 type: array
23513 items:
23514 type: string
23515 servers:
23516 - url: /sdc2/rest
23517 variables: {}
23518 summary: No body
23519 tags:
23520 - SDCE-2 APIs
23521 get:
23522 description: Get Policy
23523 operationId: getPolicy
23524 parameters:
23525 - in: path
23526 name: componentId
23527 required: true
23528 schema:
23529 type: string
23530 - description: "valid values: resources / services"
23531 in: path
23532 name: containerComponentType
23533 required: true
23534 schema:
23535 type: string
23536 enum:
23537 - resources
23538 - services
23539 - in: path
23540 name: policyId
23541 required: true
23542 schema:
23543 type: string
23544 - description: USER_ID of modifier user
23545 in: header
23546 name: USER_ID
23547 required: true
23548 schema:
23549 type: string
23550 responses:
23551 "200":
23552 description: Policy was found
23553 "400":
23554 description: Invalid content / Missing content
23555 "403":
23556 description: Restricted operation
23557 "404":
23558 description: component / policy Not found
23559 default:
23560 content:
23561 application/json:
23562 schema:
23563 type: array
23564 items:
23565 type: object
23566 properties:
23567 allowedMethods:
23568 type: array
23569 items:
23570 type: string
23571 uniqueItems: true
23572 cookies:
23573 type: object
23574 additionalProperties:
23575 type: object
23576 properties:
23577 comment:
23578 type: string
23579 domain:
23580 type: string
23581 expiry:
23582 type: string
23583 format: date-time
23584 httpOnly:
23585 type: boolean
23586 maxAge:
23587 type: integer
23588 format: int32
23589 name:
23590 type: string
23591 path:
23592 type: string
23593 secure:
23594 type: boolean
23595 value:
23596 type: string
23597 version:
23598 type: integer
23599 format: int32
23600 date:
23601 type: string
23602 format: date-time
23603 entity:
23604 type: object
23605 entityTag:
23606 type: object
23607 properties:
23608 value:
23609 type: string
23610 weak:
23611 type: boolean
23612 headers:
23613 type: object
23614 additionalProperties:
23615 type: array
23616 items:
23617 type: object
23618 language:
23619 type: object
23620 properties:
23621 country:
23622 type: string
23623 displayCountry:
23624 type: string
23625 displayLanguage:
23626 type: string
23627 displayName:
23628 type: string
23629 displayScript:
23630 type: string
23631 displayVariant:
23632 type: string
23633 extensionKeys:
23634 type: array
23635 items:
23636 type: string
23637 uniqueItems: true
23638 iso3Country:
23639 type: string
23640 iso3Language:
23641 type: string
23642 language:
23643 type: string
23644 script:
23645 type: string
23646 unicodeLocaleAttributes:
23647 type: array
23648 items:
23649 type: string
23650 uniqueItems: true
23651 unicodeLocaleKeys:
23652 type: array
23653 items:
23654 type: string
23655 uniqueItems: true
23656 variant:
23657 type: string
23658 lastModified:
23659 type: string
23660 format: date-time
23661 length:
23662 type: integer
23663 format: int32
23664 links:
23665 type: array
23666 items:
23667 type: object
23668 properties:
23669 params:
23670 type: object
23671 additionalProperties:
23672 type: string
23673 rel:
23674 type: string
23675 rels:
23676 type: array
23677 items:
23678 type: string
23679 title:
23680 type: string
23681 type:
23682 type: string
23683 uri:
23684 type: string
23685 format: uri
23686 uriBuilder:
23687 type: object
23688 uniqueItems: true
23689 location:
23690 type: string
23691 format: uri
23692 mediaType:
23693 type: object
23694 properties:
23695 parameters:
23696 type: object
23697 additionalProperties:
23698 type: string
23699 subtype:
23700 type: string
23701 type:
23702 type: string
23703 wildcardSubtype:
23704 type: boolean
23705 wildcardType:
23706 type: boolean
23707 metadata:
23708 type: object
23709 additionalProperties:
23710 type: array
23711 items:
23712 type: object
23713 status:
23714 type: integer
23715 format: int32
23716 statusInfo:
23717 type: object
23718 properties:
23719 family:
23720 type: string
23721 enum:
23722 - INFORMATIONAL
23723 - SUCCESSFUL
23724 - REDIRECTION
23725 - CLIENT_ERROR
23726 - SERVER_ERROR
23727 - OTHER
23728 reasonPhrase:
23729 type: string
23730 statusCode:
23731 type: integer
23732 format: int32
23733 stringHeaders:
23734 type: object
23735 additionalProperties:
23736 type: array
23737 items:
23738 type: string
23739 servers:
23740 - url: /sdc2/rest
23741 variables: {}
23742 summary: Returns Policy
23743 tags:
23744 - SDCE-2 APIs
23745 put:
23746 description: Update Policy metadata
23747 operationId: updatePolicy
23748 parameters:
23749 - in: path
23750 name: componentId
23751 required: true
23752 schema:
23753 type: string
23754 - description: "valid values: resources / services"
23755 in: path
23756 name: containerComponentType
23757 required: true
23758 schema:
23759 type: string
23760 enum:
23761 - resources
23762 - services
23763 - in: path
23764 name: policyId
23765 required: true
23766 schema:
23767 type: string
23768 - description: USER_ID of modifier user
23769 in: header
23770 name: USER_ID
23771 required: true
23772 schema:
23773 type: string
23774 requestBody:
23775 content:
23776 application/json:
23777 schema:
23778 type: string
23779 description: PolicyDefinition
23780 required: true
23781 responses:
23782 "200":
23783 description: Policy updated
23784 "400":
23785 description: Invalid content / Missing content
23786 "403":
23787 description: Restricted operation
23788 "404":
23789 description: component / policy Not found
23790 default:
23791 content:
23792 application/json:
23793 schema:
23794 type: array
23795 items:
23796 type: object
23797 properties:
23798 allowedMethods:
23799 type: array
23800 items:
23801 type: string
23802 uniqueItems: true
23803 cookies:
23804 type: object
23805 additionalProperties:
23806 type: object
23807 properties:
23808 comment:
23809 type: string
23810 domain:
23811 type: string
23812 expiry:
23813 type: string
23814 format: date-time
23815 httpOnly:
23816 type: boolean
23817 maxAge:
23818 type: integer
23819 format: int32
23820 name:
23821 type: string
23822 path:
23823 type: string
23824 secure:
23825 type: boolean
23826 value:
23827 type: string
23828 version:
23829 type: integer
23830 format: int32
23831 date:
23832 type: string
23833 format: date-time
23834 entity:
23835 type: object
23836 entityTag:
23837 type: object
23838 properties:
23839 value:
23840 type: string
23841 weak:
23842 type: boolean
23843 headers:
23844 type: object
23845 additionalProperties:
23846 type: array
23847 items:
23848 type: object
23849 language:
23850 type: object
23851 properties:
23852 country:
23853 type: string
23854 displayCountry:
23855 type: string
23856 displayLanguage:
23857 type: string
23858 displayName:
23859 type: string
23860 displayScript:
23861 type: string
23862 displayVariant:
23863 type: string
23864 extensionKeys:
23865 type: array
23866 items:
23867 type: string
23868 uniqueItems: true
23869 iso3Country:
23870 type: string
23871 iso3Language:
23872 type: string
23873 language:
23874 type: string
23875 script:
23876 type: string
23877 unicodeLocaleAttributes:
23878 type: array
23879 items:
23880 type: string
23881 uniqueItems: true
23882 unicodeLocaleKeys:
23883 type: array
23884 items:
23885 type: string
23886 uniqueItems: true
23887 variant:
23888 type: string
23889 lastModified:
23890 type: string
23891 format: date-time
23892 length:
23893 type: integer
23894 format: int32
23895 links:
23896 type: array
23897 items:
23898 type: object
23899 properties:
23900 params:
23901 type: object
23902 additionalProperties:
23903 type: string
23904 rel:
23905 type: string
23906 rels:
23907 type: array
23908 items:
23909 type: string
23910 title:
23911 type: string
23912 type:
23913 type: string
23914 uri:
23915 type: string
23916 format: uri
23917 uriBuilder:
23918 type: object
23919 uniqueItems: true
23920 location:
23921 type: string
23922 format: uri
23923 mediaType:
23924 type: object
23925 properties:
23926 parameters:
23927 type: object
23928 additionalProperties:
23929 type: string
23930 subtype:
23931 type: string
23932 type:
23933 type: string
23934 wildcardSubtype:
23935 type: boolean
23936 wildcardType:
23937 type: boolean
23938 metadata:
23939 type: object
23940 additionalProperties:
23941 type: array
23942 items:
23943 type: object
23944 status:
23945 type: integer
23946 format: int32
23947 statusInfo:
23948 type: object
23949 properties:
23950 family:
23951 type: string
23952 enum:
23953 - INFORMATIONAL
23954 - SUCCESSFUL
23955 - REDIRECTION
23956 - CLIENT_ERROR
23957 - SERVER_ERROR
23958 - OTHER
23959 reasonPhrase:
23960 type: string
23961 statusCode:
23962 type: integer
23963 format: int32
23964 stringHeaders:
23965 type: object
23966 additionalProperties:
23967 type: array
23968 items:
23969 type: string
23970 servers:
23971 - url: /sdc2/rest
23972 variables: {}
23973 summary: Returns updated Policy
23974 tags:
23975 - SDCE-2 APIs
23976 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/properties:
23977 get:
23978 description: Get component policy properties
23979 operationId: getPolicyProperties
23980 parameters:
23981 - description: the id of the component which is the container of the policy
23982 in: path
23983 name: componentId
23984 required: true
23985 schema:
23986 type: string
23987 - description: "valid values: resources / services"
23988 in: path
23989 name: containerComponentType
23990 required: true
23991 schema:
23992 type: string
23993 enum:
23994 - resources
23995 - services
23996 - description: the id of the policy which its properties are to return
23997 in: path
23998 name: policyId
23999 required: true
24000 schema:
24001 type: string
24002 - description: the userid
24003 in: header
24004 name: USER_ID
24005 required: true
24006 schema:
24007 type: string
24008 responses:
24009 "200":
24010 description: Properties found
24011 "400":
24012 description: "invalid content - Error: containerComponentType is invalid"
24013 "403":
24014 description: Restricted operation
24015 "404":
24016 description: Componentorpolicy not found
24017 "500":
24018 description: The GET request failed due to internal SDC problem.
24019 default:
24020 content:
24021 application/json:
24022 schema:
24023 type: array
24024 items:
24025 $ref: '#/components/schemas/PropertyDataDefinition'
24026 servers:
24027 - url: /sdc2/rest
24028 variables: {}
24029 summary: Returns component policy properties
24030 tags:
24031 - SDCE-2 APIs
24032 put:
24033 description: Update Policy properties
24034 operationId: updatePolicyProperties
24035 parameters:
24036 - in: path
24037 name: componentId
24038 required: true
24039 schema:
24040 type: string
24041 - description: "valid values: resources / services"
24042 in: path
24043 name: containerComponentType
24044 required: true
24045 schema:
24046 type: string
24047 enum:
24048 - resources
24049 - services
24050 - in: path
24051 name: policyId
24052 required: true
24053 schema:
24054 type: string
24055 - description: USER_ID of modifier user
24056 in: header
24057 name: USER_ID
24058 required: true
24059 schema:
24060 type: string
24061 requestBody:
24062 content:
24063 application/json:
24064 schema:
24065 type: string
24066 description: PolicyDefinition
24067 required: true
24068 responses:
24069 "200":
24070 description: Policy properties updated
24071 "400":
24072 description: Invalid content / Missing content
24073 "403":
24074 description: Restricted operation
24075 "404":
24076 description: component / policy Not found
24077 default:
24078 content:
24079 application/json:
24080 schema:
24081 type: array
24082 items:
24083 type: object
24084 properties:
24085 allowedMethods:
24086 type: array
24087 items:
24088 type: string
24089 uniqueItems: true
24090 cookies:
24091 type: object
24092 additionalProperties:
24093 type: object
24094 properties:
24095 comment:
24096 type: string
24097 domain:
24098 type: string
24099 expiry:
24100 type: string
24101 format: date-time
24102 httpOnly:
24103 type: boolean
24104 maxAge:
24105 type: integer
24106 format: int32
24107 name:
24108 type: string
24109 path:
24110 type: string
24111 secure:
24112 type: boolean
24113 value:
24114 type: string
24115 version:
24116 type: integer
24117 format: int32
24118 date:
24119 type: string
24120 format: date-time
24121 entity:
24122 type: object
24123 entityTag:
24124 type: object
24125 properties:
24126 value:
24127 type: string
24128 weak:
24129 type: boolean
24130 headers:
24131 type: object
24132 additionalProperties:
24133 type: array
24134 items:
24135 type: object
24136 language:
24137 type: object
24138 properties:
24139 country:
24140 type: string
24141 displayCountry:
24142 type: string
24143 displayLanguage:
24144 type: string
24145 displayName:
24146 type: string
24147 displayScript:
24148 type: string
24149 displayVariant:
24150 type: string
24151 extensionKeys:
24152 type: array
24153 items:
24154 type: string
24155 uniqueItems: true
24156 iso3Country:
24157 type: string
24158 iso3Language:
24159 type: string
24160 language:
24161 type: string
24162 script:
24163 type: string
24164 unicodeLocaleAttributes:
24165 type: array
24166 items:
24167 type: string
24168 uniqueItems: true
24169 unicodeLocaleKeys:
24170 type: array
24171 items:
24172 type: string
24173 uniqueItems: true
24174 variant:
24175 type: string
24176 lastModified:
24177 type: string
24178 format: date-time
24179 length:
24180 type: integer
24181 format: int32
24182 links:
24183 type: array
24184 items:
24185 type: object
24186 properties:
24187 params:
24188 type: object
24189 additionalProperties:
24190 type: string
24191 rel:
24192 type: string
24193 rels:
24194 type: array
24195 items:
24196 type: string
24197 title:
24198 type: string
24199 type:
24200 type: string
24201 uri:
24202 type: string
24203 format: uri
24204 uriBuilder:
24205 type: object
24206 uniqueItems: true
24207 location:
24208 type: string
24209 format: uri
24210 mediaType:
24211 type: object
24212 properties:
24213 parameters:
24214 type: object
24215 additionalProperties:
24216 type: string
24217 subtype:
24218 type: string
24219 type:
24220 type: string
24221 wildcardSubtype:
24222 type: boolean
24223 wildcardType:
24224 type: boolean
24225 metadata:
24226 type: object
24227 additionalProperties:
24228 type: array
24229 items:
24230 type: object
24231 status:
24232 type: integer
24233 format: int32
24234 statusInfo:
24235 type: object
24236 properties:
24237 family:
24238 type: string
24239 enum:
24240 - INFORMATIONAL
24241 - SUCCESSFUL
24242 - REDIRECTION
24243 - CLIENT_ERROR
24244 - SERVER_ERROR
24245 - OTHER
24246 reasonPhrase:
24247 type: string
24248 statusCode:
24249 type: integer
24250 format: int32
24251 stringHeaders:
24252 type: object
24253 additionalProperties:
24254 type: array
24255 items:
24256 type: string
24257 servers:
24258 - url: /sdc2/rest
24259 variables: {}
24260 summary: Returns updated Policy
24261 tags:
24262 - SDCE-2 APIs
24263 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/targets:
24264 post:
24265 description: update policy targets
24266 operationId: updatePolicyTargets
24267 parameters:
24268 - in: path
24269 name: componentId
24270 required: true
24271 schema:
24272 type: string
24273 - description: "valid values: resources / services"
24274 in: path
24275 name: containerComponentType
24276 required: true
24277 schema:
24278 type: string
24279 enum:
24280 - resources
24281 - services
24282 - in: path
24283 name: policyId
24284 required: true
24285 schema:
24286 type: string
24287 - description: USER_ID of modifier user
24288 in: header
24289 name: USER_ID
24290 required: true
24291 schema:
24292 type: string
24293 requestBody:
24294 content:
24295 application/json:
24296 schema:
24297 type: array
24298 items:
24299 $ref: '#/components/schemas/PolicyTargetDTO'
24300 responses:
24301 "201":
24302 description: Policy target updated
24303 "400":
24304 description: Invalid content / Missing content
24305 "403":
24306 description: Restricted operation
24307 default:
24308 content:
24309 application/json:
24310 schema:
24311 type: array
24312 items:
24313 type: object
24314 properties:
24315 allowedMethods:
24316 type: array
24317 items:
24318 type: string
24319 uniqueItems: true
24320 cookies:
24321 type: object
24322 additionalProperties:
24323 type: object
24324 properties:
24325 comment:
24326 type: string
24327 domain:
24328 type: string
24329 expiry:
24330 type: string
24331 format: date-time
24332 httpOnly:
24333 type: boolean
24334 maxAge:
24335 type: integer
24336 format: int32
24337 name:
24338 type: string
24339 path:
24340 type: string
24341 secure:
24342 type: boolean
24343 value:
24344 type: string
24345 version:
24346 type: integer
24347 format: int32
24348 date:
24349 type: string
24350 format: date-time
24351 entity:
24352 type: object
24353 entityTag:
24354 type: object
24355 properties:
24356 value:
24357 type: string
24358 weak:
24359 type: boolean
24360 headers:
24361 type: object
24362 additionalProperties:
24363 type: array
24364 items:
24365 type: object
24366 language:
24367 type: object
24368 properties:
24369 country:
24370 type: string
24371 displayCountry:
24372 type: string
24373 displayLanguage:
24374 type: string
24375 displayName:
24376 type: string
24377 displayScript:
24378 type: string
24379 displayVariant:
24380 type: string
24381 extensionKeys:
24382 type: array
24383 items:
24384 type: string
24385 uniqueItems: true
24386 iso3Country:
24387 type: string
24388 iso3Language:
24389 type: string
24390 language:
24391 type: string
24392 script:
24393 type: string
24394 unicodeLocaleAttributes:
24395 type: array
24396 items:
24397 type: string
24398 uniqueItems: true
24399 unicodeLocaleKeys:
24400 type: array
24401 items:
24402 type: string
24403 uniqueItems: true
24404 variant:
24405 type: string
24406 lastModified:
24407 type: string
24408 format: date-time
24409 length:
24410 type: integer
24411 format: int32
24412 links:
24413 type: array
24414 items:
24415 type: object
24416 properties:
24417 params:
24418 type: object
24419 additionalProperties:
24420 type: string
24421 rel:
24422 type: string
24423 rels:
24424 type: array
24425 items:
24426 type: string
24427 title:
24428 type: string
24429 type:
24430 type: string
24431 uri:
24432 type: string
24433 format: uri
24434 uriBuilder:
24435 type: object
24436 uniqueItems: true
24437 location:
24438 type: string
24439 format: uri
24440 mediaType:
24441 type: object
24442 properties:
24443 parameters:
24444 type: object
24445 additionalProperties:
24446 type: string
24447 subtype:
24448 type: string
24449 type:
24450 type: string
24451 wildcardSubtype:
24452 type: boolean
24453 wildcardType:
24454 type: boolean
24455 metadata:
24456 type: object
24457 additionalProperties:
24458 type: array
24459 items:
24460 type: object
24461 status:
24462 type: integer
24463 format: int32
24464 statusInfo:
24465 type: object
24466 properties:
24467 family:
24468 type: string
24469 enum:
24470 - INFORMATIONAL
24471 - SUCCESSFUL
24472 - REDIRECTION
24473 - CLIENT_ERROR
24474 - SERVER_ERROR
24475 - OTHER
24476 reasonPhrase:
24477 type: string
24478 statusCode:
24479 type: integer
24480 format: int32
24481 stringHeaders:
24482 type: object
24483 additionalProperties:
24484 type: array
24485 items:
24486 type: string
24487 servers:
24488 - url: /sdc2/rest
24489 variables: {}
24490 summary: Returns updated Policy
24491 tags:
24492 - SDCE-2 APIs
24493 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/undeclare:
24494 put:
24495 description: undeclare Policy
24496 operationId: undeclarePolicy
24497 parameters:
24498 - in: path
24499 name: componentId
24500 required: true
24501 schema:
24502 type: string
24503 - description: "valid values: resources / services"
24504 in: path
24505 name: containerComponentType
24506 required: true
24507 schema:
24508 type: string
24509 enum:
24510 - resources
24511 - services
24512 - in: path
24513 name: policyId
24514 required: true
24515 schema:
24516 type: string
24517 - description: USER_ID of modifier user
24518 in: header
24519 name: USER_ID
24520 required: true
24521 schema:
24522 type: string
24523 responses:
24524 "204":
24525 description: Policy was undeclared
24526 "400":
24527 description: Invalid content / Missing content
24528 "403":
24529 description: Restricted operation
24530 "404":
24531 description: component / policy Not found
24532 default:
24533 content:
24534 application/json:
24535 schema:
24536 type: array
24537 items:
24538 type: object
24539 properties:
24540 allowedMethods:
24541 type: array
24542 items:
24543 type: string
24544 uniqueItems: true
24545 cookies:
24546 type: object
24547 additionalProperties:
24548 type: object
24549 properties:
24550 comment:
24551 type: string
24552 domain:
24553 type: string
24554 expiry:
24555 type: string
24556 format: date-time
24557 httpOnly:
24558 type: boolean
24559 maxAge:
24560 type: integer
24561 format: int32
24562 name:
24563 type: string
24564 path:
24565 type: string
24566 secure:
24567 type: boolean
24568 value:
24569 type: string
24570 version:
24571 type: integer
24572 format: int32
24573 date:
24574 type: string
24575 format: date-time
24576 entity:
24577 type: object
24578 entityTag:
24579 type: object
24580 properties:
24581 value:
24582 type: string
24583 weak:
24584 type: boolean
24585 headers:
24586 type: object
24587 additionalProperties:
24588 type: array
24589 items:
24590 type: object
24591 language:
24592 type: object
24593 properties:
24594 country:
24595 type: string
24596 displayCountry:
24597 type: string
24598 displayLanguage:
24599 type: string
24600 displayName:
24601 type: string
24602 displayScript:
24603 type: string
24604 displayVariant:
24605 type: string
24606 extensionKeys:
24607 type: array
24608 items:
24609 type: string
24610 uniqueItems: true
24611 iso3Country:
24612 type: string
24613 iso3Language:
24614 type: string
24615 language:
24616 type: string
24617 script:
24618 type: string
24619 unicodeLocaleAttributes:
24620 type: array
24621 items:
24622 type: string
24623 uniqueItems: true
24624 unicodeLocaleKeys:
24625 type: array
24626 items:
24627 type: string
24628 uniqueItems: true
24629 variant:
24630 type: string
24631 lastModified:
24632 type: string
24633 format: date-time
24634 length:
24635 type: integer
24636 format: int32
24637 links:
24638 type: array
24639 items:
24640 type: object
24641 properties:
24642 params:
24643 type: object
24644 additionalProperties:
24645 type: string
24646 rel:
24647 type: string
24648 rels:
24649 type: array
24650 items:
24651 type: string
24652 title:
24653 type: string
24654 type:
24655 type: string
24656 uri:
24657 type: string
24658 format: uri
24659 uriBuilder:
24660 type: object
24661 uniqueItems: true
24662 location:
24663 type: string
24664 format: uri
24665 mediaType:
24666 type: object
24667 properties:
24668 parameters:
24669 type: object
24670 additionalProperties:
24671 type: string
24672 subtype:
24673 type: string
24674 type:
24675 type: string
24676 wildcardSubtype:
24677 type: boolean
24678 wildcardType:
24679 type: boolean
24680 metadata:
24681 type: object
24682 additionalProperties:
24683 type: array
24684 items:
24685 type: object
24686 status:
24687 type: integer
24688 format: int32
24689 statusInfo:
24690 type: object
24691 properties:
24692 family:
24693 type: string
24694 enum:
24695 - INFORMATIONAL
24696 - SUCCESSFUL
24697 - REDIRECTION
24698 - CLIENT_ERROR
24699 - SERVER_ERROR
24700 - OTHER
24701 reasonPhrase:
24702 type: string
24703 statusCode:
24704 type: integer
24705 format: int32
24706 stringHeaders:
24707 type: object
24708 additionalProperties:
24709 type: array
24710 items:
24711 type: string
24712 servers:
24713 - url: /sdc2/rest
24714 variables: {}
24715 summary: No body
24716 tags:
24717 - SDCE-2 APIs
24718 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyTypeName}:
24719 post:
24720 description: Create Policy
24721 operationId: createPolicy
24722 parameters:
24723 - in: path
24724 name: componentId
24725 required: true
24726 schema:
24727 type: string
24728 - description: "valid values: resources / services"
24729 in: path
24730 name: containerComponentType
24731 required: true
24732 schema:
24733 type: string
24734 enum:
24735 - resources
24736 - services
24737 - in: path
24738 name: policyTypeName
24739 required: true
24740 schema:
24741 type: string
24742 - description: USER_ID of modifier user
24743 in: header
24744 name: USER_ID
24745 required: true
24746 schema:
24747 type: string
24748 responses:
24749 "201":
24750 description: Policy created
24751 "400":
24752 description: Invalid content / Missing content
24753 "403":
24754 description: Restricted operation
24755 "404":
24756 description: Component not found
24757 "409":
24758 description: Policy already exist
24759 default:
24760 content:
24761 application/json:
24762 schema:
24763 type: array
24764 items:
24765 type: object
24766 properties:
24767 allowedMethods:
24768 type: array
24769 items:
24770 type: string
24771 uniqueItems: true
24772 cookies:
24773 type: object
24774 additionalProperties:
24775 type: object
24776 properties:
24777 comment:
24778 type: string
24779 domain:
24780 type: string
24781 expiry:
24782 type: string
24783 format: date-time
24784 httpOnly:
24785 type: boolean
24786 maxAge:
24787 type: integer
24788 format: int32
24789 name:
24790 type: string
24791 path:
24792 type: string
24793 secure:
24794 type: boolean
24795 value:
24796 type: string
24797 version:
24798 type: integer
24799 format: int32
24800 date:
24801 type: string
24802 format: date-time
24803 entity:
24804 type: object
24805 entityTag:
24806 type: object
24807 properties:
24808 value:
24809 type: string
24810 weak:
24811 type: boolean
24812 headers:
24813 type: object
24814 additionalProperties:
24815 type: array
24816 items:
24817 type: object
24818 language:
24819 type: object
24820 properties:
24821 country:
24822 type: string
24823 displayCountry:
24824 type: string
24825 displayLanguage:
24826 type: string
24827 displayName:
24828 type: string
24829 displayScript:
24830 type: string
24831 displayVariant:
24832 type: string
24833 extensionKeys:
24834 type: array
24835 items:
24836 type: string
24837 uniqueItems: true
24838 iso3Country:
24839 type: string
24840 iso3Language:
24841 type: string
24842 language:
24843 type: string
24844 script:
24845 type: string
24846 unicodeLocaleAttributes:
24847 type: array
24848 items:
24849 type: string
24850 uniqueItems: true
24851 unicodeLocaleKeys:
24852 type: array
24853 items:
24854 type: string
24855 uniqueItems: true
24856 variant:
24857 type: string
24858 lastModified:
24859 type: string
24860 format: date-time
24861 length:
24862 type: integer
24863 format: int32
24864 links:
24865 type: array
24866 items:
24867 type: object
24868 properties:
24869 params:
24870 type: object
24871 additionalProperties:
24872 type: string
24873 rel:
24874 type: string
24875 rels:
24876 type: array
24877 items:
24878 type: string
24879 title:
24880 type: string
24881 type:
24882 type: string
24883 uri:
24884 type: string
24885 format: uri
24886 uriBuilder:
24887 type: object
24888 uniqueItems: true
24889 location:
24890 type: string
24891 format: uri
24892 mediaType:
24893 type: object
24894 properties:
24895 parameters:
24896 type: object
24897 additionalProperties:
24898 type: string
24899 subtype:
24900 type: string
24901 type:
24902 type: string
24903 wildcardSubtype:
24904 type: boolean
24905 wildcardType:
24906 type: boolean
24907 metadata:
24908 type: object
24909 additionalProperties:
24910 type: array
24911 items:
24912 type: object
24913 status:
24914 type: integer
24915 format: int32
24916 statusInfo:
24917 type: object
24918 properties:
24919 family:
24920 type: string
24921 enum:
24922 - INFORMATIONAL
24923 - SUCCESSFUL
24924 - REDIRECTION
24925 - CLIENT_ERROR
24926 - SERVER_ERROR
24927 - OTHER
24928 reasonPhrase:
24929 type: string
24930 statusCode:
24931 type: integer
24932 format: int32
24933 stringHeaders:
24934 type: object
24935 additionalProperties:
24936 type: array
24937 items:
24938 type: string
24939 servers:
24940 - url: /sdc2/rest
24941 variables: {}
24942 summary: Returns created Policy
24943 tags:
24944 - SDCE-2 APIs
24945 /v1/catalog/{containerComponentType}/{componentId}/relationId/{relationId}:
24946 get:
24947 description: Get relation
24948 operationId: getRelationById
24949 parameters:
24950 - in: path
24951 name: containerComponentType
24952 required: true
24953 schema:
24954 type: string
24955 - in: path
24956 name: componentId
24957 required: true
24958 schema:
24959 type: string
24960 - in: path
24961 name: relationId
24962 required: true
24963 schema:
24964 type: string
24965 - in: header
24966 name: USER_ID
24967 schema:
24968 type: string
24969 responses:
24970 "200":
24971 description: relation found
24972 "403":
24973 description: Restricted operation
24974 "404":
24975 description: Relation not found
24976 default:
24977 content:
24978 application/json:
24979 schema:
24980 type: array
24981 items:
24982 type: object
24983 properties:
24984 allowedMethods:
24985 type: array
24986 items:
24987 type: string
24988 uniqueItems: true
24989 cookies:
24990 type: object
24991 additionalProperties:
24992 type: object
24993 properties:
24994 comment:
24995 type: string
24996 domain:
24997 type: string
24998 expiry:
24999 type: string
25000 format: date-time
25001 httpOnly:
25002 type: boolean
25003 maxAge:
25004 type: integer
25005 format: int32
25006 name:
25007 type: string
25008 path:
25009 type: string
25010 secure:
25011 type: boolean
25012 value:
25013 type: string
25014 version:
25015 type: integer
25016 format: int32
25017 date:
25018 type: string
25019 format: date-time
25020 entity:
25021 type: object
25022 entityTag:
25023 type: object
25024 properties:
25025 value:
25026 type: string
25027 weak:
25028 type: boolean
25029 headers:
25030 type: object
25031 additionalProperties:
25032 type: array
25033 items:
25034 type: object
25035 language:
25036 type: object
25037 properties:
25038 country:
25039 type: string
25040 displayCountry:
25041 type: string
25042 displayLanguage:
25043 type: string
25044 displayName:
25045 type: string
25046 displayScript:
25047 type: string
25048 displayVariant:
25049 type: string
25050 extensionKeys:
25051 type: array
25052 items:
25053 type: string
25054 uniqueItems: true
25055 iso3Country:
25056 type: string
25057 iso3Language:
25058 type: string
25059 language:
25060 type: string
25061 script:
25062 type: string
25063 unicodeLocaleAttributes:
25064 type: array
25065 items:
25066 type: string
25067 uniqueItems: true
25068 unicodeLocaleKeys:
25069 type: array
25070 items:
25071 type: string
25072 uniqueItems: true
25073 variant:
25074 type: string
25075 lastModified:
25076 type: string
25077 format: date-time
25078 length:
25079 type: integer
25080 format: int32
25081 links:
25082 type: array
25083 items:
25084 type: object
25085 properties:
25086 params:
25087 type: object
25088 additionalProperties:
25089 type: string
25090 rel:
25091 type: string
25092 rels:
25093 type: array
25094 items:
25095 type: string
25096 title:
25097 type: string
25098 type:
25099 type: string
25100 uri:
25101 type: string
25102 format: uri
25103 uriBuilder:
25104 type: object
25105 uniqueItems: true
25106 location:
25107 type: string
25108 format: uri
25109 mediaType:
25110 type: object
25111 properties:
25112 parameters:
25113 type: object
25114 additionalProperties:
25115 type: string
25116 subtype:
25117 type: string
25118 type:
25119 type: string
25120 wildcardSubtype:
25121 type: boolean
25122 wildcardType:
25123 type: boolean
25124 metadata:
25125 type: object
25126 additionalProperties:
25127 type: array
25128 items:
25129 type: object
25130 status:
25131 type: integer
25132 format: int32
25133 statusInfo:
25134 type: object
25135 properties:
25136 family:
25137 type: string
25138 enum:
25139 - INFORMATIONAL
25140 - SUCCESSFUL
25141 - REDIRECTION
25142 - CLIENT_ERROR
25143 - SERVER_ERROR
25144 - OTHER
25145 reasonPhrase:
25146 type: string
25147 statusCode:
25148 type: integer
25149 format: int32
25150 stringHeaders:
25151 type: object
25152 additionalProperties:
25153 type: array
25154 items:
25155 type: string
25156 servers:
25157 - url: /sdc2/rest
25158 variables: {}
25159 summary: Returns relation metadata according to relationId
25160 tags:
25161 - SDCE-2 APIs
25162 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance:
25163 post:
25164 description: Create ComponentInstance
25165 operationId: createComponentInstance
25166 parameters:
25167 - in: path
25168 name: componentId
25169 required: true
25170 schema:
25171 type: string
25172 - description: "valid values: resources / services"
25173 in: path
25174 name: containerComponentType
25175 required: true
25176 schema:
25177 type: string
25178 enum:
25179 - resources
25180 - services
25181 - description: USER_ID of modifier user
25182 in: header
25183 name: USER_ID
25184 required: true
25185 schema:
25186 type: string
25187 requestBody:
25188 content:
25189 application/json:
25190 schema:
25191 type: string
25192 description: RI object to be created
25193 required: true
25194 responses:
25195 "201":
25196 description: Component created
25197 "400":
25198 description: Invalid content / Missing content
25199 "403":
25200 description: Restricted operation
25201 "409":
25202 description: Component instance already exist
25203 default:
25204 content:
25205 application/json:
25206 schema:
25207 type: array
25208 items:
25209 type: object
25210 properties:
25211 allowedMethods:
25212 type: array
25213 items:
25214 type: string
25215 uniqueItems: true
25216 cookies:
25217 type: object
25218 additionalProperties:
25219 type: object
25220 properties:
25221 comment:
25222 type: string
25223 domain:
25224 type: string
25225 expiry:
25226 type: string
25227 format: date-time
25228 httpOnly:
25229 type: boolean
25230 maxAge:
25231 type: integer
25232 format: int32
25233 name:
25234 type: string
25235 path:
25236 type: string
25237 secure:
25238 type: boolean
25239 value:
25240 type: string
25241 version:
25242 type: integer
25243 format: int32
25244 date:
25245 type: string
25246 format: date-time
25247 entity:
25248 type: object
25249 entityTag:
25250 type: object
25251 properties:
25252 value:
25253 type: string
25254 weak:
25255 type: boolean
25256 headers:
25257 type: object
25258 additionalProperties:
25259 type: array
25260 items:
25261 type: object
25262 language:
25263 type: object
25264 properties:
25265 country:
25266 type: string
25267 displayCountry:
25268 type: string
25269 displayLanguage:
25270 type: string
25271 displayName:
25272 type: string
25273 displayScript:
25274 type: string
25275 displayVariant:
25276 type: string
25277 extensionKeys:
25278 type: array
25279 items:
25280 type: string
25281 uniqueItems: true
25282 iso3Country:
25283 type: string
25284 iso3Language:
25285 type: string
25286 language:
25287 type: string
25288 script:
25289 type: string
25290 unicodeLocaleAttributes:
25291 type: array
25292 items:
25293 type: string
25294 uniqueItems: true
25295 unicodeLocaleKeys:
25296 type: array
25297 items:
25298 type: string
25299 uniqueItems: true
25300 variant:
25301 type: string
25302 lastModified:
25303 type: string
25304 format: date-time
25305 length:
25306 type: integer
25307 format: int32
25308 links:
25309 type: array
25310 items:
25311 type: object
25312 properties:
25313 params:
25314 type: object
25315 additionalProperties:
25316 type: string
25317 rel:
25318 type: string
25319 rels:
25320 type: array
25321 items:
25322 type: string
25323 title:
25324 type: string
25325 type:
25326 type: string
25327 uri:
25328 type: string
25329 format: uri
25330 uriBuilder:
25331 type: object
25332 uniqueItems: true
25333 location:
25334 type: string
25335 format: uri
25336 mediaType:
25337 type: object
25338 properties:
25339 parameters:
25340 type: object
25341 additionalProperties:
25342 type: string
25343 subtype:
25344 type: string
25345 type:
25346 type: string
25347 wildcardSubtype:
25348 type: boolean
25349 wildcardType:
25350 type: boolean
25351 metadata:
25352 type: object
25353 additionalProperties:
25354 type: array
25355 items:
25356 type: object
25357 status:
25358 type: integer
25359 format: int32
25360 statusInfo:
25361 type: object
25362 properties:
25363 family:
25364 type: string
25365 enum:
25366 - INFORMATIONAL
25367 - SUCCESSFUL
25368 - REDIRECTION
25369 - CLIENT_ERROR
25370 - SERVER_ERROR
25371 - OTHER
25372 reasonPhrase:
25373 type: string
25374 statusCode:
25375 type: integer
25376 format: int32
25377 stringHeaders:
25378 type: object
25379 additionalProperties:
25380 type: array
25381 items:
25382 type: string
25383 servers:
25384 - url: /sdc2/rest
25385 variables: {}
25386 summary: Returns created ComponentInstance
25387 tags:
25388 - SDCE-2 APIs
25389 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate:
25390 post:
25391 description: Associate RI to RI
25392 operationId: associateRIToRI
25393 parameters:
25394 - description: unique id of the container component
25395 in: path
25396 name: componentId
25397 required: true
25398 schema:
25399 type: string
25400 - description: allowed values are resources /services / products
25401 in: path
25402 name: containerComponentType
25403 required: true
25404 schema:
25405 type: string
25406 enum:
25407 - resources
25408 - services
25409 - products
25410 - in: header
25411 name: USER_ID
25412 schema:
25413 type: string
25414 requestBody:
25415 content:
25416 application/json:
25417 schema:
25418 type: string
25419 description: RelationshipInfo
25420 required: true
25421 responses:
25422 "201":
25423 description: Relationship created
25424 "400":
25425 description: Invalid content / Missing content
25426 "403":
25427 description: Missing information
25428 "409":
25429 description: Relationship already exist
25430 default:
25431 content:
25432 application/json:
25433 schema:
25434 type: array
25435 items:
25436 type: object
25437 properties:
25438 allowedMethods:
25439 type: array
25440 items:
25441 type: string
25442 uniqueItems: true
25443 cookies:
25444 type: object
25445 additionalProperties:
25446 type: object
25447 properties:
25448 comment:
25449 type: string
25450 domain:
25451 type: string
25452 expiry:
25453 type: string
25454 format: date-time
25455 httpOnly:
25456 type: boolean
25457 maxAge:
25458 type: integer
25459 format: int32
25460 name:
25461 type: string
25462 path:
25463 type: string
25464 secure:
25465 type: boolean
25466 value:
25467 type: string
25468 version:
25469 type: integer
25470 format: int32
25471 date:
25472 type: string
25473 format: date-time
25474 entity:
25475 type: object
25476 entityTag:
25477 type: object
25478 properties:
25479 value:
25480 type: string
25481 weak:
25482 type: boolean
25483 headers:
25484 type: object
25485 additionalProperties:
25486 type: array
25487 items:
25488 type: object
25489 language:
25490 type: object
25491 properties:
25492 country:
25493 type: string
25494 displayCountry:
25495 type: string
25496 displayLanguage:
25497 type: string
25498 displayName:
25499 type: string
25500 displayScript:
25501 type: string
25502 displayVariant:
25503 type: string
25504 extensionKeys:
25505 type: array
25506 items:
25507 type: string
25508 uniqueItems: true
25509 iso3Country:
25510 type: string
25511 iso3Language:
25512 type: string
25513 language:
25514 type: string
25515 script:
25516 type: string
25517 unicodeLocaleAttributes:
25518 type: array
25519 items:
25520 type: string
25521 uniqueItems: true
25522 unicodeLocaleKeys:
25523 type: array
25524 items:
25525 type: string
25526 uniqueItems: true
25527 variant:
25528 type: string
25529 lastModified:
25530 type: string
25531 format: date-time
25532 length:
25533 type: integer
25534 format: int32
25535 links:
25536 type: array
25537 items:
25538 type: object
25539 properties:
25540 params:
25541 type: object
25542 additionalProperties:
25543 type: string
25544 rel:
25545 type: string
25546 rels:
25547 type: array
25548 items:
25549 type: string
25550 title:
25551 type: string
25552 type:
25553 type: string
25554 uri:
25555 type: string
25556 format: uri
25557 uriBuilder:
25558 type: object
25559 uniqueItems: true
25560 location:
25561 type: string
25562 format: uri
25563 mediaType:
25564 type: object
25565 properties:
25566 parameters:
25567 type: object
25568 additionalProperties:
25569 type: string
25570 subtype:
25571 type: string
25572 type:
25573 type: string
25574 wildcardSubtype:
25575 type: boolean
25576 wildcardType:
25577 type: boolean
25578 metadata:
25579 type: object
25580 additionalProperties:
25581 type: array
25582 items:
25583 type: object
25584 status:
25585 type: integer
25586 format: int32
25587 statusInfo:
25588 type: object
25589 properties:
25590 family:
25591 type: string
25592 enum:
25593 - INFORMATIONAL
25594 - SUCCESSFUL
25595 - REDIRECTION
25596 - CLIENT_ERROR
25597 - SERVER_ERROR
25598 - OTHER
25599 reasonPhrase:
25600 type: string
25601 statusCode:
25602 type: integer
25603 format: int32
25604 stringHeaders:
25605 type: object
25606 additionalProperties:
25607 type: array
25608 items:
25609 type: string
25610 servers:
25611 - url: /sdc2/rest
25612 variables: {}
25613 summary: Returns created RelationshipInfo
25614 tags:
25615 - SDCE-2 APIs
25616 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/batchDissociate:
25617 put:
25618 description: Batch Dissociate RI from RI
25619 operationId: batchDissociateRIFromRI
25620 parameters:
25621 - description: allowed values are resources/services/products
25622 in: path
25623 name: containerComponentType
25624 required: true
25625 schema:
25626 type: string
25627 enum:
25628 - resources
25629 - services
25630 - products
25631 - description: unique id of the container component
25632 in: path
25633 name: componentId
25634 required: true
25635 schema:
25636 type: string
25637 - in: header
25638 name: USER_ID
25639 schema:
25640 type: string
25641 requestBody:
25642 content:
25643 application/json:
25644 schema:
25645 type: string
25646 description: RelationshipInfo
25647 required: true
25648 responses:
25649 "201":
25650 description: Relationship deleted
25651 "400":
25652 description: Invalid Content / Missing Content
25653 "403":
25654 description: Missing Information
25655 default:
25656 content:
25657 application/json:
25658 schema:
25659 type: array
25660 items:
25661 type: object
25662 properties:
25663 allowedMethods:
25664 type: array
25665 items:
25666 type: string
25667 uniqueItems: true
25668 cookies:
25669 type: object
25670 additionalProperties:
25671 type: object
25672 properties:
25673 comment:
25674 type: string
25675 domain:
25676 type: string
25677 expiry:
25678 type: string
25679 format: date-time
25680 httpOnly:
25681 type: boolean
25682 maxAge:
25683 type: integer
25684 format: int32
25685 name:
25686 type: string
25687 path:
25688 type: string
25689 secure:
25690 type: boolean
25691 value:
25692 type: string
25693 version:
25694 type: integer
25695 format: int32
25696 date:
25697 type: string
25698 format: date-time
25699 entity:
25700 type: object
25701 entityTag:
25702 type: object
25703 properties:
25704 value:
25705 type: string
25706 weak:
25707 type: boolean
25708 headers:
25709 type: object
25710 additionalProperties:
25711 type: array
25712 items:
25713 type: object
25714 language:
25715 type: object
25716 properties:
25717 country:
25718 type: string
25719 displayCountry:
25720 type: string
25721 displayLanguage:
25722 type: string
25723 displayName:
25724 type: string
25725 displayScript:
25726 type: string
25727 displayVariant:
25728 type: string
25729 extensionKeys:
25730 type: array
25731 items:
25732 type: string
25733 uniqueItems: true
25734 iso3Country:
25735 type: string
25736 iso3Language:
25737 type: string
25738 language:
25739 type: string
25740 script:
25741 type: string
25742 unicodeLocaleAttributes:
25743 type: array
25744 items:
25745 type: string
25746 uniqueItems: true
25747 unicodeLocaleKeys:
25748 type: array
25749 items:
25750 type: string
25751 uniqueItems: true
25752 variant:
25753 type: string
25754 lastModified:
25755 type: string
25756 format: date-time
25757 length:
25758 type: integer
25759 format: int32
25760 links:
25761 type: array
25762 items:
25763 type: object
25764 properties:
25765 params:
25766 type: object
25767 additionalProperties:
25768 type: string
25769 rel:
25770 type: string
25771 rels:
25772 type: array
25773 items:
25774 type: string
25775 title:
25776 type: string
25777 type:
25778 type: string
25779 uri:
25780 type: string
25781 format: uri
25782 uriBuilder:
25783 type: object
25784 uniqueItems: true
25785 location:
25786 type: string
25787 format: uri
25788 mediaType:
25789 type: object
25790 properties:
25791 parameters:
25792 type: object
25793 additionalProperties:
25794 type: string
25795 subtype:
25796 type: string
25797 type:
25798 type: string
25799 wildcardSubtype:
25800 type: boolean
25801 wildcardType:
25802 type: boolean
25803 metadata:
25804 type: object
25805 additionalProperties:
25806 type: array
25807 items:
25808 type: object
25809 status:
25810 type: integer
25811 format: int32
25812 statusInfo:
25813 type: object
25814 properties:
25815 family:
25816 type: string
25817 enum:
25818 - INFORMATIONAL
25819 - SUCCESSFUL
25820 - REDIRECTION
25821 - CLIENT_ERROR
25822 - SERVER_ERROR
25823 - OTHER
25824 reasonPhrase:
25825 type: string
25826 statusCode:
25827 type: integer
25828 format: int32
25829 stringHeaders:
25830 type: object
25831 additionalProperties:
25832 type: array
25833 items:
25834 type: string
25835 servers:
25836 - url: /sdc2/rest
25837 variables: {}
25838 summary: Returns deleted RelationShip Info
25839 tags:
25840 - SDCE-2 APIs
25841 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate:
25842 post:
25843 description: Create RI and associate RI to RI
25844 operationId: createAndAssociateRIToRI
25845 parameters:
25846 - in: path
25847 name: componentId
25848 required: true
25849 schema:
25850 type: string
25851 - description: "valid values: resources / services"
25852 in: path
25853 name: containerComponentType
25854 required: true
25855 schema:
25856 type: string
25857 enum:
25858 - resources
25859 - services
25860 - products
25861 responses:
25862 "201":
25863 description: RI created
25864 "400":
25865 description: Invalid content / Missing content
25866 "403":
25867 description: Restricted operation
25868 "409":
25869 description: Relationship already exist
25870 default:
25871 content:
25872 application/json:
25873 schema:
25874 type: array
25875 items:
25876 type: object
25877 properties:
25878 allowedMethods:
25879 type: array
25880 items:
25881 type: string
25882 uniqueItems: true
25883 cookies:
25884 type: object
25885 additionalProperties:
25886 type: object
25887 properties:
25888 comment:
25889 type: string
25890 domain:
25891 type: string
25892 expiry:
25893 type: string
25894 format: date-time
25895 httpOnly:
25896 type: boolean
25897 maxAge:
25898 type: integer
25899 format: int32
25900 name:
25901 type: string
25902 path:
25903 type: string
25904 secure:
25905 type: boolean
25906 value:
25907 type: string
25908 version:
25909 type: integer
25910 format: int32
25911 date:
25912 type: string
25913 format: date-time
25914 entity:
25915 type: object
25916 entityTag:
25917 type: object
25918 properties:
25919 value:
25920 type: string
25921 weak:
25922 type: boolean
25923 headers:
25924 type: object
25925 additionalProperties:
25926 type: array
25927 items:
25928 type: object
25929 language:
25930 type: object
25931 properties:
25932 country:
25933 type: string
25934 displayCountry:
25935 type: string
25936 displayLanguage:
25937 type: string
25938 displayName:
25939 type: string
25940 displayScript:
25941 type: string
25942 displayVariant:
25943 type: string
25944 extensionKeys:
25945 type: array
25946 items:
25947 type: string
25948 uniqueItems: true
25949 iso3Country:
25950 type: string
25951 iso3Language:
25952 type: string
25953 language:
25954 type: string
25955 script:
25956 type: string
25957 unicodeLocaleAttributes:
25958 type: array
25959 items:
25960 type: string
25961 uniqueItems: true
25962 unicodeLocaleKeys:
25963 type: array
25964 items:
25965 type: string
25966 uniqueItems: true
25967 variant:
25968 type: string
25969 lastModified:
25970 type: string
25971 format: date-time
25972 length:
25973 type: integer
25974 format: int32
25975 links:
25976 type: array
25977 items:
25978 type: object
25979 properties:
25980 params:
25981 type: object
25982 additionalProperties:
25983 type: string
25984 rel:
25985 type: string
25986 rels:
25987 type: array
25988 items:
25989 type: string
25990 title:
25991 type: string
25992 type:
25993 type: string
25994 uri:
25995 type: string
25996 format: uri
25997 uriBuilder:
25998 type: object
25999 uniqueItems: true
26000 location:
26001 type: string
26002 format: uri
26003 mediaType:
26004 type: object
26005 properties:
26006 parameters:
26007 type: object
26008 additionalProperties:
26009 type: string
26010 subtype:
26011 type: string
26012 type:
26013 type: string
26014 wildcardSubtype:
26015 type: boolean
26016 wildcardType:
26017 type: boolean
26018 metadata:
26019 type: object
26020 additionalProperties:
26021 type: array
26022 items:
26023 type: object
26024 status:
26025 type: integer
26026 format: int32
26027 statusInfo:
26028 type: object
26029 properties:
26030 family:
26031 type: string
26032 enum:
26033 - INFORMATIONAL
26034 - SUCCESSFUL
26035 - REDIRECTION
26036 - CLIENT_ERROR
26037 - SERVER_ERROR
26038 - OTHER
26039 reasonPhrase:
26040 type: string
26041 statusCode:
26042 type: integer
26043 format: int32
26044 stringHeaders:
26045 type: object
26046 additionalProperties:
26047 type: array
26048 items:
26049 type: string
26050 servers:
26051 - url: /sdc2/rest
26052 variables: {}
26053 summary: Returns created RI and RelationshipInfo
26054 tags:
26055 - SDCE-2 APIs
26056 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/dissociate:
26057 put:
26058 description: Dissociate RI from RI
26059 operationId: dissociateRIFromRI
26060 parameters:
26061 - description: allowed values are resources /services / products
26062 in: path
26063 name: containerComponentType
26064 required: true
26065 schema:
26066 type: string
26067 enum:
26068 - resources
26069 - services
26070 - products
26071 - description: unique id of the container component
26072 in: path
26073 name: componentId
26074 required: true
26075 schema:
26076 type: string
26077 - in: header
26078 name: USER_ID
26079 schema:
26080 type: string
26081 requestBody:
26082 content:
26083 application/json:
26084 schema:
26085 type: string
26086 description: RelationshipInfo
26087 required: true
26088 responses:
26089 "201":
26090 description: Relationship deleted
26091 "400":
26092 description: Invalid content / Missing content
26093 "403":
26094 description: Missing information
26095 default:
26096 content:
26097 application/json:
26098 schema:
26099 type: array
26100 items:
26101 type: object
26102 properties:
26103 allowedMethods:
26104 type: array
26105 items:
26106 type: string
26107 uniqueItems: true
26108 cookies:
26109 type: object
26110 additionalProperties:
26111 type: object
26112 properties:
26113 comment:
26114 type: string
26115 domain:
26116 type: string
26117 expiry:
26118 type: string
26119 format: date-time
26120 httpOnly:
26121 type: boolean
26122 maxAge:
26123 type: integer
26124 format: int32
26125 name:
26126 type: string
26127 path:
26128 type: string
26129 secure:
26130 type: boolean
26131 value:
26132 type: string
26133 version:
26134 type: integer
26135 format: int32
26136 date:
26137 type: string
26138 format: date-time
26139 entity:
26140 type: object
26141 entityTag:
26142 type: object
26143 properties:
26144 value:
26145 type: string
26146 weak:
26147 type: boolean
26148 headers:
26149 type: object
26150 additionalProperties:
26151 type: array
26152 items:
26153 type: object
26154 language:
26155 type: object
26156 properties:
26157 country:
26158 type: string
26159 displayCountry:
26160 type: string
26161 displayLanguage:
26162 type: string
26163 displayName:
26164 type: string
26165 displayScript:
26166 type: string
26167 displayVariant:
26168 type: string
26169 extensionKeys:
26170 type: array
26171 items:
26172 type: string
26173 uniqueItems: true
26174 iso3Country:
26175 type: string
26176 iso3Language:
26177 type: string
26178 language:
26179 type: string
26180 script:
26181 type: string
26182 unicodeLocaleAttributes:
26183 type: array
26184 items:
26185 type: string
26186 uniqueItems: true
26187 unicodeLocaleKeys:
26188 type: array
26189 items:
26190 type: string
26191 uniqueItems: true
26192 variant:
26193 type: string
26194 lastModified:
26195 type: string
26196 format: date-time
26197 length:
26198 type: integer
26199 format: int32
26200 links:
26201 type: array
26202 items:
26203 type: object
26204 properties:
26205 params:
26206 type: object
26207 additionalProperties:
26208 type: string
26209 rel:
26210 type: string
26211 rels:
26212 type: array
26213 items:
26214 type: string
26215 title:
26216 type: string
26217 type:
26218 type: string
26219 uri:
26220 type: string
26221 format: uri
26222 uriBuilder:
26223 type: object
26224 uniqueItems: true
26225 location:
26226 type: string
26227 format: uri
26228 mediaType:
26229 type: object
26230 properties:
26231 parameters:
26232 type: object
26233 additionalProperties:
26234 type: string
26235 subtype:
26236 type: string
26237 type:
26238 type: string
26239 wildcardSubtype:
26240 type: boolean
26241 wildcardType:
26242 type: boolean
26243 metadata:
26244 type: object
26245 additionalProperties:
26246 type: array
26247 items:
26248 type: object
26249 status:
26250 type: integer
26251 format: int32
26252 statusInfo:
26253 type: object
26254 properties:
26255 family:
26256 type: string
26257 enum:
26258 - INFORMATIONAL
26259 - SUCCESSFUL
26260 - REDIRECTION
26261 - CLIENT_ERROR
26262 - SERVER_ERROR
26263 - OTHER
26264 reasonPhrase:
26265 type: string
26266 statusCode:
26267 type: integer
26268 format: int32
26269 stringHeaders:
26270 type: object
26271 additionalProperties:
26272 type: array
26273 items:
26274 type: string
26275 servers:
26276 - url: /sdc2/rest
26277 variables: {}
26278 summary: Returns deleted RelationshipInfo
26279 tags:
26280 - SDCE-2 APIs
26281 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance:
26282 post:
26283 description: Update resource instance multiple component
26284 operationId: updateMultipleComponentInstance
26285 parameters:
26286 - in: path
26287 name: componentId
26288 required: true
26289 schema:
26290 type: string
26291 - description: "valid values: resources / services / products"
26292 in: path
26293 name: containerComponentType
26294 required: true
26295 schema:
26296 type: string
26297 enum:
26298 - resources
26299 - services
26300 - products
26301 requestBody:
26302 content:
26303 application/json:
26304 schema:
26305 type: string
26306 description: Component Instance JSON Array
26307 required: true
26308 responses:
26309 "200":
26310 description: Resource instance updated
26311 "400":
26312 description: Invalid content / Missing content
26313 "403":
26314 description: Restricted operation
26315 default:
26316 content:
26317 application/json:
26318 schema:
26319 type: array
26320 items:
26321 type: object
26322 properties:
26323 allowedMethods:
26324 type: array
26325 items:
26326 type: string
26327 uniqueItems: true
26328 cookies:
26329 type: object
26330 additionalProperties:
26331 type: object
26332 properties:
26333 comment:
26334 type: string
26335 domain:
26336 type: string
26337 expiry:
26338 type: string
26339 format: date-time
26340 httpOnly:
26341 type: boolean
26342 maxAge:
26343 type: integer
26344 format: int32
26345 name:
26346 type: string
26347 path:
26348 type: string
26349 secure:
26350 type: boolean
26351 value:
26352 type: string
26353 version:
26354 type: integer
26355 format: int32
26356 date:
26357 type: string
26358 format: date-time
26359 entity:
26360 type: object
26361 entityTag:
26362 type: object
26363 properties:
26364 value:
26365 type: string
26366 weak:
26367 type: boolean
26368 headers:
26369 type: object
26370 additionalProperties:
26371 type: array
26372 items:
26373 type: object
26374 language:
26375 type: object
26376 properties:
26377 country:
26378 type: string
26379 displayCountry:
26380 type: string
26381 displayLanguage:
26382 type: string
26383 displayName:
26384 type: string
26385 displayScript:
26386 type: string
26387 displayVariant:
26388 type: string
26389 extensionKeys:
26390 type: array
26391 items:
26392 type: string
26393 uniqueItems: true
26394 iso3Country:
26395 type: string
26396 iso3Language:
26397 type: string
26398 language:
26399 type: string
26400 script:
26401 type: string
26402 unicodeLocaleAttributes:
26403 type: array
26404 items:
26405 type: string
26406 uniqueItems: true
26407 unicodeLocaleKeys:
26408 type: array
26409 items:
26410 type: string
26411 uniqueItems: true
26412 variant:
26413 type: string
26414 lastModified:
26415 type: string
26416 format: date-time
26417 length:
26418 type: integer
26419 format: int32
26420 links:
26421 type: array
26422 items:
26423 type: object
26424 properties:
26425 params:
26426 type: object
26427 additionalProperties:
26428 type: string
26429 rel:
26430 type: string
26431 rels:
26432 type: array
26433 items:
26434 type: string
26435 title:
26436 type: string
26437 type:
26438 type: string
26439 uri:
26440 type: string
26441 format: uri
26442 uriBuilder:
26443 type: object
26444 uniqueItems: true
26445 location:
26446 type: string
26447 format: uri
26448 mediaType:
26449 type: object
26450 properties:
26451 parameters:
26452 type: object
26453 additionalProperties:
26454 type: string
26455 subtype:
26456 type: string
26457 type:
26458 type: string
26459 wildcardSubtype:
26460 type: boolean
26461 wildcardType:
26462 type: boolean
26463 metadata:
26464 type: object
26465 additionalProperties:
26466 type: array
26467 items:
26468 type: object
26469 status:
26470 type: integer
26471 format: int32
26472 statusInfo:
26473 type: object
26474 properties:
26475 family:
26476 type: string
26477 enum:
26478 - INFORMATIONAL
26479 - SUCCESSFUL
26480 - REDIRECTION
26481 - CLIENT_ERROR
26482 - SERVER_ERROR
26483 - OTHER
26484 reasonPhrase:
26485 type: string
26486 statusCode:
26487 type: integer
26488 format: int32
26489 stringHeaders:
26490 type: object
26491 additionalProperties:
26492 type: array
26493 items:
26494 type: string
26495 servers:
26496 - url: /sdc2/rest
26497 variables: {}
26498 summary: Returns updated resource instance
26499 tags:
26500 - SDCE-2 APIs
26501 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}:
26502 post:
26503 description: Update resource instance
26504 operationId: updateComponentInstanceMetadata
26505 parameters:
26506 - in: path
26507 name: componentId
26508 required: true
26509 schema:
26510 type: string
26511 - in: path
26512 name: componentInstanceId
26513 required: true
26514 schema:
26515 type: string
26516 - description: "valid values: resources / services / products"
26517 in: path
26518 name: containerComponentType
26519 required: true
26520 schema:
26521 type: string
26522 enum:
26523 - resources
26524 - services
26525 - products
26526 responses:
26527 "200":
26528 description: Resource instance updated
26529 "400":
26530 description: Invalid content / Missing content
26531 "403":
26532 description: Restricted operation
26533 default:
26534 content:
26535 application/json:
26536 schema:
26537 type: array
26538 items:
26539 type: object
26540 properties:
26541 allowedMethods:
26542 type: array
26543 items:
26544 type: string
26545 uniqueItems: true
26546 cookies:
26547 type: object
26548 additionalProperties:
26549 type: object
26550 properties:
26551 comment:
26552 type: string
26553 domain:
26554 type: string
26555 expiry:
26556 type: string
26557 format: date-time
26558 httpOnly:
26559 type: boolean
26560 maxAge:
26561 type: integer
26562 format: int32
26563 name:
26564 type: string
26565 path:
26566 type: string
26567 secure:
26568 type: boolean
26569 value:
26570 type: string
26571 version:
26572 type: integer
26573 format: int32
26574 date:
26575 type: string
26576 format: date-time
26577 entity:
26578 type: object
26579 entityTag:
26580 type: object
26581 properties:
26582 value:
26583 type: string
26584 weak:
26585 type: boolean
26586 headers:
26587 type: object
26588 additionalProperties:
26589 type: array
26590 items:
26591 type: object
26592 language:
26593 type: object
26594 properties:
26595 country:
26596 type: string
26597 displayCountry:
26598 type: string
26599 displayLanguage:
26600 type: string
26601 displayName:
26602 type: string
26603 displayScript:
26604 type: string
26605 displayVariant:
26606 type: string
26607 extensionKeys:
26608 type: array
26609 items:
26610 type: string
26611 uniqueItems: true
26612 iso3Country:
26613 type: string
26614 iso3Language:
26615 type: string
26616 language:
26617 type: string
26618 script:
26619 type: string
26620 unicodeLocaleAttributes:
26621 type: array
26622 items:
26623 type: string
26624 uniqueItems: true
26625 unicodeLocaleKeys:
26626 type: array
26627 items:
26628 type: string
26629 uniqueItems: true
26630 variant:
26631 type: string
26632 lastModified:
26633 type: string
26634 format: date-time
26635 length:
26636 type: integer
26637 format: int32
26638 links:
26639 type: array
26640 items:
26641 type: object
26642 properties:
26643 params:
26644 type: object
26645 additionalProperties:
26646 type: string
26647 rel:
26648 type: string
26649 rels:
26650 type: array
26651 items:
26652 type: string
26653 title:
26654 type: string
26655 type:
26656 type: string
26657 uri:
26658 type: string
26659 format: uri
26660 uriBuilder:
26661 type: object
26662 uniqueItems: true
26663 location:
26664 type: string
26665 format: uri
26666 mediaType:
26667 type: object
26668 properties:
26669 parameters:
26670 type: object
26671 additionalProperties:
26672 type: string
26673 subtype:
26674 type: string
26675 type:
26676 type: string
26677 wildcardSubtype:
26678 type: boolean
26679 wildcardType:
26680 type: boolean
26681 metadata:
26682 type: object
26683 additionalProperties:
26684 type: array
26685 items:
26686 type: object
26687 status:
26688 type: integer
26689 format: int32
26690 statusInfo:
26691 type: object
26692 properties:
26693 family:
26694 type: string
26695 enum:
26696 - INFORMATIONAL
26697 - SUCCESSFUL
26698 - REDIRECTION
26699 - CLIENT_ERROR
26700 - SERVER_ERROR
26701 - OTHER
26702 reasonPhrase:
26703 type: string
26704 statusCode:
26705 type: integer
26706 format: int32
26707 stringHeaders:
26708 type: object
26709 additionalProperties:
26710 type: array
26711 items:
26712 type: string
26713 servers:
26714 - url: /sdc2/rest
26715 variables: {}
26716 summary: Returns updated resource instance
26717 tags:
26718 - SDCE-2 APIs
26719 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts:
26720 post:
26721 description: Load Resource Instance artifact payload
26722 operationId: loadComponentInstanceArtifact
26723 parameters:
26724 - in: header
26725 name: USER_ID
26726 schema:
26727 type: string
26728 - in: header
26729 name: Content-MD5
26730 schema:
26731 type: string
26732 - description: "valid values: resources / services"
26733 in: path
26734 name: containerComponentType
26735 required: true
26736 schema:
26737 type: string
26738 enum:
26739 - resources
26740 - services
26741 - in: path
26742 name: componentId
26743 required: true
26744 schema:
26745 type: string
26746 - in: path
26747 name: componentInstanceId
26748 required: true
26749 schema:
26750 type: string
26751 requestBody:
26752 content:
26753 application/json:
26754 schema:
26755 type: string
26756 description: json describe the artifact
26757 required: true
26758 responses:
26759 "200":
26760 description: Artifact updated
26761 "400":
26762 description: Invalid content / Missing content
26763 "403":
26764 description: Restricted operation
26765 default:
26766 content:
26767 application/json:
26768 schema:
26769 type: array
26770 items:
26771 type: object
26772 properties:
26773 allowedMethods:
26774 type: array
26775 items:
26776 type: string
26777 uniqueItems: true
26778 cookies:
26779 type: object
26780 additionalProperties:
26781 type: object
26782 properties:
26783 comment:
26784 type: string
26785 domain:
26786 type: string
26787 expiry:
26788 type: string
26789 format: date-time
26790 httpOnly:
26791 type: boolean
26792 maxAge:
26793 type: integer
26794 format: int32
26795 name:
26796 type: string
26797 path:
26798 type: string
26799 secure:
26800 type: boolean
26801 value:
26802 type: string
26803 version:
26804 type: integer
26805 format: int32
26806 date:
26807 type: string
26808 format: date-time
26809 entity:
26810 type: object
26811 entityTag:
26812 type: object
26813 properties:
26814 value:
26815 type: string
26816 weak:
26817 type: boolean
26818 headers:
26819 type: object
26820 additionalProperties:
26821 type: array
26822 items:
26823 type: object
26824 language:
26825 type: object
26826 properties:
26827 country:
26828 type: string
26829 displayCountry:
26830 type: string
26831 displayLanguage:
26832 type: string
26833 displayName:
26834 type: string
26835 displayScript:
26836 type: string
26837 displayVariant:
26838 type: string
26839 extensionKeys:
26840 type: array
26841 items:
26842 type: string
26843 uniqueItems: true
26844 iso3Country:
26845 type: string
26846 iso3Language:
26847 type: string
26848 language:
26849 type: string
26850 script:
26851 type: string
26852 unicodeLocaleAttributes:
26853 type: array
26854 items:
26855 type: string
26856 uniqueItems: true
26857 unicodeLocaleKeys:
26858 type: array
26859 items:
26860 type: string
26861 uniqueItems: true
26862 variant:
26863 type: string
26864 lastModified:
26865 type: string
26866 format: date-time
26867 length:
26868 type: integer
26869 format: int32
26870 links:
26871 type: array
26872 items:
26873 type: object
26874 properties:
26875 params:
26876 type: object
26877 additionalProperties:
26878 type: string
26879 rel:
26880 type: string
26881 rels:
26882 type: array
26883 items:
26884 type: string
26885 title:
26886 type: string
26887 type:
26888 type: string
26889 uri:
26890 type: string
26891 format: uri
26892 uriBuilder:
26893 type: object
26894 uniqueItems: true
26895 location:
26896 type: string
26897 format: uri
26898 mediaType:
26899 type: object
26900 properties:
26901 parameters:
26902 type: object
26903 additionalProperties:
26904 type: string
26905 subtype:
26906 type: string
26907 type:
26908 type: string
26909 wildcardSubtype:
26910 type: boolean
26911 wildcardType:
26912 type: boolean
26913 metadata:
26914 type: object
26915 additionalProperties:
26916 type: array
26917 items:
26918 type: object
26919 status:
26920 type: integer
26921 format: int32
26922 statusInfo:
26923 type: object
26924 properties:
26925 family:
26926 type: string
26927 enum:
26928 - INFORMATIONAL
26929 - SUCCESSFUL
26930 - REDIRECTION
26931 - CLIENT_ERROR
26932 - SERVER_ERROR
26933 - OTHER
26934 reasonPhrase:
26935 type: string
26936 statusCode:
26937 type: integer
26938 format: int32
26939 stringHeaders:
26940 type: object
26941 additionalProperties:
26942 type: array
26943 items:
26944 type: string
26945 servers:
26946 - url: /sdc2/rest
26947 variables: {}
26948 summary: Returns updated artifact
26949 tags:
26950 - SDCE-2 APIs
26951 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}:
26952 delete:
26953 description: Delete Resource Instance artifact
26954 operationId: deleteComponentInstanceArtifact
26955 parameters:
26956 - in: header
26957 name: USER_ID
26958 schema:
26959 type: string
26960 - in: header
26961 name: Content-MD5
26962 schema:
26963 type: string
26964 - description: "valid values: resources / services"
26965 in: path
26966 name: containerComponentType
26967 required: true
26968 schema:
26969 type: string
26970 enum:
26971 - resources
26972 - services
26973 - in: path
26974 name: componentId
26975 required: true
26976 schema:
26977 type: string
26978 - in: path
26979 name: componentInstanceId
26980 required: true
26981 schema:
26982 type: string
26983 - in: path
26984 name: artifactId
26985 required: true
26986 schema:
26987 type: string
26988 requestBody:
26989 content:
26990 application/json:
26991 schema:
26992 type: string
26993 description: json describe the artifact
26994 required: true
26995 responses:
26996 "200":
26997 description: Artifact updated
26998 "400":
26999 description: Invalid content / Missing content
27000 "403":
27001 description: Restricted operation
27002 default:
27003 content:
27004 application/json:
27005 schema:
27006 type: array
27007 items:
27008 type: object
27009 properties:
27010 allowedMethods:
27011 type: array
27012 items:
27013 type: string
27014 uniqueItems: true
27015 cookies:
27016 type: object
27017 additionalProperties:
27018 type: object
27019 properties:
27020 comment:
27021 type: string
27022 domain:
27023 type: string
27024 expiry:
27025 type: string
27026 format: date-time
27027 httpOnly:
27028 type: boolean
27029 maxAge:
27030 type: integer
27031 format: int32
27032 name:
27033 type: string
27034 path:
27035 type: string
27036 secure:
27037 type: boolean
27038 value:
27039 type: string
27040 version:
27041 type: integer
27042 format: int32
27043 date:
27044 type: string
27045 format: date-time
27046 entity:
27047 type: object
27048 entityTag:
27049 type: object
27050 properties:
27051 value:
27052 type: string
27053 weak:
27054 type: boolean
27055 headers:
27056 type: object
27057 additionalProperties:
27058 type: array
27059 items:
27060 type: object
27061 language:
27062 type: object
27063 properties:
27064 country:
27065 type: string
27066 displayCountry:
27067 type: string
27068 displayLanguage:
27069 type: string
27070 displayName:
27071 type: string
27072 displayScript:
27073 type: string
27074 displayVariant:
27075 type: string
27076 extensionKeys:
27077 type: array
27078 items:
27079 type: string
27080 uniqueItems: true
27081 iso3Country:
27082 type: string
27083 iso3Language:
27084 type: string
27085 language:
27086 type: string
27087 script:
27088 type: string
27089 unicodeLocaleAttributes:
27090 type: array
27091 items:
27092 type: string
27093 uniqueItems: true
27094 unicodeLocaleKeys:
27095 type: array
27096 items:
27097 type: string
27098 uniqueItems: true
27099 variant:
27100 type: string
27101 lastModified:
27102 type: string
27103 format: date-time
27104 length:
27105 type: integer
27106 format: int32
27107 links:
27108 type: array
27109 items:
27110 type: object
27111 properties:
27112 params:
27113 type: object
27114 additionalProperties:
27115 type: string
27116 rel:
27117 type: string
27118 rels:
27119 type: array
27120 items:
27121 type: string
27122 title:
27123 type: string
27124 type:
27125 type: string
27126 uri:
27127 type: string
27128 format: uri
27129 uriBuilder:
27130 type: object
27131 uniqueItems: true
27132 location:
27133 type: string
27134 format: uri
27135 mediaType:
27136 type: object
27137 properties:
27138 parameters:
27139 type: object
27140 additionalProperties:
27141 type: string
27142 subtype:
27143 type: string
27144 type:
27145 type: string
27146 wildcardSubtype:
27147 type: boolean
27148 wildcardType:
27149 type: boolean
27150 metadata:
27151 type: object
27152 additionalProperties:
27153 type: array
27154 items:
27155 type: object
27156 status:
27157 type: integer
27158 format: int32
27159 statusInfo:
27160 type: object
27161 properties:
27162 family:
27163 type: string
27164 enum:
27165 - INFORMATIONAL
27166 - SUCCESSFUL
27167 - REDIRECTION
27168 - CLIENT_ERROR
27169 - SERVER_ERROR
27170 - OTHER
27171 reasonPhrase:
27172 type: string
27173 statusCode:
27174 type: integer
27175 format: int32
27176 stringHeaders:
27177 type: object
27178 additionalProperties:
27179 type: array
27180 items:
27181 type: string
27182 servers:
27183 - url: /sdc2/rest
27184 variables: {}
27185 summary: Returns deleted artifact
27186 tags:
27187 - SDCE-2 APIs
27188 post:
27189 description: Update Resource Instance artifact payload
27190 operationId: updateComponentInstanceArtifact
27191 parameters:
27192 - in: header
27193 name: USER_ID
27194 schema:
27195 type: string
27196 - in: header
27197 name: Content-MD5
27198 schema:
27199 type: string
27200 - description: "valid values: resources / services"
27201 in: path
27202 name: containerComponentType
27203 required: true
27204 schema:
27205 type: string
27206 enum:
27207 - resources
27208 - services
27209 - in: path
27210 name: componentId
27211 required: true
27212 schema:
27213 type: string
27214 - in: path
27215 name: componentInstanceId
27216 required: true
27217 schema:
27218 type: string
27219 - in: path
27220 name: artifactId
27221 required: true
27222 schema:
27223 type: string
27224 requestBody:
27225 content:
27226 application/json:
27227 schema:
27228 type: string
27229 description: json describe the artifact
27230 required: true
27231 responses:
27232 "200":
27233 description: Artifact updated
27234 "400":
27235 description: Invalid content / Missing content
27236 "403":
27237 description: Restricted operation
27238 default:
27239 content:
27240 application/json:
27241 schema:
27242 type: array
27243 items:
27244 type: object
27245 properties:
27246 allowedMethods:
27247 type: array
27248 items:
27249 type: string
27250 uniqueItems: true
27251 cookies:
27252 type: object
27253 additionalProperties:
27254 type: object
27255 properties:
27256 comment:
27257 type: string
27258 domain:
27259 type: string
27260 expiry:
27261 type: string
27262 format: date-time
27263 httpOnly:
27264 type: boolean
27265 maxAge:
27266 type: integer
27267 format: int32
27268 name:
27269 type: string
27270 path:
27271 type: string
27272 secure:
27273 type: boolean
27274 value:
27275 type: string
27276 version:
27277 type: integer
27278 format: int32
27279 date:
27280 type: string
27281 format: date-time
27282 entity:
27283 type: object
27284 entityTag:
27285 type: object
27286 properties:
27287 value:
27288 type: string
27289 weak:
27290 type: boolean
27291 headers:
27292 type: object
27293 additionalProperties:
27294 type: array
27295 items:
27296 type: object
27297 language:
27298 type: object
27299 properties:
27300 country:
27301 type: string
27302 displayCountry:
27303 type: string
27304 displayLanguage:
27305 type: string
27306 displayName:
27307 type: string
27308 displayScript:
27309 type: string
27310 displayVariant:
27311 type: string
27312 extensionKeys:
27313 type: array
27314 items:
27315 type: string
27316 uniqueItems: true
27317 iso3Country:
27318 type: string
27319 iso3Language:
27320 type: string
27321 language:
27322 type: string
27323 script:
27324 type: string
27325 unicodeLocaleAttributes:
27326 type: array
27327 items:
27328 type: string
27329 uniqueItems: true
27330 unicodeLocaleKeys:
27331 type: array
27332 items:
27333 type: string
27334 uniqueItems: true
27335 variant:
27336 type: string
27337 lastModified:
27338 type: string
27339 format: date-time
27340 length:
27341 type: integer
27342 format: int32
27343 links:
27344 type: array
27345 items:
27346 type: object
27347 properties:
27348 params:
27349 type: object
27350 additionalProperties:
27351 type: string
27352 rel:
27353 type: string
27354 rels:
27355 type: array
27356 items:
27357 type: string
27358 title:
27359 type: string
27360 type:
27361 type: string
27362 uri:
27363 type: string
27364 format: uri
27365 uriBuilder:
27366 type: object
27367 uniqueItems: true
27368 location:
27369 type: string
27370 format: uri
27371 mediaType:
27372 type: object
27373 properties:
27374 parameters:
27375 type: object
27376 additionalProperties:
27377 type: string
27378 subtype:
27379 type: string
27380 type:
27381 type: string
27382 wildcardSubtype:
27383 type: boolean
27384 wildcardType:
27385 type: boolean
27386 metadata:
27387 type: object
27388 additionalProperties:
27389 type: array
27390 items:
27391 type: object
27392 status:
27393 type: integer
27394 format: int32
27395 statusInfo:
27396 type: object
27397 properties:
27398 family:
27399 type: string
27400 enum:
27401 - INFORMATIONAL
27402 - SUCCESSFUL
27403 - REDIRECTION
27404 - CLIENT_ERROR
27405 - SERVER_ERROR
27406 - OTHER
27407 reasonPhrase:
27408 type: string
27409 statusCode:
27410 type: integer
27411 format: int32
27412 stringHeaders:
27413 type: object
27414 additionalProperties:
27415 type: array
27416 items:
27417 type: string
27418 servers:
27419 - url: /sdc2/rest
27420 variables: {}
27421 summary: Returns updated artifact
27422 tags:
27423 - SDCE-2 APIs
27424 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams:
27425 post:
27426 description: Update Resource Instance HEAT_ENV parameters
27427 operationId: updateRIArtifact
27428 parameters:
27429 - description: "valid values: resources / services"
27430 in: path
27431 name: containerComponentType
27432 required: true
27433 schema:
27434 type: string
27435 enum:
27436 - resources
27437 - services
27438 - in: path
27439 name: componentId
27440 required: true
27441 schema:
27442 type: string
27443 - in: path
27444 name: componentInstanceId
27445 required: true
27446 schema:
27447 type: string
27448 - in: path
27449 name: artifactId
27450 required: true
27451 schema:
27452 type: string
27453 requestBody:
27454 content:
27455 application/json:
27456 schema:
27457 type: string
27458 description: json describe the artifact
27459 required: true
27460 responses:
27461 "200":
27462 description: Artifact updated
27463 "400":
27464 description: Invalid content / Missing content
27465 "403":
27466 description: Restricted operation
27467 default:
27468 content:
27469 application/json:
27470 schema:
27471 type: array
27472 items:
27473 type: object
27474 properties:
27475 allowedMethods:
27476 type: array
27477 items:
27478 type: string
27479 uniqueItems: true
27480 cookies:
27481 type: object
27482 additionalProperties:
27483 type: object
27484 properties:
27485 comment:
27486 type: string
27487 domain:
27488 type: string
27489 expiry:
27490 type: string
27491 format: date-time
27492 httpOnly:
27493 type: boolean
27494 maxAge:
27495 type: integer
27496 format: int32
27497 name:
27498 type: string
27499 path:
27500 type: string
27501 secure:
27502 type: boolean
27503 value:
27504 type: string
27505 version:
27506 type: integer
27507 format: int32
27508 date:
27509 type: string
27510 format: date-time
27511 entity:
27512 type: object
27513 entityTag:
27514 type: object
27515 properties:
27516 value:
27517 type: string
27518 weak:
27519 type: boolean
27520 headers:
27521 type: object
27522 additionalProperties:
27523 type: array
27524 items:
27525 type: object
27526 language:
27527 type: object
27528 properties:
27529 country:
27530 type: string
27531 displayCountry:
27532 type: string
27533 displayLanguage:
27534 type: string
27535 displayName:
27536 type: string
27537 displayScript:
27538 type: string
27539 displayVariant:
27540 type: string
27541 extensionKeys:
27542 type: array
27543 items:
27544 type: string
27545 uniqueItems: true
27546 iso3Country:
27547 type: string
27548 iso3Language:
27549 type: string
27550 language:
27551 type: string
27552 script:
27553 type: string
27554 unicodeLocaleAttributes:
27555 type: array
27556 items:
27557 type: string
27558 uniqueItems: true
27559 unicodeLocaleKeys:
27560 type: array
27561 items:
27562 type: string
27563 uniqueItems: true
27564 variant:
27565 type: string
27566 lastModified:
27567 type: string
27568 format: date-time
27569 length:
27570 type: integer
27571 format: int32
27572 links:
27573 type: array
27574 items:
27575 type: object
27576 properties:
27577 params:
27578 type: object
27579 additionalProperties:
27580 type: string
27581 rel:
27582 type: string
27583 rels:
27584 type: array
27585 items:
27586 type: string
27587 title:
27588 type: string
27589 type:
27590 type: string
27591 uri:
27592 type: string
27593 format: uri
27594 uriBuilder:
27595 type: object
27596 uniqueItems: true
27597 location:
27598 type: string
27599 format: uri
27600 mediaType:
27601 type: object
27602 properties:
27603 parameters:
27604 type: object
27605 additionalProperties:
27606 type: string
27607 subtype:
27608 type: string
27609 type:
27610 type: string
27611 wildcardSubtype:
27612 type: boolean
27613 wildcardType:
27614 type: boolean
27615 metadata:
27616 type: object
27617 additionalProperties:
27618 type: array
27619 items:
27620 type: object
27621 status:
27622 type: integer
27623 format: int32
27624 statusInfo:
27625 type: object
27626 properties:
27627 family:
27628 type: string
27629 enum:
27630 - INFORMATIONAL
27631 - SUCCESSFUL
27632 - REDIRECTION
27633 - CLIENT_ERROR
27634 - SERVER_ERROR
27635 - OTHER
27636 reasonPhrase:
27637 type: string
27638 statusCode:
27639 type: integer
27640 format: int32
27641 stringHeaders:
27642 type: object
27643 additionalProperties:
27644 type: array
27645 items:
27646 type: string
27647 servers:
27648 - url: /sdc2/rest
27649 variables: {}
27650 summary: Returns updated artifact
27651 tags:
27652 - SDCE-2 APIs
27653 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attributes:
27654 post:
27655 description: Update resource instance attribute
27656 operationId: updateResourceInstanceAttribute
27657 parameters:
27658 - description: service id
27659 in: path
27660 name: componentId
27661 required: true
27662 schema:
27663 type: string
27664 - description: "valid values: resources / services"
27665 in: path
27666 name: containerComponentType
27667 required: true
27668 schema:
27669 type: string
27670 enum:
27671 - resources
27672 - services
27673 - description: resource instance id
27674 in: path
27675 name: componentInstanceId
27676 required: true
27677 schema:
27678 type: string
27679 - description: id of user initiating the operation
27680 in: header
27681 name: USER_ID
27682 schema:
27683 type: string
27684 requestBody:
27685 content:
27686 application/json:
27687 schema:
27688 type: string
27689 description: Component Instance Properties JSON Array
27690 required: true
27691 responses:
27692 "201":
27693 description: Resource instance created
27694 "400":
27695 description: Invalid content / Missing content
27696 "403":
27697 description: Restricted operation
27698 default:
27699 content:
27700 application/json:
27701 schema:
27702 type: array
27703 items:
27704 type: object
27705 properties:
27706 allowedMethods:
27707 type: array
27708 items:
27709 type: string
27710 uniqueItems: true
27711 cookies:
27712 type: object
27713 additionalProperties:
27714 type: object
27715 properties:
27716 comment:
27717 type: string
27718 domain:
27719 type: string
27720 expiry:
27721 type: string
27722 format: date-time
27723 httpOnly:
27724 type: boolean
27725 maxAge:
27726 type: integer
27727 format: int32
27728 name:
27729 type: string
27730 path:
27731 type: string
27732 secure:
27733 type: boolean
27734 value:
27735 type: string
27736 version:
27737 type: integer
27738 format: int32
27739 date:
27740 type: string
27741 format: date-time
27742 entity:
27743 type: object
27744 entityTag:
27745 type: object
27746 properties:
27747 value:
27748 type: string
27749 weak:
27750 type: boolean
27751 headers:
27752 type: object
27753 additionalProperties:
27754 type: array
27755 items:
27756 type: object
27757 language:
27758 type: object
27759 properties:
27760 country:
27761 type: string
27762 displayCountry:
27763 type: string
27764 displayLanguage:
27765 type: string
27766 displayName:
27767 type: string
27768 displayScript:
27769 type: string
27770 displayVariant:
27771 type: string
27772 extensionKeys:
27773 type: array
27774 items:
27775 type: string
27776 uniqueItems: true
27777 iso3Country:
27778 type: string
27779 iso3Language:
27780 type: string
27781 language:
27782 type: string
27783 script:
27784 type: string
27785 unicodeLocaleAttributes:
27786 type: array
27787 items:
27788 type: string
27789 uniqueItems: true
27790 unicodeLocaleKeys:
27791 type: array
27792 items:
27793 type: string
27794 uniqueItems: true
27795 variant:
27796 type: string
27797 lastModified:
27798 type: string
27799 format: date-time
27800 length:
27801 type: integer
27802 format: int32
27803 links:
27804 type: array
27805 items:
27806 type: object
27807 properties:
27808 params:
27809 type: object
27810 additionalProperties:
27811 type: string
27812 rel:
27813 type: string
27814 rels:
27815 type: array
27816 items:
27817 type: string
27818 title:
27819 type: string
27820 type:
27821 type: string
27822 uri:
27823 type: string
27824 format: uri
27825 uriBuilder:
27826 type: object
27827 uniqueItems: true
27828 location:
27829 type: string
27830 format: uri
27831 mediaType:
27832 type: object
27833 properties:
27834 parameters:
27835 type: object
27836 additionalProperties:
27837 type: string
27838 subtype:
27839 type: string
27840 type:
27841 type: string
27842 wildcardSubtype:
27843 type: boolean
27844 wildcardType:
27845 type: boolean
27846 metadata:
27847 type: object
27848 additionalProperties:
27849 type: array
27850 items:
27851 type: object
27852 status:
27853 type: integer
27854 format: int32
27855 statusInfo:
27856 type: object
27857 properties:
27858 family:
27859 type: string
27860 enum:
27861 - INFORMATIONAL
27862 - SUCCESSFUL
27863 - REDIRECTION
27864 - CLIENT_ERROR
27865 - SERVER_ERROR
27866 - OTHER
27867 reasonPhrase:
27868 type: string
27869 statusCode:
27870 type: integer
27871 format: int32
27872 stringHeaders:
27873 type: object
27874 additionalProperties:
27875 type: array
27876 items:
27877 type: string
27878 servers:
27879 - url: /sdc2/rest
27880 variables: {}
27881 summary: Returns updated resource instance property
27882 tags:
27883 - SDCE-2 APIs
27884 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion:
27885 post:
27886 description: Update resource instance
27887 operationId: changeResourceInstanceVersion
27888 parameters:
27889 - in: path
27890 name: componentId
27891 required: true
27892 schema:
27893 type: string
27894 - in: path
27895 name: componentInstanceId
27896 required: true
27897 schema:
27898 type: string
27899 - description: "valid values: resources / services"
27900 in: path
27901 name: containerComponentType
27902 required: true
27903 schema:
27904 type: string
27905 enum:
27906 - resources
27907 - services
27908 responses:
27909 "201":
27910 description: Resource instance created
27911 "400":
27912 description: Invalid content / Missing content
27913 "403":
27914 description: Restricted operation
27915 default:
27916 content:
27917 application/json:
27918 schema:
27919 type: array
27920 items:
27921 type: object
27922 properties:
27923 allowedMethods:
27924 type: array
27925 items:
27926 type: string
27927 uniqueItems: true
27928 cookies:
27929 type: object
27930 additionalProperties:
27931 type: object
27932 properties:
27933 comment:
27934 type: string
27935 domain:
27936 type: string
27937 expiry:
27938 type: string
27939 format: date-time
27940 httpOnly:
27941 type: boolean
27942 maxAge:
27943 type: integer
27944 format: int32
27945 name:
27946 type: string
27947 path:
27948 type: string
27949 secure:
27950 type: boolean
27951 value:
27952 type: string
27953 version:
27954 type: integer
27955 format: int32
27956 date:
27957 type: string
27958 format: date-time
27959 entity:
27960 type: object
27961 entityTag:
27962 type: object
27963 properties:
27964 value:
27965 type: string
27966 weak:
27967 type: boolean
27968 headers:
27969 type: object
27970 additionalProperties:
27971 type: array
27972 items:
27973 type: object
27974 language:
27975 type: object
27976 properties:
27977 country:
27978 type: string
27979 displayCountry:
27980 type: string
27981 displayLanguage:
27982 type: string
27983 displayName:
27984 type: string
27985 displayScript:
27986 type: string
27987 displayVariant:
27988 type: string
27989 extensionKeys:
27990 type: array
27991 items:
27992 type: string
27993 uniqueItems: true
27994 iso3Country:
27995 type: string
27996 iso3Language:
27997 type: string
27998 language:
27999 type: string
28000 script:
28001 type: string
28002 unicodeLocaleAttributes:
28003 type: array
28004 items:
28005 type: string
28006 uniqueItems: true
28007 unicodeLocaleKeys:
28008 type: array
28009 items:
28010 type: string
28011 uniqueItems: true
28012 variant:
28013 type: string
28014 lastModified:
28015 type: string
28016 format: date-time
28017 length:
28018 type: integer
28019 format: int32
28020 links:
28021 type: array
28022 items:
28023 type: object
28024 properties:
28025 params:
28026 type: object
28027 additionalProperties:
28028 type: string
28029 rel:
28030 type: string
28031 rels:
28032 type: array
28033 items:
28034 type: string
28035 title:
28036 type: string
28037 type:
28038 type: string
28039 uri:
28040 type: string
28041 format: uri
28042 uriBuilder:
28043 type: object
28044 uniqueItems: true
28045 location:
28046 type: string
28047 format: uri
28048 mediaType:
28049 type: object
28050 properties:
28051 parameters:
28052 type: object
28053 additionalProperties:
28054 type: string
28055 subtype:
28056 type: string
28057 type:
28058 type: string
28059 wildcardSubtype:
28060 type: boolean
28061 wildcardType:
28062 type: boolean
28063 metadata:
28064 type: object
28065 additionalProperties:
28066 type: array
28067 items:
28068 type: object
28069 status:
28070 type: integer
28071 format: int32
28072 statusInfo:
28073 type: object
28074 properties:
28075 family:
28076 type: string
28077 enum:
28078 - INFORMATIONAL
28079 - SUCCESSFUL
28080 - REDIRECTION
28081 - CLIENT_ERROR
28082 - SERVER_ERROR
28083 - OTHER
28084 reasonPhrase:
28085 type: string
28086 statusCode:
28087 type: integer
28088 format: int32
28089 stringHeaders:
28090 type: object
28091 additionalProperties:
28092 type: array
28093 items:
28094 type: string
28095 servers:
28096 - url: /sdc2/rest
28097 variables: {}
28098 summary: Returns updated resource instance
28099 tags:
28100 - SDCE-2 APIs
28101 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstId}:
28102 get:
28103 description: 'Get group artifacts '
28104 operationId: getGroupArtifactById
28105 parameters:
28106 - in: path
28107 name: containerComponentType
28108 required: true
28109 schema:
28110 type: string
28111 - in: path
28112 name: componentId
28113 required: true
28114 schema:
28115 type: string
28116 - in: path
28117 name: componentInstanceId
28118 required: true
28119 schema:
28120 type: string
28121 - in: path
28122 name: groupInstId
28123 required: true
28124 schema:
28125 type: string
28126 - in: header
28127 name: USER_ID
28128 schema:
28129 type: string
28130 responses:
28131 "200":
28132 description: group found
28133 "403":
28134 description: Restricted operation
28135 "404":
28136 description: Group not found
28137 default:
28138 content:
28139 application/json:
28140 schema:
28141 type: array
28142 items:
28143 type: object
28144 properties:
28145 allowedMethods:
28146 type: array
28147 items:
28148 type: string
28149 uniqueItems: true
28150 cookies:
28151 type: object
28152 additionalProperties:
28153 type: object
28154 properties:
28155 comment:
28156 type: string
28157 domain:
28158 type: string
28159 expiry:
28160 type: string
28161 format: date-time
28162 httpOnly:
28163 type: boolean
28164 maxAge:
28165 type: integer
28166 format: int32
28167 name:
28168 type: string
28169 path:
28170 type: string
28171 secure:
28172 type: boolean
28173 value:
28174 type: string
28175 version:
28176 type: integer
28177 format: int32
28178 date:
28179 type: string
28180 format: date-time
28181 entity:
28182 type: object
28183 entityTag:
28184 type: object
28185 properties:
28186 value:
28187 type: string
28188 weak:
28189 type: boolean
28190 headers:
28191 type: object
28192 additionalProperties:
28193 type: array
28194 items:
28195 type: object
28196 language:
28197 type: object
28198 properties:
28199 country:
28200 type: string
28201 displayCountry:
28202 type: string
28203 displayLanguage:
28204 type: string
28205 displayName:
28206 type: string
28207 displayScript:
28208 type: string
28209 displayVariant:
28210 type: string
28211 extensionKeys:
28212 type: array
28213 items:
28214 type: string
28215 uniqueItems: true
28216 iso3Country:
28217 type: string
28218 iso3Language:
28219 type: string
28220 language:
28221 type: string
28222 script:
28223 type: string
28224 unicodeLocaleAttributes:
28225 type: array
28226 items:
28227 type: string
28228 uniqueItems: true
28229 unicodeLocaleKeys:
28230 type: array
28231 items:
28232 type: string
28233 uniqueItems: true
28234 variant:
28235 type: string
28236 lastModified:
28237 type: string
28238 format: date-time
28239 length:
28240 type: integer
28241 format: int32
28242 links:
28243 type: array
28244 items:
28245 type: object
28246 properties:
28247 params:
28248 type: object
28249 additionalProperties:
28250 type: string
28251 rel:
28252 type: string
28253 rels:
28254 type: array
28255 items:
28256 type: string
28257 title:
28258 type: string
28259 type:
28260 type: string
28261 uri:
28262 type: string
28263 format: uri
28264 uriBuilder:
28265 type: object
28266 uniqueItems: true
28267 location:
28268 type: string
28269 format: uri
28270 mediaType:
28271 type: object
28272 properties:
28273 parameters:
28274 type: object
28275 additionalProperties:
28276 type: string
28277 subtype:
28278 type: string
28279 type:
28280 type: string
28281 wildcardSubtype:
28282 type: boolean
28283 wildcardType:
28284 type: boolean
28285 metadata:
28286 type: object
28287 additionalProperties:
28288 type: array
28289 items:
28290 type: object
28291 status:
28292 type: integer
28293 format: int32
28294 statusInfo:
28295 type: object
28296 properties:
28297 family:
28298 type: string
28299 enum:
28300 - INFORMATIONAL
28301 - SUCCESSFUL
28302 - REDIRECTION
28303 - CLIENT_ERROR
28304 - SERVER_ERROR
28305 - OTHER
28306 reasonPhrase:
28307 type: string
28308 statusCode:
28309 type: integer
28310 format: int32
28311 stringHeaders:
28312 type: object
28313 additionalProperties:
28314 type: array
28315 items:
28316 type: string
28317 servers:
28318 - url: /sdc2/rest
28319 variables: {}
28320 summary: Returns artifacts metadata according to groupInstId
28321 tags:
28322 - SDCE-2 APIs
28323 ? /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property
28324 : post:
28325 description: Update resource instance property
28326 operationId: updateGroupInstanceProperty
28327 parameters:
28328 - description: service id
28329 in: path
28330 name: componentId
28331 required: true
28332 schema:
28333 type: string
28334 - description: "valid values: resources / services"
28335 in: path
28336 name: containerComponentType
28337 required: true
28338 schema:
28339 type: string
28340 enum:
28341 - resources
28342 - services
28343 - description: resource instance id
28344 in: path
28345 name: componentInstanceId
28346 required: true
28347 schema:
28348 type: string
28349 - description: group instance id
28350 in: path
28351 name: groupInstanceId
28352 required: true
28353 schema:
28354 type: string
28355 - description: id of user initiating the operation
28356 in: header
28357 name: USER_ID
28358 schema:
28359 type: string
28360 responses:
28361 "201":
28362 description: Resource instance created
28363 "400":
28364 description: Invalid content / Missing content
28365 "403":
28366 description: Restricted operation
28367 default:
28368 content:
28369 application/json:
28370 schema:
28371 type: array
28372 items:
28373 type: object
28374 properties:
28375 allowedMethods:
28376 type: array
28377 items:
28378 type: string
28379 uniqueItems: true
28380 cookies:
28381 type: object
28382 additionalProperties:
28383 type: object
28384 properties:
28385 comment:
28386 type: string
28387 domain:
28388 type: string
28389 expiry:
28390 type: string
28391 format: date-time
28392 httpOnly:
28393 type: boolean
28394 maxAge:
28395 type: integer
28396 format: int32
28397 name:
28398 type: string
28399 path:
28400 type: string
28401 secure:
28402 type: boolean
28403 value:
28404 type: string
28405 version:
28406 type: integer
28407 format: int32
28408 date:
28409 type: string
28410 format: date-time
28411 entity:
28412 type: object
28413 entityTag:
28414 type: object
28415 properties:
28416 value:
28417 type: string
28418 weak:
28419 type: boolean
28420 headers:
28421 type: object
28422 additionalProperties:
28423 type: array
28424 items:
28425 type: object
28426 language:
28427 type: object
28428 properties:
28429 country:
28430 type: string
28431 displayCountry:
28432 type: string
28433 displayLanguage:
28434 type: string
28435 displayName:
28436 type: string
28437 displayScript:
28438 type: string
28439 displayVariant:
28440 type: string
28441 extensionKeys:
28442 type: array
28443 items:
28444 type: string
28445 uniqueItems: true
28446 iso3Country:
28447 type: string
28448 iso3Language:
28449 type: string
28450 language:
28451 type: string
28452 script:
28453 type: string
28454 unicodeLocaleAttributes:
28455 type: array
28456 items:
28457 type: string
28458 uniqueItems: true
28459 unicodeLocaleKeys:
28460 type: array
28461 items:
28462 type: string
28463 uniqueItems: true
28464 variant:
28465 type: string
28466 lastModified:
28467 type: string
28468 format: date-time
28469 length:
28470 type: integer
28471 format: int32
28472 links:
28473 type: array
28474 items:
28475 type: object
28476 properties:
28477 params:
28478 type: object
28479 additionalProperties:
28480 type: string
28481 rel:
28482 type: string
28483 rels:
28484 type: array
28485 items:
28486 type: string
28487 title:
28488 type: string
28489 type:
28490 type: string
28491 uri:
28492 type: string
28493 format: uri
28494 uriBuilder:
28495 type: object
28496 uniqueItems: true
28497 location:
28498 type: string
28499 format: uri
28500 mediaType:
28501 type: object
28502 properties:
28503 parameters:
28504 type: object
28505 additionalProperties:
28506 type: string
28507 subtype:
28508 type: string
28509 type:
28510 type: string
28511 wildcardSubtype:
28512 type: boolean
28513 wildcardType:
28514 type: boolean
28515 metadata:
28516 type: object
28517 additionalProperties:
28518 type: array
28519 items:
28520 type: object
28521 status:
28522 type: integer
28523 format: int32
28524 statusInfo:
28525 type: object
28526 properties:
28527 family:
28528 type: string
28529 enum:
28530 - INFORMATIONAL
28531 - SUCCESSFUL
28532 - REDIRECTION
28533 - CLIENT_ERROR
28534 - SERVER_ERROR
28535 - OTHER
28536 reasonPhrase:
28537 type: string
28538 statusCode:
28539 type: integer
28540 format: int32
28541 stringHeaders:
28542 type: object
28543 additionalProperties:
28544 type: array
28545 items:
28546 type: string
28547 servers:
28548 - url: /sdc2/rest
28549 variables: {}
28550 summary: Returns updated resource instance property
28551 tags:
28552 - SDCE-2 APIs
28553 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/inputs:
28554 post:
28555 description: Update resource instance property
28556 operationId: updateResourceInstanceInput
28557 parameters:
28558 - description: service id
28559 in: path
28560 name: componentId
28561 required: true
28562 schema:
28563 type: string
28564 - description: "valid values: resources / services"
28565 in: path
28566 name: containerComponentType
28567 required: true
28568 schema:
28569 type: string
28570 enum:
28571 - resources
28572 - services
28573 - description: resource instance id
28574 in: path
28575 name: componentInstanceId
28576 required: true
28577 schema:
28578 type: string
28579 - description: id of user initiating the operation
28580 in: header
28581 name: USER_ID
28582 schema:
28583 type: string
28584 requestBody:
28585 content:
28586 application/json:
28587 schema:
28588 type: string
28589 description: Component Instance Properties JSON Array
28590 required: true
28591 responses:
28592 "201":
28593 description: Resource instance created
28594 "400":
28595 description: Invalid content / Missing content
28596 "403":
28597 description: Restricted operation
28598 default:
28599 content:
28600 application/json:
28601 schema:
28602 type: array
28603 items:
28604 type: object
28605 properties:
28606 allowedMethods:
28607 type: array
28608 items:
28609 type: string
28610 uniqueItems: true
28611 cookies:
28612 type: object
28613 additionalProperties:
28614 type: object
28615 properties:
28616 comment:
28617 type: string
28618 domain:
28619 type: string
28620 expiry:
28621 type: string
28622 format: date-time
28623 httpOnly:
28624 type: boolean
28625 maxAge:
28626 type: integer
28627 format: int32
28628 name:
28629 type: string
28630 path:
28631 type: string
28632 secure:
28633 type: boolean
28634 value:
28635 type: string
28636 version:
28637 type: integer
28638 format: int32
28639 date:
28640 type: string
28641 format: date-time
28642 entity:
28643 type: object
28644 entityTag:
28645 type: object
28646 properties:
28647 value:
28648 type: string
28649 weak:
28650 type: boolean
28651 headers:
28652 type: object
28653 additionalProperties:
28654 type: array
28655 items:
28656 type: object
28657 language:
28658 type: object
28659 properties:
28660 country:
28661 type: string
28662 displayCountry:
28663 type: string
28664 displayLanguage:
28665 type: string
28666 displayName:
28667 type: string
28668 displayScript:
28669 type: string
28670 displayVariant:
28671 type: string
28672 extensionKeys:
28673 type: array
28674 items:
28675 type: string
28676 uniqueItems: true
28677 iso3Country:
28678 type: string
28679 iso3Language:
28680 type: string
28681 language:
28682 type: string
28683 script:
28684 type: string
28685 unicodeLocaleAttributes:
28686 type: array
28687 items:
28688 type: string
28689 uniqueItems: true
28690 unicodeLocaleKeys:
28691 type: array
28692 items:
28693 type: string
28694 uniqueItems: true
28695 variant:
28696 type: string
28697 lastModified:
28698 type: string
28699 format: date-time
28700 length:
28701 type: integer
28702 format: int32
28703 links:
28704 type: array
28705 items:
28706 type: object
28707 properties:
28708 params:
28709 type: object
28710 additionalProperties:
28711 type: string
28712 rel:
28713 type: string
28714 rels:
28715 type: array
28716 items:
28717 type: string
28718 title:
28719 type: string
28720 type:
28721 type: string
28722 uri:
28723 type: string
28724 format: uri
28725 uriBuilder:
28726 type: object
28727 uniqueItems: true
28728 location:
28729 type: string
28730 format: uri
28731 mediaType:
28732 type: object
28733 properties:
28734 parameters:
28735 type: object
28736 additionalProperties:
28737 type: string
28738 subtype:
28739 type: string
28740 type:
28741 type: string
28742 wildcardSubtype:
28743 type: boolean
28744 wildcardType:
28745 type: boolean
28746 metadata:
28747 type: object
28748 additionalProperties:
28749 type: array
28750 items:
28751 type: object
28752 status:
28753 type: integer
28754 format: int32
28755 statusInfo:
28756 type: object
28757 properties:
28758 family:
28759 type: string
28760 enum:
28761 - INFORMATIONAL
28762 - SUCCESSFUL
28763 - REDIRECTION
28764 - CLIENT_ERROR
28765 - SERVER_ERROR
28766 - OTHER
28767 reasonPhrase:
28768 type: string
28769 statusCode:
28770 type: integer
28771 format: int32
28772 stringHeaders:
28773 type: object
28774 additionalProperties:
28775 type: array
28776 items:
28777 type: string
28778 servers:
28779 - url: /sdc2/rest
28780 variables: {}
28781 summary: Returns updated resource instance property
28782 tags:
28783 - SDCE-2 APIs
28784 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/properties:
28785 post:
28786 description: Update resource instance property
28787 operationId: updateResourceInstanceProperties
28788 parameters:
28789 - description: service id
28790 in: path
28791 name: componentId
28792 required: true
28793 schema:
28794 type: string
28795 - description: "valid values: resources / services"
28796 in: path
28797 name: containerComponentType
28798 required: true
28799 schema:
28800 type: string
28801 enum:
28802 - resources
28803 - services
28804 - description: resource instance id
28805 in: path
28806 name: componentInstanceId
28807 required: true
28808 schema:
28809 type: string
28810 - description: id of user initiating the operation
28811 in: header
28812 name: USER_ID
28813 schema:
28814 type: string
28815 requestBody:
28816 content:
28817 application/json:
28818 schema:
28819 type: string
28820 description: Component Instance Properties JSON Array
28821 required: true
28822 responses:
28823 "201":
28824 description: Resource instance created
28825 "400":
28826 description: Invalid content / Missing content
28827 "403":
28828 description: Restricted operation
28829 default:
28830 content:
28831 application/json:
28832 schema:
28833 type: array
28834 items:
28835 type: object
28836 properties:
28837 allowedMethods:
28838 type: array
28839 items:
28840 type: string
28841 uniqueItems: true
28842 cookies:
28843 type: object
28844 additionalProperties:
28845 type: object
28846 properties:
28847 comment:
28848 type: string
28849 domain:
28850 type: string
28851 expiry:
28852 type: string
28853 format: date-time
28854 httpOnly:
28855 type: boolean
28856 maxAge:
28857 type: integer
28858 format: int32
28859 name:
28860 type: string
28861 path:
28862 type: string
28863 secure:
28864 type: boolean
28865 value:
28866 type: string
28867 version:
28868 type: integer
28869 format: int32
28870 date:
28871 type: string
28872 format: date-time
28873 entity:
28874 type: object
28875 entityTag:
28876 type: object
28877 properties:
28878 value:
28879 type: string
28880 weak:
28881 type: boolean
28882 headers:
28883 type: object
28884 additionalProperties:
28885 type: array
28886 items:
28887 type: object
28888 language:
28889 type: object
28890 properties:
28891 country:
28892 type: string
28893 displayCountry:
28894 type: string
28895 displayLanguage:
28896 type: string
28897 displayName:
28898 type: string
28899 displayScript:
28900 type: string
28901 displayVariant:
28902 type: string
28903 extensionKeys:
28904 type: array
28905 items:
28906 type: string
28907 uniqueItems: true
28908 iso3Country:
28909 type: string
28910 iso3Language:
28911 type: string
28912 language:
28913 type: string
28914 script:
28915 type: string
28916 unicodeLocaleAttributes:
28917 type: array
28918 items:
28919 type: string
28920 uniqueItems: true
28921 unicodeLocaleKeys:
28922 type: array
28923 items:
28924 type: string
28925 uniqueItems: true
28926 variant:
28927 type: string
28928 lastModified:
28929 type: string
28930 format: date-time
28931 length:
28932 type: integer
28933 format: int32
28934 links:
28935 type: array
28936 items:
28937 type: object
28938 properties:
28939 params:
28940 type: object
28941 additionalProperties:
28942 type: string
28943 rel:
28944 type: string
28945 rels:
28946 type: array
28947 items:
28948 type: string
28949 title:
28950 type: string
28951 type:
28952 type: string
28953 uri:
28954 type: string
28955 format: uri
28956 uriBuilder:
28957 type: object
28958 uniqueItems: true
28959 location:
28960 type: string
28961 format: uri
28962 mediaType:
28963 type: object
28964 properties:
28965 parameters:
28966 type: object
28967 additionalProperties:
28968 type: string
28969 subtype:
28970 type: string
28971 type:
28972 type: string
28973 wildcardSubtype:
28974 type: boolean
28975 wildcardType:
28976 type: boolean
28977 metadata:
28978 type: object
28979 additionalProperties:
28980 type: array
28981 items:
28982 type: object
28983 status:
28984 type: integer
28985 format: int32
28986 statusInfo:
28987 type: object
28988 properties:
28989 family:
28990 type: string
28991 enum:
28992 - INFORMATIONAL
28993 - SUCCESSFUL
28994 - REDIRECTION
28995 - CLIENT_ERROR
28996 - SERVER_ERROR
28997 - OTHER
28998 reasonPhrase:
28999 type: string
29000 statusCode:
29001 type: integer
29002 format: int32
29003 stringHeaders:
29004 type: object
29005 additionalProperties:
29006 type: array
29007 items:
29008 type: string
29009 servers:
29010 - url: /sdc2/rest
29011 variables: {}
29012 summary: Returns updated resource instance property
29013 tags:
29014 - SDCE-2 APIs
29015 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId}:
29016 delete:
29017 description: Update resource instance
29018 operationId: deleteResourceInstanceProperty
29019 parameters:
29020 - description: service id
29021 in: path
29022 name: componentId
29023 required: true
29024 schema:
29025 type: string
29026 - description: "valid values: resources / services"
29027 in: path
29028 name: containerComponentType
29029 required: true
29030 schema:
29031 type: string
29032 enum:
29033 - resources
29034 - services
29035 - description: resource instance id
29036 in: path
29037 name: componentInstanceId
29038 required: true
29039 schema:
29040 type: string
29041 - description: property id
29042 in: path
29043 name: propertyId
29044 required: true
29045 schema:
29046 type: string
29047 - description: id of user initiating the operation
29048 in: header
29049 name: USER_ID
29050 schema:
29051 type: string
29052 responses:
29053 "201":
29054 description: Resource instance created
29055 "400":
29056 description: Invalid content / Missing content
29057 "403":
29058 description: Restricted operation
29059 default:
29060 content:
29061 application/json:
29062 schema:
29063 type: array
29064 items:
29065 type: object
29066 properties:
29067 allowedMethods:
29068 type: array
29069 items:
29070 type: string
29071 uniqueItems: true
29072 cookies:
29073 type: object
29074 additionalProperties:
29075 type: object
29076 properties:
29077 comment:
29078 type: string
29079 domain:
29080 type: string
29081 expiry:
29082 type: string
29083 format: date-time
29084 httpOnly:
29085 type: boolean
29086 maxAge:
29087 type: integer
29088 format: int32
29089 name:
29090 type: string
29091 path:
29092 type: string
29093 secure:
29094 type: boolean
29095 value:
29096 type: string
29097 version:
29098 type: integer
29099 format: int32
29100 date:
29101 type: string
29102 format: date-time
29103 entity:
29104 type: object
29105 entityTag:
29106 type: object
29107 properties:
29108 value:
29109 type: string
29110 weak:
29111 type: boolean
29112 headers:
29113 type: object
29114 additionalProperties:
29115 type: array
29116 items:
29117 type: object
29118 language:
29119 type: object
29120 properties:
29121 country:
29122 type: string
29123 displayCountry:
29124 type: string
29125 displayLanguage:
29126 type: string
29127 displayName:
29128 type: string
29129 displayScript:
29130 type: string
29131 displayVariant:
29132 type: string
29133 extensionKeys:
29134 type: array
29135 items:
29136 type: string
29137 uniqueItems: true
29138 iso3Country:
29139 type: string
29140 iso3Language:
29141 type: string
29142 language:
29143 type: string
29144 script:
29145 type: string
29146 unicodeLocaleAttributes:
29147 type: array
29148 items:
29149 type: string
29150 uniqueItems: true
29151 unicodeLocaleKeys:
29152 type: array
29153 items:
29154 type: string
29155 uniqueItems: true
29156 variant:
29157 type: string
29158 lastModified:
29159 type: string
29160 format: date-time
29161 length:
29162 type: integer
29163 format: int32
29164 links:
29165 type: array
29166 items:
29167 type: object
29168 properties:
29169 params:
29170 type: object
29171 additionalProperties:
29172 type: string
29173 rel:
29174 type: string
29175 rels:
29176 type: array
29177 items:
29178 type: string
29179 title:
29180 type: string
29181 type:
29182 type: string
29183 uri:
29184 type: string
29185 format: uri
29186 uriBuilder:
29187 type: object
29188 uniqueItems: true
29189 location:
29190 type: string
29191 format: uri
29192 mediaType:
29193 type: object
29194 properties:
29195 parameters:
29196 type: object
29197 additionalProperties:
29198 type: string
29199 subtype:
29200 type: string
29201 type:
29202 type: string
29203 wildcardSubtype:
29204 type: boolean
29205 wildcardType:
29206 type: boolean
29207 metadata:
29208 type: object
29209 additionalProperties:
29210 type: array
29211 items:
29212 type: object
29213 status:
29214 type: integer
29215 format: int32
29216 statusInfo:
29217 type: object
29218 properties:
29219 family:
29220 type: string
29221 enum:
29222 - INFORMATIONAL
29223 - SUCCESSFUL
29224 - REDIRECTION
29225 - CLIENT_ERROR
29226 - SERVER_ERROR
29227 - OTHER
29228 reasonPhrase:
29229 type: string
29230 statusCode:
29231 type: integer
29232 format: int32
29233 stringHeaders:
29234 type: object
29235 additionalProperties:
29236 type: array
29237 items:
29238 type: string
29239 servers:
29240 - url: /sdc2/rest
29241 variables: {}
29242 summary: Returns deleted resource instance property
29243 tags:
29244 - SDCE-2 APIs
29245 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId}:
29246 delete:
29247 description: Delete ResourceInstance
29248 operationId: deleteResourceInstance
29249 parameters:
29250 - in: path
29251 name: componentId
29252 required: true
29253 schema:
29254 type: string
29255 - in: path
29256 name: resourceInstanceId
29257 required: true
29258 schema:
29259 type: string
29260 - description: "valid values: resources / services / products"
29261 in: path
29262 name: containerComponentType
29263 required: true
29264 schema:
29265 type: string
29266 enum:
29267 - resources
29268 - services
29269 - products
29270 responses:
29271 "201":
29272 description: ResourceInstance deleted
29273 "400":
29274 description: Invalid content / Missing content
29275 "403":
29276 description: Restricted operation
29277 default:
29278 content:
29279 application/json:
29280 schema:
29281 type: array
29282 items:
29283 type: object
29284 properties:
29285 allowedMethods:
29286 type: array
29287 items:
29288 type: string
29289 uniqueItems: true
29290 cookies:
29291 type: object
29292 additionalProperties:
29293 type: object
29294 properties:
29295 comment:
29296 type: string
29297 domain:
29298 type: string
29299 expiry:
29300 type: string
29301 format: date-time
29302 httpOnly:
29303 type: boolean
29304 maxAge:
29305 type: integer
29306 format: int32
29307 name:
29308 type: string
29309 path:
29310 type: string
29311 secure:
29312 type: boolean
29313 value:
29314 type: string
29315 version:
29316 type: integer
29317 format: int32
29318 date:
29319 type: string
29320 format: date-time
29321 entity:
29322 type: object
29323 entityTag:
29324 type: object
29325 properties:
29326 value:
29327 type: string
29328 weak:
29329 type: boolean
29330 headers:
29331 type: object
29332 additionalProperties:
29333 type: array
29334 items:
29335 type: object
29336 language:
29337 type: object
29338 properties:
29339 country:
29340 type: string
29341 displayCountry:
29342 type: string
29343 displayLanguage:
29344 type: string
29345 displayName:
29346 type: string
29347 displayScript:
29348 type: string
29349 displayVariant:
29350 type: string
29351 extensionKeys:
29352 type: array
29353 items:
29354 type: string
29355 uniqueItems: true
29356 iso3Country:
29357 type: string
29358 iso3Language:
29359 type: string
29360 language:
29361 type: string
29362 script:
29363 type: string
29364 unicodeLocaleAttributes:
29365 type: array
29366 items:
29367 type: string
29368 uniqueItems: true
29369 unicodeLocaleKeys:
29370 type: array
29371 items:
29372 type: string
29373 uniqueItems: true
29374 variant:
29375 type: string
29376 lastModified:
29377 type: string
29378 format: date-time
29379 length:
29380 type: integer
29381 format: int32
29382 links:
29383 type: array
29384 items:
29385 type: object
29386 properties:
29387 params:
29388 type: object
29389 additionalProperties:
29390 type: string
29391 rel:
29392 type: string
29393 rels:
29394 type: array
29395 items:
29396 type: string
29397 title:
29398 type: string
29399 type:
29400 type: string
29401 uri:
29402 type: string
29403 format: uri
29404 uriBuilder:
29405 type: object
29406 uniqueItems: true
29407 location:
29408 type: string
29409 format: uri
29410 mediaType:
29411 type: object
29412 properties:
29413 parameters:
29414 type: object
29415 additionalProperties:
29416 type: string
29417 subtype:
29418 type: string
29419 type:
29420 type: string
29421 wildcardSubtype:
29422 type: boolean
29423 wildcardType:
29424 type: boolean
29425 metadata:
29426 type: object
29427 additionalProperties:
29428 type: array
29429 items:
29430 type: object
29431 status:
29432 type: integer
29433 format: int32
29434 statusInfo:
29435 type: object
29436 properties:
29437 family:
29438 type: string
29439 enum:
29440 - INFORMATIONAL
29441 - SUCCESSFUL
29442 - REDIRECTION
29443 - CLIENT_ERROR
29444 - SERVER_ERROR
29445 - OTHER
29446 reasonPhrase:
29447 type: string
29448 statusCode:
29449 type: integer
29450 format: int32
29451 stringHeaders:
29452 type: object
29453 additionalProperties:
29454 type: array
29455 items:
29456 type: string
29457 servers:
29458 - url: /sdc2/rest
29459 variables: {}
29460 summary: Returns delete resourceInstance
29461 tags:
29462 - SDCE-2 APIs
29463 /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifacts/{artifactId}:
29464 get:
29465 description: Download component Artifact in Base64
29466 operationId: downloadResourceInstanceArtifactBase64
29467 parameters:
29468 - description: "valid values: resources / services"
29469 in: path
29470 name: containerComponentType
29471 required: true
29472 schema:
29473 type: string
29474 enum:
29475 - resources
29476 - services
29477 - in: path
29478 name: componentId
29479 required: true
29480 schema:
29481 type: string
29482 - in: path
29483 name: componentInstanceId
29484 required: true
29485 schema:
29486 type: string
29487 - in: path
29488 name: artifactId
29489 required: true
29490 schema:
29491 type: string
29492 responses:
29493 "200":
29494 description: ResourceInstance artifact downloaded
29495 "404":
29496 description: ResourceInstance/Artifact not found
29497 default:
29498 content:
29499 application/json:
29500 schema:
29501 type: array
29502 items:
29503 type: object
29504 properties:
29505 allowedMethods:
29506 type: array
29507 items:
29508 type: string
29509 uniqueItems: true
29510 cookies:
29511 type: object
29512 additionalProperties:
29513 type: object
29514 properties:
29515 comment:
29516 type: string
29517 domain:
29518 type: string
29519 expiry:
29520 type: string
29521 format: date-time
29522 httpOnly:
29523 type: boolean
29524 maxAge:
29525 type: integer
29526 format: int32
29527 name:
29528 type: string
29529 path:
29530 type: string
29531 secure:
29532 type: boolean
29533 value:
29534 type: string
29535 version:
29536 type: integer
29537 format: int32
29538 date:
29539 type: string
29540 format: date-time
29541 entity:
29542 type: object
29543 entityTag:
29544 type: object
29545 properties:
29546 value:
29547 type: string
29548 weak:
29549 type: boolean
29550 headers:
29551 type: object
29552 additionalProperties:
29553 type: array
29554 items:
29555 type: object
29556 language:
29557 type: object
29558 properties:
29559 country:
29560 type: string
29561 displayCountry:
29562 type: string
29563 displayLanguage:
29564 type: string
29565 displayName:
29566 type: string
29567 displayScript:
29568 type: string
29569 displayVariant:
29570 type: string
29571 extensionKeys:
29572 type: array
29573 items:
29574 type: string
29575 uniqueItems: true
29576 iso3Country:
29577 type: string
29578 iso3Language:
29579 type: string
29580 language:
29581 type: string
29582 script:
29583 type: string
29584 unicodeLocaleAttributes:
29585 type: array
29586 items:
29587 type: string
29588 uniqueItems: true
29589 unicodeLocaleKeys:
29590 type: array
29591 items:
29592 type: string
29593 uniqueItems: true
29594 variant:
29595 type: string
29596 lastModified:
29597 type: string
29598 format: date-time
29599 length:
29600 type: integer
29601 format: int32
29602 links:
29603 type: array
29604 items:
29605 type: object
29606 properties:
29607 params:
29608 type: object
29609 additionalProperties:
29610 type: string
29611 rel:
29612 type: string
29613 rels:
29614 type: array
29615 items:
29616 type: string
29617 title:
29618 type: string
29619 type:
29620 type: string
29621 uri:
29622 type: string
29623 format: uri
29624 uriBuilder:
29625 type: object
29626 uniqueItems: true
29627 location:
29628 type: string
29629 format: uri
29630 mediaType:
29631 type: object
29632 properties:
29633 parameters:
29634 type: object
29635 additionalProperties:
29636 type: string
29637 subtype:
29638 type: string
29639 type:
29640 type: string
29641 wildcardSubtype:
29642 type: boolean
29643 wildcardType:
29644 type: boolean
29645 metadata:
29646 type: object
29647 additionalProperties:
29648 type: array
29649 items:
29650 type: object
29651 status:
29652 type: integer
29653 format: int32
29654 statusInfo:
29655 type: object
29656 properties:
29657 family:
29658 type: string
29659 enum:
29660 - INFORMATIONAL
29661 - SUCCESSFUL
29662 - REDIRECTION
29663 - CLIENT_ERROR
29664 - SERVER_ERROR
29665 - OTHER
29666 reasonPhrase:
29667 type: string
29668 statusCode:
29669 type: integer
29670 format: int32
29671 stringHeaders:
29672 type: object
29673 additionalProperties:
29674 type: array
29675 items:
29676 type: string
29677 servers:
29678 - url: /sdc2/rest
29679 variables: {}
29680 summary: Returns downloaded artifact
29681 tags:
29682 - SDCE-2 APIs
29683 /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType}:
29684 get:
29685 description: Get component Artifacts
29686 operationId: getComponentInstanceArtifacts
29687 parameters:
29688 - description: "valid values: resources / services"
29689 in: path
29690 name: containerComponentType
29691 required: true
29692 schema:
29693 type: string
29694 enum:
29695 - resources
29696 - services
29697 - in: path
29698 name: componentId
29699 required: true
29700 schema:
29701 type: string
29702 - in: path
29703 name: componentInstanceId
29704 required: true
29705 schema:
29706 type: string
29707 - in: path
29708 name: artifactGroupType
29709 required: true
29710 schema:
29711 type: string
29712 responses:
29713 "200":
29714 description: Component artifacts
29715 "404":
29716 description: Resource/Artifact not found
29717 default:
29718 content:
29719 application/json:
29720 schema:
29721 type: array
29722 items:
29723 type: object
29724 properties:
29725 allowedMethods:
29726 type: array
29727 items:
29728 type: string
29729 uniqueItems: true
29730 cookies:
29731 type: object
29732 additionalProperties:
29733 type: object
29734 properties:
29735 comment:
29736 type: string
29737 domain:
29738 type: string
29739 expiry:
29740 type: string
29741 format: date-time
29742 httpOnly:
29743 type: boolean
29744 maxAge:
29745 type: integer
29746 format: int32
29747 name:
29748 type: string
29749 path:
29750 type: string
29751 secure:
29752 type: boolean
29753 value:
29754 type: string
29755 version:
29756 type: integer
29757 format: int32
29758 date:
29759 type: string
29760 format: date-time
29761 entity:
29762 type: object
29763 entityTag:
29764 type: object
29765 properties:
29766 value:
29767 type: string
29768 weak:
29769 type: boolean
29770 headers:
29771 type: object
29772 additionalProperties:
29773 type: array
29774 items:
29775 type: object
29776 language:
29777 type: object
29778 properties:
29779 country:
29780 type: string
29781 displayCountry:
29782 type: string
29783 displayLanguage:
29784 type: string
29785 displayName:
29786 type: string
29787 displayScript:
29788 type: string
29789 displayVariant:
29790 type: string
29791 extensionKeys:
29792 type: array
29793 items:
29794 type: string
29795 uniqueItems: true
29796 iso3Country:
29797 type: string
29798 iso3Language:
29799 type: string
29800 language:
29801 type: string
29802 script:
29803 type: string
29804 unicodeLocaleAttributes:
29805 type: array
29806 items:
29807 type: string
29808 uniqueItems: true
29809 unicodeLocaleKeys:
29810 type: array
29811 items:
29812 type: string
29813 uniqueItems: true
29814 variant:
29815 type: string
29816 lastModified:
29817 type: string
29818 format: date-time
29819 length:
29820 type: integer
29821 format: int32
29822 links:
29823 type: array
29824 items:
29825 type: object
29826 properties:
29827 params:
29828 type: object
29829 additionalProperties:
29830 type: string
29831 rel:
29832 type: string
29833 rels:
29834 type: array
29835 items:
29836 type: string
29837 title:
29838 type: string
29839 type:
29840 type: string
29841 uri:
29842 type: string
29843 format: uri
29844 uriBuilder:
29845 type: object
29846 uniqueItems: true
29847 location:
29848 type: string
29849 format: uri
29850 mediaType:
29851 type: object
29852 properties:
29853 parameters:
29854 type: object
29855 additionalProperties:
29856 type: string
29857 subtype:
29858 type: string
29859 type:
29860 type: string
29861 wildcardSubtype:
29862 type: boolean
29863 wildcardType:
29864 type: boolean
29865 metadata:
29866 type: object
29867 additionalProperties:
29868 type: array
29869 items:
29870 type: object
29871 status:
29872 type: integer
29873 format: int32
29874 statusInfo:
29875 type: object
29876 properties:
29877 family:
29878 type: string
29879 enum:
29880 - INFORMATIONAL
29881 - SUCCESSFUL
29882 - REDIRECTION
29883 - CLIENT_ERROR
29884 - SERVER_ERROR
29885 - OTHER
29886 reasonPhrase:
29887 type: string
29888 statusCode:
29889 type: integer
29890 format: int32
29891 stringHeaders:
29892 type: object
29893 additionalProperties:
29894 type: array
29895 items:
29896 type: string
29897 servers:
29898 - url: /sdc2/rest
29899 variables: {}
29900 summary: Returns artifacts
29901 tags:
29902 - SDCE-2 APIs
29903 /v1/catalog/{containerComponentType}/{componentId}/update/inputs:
29904 post:
29905 description: Update resource inputs
29906 operationId: updateComponentInputs
29907 parameters:
29908 - description: "valid values: resources / services"
29909 in: path
29910 name: containerComponentType
29911 required: true
29912 schema:
29913 type: string
29914 enum:
29915 - resources
29916 - services
29917 - in: path
29918 name: componentId
29919 required: true
29920 schema:
29921 type: string
29922 requestBody:
29923 content:
29924 application/json:
29925 schema:
29926 type: string
29927 description: json describe the input
29928 required: true
29929 responses:
29930 "200":
29931 description: Input updated
29932 "400":
29933 description: Invalid content / Missing content
29934 "403":
29935 description: Restricted operation
29936 default:
29937 content:
29938 application/json:
29939 schema:
29940 type: array
29941 items:
29942 type: object
29943 properties:
29944 allowedMethods:
29945 type: array
29946 items:
29947 type: string
29948 uniqueItems: true
29949 cookies:
29950 type: object
29951 additionalProperties:
29952 type: object
29953 properties:
29954 comment:
29955 type: string
29956 domain:
29957 type: string
29958 expiry:
29959 type: string
29960 format: date-time
29961 httpOnly:
29962 type: boolean
29963 maxAge:
29964 type: integer
29965 format: int32
29966 name:
29967 type: string
29968 path:
29969 type: string
29970 secure:
29971 type: boolean
29972 value:
29973 type: string
29974 version:
29975 type: integer
29976 format: int32
29977 date:
29978 type: string
29979 format: date-time
29980 entity:
29981 type: object
29982 entityTag:
29983 type: object
29984 properties:
29985 value:
29986 type: string
29987 weak:
29988 type: boolean
29989 headers:
29990 type: object
29991 additionalProperties:
29992 type: array
29993 items:
29994 type: object
29995 language:
29996 type: object
29997 properties:
29998 country:
29999 type: string
30000 displayCountry:
30001 type: string
30002 displayLanguage:
30003 type: string
30004 displayName:
30005 type: string
30006 displayScript:
30007 type: string
30008 displayVariant:
30009 type: string
30010 extensionKeys:
30011 type: array
30012 items:
30013 type: string
30014 uniqueItems: true
30015 iso3Country:
30016 type: string
30017 iso3Language:
30018 type: string
30019 language:
30020 type: string
30021 script:
30022 type: string
30023 unicodeLocaleAttributes:
30024 type: array
30025 items:
30026 type: string
30027 uniqueItems: true
30028 unicodeLocaleKeys:
30029 type: array
30030 items:
30031 type: string
30032 uniqueItems: true
30033 variant:
30034 type: string
30035 lastModified:
30036 type: string
30037 format: date-time
30038 length:
30039 type: integer
30040 format: int32
30041 links:
30042 type: array
30043 items:
30044 type: object
30045 properties:
30046 params:
30047 type: object
30048 additionalProperties:
30049 type: string
30050 rel:
30051 type: string
30052 rels:
30053 type: array
30054 items:
30055 type: string
30056 title:
30057 type: string
30058 type:
30059 type: string
30060 uri:
30061 type: string
30062 format: uri
30063 uriBuilder:
30064 type: object
30065 uniqueItems: true
30066 location:
30067 type: string
30068 format: uri
30069 mediaType:
30070 type: object
30071 properties:
30072 parameters:
30073 type: object
30074 additionalProperties:
30075 type: string
30076 subtype:
30077 type: string
30078 type:
30079 type: string
30080 wildcardSubtype:
30081 type: boolean
30082 wildcardType:
30083 type: boolean
30084 metadata:
30085 type: object
30086 additionalProperties:
30087 type: array
30088 items:
30089 type: object
30090 status:
30091 type: integer
30092 format: int32
30093 statusInfo:
30094 type: object
30095 properties:
30096 family:
30097 type: string
30098 enum:
30099 - INFORMATIONAL
30100 - SUCCESSFUL
30101 - REDIRECTION
30102 - CLIENT_ERROR
30103 - SERVER_ERROR
30104 - OTHER
30105 reasonPhrase:
30106 type: string
30107 statusCode:
30108 type: integer
30109 format: int32
30110 stringHeaders:
30111 type: object
30112 additionalProperties:
30113 type: array
30114 items:
30115 type: string
30116 servers:
30117 - url: /sdc2/rest
30118 variables: {}
30119 summary: Returns updated input
30120 tags:
30121 - SDCE-2 APIs
30122 /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/attributes:
30123 get:
30124 description: Get component instance attributes
30125 operationId: getInstanceAttributesById
30126 parameters:
30127 - in: path
30128 name: containerComponentType
30129 required: true
30130 schema:
30131 type: string
30132 - in: path
30133 name: containerComponentId
30134 required: true
30135 schema:
30136 type: string
30137 - in: path
30138 name: componentInstanceUniqueId
30139 required: true
30140 schema:
30141 type: string
30142 - in: header
30143 name: USER_ID
30144 schema:
30145 type: string
30146 responses:
30147 "200":
30148 description: Attributes found
30149 "403":
30150 description: Restricted operation
30151 "404":
30152 description: Component/Component Instance - not found
30153 default:
30154 content:
30155 application/json:
30156 schema:
30157 type: array
30158 items:
30159 type: object
30160 properties:
30161 allowedMethods:
30162 type: array
30163 items:
30164 type: string
30165 uniqueItems: true
30166 cookies:
30167 type: object
30168 additionalProperties:
30169 type: object
30170 properties:
30171 comment:
30172 type: string
30173 domain:
30174 type: string
30175 expiry:
30176 type: string
30177 format: date-time
30178 httpOnly:
30179 type: boolean
30180 maxAge:
30181 type: integer
30182 format: int32
30183 name:
30184 type: string
30185 path:
30186 type: string
30187 secure:
30188 type: boolean
30189 value:
30190 type: string
30191 version:
30192 type: integer
30193 format: int32
30194 date:
30195 type: string
30196 format: date-time
30197 entity:
30198 type: object
30199 entityTag:
30200 type: object
30201 properties:
30202 value:
30203 type: string
30204 weak:
30205 type: boolean
30206 headers:
30207 type: object
30208 additionalProperties:
30209 type: array
30210 items:
30211 type: object
30212 language:
30213 type: object
30214 properties:
30215 country:
30216 type: string
30217 displayCountry:
30218 type: string
30219 displayLanguage:
30220 type: string
30221 displayName:
30222 type: string
30223 displayScript:
30224 type: string
30225 displayVariant:
30226 type: string
30227 extensionKeys:
30228 type: array
30229 items:
30230 type: string
30231 uniqueItems: true
30232 iso3Country:
30233 type: string
30234 iso3Language:
30235 type: string
30236 language:
30237 type: string
30238 script:
30239 type: string
30240 unicodeLocaleAttributes:
30241 type: array
30242 items:
30243 type: string
30244 uniqueItems: true
30245 unicodeLocaleKeys:
30246 type: array
30247 items:
30248 type: string
30249 uniqueItems: true
30250 variant:
30251 type: string
30252 lastModified:
30253 type: string
30254 format: date-time
30255 length:
30256 type: integer
30257 format: int32
30258 links:
30259 type: array
30260 items:
30261 type: object
30262 properties:
30263 params:
30264 type: object
30265 additionalProperties:
30266 type: string
30267 rel:
30268 type: string
30269 rels:
30270 type: array
30271 items:
30272 type: string
30273 title:
30274 type: string
30275 type:
30276 type: string
30277 uri:
30278 type: string
30279 format: uri
30280 uriBuilder:
30281 type: object
30282 uniqueItems: true
30283 location:
30284 type: string
30285 format: uri
30286 mediaType:
30287 type: object
30288 properties:
30289 parameters:
30290 type: object
30291 additionalProperties:
30292 type: string
30293 subtype:
30294 type: string
30295 type:
30296 type: string
30297 wildcardSubtype:
30298 type: boolean
30299 wildcardType:
30300 type: boolean
30301 metadata:
30302 type: object
30303 additionalProperties:
30304 type: array
30305 items:
30306 type: object
30307 status:
30308 type: integer
30309 format: int32
30310 statusInfo:
30311 type: object
30312 properties:
30313 family:
30314 type: string
30315 enum:
30316 - INFORMATIONAL
30317 - SUCCESSFUL
30318 - REDIRECTION
30319 - CLIENT_ERROR
30320 - SERVER_ERROR
30321 - OTHER
30322 reasonPhrase:
30323 type: string
30324 statusCode:
30325 type: integer
30326 format: int32
30327 stringHeaders:
30328 type: object
30329 additionalProperties:
30330 type: array
30331 items:
30332 type: string
30333 servers:
30334 - url: /sdc2/rest
30335 variables: {}
30336 summary: Returns component instance attributes
30337 tags:
30338 - SDCE-2 APIs
30339 /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability:
30340 put:
30341 description: Update Component Instance Capability
30342 operationId: updateInstanceRequirement
30343 parameters:
30344 - in: path
30345 name: containerComponentType
30346 required: true
30347 schema:
30348 type: string
30349 - in: path
30350 name: containerComponentId
30351 required: true
30352 schema:
30353 type: string
30354 - in: path
30355 name: componentInstanceUniqueId
30356 required: true
30357 schema:
30358 type: string
30359 - in: header
30360 name: USER_ID
30361 schema:
30362 type: string
30363 requestBody:
30364 content:
30365 application/json:
30366 schema:
30367 $ref: '#/components/schemas/ComponentInstanceCapabilityUpdateModel'
30368 description: Component instance capability to update
30369 required: true
30370 responses:
30371 "200":
30372 description: Resource instance capability successfully updated
30373 "400":
30374 description: Invalid content / Missing content
30375 "403":
30376 description: Restricted operation
30377 "404":
30378 description: Component/Component Instance/Capability not found
30379 default:
30380 content:
30381 application/json:
30382 schema:
30383 type: array
30384 items:
30385 type: object
30386 properties:
30387 allowedMethods:
30388 type: array
30389 items:
30390 type: string
30391 uniqueItems: true
30392 cookies:
30393 type: object
30394 additionalProperties:
30395 type: object
30396 properties:
30397 comment:
30398 type: string
30399 domain:
30400 type: string
30401 expiry:
30402 type: string
30403 format: date-time
30404 httpOnly:
30405 type: boolean
30406 maxAge:
30407 type: integer
30408 format: int32
30409 name:
30410 type: string
30411 path:
30412 type: string
30413 secure:
30414 type: boolean
30415 value:
30416 type: string
30417 version:
30418 type: integer
30419 format: int32
30420 date:
30421 type: string
30422 format: date-time
30423 entity:
30424 type: object
30425 entityTag:
30426 type: object
30427 properties:
30428 value:
30429 type: string
30430 weak:
30431 type: boolean
30432 headers:
30433 type: object
30434 additionalProperties:
30435 type: array
30436 items:
30437 type: object
30438 language:
30439 type: object
30440 properties:
30441 country:
30442 type: string
30443 displayCountry:
30444 type: string
30445 displayLanguage:
30446 type: string
30447 displayName:
30448 type: string
30449 displayScript:
30450 type: string
30451 displayVariant:
30452 type: string
30453 extensionKeys:
30454 type: array
30455 items:
30456 type: string
30457 uniqueItems: true
30458 iso3Country:
30459 type: string
30460 iso3Language:
30461 type: string
30462 language:
30463 type: string
30464 script:
30465 type: string
30466 unicodeLocaleAttributes:
30467 type: array
30468 items:
30469 type: string
30470 uniqueItems: true
30471 unicodeLocaleKeys:
30472 type: array
30473 items:
30474 type: string
30475 uniqueItems: true
30476 variant:
30477 type: string
30478 lastModified:
30479 type: string
30480 format: date-time
30481 length:
30482 type: integer
30483 format: int32
30484 links:
30485 type: array
30486 items:
30487 type: object
30488 properties:
30489 params:
30490 type: object
30491 additionalProperties:
30492 type: string
30493 rel:
30494 type: string
30495 rels:
30496 type: array
30497 items:
30498 type: string
30499 title:
30500 type: string
30501 type:
30502 type: string
30503 uri:
30504 type: string
30505 format: uri
30506 uriBuilder:
30507 type: object
30508 uniqueItems: true
30509 location:
30510 type: string
30511 format: uri
30512 mediaType:
30513 type: object
30514 properties:
30515 parameters:
30516 type: object
30517 additionalProperties:
30518 type: string
30519 subtype:
30520 type: string
30521 type:
30522 type: string
30523 wildcardSubtype:
30524 type: boolean
30525 wildcardType:
30526 type: boolean
30527 metadata:
30528 type: object
30529 additionalProperties:
30530 type: array
30531 items:
30532 type: object
30533 status:
30534 type: integer
30535 format: int32
30536 statusInfo:
30537 type: object
30538 properties:
30539 family:
30540 type: string
30541 enum:
30542 - INFORMATIONAL
30543 - SUCCESSFUL
30544 - REDIRECTION
30545 - CLIENT_ERROR
30546 - SERVER_ERROR
30547 - OTHER
30548 reasonPhrase:
30549 type: string
30550 statusCode:
30551 type: integer
30552 format: int32
30553 stringHeaders:
30554 type: object
30555 additionalProperties:
30556 type: array
30557 items:
30558 type: string
30559 servers:
30560 - url: /sdc2/rest
30561 variables: {}
30562 summary: Returns updated Component Instance Capability
30563 tags:
30564 - SDCE-2 APIs
30565 ? /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability/{capabilityType}/capabilityName/{capabilityName}/ownerId/{ownerId}/properties
30566 : get:
30567 description: Get component instance capability properties
30568 operationId: getInstanceCapabilityPropertiesById
30569 parameters:
30570 - in: path
30571 name: containerComponentType
30572 required: true
30573 schema:
30574 type: string
30575 - in: path
30576 name: containerComponentId
30577 required: true
30578 schema:
30579 type: string
30580 - in: path
30581 name: componentInstanceUniqueId
30582 required: true
30583 schema:
30584 type: string
30585 - in: path
30586 name: capabilityType
30587 required: true
30588 schema:
30589 type: string
30590 - in: path
30591 name: capabilityName
30592 required: true
30593 schema:
30594 type: string
30595 - in: path
30596 name: ownerId
30597 required: true
30598 schema:
30599 type: string
30600 - in: header
30601 name: USER_ID
30602 schema:
30603 type: string
30604 responses:
30605 "200":
30606 description: Properties found
30607 "403":
30608 description: Restricted operation
30609 "404":
30610 description: Component/Component Instance/Capability - not found
30611 default:
30612 content:
30613 application/json:
30614 schema:
30615 type: array
30616 items:
30617 type: object
30618 properties:
30619 allowedMethods:
30620 type: array
30621 items:
30622 type: string
30623 uniqueItems: true
30624 cookies:
30625 type: object
30626 additionalProperties:
30627 type: object
30628 properties:
30629 comment:
30630 type: string
30631 domain:
30632 type: string
30633 expiry:
30634 type: string
30635 format: date-time
30636 httpOnly:
30637 type: boolean
30638 maxAge:
30639 type: integer
30640 format: int32
30641 name:
30642 type: string
30643 path:
30644 type: string
30645 secure:
30646 type: boolean
30647 value:
30648 type: string
30649 version:
30650 type: integer
30651 format: int32
30652 date:
30653 type: string
30654 format: date-time
30655 entity:
30656 type: object
30657 entityTag:
30658 type: object
30659 properties:
30660 value:
30661 type: string
30662 weak:
30663 type: boolean
30664 headers:
30665 type: object
30666 additionalProperties:
30667 type: array
30668 items:
30669 type: object
30670 language:
30671 type: object
30672 properties:
30673 country:
30674 type: string
30675 displayCountry:
30676 type: string
30677 displayLanguage:
30678 type: string
30679 displayName:
30680 type: string
30681 displayScript:
30682 type: string
30683 displayVariant:
30684 type: string
30685 extensionKeys:
30686 type: array
30687 items:
30688 type: string
30689 uniqueItems: true
30690 iso3Country:
30691 type: string
30692 iso3Language:
30693 type: string
30694 language:
30695 type: string
30696 script:
30697 type: string
30698 unicodeLocaleAttributes:
30699 type: array
30700 items:
30701 type: string
30702 uniqueItems: true
30703 unicodeLocaleKeys:
30704 type: array
30705 items:
30706 type: string
30707 uniqueItems: true
30708 variant:
30709 type: string
30710 lastModified:
30711 type: string
30712 format: date-time
30713 length:
30714 type: integer
30715 format: int32
30716 links:
30717 type: array
30718 items:
30719 type: object
30720 properties:
30721 params:
30722 type: object
30723 additionalProperties:
30724 type: string
30725 rel:
30726 type: string
30727 rels:
30728 type: array
30729 items:
30730 type: string
30731 title:
30732 type: string
30733 type:
30734 type: string
30735 uri:
30736 type: string
30737 format: uri
30738 uriBuilder:
30739 type: object
30740 uniqueItems: true
30741 location:
30742 type: string
30743 format: uri
30744 mediaType:
30745 type: object
30746 properties:
30747 parameters:
30748 type: object
30749 additionalProperties:
30750 type: string
30751 subtype:
30752 type: string
30753 type:
30754 type: string
30755 wildcardSubtype:
30756 type: boolean
30757 wildcardType:
30758 type: boolean
30759 metadata:
30760 type: object
30761 additionalProperties:
30762 type: array
30763 items:
30764 type: object
30765 status:
30766 type: integer
30767 format: int32
30768 statusInfo:
30769 type: object
30770 properties:
30771 family:
30772 type: string
30773 enum:
30774 - INFORMATIONAL
30775 - SUCCESSFUL
30776 - REDIRECTION
30777 - CLIENT_ERROR
30778 - SERVER_ERROR
30779 - OTHER
30780 reasonPhrase:
30781 type: string
30782 statusCode:
30783 type: integer
30784 format: int32
30785 stringHeaders:
30786 type: object
30787 additionalProperties:
30788 type: array
30789 items:
30790 type: string
30791 servers:
30792 - url: /sdc2/rest
30793 variables: {}
30794 summary: Returns component instance capability properties
30795 tags:
30796 - SDCE-2 APIs
30797 put:
30798 description: Update Instance Capabilty Property
30799 operationId: updateInstanceCapabilityProperty
30800 parameters:
30801 - in: path
30802 name: containerComponentType
30803 required: true
30804 schema:
30805 type: string
30806 - in: path
30807 name: containerComponentId
30808 required: true
30809 schema:
30810 type: string
30811 - in: path
30812 name: componentInstanceUniqueId
30813 required: true
30814 schema:
30815 type: string
30816 - in: path
30817 name: capabilityType
30818 required: true
30819 schema:
30820 type: string
30821 - in: path
30822 name: capabilityName
30823 required: true
30824 schema:
30825 type: string
30826 - in: path
30827 name: ownerId
30828 required: true
30829 schema:
30830 type: string
30831 - in: header
30832 name: USER_ID
30833 schema:
30834 type: string
30835 requestBody:
30836 content:
30837 application/json:
30838 schema:
30839 type: string
30840 description: Instance capabilty property to update
30841 required: true
30842 responses:
30843 "200":
30844 description: Resource instance capabilty property updated
30845 "400":
30846 description: Invalid content / Missing content
30847 "403":
30848 description: Restricted operation
30849 "404":
30850 description: Component/Component Instance/Capability - not found
30851 default:
30852 content:
30853 application/json:
30854 schema:
30855 type: array
30856 items:
30857 type: object
30858 properties:
30859 allowedMethods:
30860 type: array
30861 items:
30862 type: string
30863 uniqueItems: true
30864 cookies:
30865 type: object
30866 additionalProperties:
30867 type: object
30868 properties:
30869 comment:
30870 type: string
30871 domain:
30872 type: string
30873 expiry:
30874 type: string
30875 format: date-time
30876 httpOnly:
30877 type: boolean
30878 maxAge:
30879 type: integer
30880 format: int32
30881 name:
30882 type: string
30883 path:
30884 type: string
30885 secure:
30886 type: boolean
30887 value:
30888 type: string
30889 version:
30890 type: integer
30891 format: int32
30892 date:
30893 type: string
30894 format: date-time
30895 entity:
30896 type: object
30897 entityTag:
30898 type: object
30899 properties:
30900 value:
30901 type: string
30902 weak:
30903 type: boolean
30904 headers:
30905 type: object
30906 additionalProperties:
30907 type: array
30908 items:
30909 type: object
30910 language:
30911 type: object
30912 properties:
30913 country:
30914 type: string
30915 displayCountry:
30916 type: string
30917 displayLanguage:
30918 type: string
30919 displayName:
30920 type: string
30921 displayScript:
30922 type: string
30923 displayVariant:
30924 type: string
30925 extensionKeys:
30926 type: array
30927 items:
30928 type: string
30929 uniqueItems: true
30930 iso3Country:
30931 type: string
30932 iso3Language:
30933 type: string
30934 language:
30935 type: string
30936 script:
30937 type: string
30938 unicodeLocaleAttributes:
30939 type: array
30940 items:
30941 type: string
30942 uniqueItems: true
30943 unicodeLocaleKeys:
30944 type: array
30945 items:
30946 type: string
30947 uniqueItems: true
30948 variant:
30949 type: string
30950 lastModified:
30951 type: string
30952 format: date-time
30953 length:
30954 type: integer
30955 format: int32
30956 links:
30957 type: array
30958 items:
30959 type: object
30960 properties:
30961 params:
30962 type: object
30963 additionalProperties:
30964 type: string
30965 rel:
30966 type: string
30967 rels:
30968 type: array
30969 items:
30970 type: string
30971 title:
30972 type: string
30973 type:
30974 type: string
30975 uri:
30976 type: string
30977 format: uri
30978 uriBuilder:
30979 type: object
30980 uniqueItems: true
30981 location:
30982 type: string
30983 format: uri
30984 mediaType:
30985 type: object
30986 properties:
30987 parameters:
30988 type: object
30989 additionalProperties:
30990 type: string
30991 subtype:
30992 type: string
30993 type:
30994 type: string
30995 wildcardSubtype:
30996 type: boolean
30997 wildcardType:
30998 type: boolean
30999 metadata:
31000 type: object
31001 additionalProperties:
31002 type: array
31003 items:
31004 type: object
31005 status:
31006 type: integer
31007 format: int32
31008 statusInfo:
31009 type: object
31010 properties:
31011 family:
31012 type: string
31013 enum:
31014 - INFORMATIONAL
31015 - SUCCESSFUL
31016 - REDIRECTION
31017 - CLIENT_ERROR
31018 - SERVER_ERROR
31019 - OTHER
31020 reasonPhrase:
31021 type: string
31022 statusCode:
31023 type: integer
31024 format: int32
31025 stringHeaders:
31026 type: object
31027 additionalProperties:
31028 type: array
31029 items:
31030 type: string
31031 servers:
31032 - url: /sdc2/rest
31033 variables: {}
31034 summary: Returns updated property
31035 tags:
31036 - SDCE-2 APIs
31037 /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/properties:
31038 get:
31039 description: Get component instance properties
31040 operationId: getInstancePropertiesById
31041 parameters:
31042 - in: path
31043 name: containerComponentType
31044 required: true
31045 schema:
31046 type: string
31047 - in: path
31048 name: containerComponentId
31049 required: true
31050 schema:
31051 type: string
31052 - in: path
31053 name: componentInstanceUniqueId
31054 required: true
31055 schema:
31056 type: string
31057 - in: header
31058 name: USER_ID
31059 schema:
31060 type: string
31061 responses:
31062 "200":
31063 description: Properties found
31064 "403":
31065 description: Restricted operation
31066 "404":
31067 description: Component/Component Instance - not found
31068 default:
31069 content:
31070 application/json:
31071 schema:
31072 type: array
31073 items:
31074 type: object
31075 properties:
31076 allowedMethods:
31077 type: array
31078 items:
31079 type: string
31080 uniqueItems: true
31081 cookies:
31082 type: object
31083 additionalProperties:
31084 type: object
31085 properties:
31086 comment:
31087 type: string
31088 domain:
31089 type: string
31090 expiry:
31091 type: string
31092 format: date-time
31093 httpOnly:
31094 type: boolean
31095 maxAge:
31096 type: integer
31097 format: int32
31098 name:
31099 type: string
31100 path:
31101 type: string
31102 secure:
31103 type: boolean
31104 value:
31105 type: string
31106 version:
31107 type: integer
31108 format: int32
31109 date:
31110 type: string
31111 format: date-time
31112 entity:
31113 type: object
31114 entityTag:
31115 type: object
31116 properties:
31117 value:
31118 type: string
31119 weak:
31120 type: boolean
31121 headers:
31122 type: object
31123 additionalProperties:
31124 type: array
31125 items:
31126 type: object
31127 language:
31128 type: object
31129 properties:
31130 country:
31131 type: string
31132 displayCountry:
31133 type: string
31134 displayLanguage:
31135 type: string
31136 displayName:
31137 type: string
31138 displayScript:
31139 type: string
31140 displayVariant:
31141 type: string
31142 extensionKeys:
31143 type: array
31144 items:
31145 type: string
31146 uniqueItems: true
31147 iso3Country:
31148 type: string
31149 iso3Language:
31150 type: string
31151 language:
31152 type: string
31153 script:
31154 type: string
31155 unicodeLocaleAttributes:
31156 type: array
31157 items:
31158 type: string
31159 uniqueItems: true
31160 unicodeLocaleKeys:
31161 type: array
31162 items:
31163 type: string
31164 uniqueItems: true
31165 variant:
31166 type: string
31167 lastModified:
31168 type: string
31169 format: date-time
31170 length:
31171 type: integer
31172 format: int32
31173 links:
31174 type: array
31175 items:
31176 type: object
31177 properties:
31178 params:
31179 type: object
31180 additionalProperties:
31181 type: string
31182 rel:
31183 type: string
31184 rels:
31185 type: array
31186 items:
31187 type: string
31188 title:
31189 type: string
31190 type:
31191 type: string
31192 uri:
31193 type: string
31194 format: uri
31195 uriBuilder:
31196 type: object
31197 uniqueItems: true
31198 location:
31199 type: string
31200 format: uri
31201 mediaType:
31202 type: object
31203 properties:
31204 parameters:
31205 type: object
31206 additionalProperties:
31207 type: string
31208 subtype:
31209 type: string
31210 type:
31211 type: string
31212 wildcardSubtype:
31213 type: boolean
31214 wildcardType:
31215 type: boolean
31216 metadata:
31217 type: object
31218 additionalProperties:
31219 type: array
31220 items:
31221 type: object
31222 status:
31223 type: integer
31224 format: int32
31225 statusInfo:
31226 type: object
31227 properties:
31228 family:
31229 type: string
31230 enum:
31231 - INFORMATIONAL
31232 - SUCCESSFUL
31233 - REDIRECTION
31234 - CLIENT_ERROR
31235 - SERVER_ERROR
31236 - OTHER
31237 reasonPhrase:
31238 type: string
31239 statusCode:
31240 type: integer
31241 format: int32
31242 stringHeaders:
31243 type: object
31244 additionalProperties:
31245 type: array
31246 items:
31247 type: string
31248 servers:
31249 - url: /sdc2/rest
31250 variables: {}
31251 summary: Returns component instance properties
31252 tags:
31253 - SDCE-2 APIs
31254 ? /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/requirement/{capabilityType}/requirementName/{requirementName}
31255 : put:
31256 description: Update Instance Requirement
31257 operationId: updateInstanceRequirement_1
31258 parameters:
31259 - in: path
31260 name: containerComponentType
31261 required: true
31262 schema:
31263 type: string
31264 - in: path
31265 name: containerComponentId
31266 required: true
31267 schema:
31268 type: string
31269 - in: path
31270 name: componentInstanceUniqueId
31271 required: true
31272 schema:
31273 type: string
31274 - in: path
31275 name: capabilityType
31276 required: true
31277 schema:
31278 type: string
31279 - in: path
31280 name: requirementName
31281 required: true
31282 schema:
31283 type: string
31284 - in: header
31285 name: USER_ID
31286 schema:
31287 type: string
31288 requestBody:
31289 content:
31290 application/json:
31291 schema:
31292 type: string
31293 description: Instance capabilty requirement to update
31294 required: true
31295 responses:
31296 "200":
31297 description: Resource instance requirement updated
31298 "400":
31299 description: Invalid content / Missing content
31300 "403":
31301 description: Restricted operation
31302 "404":
31303 description: Component/Component Instance/Requirement - not found
31304 default:
31305 content:
31306 application/json:
31307 schema:
31308 type: array
31309 items:
31310 type: object
31311 properties:
31312 allowedMethods:
31313 type: array
31314 items:
31315 type: string
31316 uniqueItems: true
31317 cookies:
31318 type: object
31319 additionalProperties:
31320 type: object
31321 properties:
31322 comment:
31323 type: string
31324 domain:
31325 type: string
31326 expiry:
31327 type: string
31328 format: date-time
31329 httpOnly:
31330 type: boolean
31331 maxAge:
31332 type: integer
31333 format: int32
31334 name:
31335 type: string
31336 path:
31337 type: string
31338 secure:
31339 type: boolean
31340 value:
31341 type: string
31342 version:
31343 type: integer
31344 format: int32
31345 date:
31346 type: string
31347 format: date-time
31348 entity:
31349 type: object
31350 entityTag:
31351 type: object
31352 properties:
31353 value:
31354 type: string
31355 weak:
31356 type: boolean
31357 headers:
31358 type: object
31359 additionalProperties:
31360 type: array
31361 items:
31362 type: object
31363 language:
31364 type: object
31365 properties:
31366 country:
31367 type: string
31368 displayCountry:
31369 type: string
31370 displayLanguage:
31371 type: string
31372 displayName:
31373 type: string
31374 displayScript:
31375 type: string
31376 displayVariant:
31377 type: string
31378 extensionKeys:
31379 type: array
31380 items:
31381 type: string
31382 uniqueItems: true
31383 iso3Country:
31384 type: string
31385 iso3Language:
31386 type: string
31387 language:
31388 type: string
31389 script:
31390 type: string
31391 unicodeLocaleAttributes:
31392 type: array
31393 items:
31394 type: string
31395 uniqueItems: true
31396 unicodeLocaleKeys:
31397 type: array
31398 items:
31399 type: string
31400 uniqueItems: true
31401 variant:
31402 type: string
31403 lastModified:
31404 type: string
31405 format: date-time
31406 length:
31407 type: integer
31408 format: int32
31409 links:
31410 type: array
31411 items:
31412 type: object
31413 properties:
31414 params:
31415 type: object
31416 additionalProperties:
31417 type: string
31418 rel:
31419 type: string
31420 rels:
31421 type: array
31422 items:
31423 type: string
31424 title:
31425 type: string
31426 type:
31427 type: string
31428 uri:
31429 type: string
31430 format: uri
31431 uriBuilder:
31432 type: object
31433 uniqueItems: true
31434 location:
31435 type: string
31436 format: uri
31437 mediaType:
31438 type: object
31439 properties:
31440 parameters:
31441 type: object
31442 additionalProperties:
31443 type: string
31444 subtype:
31445 type: string
31446 type:
31447 type: string
31448 wildcardSubtype:
31449 type: boolean
31450 wildcardType:
31451 type: boolean
31452 metadata:
31453 type: object
31454 additionalProperties:
31455 type: array
31456 items:
31457 type: object
31458 status:
31459 type: integer
31460 format: int32
31461 statusInfo:
31462 type: object
31463 properties:
31464 family:
31465 type: string
31466 enum:
31467 - INFORMATIONAL
31468 - SUCCESSFUL
31469 - REDIRECTION
31470 - CLIENT_ERROR
31471 - SERVER_ERROR
31472 - OTHER
31473 reasonPhrase:
31474 type: string
31475 statusCode:
31476 type: integer
31477 format: int32
31478 stringHeaders:
31479 type: object
31480 additionalProperties:
31481 type: array
31482 items:
31483 type: string
31484 servers:
31485 - url: /sdc2/rest
31486 variables: {}
31487 summary: Returns updated requirement
31488 tags:
31489 - SDCE-2 APIs
31490 /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy:
31491 post:
31492 description: Create service proxy
31493 operationId: createServiceProxy
31494 parameters:
31495 - in: path
31496 name: containerComponentId
31497 required: true
31498 schema:
31499 type: string
31500 - description: "valid values: resources / services"
31501 in: path
31502 name: containerComponentType
31503 required: true
31504 schema:
31505 type: string
31506 enum:
31507 - resources
31508 - services
31509 - description: USER_ID of modifier user
31510 in: header
31511 name: USER_ID
31512 required: true
31513 schema:
31514 type: string
31515 requestBody:
31516 content:
31517 application/json:
31518 schema:
31519 type: string
31520 description: RI object to be created
31521 required: true
31522 responses:
31523 "201":
31524 description: Service proxy created
31525 "400":
31526 description: Invalid content / Missing content
31527 "403":
31528 description: Restricted operation
31529 "409":
31530 description: Service proxy already exist
31531 default:
31532 content:
31533 application/json:
31534 schema:
31535 type: array
31536 items:
31537 type: object
31538 properties:
31539 allowedMethods:
31540 type: array
31541 items:
31542 type: string
31543 uniqueItems: true
31544 cookies:
31545 type: object
31546 additionalProperties:
31547 type: object
31548 properties:
31549 comment:
31550 type: string
31551 domain:
31552 type: string
31553 expiry:
31554 type: string
31555 format: date-time
31556 httpOnly:
31557 type: boolean
31558 maxAge:
31559 type: integer
31560 format: int32
31561 name:
31562 type: string
31563 path:
31564 type: string
31565 secure:
31566 type: boolean
31567 value:
31568 type: string
31569 version:
31570 type: integer
31571 format: int32
31572 date:
31573 type: string
31574 format: date-time
31575 entity:
31576 type: object
31577 entityTag:
31578 type: object
31579 properties:
31580 value:
31581 type: string
31582 weak:
31583 type: boolean
31584 headers:
31585 type: object
31586 additionalProperties:
31587 type: array
31588 items:
31589 type: object
31590 language:
31591 type: object
31592 properties:
31593 country:
31594 type: string
31595 displayCountry:
31596 type: string
31597 displayLanguage:
31598 type: string
31599 displayName:
31600 type: string
31601 displayScript:
31602 type: string
31603 displayVariant:
31604 type: string
31605 extensionKeys:
31606 type: array
31607 items:
31608 type: string
31609 uniqueItems: true
31610 iso3Country:
31611 type: string
31612 iso3Language:
31613 type: string
31614 language:
31615 type: string
31616 script:
31617 type: string
31618 unicodeLocaleAttributes:
31619 type: array
31620 items:
31621 type: string
31622 uniqueItems: true
31623 unicodeLocaleKeys:
31624 type: array
31625 items:
31626 type: string
31627 uniqueItems: true
31628 variant:
31629 type: string
31630 lastModified:
31631 type: string
31632 format: date-time
31633 length:
31634 type: integer
31635 format: int32
31636 links:
31637 type: array
31638 items:
31639 type: object
31640 properties:
31641 params:
31642 type: object
31643 additionalProperties:
31644 type: string
31645 rel:
31646 type: string
31647 rels:
31648 type: array
31649 items:
31650 type: string
31651 title:
31652 type: string
31653 type:
31654 type: string
31655 uri:
31656 type: string
31657 format: uri
31658 uriBuilder:
31659 type: object
31660 uniqueItems: true
31661 location:
31662 type: string
31663 format: uri
31664 mediaType:
31665 type: object
31666 properties:
31667 parameters:
31668 type: object
31669 additionalProperties:
31670 type: string
31671 subtype:
31672 type: string
31673 type:
31674 type: string
31675 wildcardSubtype:
31676 type: boolean
31677 wildcardType:
31678 type: boolean
31679 metadata:
31680 type: object
31681 additionalProperties:
31682 type: array
31683 items:
31684 type: object
31685 status:
31686 type: integer
31687 format: int32
31688 statusInfo:
31689 type: object
31690 properties:
31691 family:
31692 type: string
31693 enum:
31694 - INFORMATIONAL
31695 - SUCCESSFUL
31696 - REDIRECTION
31697 - CLIENT_ERROR
31698 - SERVER_ERROR
31699 - OTHER
31700 reasonPhrase:
31701 type: string
31702 statusCode:
31703 type: integer
31704 format: int32
31705 stringHeaders:
31706 type: object
31707 additionalProperties:
31708 type: array
31709 items:
31710 type: string
31711 servers:
31712 - url: /sdc2/rest
31713 variables: {}
31714 summary: Returns created service proxy
31715 tags:
31716 - SDCE-2 APIs
31717 /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}:
31718 delete:
31719 description: Delete service proxy
31720 operationId: deleteServiceProxy
31721 parameters:
31722 - in: path
31723 name: containerComponentId
31724 required: true
31725 schema:
31726 type: string
31727 - in: path
31728 name: serviceProxyId
31729 required: true
31730 schema:
31731 type: string
31732 - description: "valid values: resources / services / products"
31733 in: path
31734 name: containerComponentType
31735 required: true
31736 schema:
31737 type: string
31738 enum:
31739 - resources
31740 - services
31741 responses:
31742 "201":
31743 description: Service proxy deleted
31744 "400":
31745 description: Invalid content / Missing content
31746 "403":
31747 description: Restricted operation
31748 default:
31749 content:
31750 application/json:
31751 schema:
31752 type: array
31753 items:
31754 type: object
31755 properties:
31756 allowedMethods:
31757 type: array
31758 items:
31759 type: string
31760 uniqueItems: true
31761 cookies:
31762 type: object
31763 additionalProperties:
31764 type: object
31765 properties:
31766 comment:
31767 type: string
31768 domain:
31769 type: string
31770 expiry:
31771 type: string
31772 format: date-time
31773 httpOnly:
31774 type: boolean
31775 maxAge:
31776 type: integer
31777 format: int32
31778 name:
31779 type: string
31780 path:
31781 type: string
31782 secure:
31783 type: boolean
31784 value:
31785 type: string
31786 version:
31787 type: integer
31788 format: int32
31789 date:
31790 type: string
31791 format: date-time
31792 entity:
31793 type: object
31794 entityTag:
31795 type: object
31796 properties:
31797 value:
31798 type: string
31799 weak:
31800 type: boolean
31801 headers:
31802 type: object
31803 additionalProperties:
31804 type: array
31805 items:
31806 type: object
31807 language:
31808 type: object
31809 properties:
31810 country:
31811 type: string
31812 displayCountry:
31813 type: string
31814 displayLanguage:
31815 type: string
31816 displayName:
31817 type: string
31818 displayScript:
31819 type: string
31820 displayVariant:
31821 type: string
31822 extensionKeys:
31823 type: array
31824 items:
31825 type: string
31826 uniqueItems: true
31827 iso3Country:
31828 type: string
31829 iso3Language:
31830 type: string
31831 language:
31832 type: string
31833 script:
31834 type: string
31835 unicodeLocaleAttributes:
31836 type: array
31837 items:
31838 type: string
31839 uniqueItems: true
31840 unicodeLocaleKeys:
31841 type: array
31842 items:
31843 type: string
31844 uniqueItems: true
31845 variant:
31846 type: string
31847 lastModified:
31848 type: string
31849 format: date-time
31850 length:
31851 type: integer
31852 format: int32
31853 links:
31854 type: array
31855 items:
31856 type: object
31857 properties:
31858 params:
31859 type: object
31860 additionalProperties:
31861 type: string
31862 rel:
31863 type: string
31864 rels:
31865 type: array
31866 items:
31867 type: string
31868 title:
31869 type: string
31870 type:
31871 type: string
31872 uri:
31873 type: string
31874 format: uri
31875 uriBuilder:
31876 type: object
31877 uniqueItems: true
31878 location:
31879 type: string
31880 format: uri
31881 mediaType:
31882 type: object
31883 properties:
31884 parameters:
31885 type: object
31886 additionalProperties:
31887 type: string
31888 subtype:
31889 type: string
31890 type:
31891 type: string
31892 wildcardSubtype:
31893 type: boolean
31894 wildcardType:
31895 type: boolean
31896 metadata:
31897 type: object
31898 additionalProperties:
31899 type: array
31900 items:
31901 type: object
31902 status:
31903 type: integer
31904 format: int32
31905 statusInfo:
31906 type: object
31907 properties:
31908 family:
31909 type: string
31910 enum:
31911 - INFORMATIONAL
31912 - SUCCESSFUL
31913 - REDIRECTION
31914 - CLIENT_ERROR
31915 - SERVER_ERROR
31916 - OTHER
31917 reasonPhrase:
31918 type: string
31919 statusCode:
31920 type: integer
31921 format: int32
31922 stringHeaders:
31923 type: object
31924 additionalProperties:
31925 type: array
31926 items:
31927 type: string
31928 servers:
31929 - url: /sdc2/rest
31930 variables: {}
31931 summary: Returns delete service proxy
31932 tags:
31933 - SDCE-2 APIs
31934 /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}/changeVersion/{newServiceId}:
31935 post:
31936 description: Update service proxy with new version
31937 operationId: changeServiceProxyVersion
31938 parameters:
31939 - in: path
31940 name: containerComponentId
31941 required: true
31942 schema:
31943 type: string
31944 - in: path
31945 name: serviceProxyId
31946 required: true
31947 schema:
31948 type: string
31949 - description: "valid values: resources / services"
31950 in: path
31951 name: containerComponentType
31952 required: true
31953 schema:
31954 type: string
31955 enum:
31956 - resources
31957 - services
31958 responses:
31959 "201":
31960 description: Service proxy created
31961 "400":
31962 description: Invalid content / Missing content
31963 "403":
31964 description: Restricted operation
31965 default:
31966 content:
31967 application/json:
31968 schema:
31969 type: array
31970 items:
31971 type: object
31972 properties:
31973 allowedMethods:
31974 type: array
31975 items:
31976 type: string
31977 uniqueItems: true
31978 cookies:
31979 type: object
31980 additionalProperties:
31981 type: object
31982 properties:
31983 comment:
31984 type: string
31985 domain:
31986 type: string
31987 expiry:
31988 type: string
31989 format: date-time
31990 httpOnly:
31991 type: boolean
31992 maxAge:
31993 type: integer
31994 format: int32
31995 name:
31996 type: string
31997 path:
31998 type: string
31999 secure:
32000 type: boolean
32001 value:
32002 type: string
32003 version:
32004 type: integer
32005 format: int32
32006 date:
32007 type: string
32008 format: date-time
32009 entity:
32010 type: object
32011 entityTag:
32012 type: object
32013 properties:
32014 value:
32015 type: string
32016 weak:
32017 type: boolean
32018 headers:
32019 type: object
32020 additionalProperties:
32021 type: array
32022 items:
32023 type: object
32024 language:
32025 type: object
32026 properties:
32027 country:
32028 type: string
32029 displayCountry:
32030 type: string
32031 displayLanguage:
32032 type: string
32033 displayName:
32034 type: string
32035 displayScript:
32036 type: string
32037 displayVariant:
32038 type: string
32039 extensionKeys:
32040 type: array
32041 items:
32042 type: string
32043 uniqueItems: true
32044 iso3Country:
32045 type: string
32046 iso3Language:
32047 type: string
32048 language:
32049 type: string
32050 script:
32051 type: string
32052 unicodeLocaleAttributes:
32053 type: array
32054 items:
32055 type: string
32056 uniqueItems: true
32057 unicodeLocaleKeys:
32058 type: array
32059 items:
32060 type: string
32061 uniqueItems: true
32062 variant:
32063 type: string
32064 lastModified:
32065 type: string
32066 format: date-time
32067 length:
32068 type: integer
32069 format: int32
32070 links:
32071 type: array
32072 items:
32073 type: object
32074 properties:
32075 params:
32076 type: object
32077 additionalProperties:
32078 type: string
32079 rel:
32080 type: string
32081 rels:
32082 type: array
32083 items:
32084 type: string
32085 title:
32086 type: string
32087 type:
32088 type: string
32089 uri:
32090 type: string
32091 format: uri
32092 uriBuilder:
32093 type: object
32094 uniqueItems: true
32095 location:
32096 type: string
32097 format: uri
32098 mediaType:
32099 type: object
32100 properties:
32101 parameters:
32102 type: object
32103 additionalProperties:
32104 type: string
32105 subtype:
32106 type: string
32107 type:
32108 type: string
32109 wildcardSubtype:
32110 type: boolean
32111 wildcardType:
32112 type: boolean
32113 metadata:
32114 type: object
32115 additionalProperties:
32116 type: array
32117 items:
32118 type: object
32119 status:
32120 type: integer
32121 format: int32
32122 statusInfo:
32123 type: object
32124 properties:
32125 family:
32126 type: string
32127 enum:
32128 - INFORMATIONAL
32129 - SUCCESSFUL
32130 - REDIRECTION
32131 - CLIENT_ERROR
32132 - SERVER_ERROR
32133 - OTHER
32134 reasonPhrase:
32135 type: string
32136 statusCode:
32137 type: integer
32138 format: int32
32139 stringHeaders:
32140 type: object
32141 additionalProperties:
32142 type: array
32143 items:
32144 type: string
32145 servers:
32146 - url: /sdc2/rest
32147 variables: {}
32148 summary: Returns updated service proxy
32149 tags:
32150 - SDCE-2 APIs
32151 /v1/catalog/{containerComponentType}/{serviceId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}:
32152 put:
32153 description: Update Group Instance Property Values
32154 operationId: updateGroupInstancePropertyValues
32155 parameters:
32156 - in: path
32157 name: serviceId
32158 required: true
32159 schema:
32160 type: string
32161 - in: path
32162 name: componentInstanceId
32163 required: true
32164 schema:
32165 type: string
32166 - in: path
32167 name: groupInstanceId
32168 required: true
32169 schema:
32170 type: string
32171 - in: header
32172 name: USER_ID
32173 schema:
32174 type: string
32175 requestBody:
32176 content:
32177 application/json:
32178 schema:
32179 type: string
32180 description: Group instance object to be Updated
32181 required: true
32182 responses:
32183 "200":
32184 description: Group Instance Property Values Updated
32185 "400":
32186 description: Invalid content / Missing content
32187 "403":
32188 description: Restricted operation
32189 default:
32190 content:
32191 application/json:
32192 schema:
32193 type: array
32194 items:
32195 $ref: '#/components/schemas/Service'
32196 servers:
32197 - url: /sdc2/rest
32198 variables: {}
32199 summary: Returns updated group instance
32200 tags:
32201 - SDCE-2 APIs
32202 /v1/catalogUpdateTime:
32203 get:
32204 description: Retrieve previus and current catalog update time
32205 operationId: getCatalogUpdateTime
32206 parameters:
32207 - in: header
32208 name: USER_ID
32209 schema:
32210 type: string
32211 responses:
32212 "200":
32213 description: Retrieve previus and current catalog update time
32214 default:
32215 content:
32216 application/json:
32217 schema:
32218 type: array
32219 items:
32220 type: object
32221 properties:
32222 allowedMethods:
32223 type: array
32224 items:
32225 type: string
32226 uniqueItems: true
32227 cookies:
32228 type: object
32229 additionalProperties:
32230 type: object
32231 properties:
32232 comment:
32233 type: string
32234 domain:
32235 type: string
32236 expiry:
32237 type: string
32238 format: date-time
32239 httpOnly:
32240 type: boolean
32241 maxAge:
32242 type: integer
32243 format: int32
32244 name:
32245 type: string
32246 path:
32247 type: string
32248 secure:
32249 type: boolean
32250 value:
32251 type: string
32252 version:
32253 type: integer
32254 format: int32
32255 date:
32256 type: string
32257 format: date-time
32258 entity:
32259 type: object
32260 entityTag:
32261 type: object
32262 properties:
32263 value:
32264 type: string
32265 weak:
32266 type: boolean
32267 headers:
32268 type: object
32269 additionalProperties:
32270 type: array
32271 items:
32272 type: object
32273 language:
32274 type: object
32275 properties:
32276 country:
32277 type: string
32278 displayCountry:
32279 type: string
32280 displayLanguage:
32281 type: string
32282 displayName:
32283 type: string
32284 displayScript:
32285 type: string
32286 displayVariant:
32287 type: string
32288 extensionKeys:
32289 type: array
32290 items:
32291 type: string
32292 uniqueItems: true
32293 iso3Country:
32294 type: string
32295 iso3Language:
32296 type: string
32297 language:
32298 type: string
32299 script:
32300 type: string
32301 unicodeLocaleAttributes:
32302 type: array
32303 items:
32304 type: string
32305 uniqueItems: true
32306 unicodeLocaleKeys:
32307 type: array
32308 items:
32309 type: string
32310 uniqueItems: true
32311 variant:
32312 type: string
32313 lastModified:
32314 type: string
32315 format: date-time
32316 length:
32317 type: integer
32318 format: int32
32319 links:
32320 type: array
32321 items:
32322 type: object
32323 properties:
32324 params:
32325 type: object
32326 additionalProperties:
32327 type: string
32328 rel:
32329 type: string
32330 rels:
32331 type: array
32332 items:
32333 type: string
32334 title:
32335 type: string
32336 type:
32337 type: string
32338 uri:
32339 type: string
32340 format: uri
32341 uriBuilder:
32342 type: object
32343 uniqueItems: true
32344 location:
32345 type: string
32346 format: uri
32347 mediaType:
32348 type: object
32349 properties:
32350 parameters:
32351 type: object
32352 additionalProperties:
32353 type: string
32354 subtype:
32355 type: string
32356 type:
32357 type: string
32358 wildcardSubtype:
32359 type: boolean
32360 wildcardType:
32361 type: boolean
32362 metadata:
32363 type: object
32364 additionalProperties:
32365 type: array
32366 items:
32367 type: object
32368 status:
32369 type: integer
32370 format: int32
32371 statusInfo:
32372 type: object
32373 properties:
32374 family:
32375 type: string
32376 enum:
32377 - INFORMATIONAL
32378 - SUCCESSFUL
32379 - REDIRECTION
32380 - CLIENT_ERROR
32381 - SERVER_ERROR
32382 - OTHER
32383 reasonPhrase:
32384 type: string
32385 statusCode:
32386 type: integer
32387 format: int32
32388 stringHeaders:
32389 type: object
32390 additionalProperties:
32391 type: array
32392 items:
32393 type: string
32394 servers:
32395 - url: /sdc2/rest
32396 variables: {}
32397 summary: Retrieve previus and current catalog update time
32398 tags:
32399 - SDCE-2 APIs
32400 /v1/categories/{componentType}:
32401 get:
32402 description: Retrieve the list of all resource/service/product categories/sub-categories/groupings
32403 operationId: getComponentCategories
32404 parameters:
32405 - description: allowed values are resources / services/ products
32406 in: path
32407 name: componentType
32408 required: true
32409 schema:
32410 type: string
32411 enum:
32412 - resources
32413 - services
32414 - products
32415 - in: header
32416 name: USER_ID
32417 schema:
32418 type: string
32419 responses:
32420 "200":
32421 description: Returns categories Ok
32422 "400":
32423 description: Invalid component type
32424 "403":
32425 description: Missing information
32426 "409":
32427 description: Restricted operation
32428 "500":
32429 description: Internal Server Error
32430 default:
32431 content:
32432 application/json:
32433 schema:
32434 type: array
32435 items:
32436 type: object
32437 properties:
32438 allowedMethods:
32439 type: array
32440 items:
32441 type: string
32442 uniqueItems: true
32443 cookies:
32444 type: object
32445 additionalProperties:
32446 type: object
32447 properties:
32448 comment:
32449 type: string
32450 domain:
32451 type: string
32452 expiry:
32453 type: string
32454 format: date-time
32455 httpOnly:
32456 type: boolean
32457 maxAge:
32458 type: integer
32459 format: int32
32460 name:
32461 type: string
32462 path:
32463 type: string
32464 secure:
32465 type: boolean
32466 value:
32467 type: string
32468 version:
32469 type: integer
32470 format: int32
32471 date:
32472 type: string
32473 format: date-time
32474 entity:
32475 type: object
32476 entityTag:
32477 type: object
32478 properties:
32479 value:
32480 type: string
32481 weak:
32482 type: boolean
32483 headers:
32484 type: object
32485 additionalProperties:
32486 type: array
32487 items:
32488 type: object
32489 language:
32490 type: object
32491 properties:
32492 country:
32493 type: string
32494 displayCountry:
32495 type: string
32496 displayLanguage:
32497 type: string
32498 displayName:
32499 type: string
32500 displayScript:
32501 type: string
32502 displayVariant:
32503 type: string
32504 extensionKeys:
32505 type: array
32506 items:
32507 type: string
32508 uniqueItems: true
32509 iso3Country:
32510 type: string
32511 iso3Language:
32512 type: string
32513 language:
32514 type: string
32515 script:
32516 type: string
32517 unicodeLocaleAttributes:
32518 type: array
32519 items:
32520 type: string
32521 uniqueItems: true
32522 unicodeLocaleKeys:
32523 type: array
32524 items:
32525 type: string
32526 uniqueItems: true
32527 variant:
32528 type: string
32529 lastModified:
32530 type: string
32531 format: date-time
32532 length:
32533 type: integer
32534 format: int32
32535 links:
32536 type: array
32537 items:
32538 type: object
32539 properties:
32540 params:
32541 type: object
32542 additionalProperties:
32543 type: string
32544 rel:
32545 type: string
32546 rels:
32547 type: array
32548 items:
32549 type: string
32550 title:
32551 type: string
32552 type:
32553 type: string
32554 uri:
32555 type: string
32556 format: uri
32557 uriBuilder:
32558 type: object
32559 uniqueItems: true
32560 location:
32561 type: string
32562 format: uri
32563 mediaType:
32564 type: object
32565 properties:
32566 parameters:
32567 type: object
32568 additionalProperties:
32569 type: string
32570 subtype:
32571 type: string
32572 type:
32573 type: string
32574 wildcardSubtype:
32575 type: boolean
32576 wildcardType:
32577 type: boolean
32578 metadata:
32579 type: object
32580 additionalProperties:
32581 type: array
32582 items:
32583 type: object
32584 status:
32585 type: integer
32586 format: int32
32587 statusInfo:
32588 type: object
32589 properties:
32590 family:
32591 type: string
32592 enum:
32593 - INFORMATIONAL
32594 - SUCCESSFUL
32595 - REDIRECTION
32596 - CLIENT_ERROR
32597 - SERVER_ERROR
32598 - OTHER
32599 reasonPhrase:
32600 type: string
32601 statusCode:
32602 type: integer
32603 format: int32
32604 stringHeaders:
32605 type: object
32606 additionalProperties:
32607 type: array
32608 items:
32609 type: string
32610 servers:
32611 - url: /sdc2/rest
32612 variables: {}
32613 summary: Retrieve the list of all resource/service/product categories/sub-categories/groupings.
32614 tags:
32615 - SDCE-2 APIs
32616 /v1/category/{componentType}:
32617 post:
32618 description: Create new component category
32619 operationId: createComponentCategory
32620 parameters:
32621 - description: allowed values are resources /services / products
32622 in: path
32623 name: componentType
32624 required: true
32625 schema:
32626 type: string
32627 enum:
32628 - resources
32629 - services
32630 - products
32631 - in: header
32632 name: USER_ID
32633 schema:
32634 type: string
32635 requestBody:
32636 content:
32637 application/json:
32638 schema:
32639 type: string
32640 description: Category to be created
32641 required: true
32642 responses:
32643 "201":
32644 description: Category created
32645 "400":
32646 description: Invalid category data
32647 "403":
32648 description: USER_ID header is missing
32649 "409":
32650 description: Category already exists / User not permitted to perform the
32651 action
32652 "500":
32653 description: General Error
32654 servers:
32655 - url: /sdc2/rest
32656 variables: {}
32657 summary: Create new component category
32658 tags:
32659 - SDCE-2 APIs
32660 /v1/category/{componentType}/{categoryId}/subCategory:
32661 post:
32662 description: Create new component sub-category
32663 operationId: createComponentSubCategory
32664 parameters:
32665 - description: allowed values are resources / products
32666 in: path
32667 name: componentType
32668 required: true
32669 schema:
32670 type: string
32671 enum:
32672 - resources
32673 - products
32674 - description: Parent category unique ID
32675 in: path
32676 name: categoryId
32677 required: true
32678 schema:
32679 type: string
32680 - in: header
32681 name: USER_ID
32682 schema:
32683 type: string
32684 requestBody:
32685 content:
32686 application/json:
32687 schema:
32688 type: string
32689 description: "Subcategory to be created. \ne.g. {\"name\":\"Resource-subcat\"\
32690 }"
32691 required: true
32692 responses:
32693 "201":
32694 description: Subcategory created
32695 "400":
32696 description: Invalid subcategory data
32697 "403":
32698 description: USER_ID header is missing
32699 "404":
32700 description: Parent category wasn't found
32701 "409":
32702 description: Subcategory already exists / User not permitted to perform
32703 the action
32704 "500":
32705 description: General Error
32706 servers:
32707 - url: /sdc2/rest
32708 variables: {}
32709 summary: Create new component sub-category for existing category
32710 tags:
32711 - SDCE-2 APIs
32712 /v1/category/{componentType}/{categoryId}/subCategory/{subCategoryId}/grouping:
32713 post:
32714 description: Create new component grouping
32715 operationId: createComponentGrouping
32716 parameters:
32717 - description: allowed values are products
32718 in: path
32719 name: componentType
32720 required: true
32721 schema:
32722 type: string
32723 enum:
32724 - products
32725 - description: Parent category unique ID
32726 in: path
32727 name: categoryId
32728 required: true
32729 schema:
32730 type: string
32731 - description: Parent sub-category unique ID
32732 in: path
32733 name: subCategoryId
32734 required: true
32735 schema:
32736 type: string
32737 - in: header
32738 name: USER_ID
32739 schema:
32740 type: string
32741 requestBody:
32742 content:
32743 application/json:
32744 schema:
32745 type: string
32746 description: Subcategory to be created
32747 required: true
32748 responses:
32749 "201":
32750 description: Grouping created
32751 "400":
32752 description: Invalid grouping data
32753 "403":
32754 description: USER_ID header is missing
32755 "404":
32756 description: Parent category or subcategory were not found
32757 "409":
32758 description: Grouping already exists / User not permitted to perform the
32759 action
32760 "500":
32761 description: General Error
32762 servers:
32763 - url: /sdc2/rest
32764 variables: {}
32765 summary: Create new component grouping for existing sub-category
32766 tags:
32767 - SDCE-2 APIs
32768 /v1/category/{componentType}/{categoryName}/baseTypes:
32769 get:
32770 description: Get base types for category
32771 operationId: getCategoryBaseTypes
32772 parameters:
32773 - in: path
32774 name: categoryName
32775 required: true
32776 schema:
32777 type: string
32778 - in: path
32779 name: componentType
32780 required: true
32781 schema:
32782 type: string
32783 - in: header
32784 name: USER_ID
32785 schema:
32786 type: string
32787 - description: model
32788 in: query
32789 name: model
32790 schema:
32791 type: string
32792 responses:
32793 "200":
32794 description: Returns base types Ok
32795 "404":
32796 description: No base types were found
32797 "500":
32798 description: Internal Server Error
32799 servers:
32800 - url: /sdc2/rest
32801 variables: {}
32802 summary: Get base types for category
32803 tags:
32804 - SDCE-2 APIs
32805 /v1/category/{componentType}/{categoryUniqueId}:
32806 delete:
32807 description: Delete component category
32808 operationId: deleteComponentCategory
32809 parameters:
32810 - in: path
32811 name: categoryUniqueId
32812 required: true
32813 schema:
32814 type: string
32815 - in: path
32816 name: componentType
32817 required: true
32818 schema:
32819 type: string
32820 - in: header
32821 name: USER_ID
32822 schema:
32823 type: string
32824 responses:
32825 "204":
32826 description: Category deleted
32827 "403":
32828 description: USER_ID header is missing
32829 "404":
32830 description: Category not found
32831 "409":
32832 description: User not permitted to perform the action
32833 "500":
32834 description: General Error
32835 default:
32836 content:
32837 application/json:
32838 schema:
32839 type: array
32840 items:
32841 $ref: '#/components/schemas/Category'
32842 servers:
32843 - url: /sdc2/rest
32844 variables: {}
32845 summary: Delete component category
32846 tags:
32847 - SDCE-2 APIs
32848 /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}:
32849 delete:
32850 description: Delete component category
32851 operationId: deleteComponentSubCategory
32852 parameters:
32853 - in: path
32854 name: categoryUniqueId
32855 required: true
32856 schema:
32857 type: string
32858 - in: path
32859 name: subCategoryUniqueId
32860 required: true
32861 schema:
32862 type: string
32863 - in: path
32864 name: componentType
32865 required: true
32866 schema:
32867 type: string
32868 - in: header
32869 name: USER_ID
32870 schema:
32871 type: string
32872 responses:
32873 "204":
32874 description: Category deleted
32875 "403":
32876 description: USER_ID header is missing
32877 "404":
32878 description: Category not found
32879 "409":
32880 description: User not permitted to perform the action
32881 "500":
32882 description: General Error
32883 default:
32884 content:
32885 application/json:
32886 schema:
32887 type: array
32888 items:
32889 $ref: '#/components/schemas/Category'
32890 servers:
32891 - url: /sdc2/rest
32892 variables: {}
32893 summary: Delete component category
32894 tags:
32895 - SDCE-2 APIs
32896 /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}/grouping/{groupingUniqueId}:
32897 delete:
32898 description: Delete component category
32899 operationId: deleteComponentGrouping
32900 parameters:
32901 - in: path
32902 name: categoryUniqueId
32903 required: true
32904 schema:
32905 type: string
32906 - in: path
32907 name: subCategoryUniqueId
32908 required: true
32909 schema:
32910 type: string
32911 - in: path
32912 name: groupingUniqueId
32913 required: true
32914 schema:
32915 type: string
32916 - in: path
32917 name: componentType
32918 required: true
32919 schema:
32920 type: string
32921 - in: header
32922 name: USER_ID
32923 schema:
32924 type: string
32925 responses:
32926 "204":
32927 description: Category deleted
32928 "403":
32929 description: USER_ID header is missing
32930 "404":
32931 description: Category not found
32932 "409":
32933 description: User not permitted to perform the action
32934 "500":
32935 description: General Error
32936 default:
32937 content:
32938 application/json:
32939 schema:
32940 type: array
32941 items:
32942 $ref: '#/components/schemas/Category'
32943 servers:
32944 - url: /sdc2/rest
32945 variables: {}
32946 summary: Delete component category
32947 tags:
32948 - SDCE-2 APIs
32949 /v1/consumers:
32950 post:
32951 description: Consumer credentials
32952 operationId: createConsumer
32953 parameters:
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: Consumer Object to be created
32964 required: true
32965 responses:
32966 "201":
32967 description: Consumer credentials created
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 type: object
32979 properties:
32980 allowedMethods:
32981 type: array
32982 items:
32983 type: string
32984 uniqueItems: true
32985 cookies:
32986 type: object
32987 additionalProperties:
32988 type: object
32989 properties:
32990 comment:
32991 type: string
32992 domain:
32993 type: string
32994 expiry:
32995 type: string
32996 format: date-time
32997 httpOnly:
32998 type: boolean
32999 maxAge:
33000 type: integer
33001 format: int32
33002 name:
33003 type: string
33004 path:
33005 type: string
33006 secure:
33007 type: boolean
33008 value:
33009 type: string
33010 version:
33011 type: integer
33012 format: int32
33013 date:
33014 type: string
33015 format: date-time
33016 entity:
33017 type: object
33018 entityTag:
33019 type: object
33020 properties:
33021 value:
33022 type: string
33023 weak:
33024 type: boolean
33025 headers:
33026 type: object
33027 additionalProperties:
33028 type: array
33029 items:
33030 type: object
33031 language:
33032 type: object
33033 properties:
33034 country:
33035 type: string
33036 displayCountry:
33037 type: string
33038 displayLanguage:
33039 type: string
33040 displayName:
33041 type: string
33042 displayScript:
33043 type: string
33044 displayVariant:
33045 type: string
33046 extensionKeys:
33047 type: array
33048 items:
33049 type: string
33050 uniqueItems: true
33051 iso3Country:
33052 type: string
33053 iso3Language:
33054 type: string
33055 language:
33056 type: string
33057 script:
33058 type: string
33059 unicodeLocaleAttributes:
33060 type: array
33061 items:
33062 type: string
33063 uniqueItems: true
33064 unicodeLocaleKeys:
33065 type: array
33066 items:
33067 type: string
33068 uniqueItems: true
33069 variant:
33070 type: string
33071 lastModified:
33072 type: string
33073 format: date-time
33074 length:
33075 type: integer
33076 format: int32
33077 links:
33078 type: array
33079 items:
33080 type: object
33081 properties:
33082 params:
33083 type: object
33084 additionalProperties:
33085 type: string
33086 rel:
33087 type: string
33088 rels:
33089 type: array
33090 items:
33091 type: string
33092 title:
33093 type: string
33094 type:
33095 type: string
33096 uri:
33097 type: string
33098 format: uri
33099 uriBuilder:
33100 type: object
33101 uniqueItems: true
33102 location:
33103 type: string
33104 format: uri
33105 mediaType:
33106 type: object
33107 properties:
33108 parameters:
33109 type: object
33110 additionalProperties:
33111 type: string
33112 subtype:
33113 type: string
33114 type:
33115 type: string
33116 wildcardSubtype:
33117 type: boolean
33118 wildcardType:
33119 type: boolean
33120 metadata:
33121 type: object
33122 additionalProperties:
33123 type: array
33124 items:
33125 type: object
33126 status:
33127 type: integer
33128 format: int32
33129 statusInfo:
33130 type: object
33131 properties:
33132 family:
33133 type: string
33134 enum:
33135 - INFORMATIONAL
33136 - SUCCESSFUL
33137 - REDIRECTION
33138 - CLIENT_ERROR
33139 - SERVER_ERROR
33140 - OTHER
33141 reasonPhrase:
33142 type: string
33143 statusCode:
33144 type: integer
33145 format: int32
33146 stringHeaders:
33147 type: object
33148 additionalProperties:
33149 type: array
33150 items:
33151 type: string
33152 servers:
33153 - url: /sdc2/rest
33154 variables: {}
33155 summary: Returns created ECOMP consumer credentials
33156 tags:
33157 - SDCE-2 APIs
33158 /v1/consumers/{consumerId}:
33159 delete:
33160 description: Deletes Consumer
33161 operationId: deleteConsumer
33162 parameters:
33163 - in: path
33164 name: consumerId
33165 required: true
33166 schema:
33167 type: string
33168 - in: header
33169 name: USER_ID
33170 schema:
33171 type: string
33172 responses:
33173 "204":
33174 description: Consumer deleted
33175 "403":
33176 description: Restricted operation
33177 "404":
33178 description: Consumer not found
33179 default:
33180 content:
33181 application/json:
33182 schema:
33183 type: array
33184 items:
33185 $ref: '#/components/schemas/ConsumerDefinition'
33186 servers:
33187 - url: /sdc2/rest
33188 variables: {}
33189 summary: Returns deleted consumer according to ConsumerID
33190 tags:
33191 - SDCE-2 APIs
33192 get:
33193 description: Retrieve Consumer
33194 operationId: getConsumer
33195 parameters:
33196 - in: path
33197 name: consumerId
33198 required: true
33199 schema:
33200 type: string
33201 - in: header
33202 name: USER_ID
33203 schema:
33204 type: string
33205 responses:
33206 "200":
33207 description: Consumer found
33208 "403":
33209 description: Restricted operation
33210 "404":
33211 description: Consumer not found
33212 default:
33213 content:
33214 application/json:
33215 schema:
33216 type: array
33217 items:
33218 $ref: '#/components/schemas/ConsumerDefinition'
33219 servers:
33220 - url: /sdc2/rest
33221 variables: {}
33222 summary: Returns consumer according to ConsumerID
33223 tags:
33224 - SDCE-2 APIs
33225 /v1/ecompPortalMenu:
33226 get:
33227 description: Retrieve ecomp portal menu - MOC
33228 operationId: getListOfCsars
33229 responses:
33230 "200":
33231 description: Retrieve ecomp portal menu
33232 default:
33233 content:
33234 application/json:
33235 schema:
33236 type: array
33237 items:
33238 $ref: '#/components/schemas/User'
33239 servers:
33240 - url: /sdc2/rest
33241 variables: {}
33242 summary: Retrieve ecomp portal menu
33243 tags:
33244 - SDCE-2 APIs
33245 /v1/followed:
33246 get:
33247 description: Retrieve all followed
33248 operationId: getFollowedResourcesServices
33249 parameters:
33250 - in: header
33251 name: USER_ID
33252 schema:
33253 type: string
33254 responses:
33255 "200":
33256 description: Returns followed Ok
33257 "404":
33258 description: User not found
33259 "500":
33260 description: Internal Server Error
33261 default:
33262 content:
33263 application/json:
33264 schema:
33265 type: array
33266 items:
33267 $ref: '#/components/schemas/User'
33268 servers:
33269 - url: /sdc2/rest
33270 variables: {}
33271 summary: Retrieve all followed
33272 tags:
33273 - SDCE-2 APIs
33274 /v1/inactiveComponents/{componentType}:
33275 delete:
33276 operationId: deleteMarkedResources
33277 parameters:
33278 - in: path
33279 name: componentType
33280 required: true
33281 schema:
33282 type: string
33283 responses:
33284 default:
33285 content:
33286 '*/*': {}
33287 description: default response
33288 servers:
33289 - url: /sdc2/rest
33290 variables: {}
33291 tags:
33292 - SDCE-2 APIs
33293 /v1/propertyScopes:
33294 get:
33295 description: Retrieve all propertyScopes
33296 operationId: getPropertyScopes
33297 parameters:
33298 - in: header
33299 name: USER_ID
33300 schema:
33301 type: string
33302 responses:
33303 "200":
33304 description: Returns propertyScopes Ok
33305 "404":
33306 description: No propertyScopes were found
33307 "500":
33308 description: Internal Server Error
33309 default:
33310 content:
33311 application/json:
33312 schema:
33313 type: array
33314 items:
33315 $ref: '#/components/schemas/User'
33316 servers:
33317 - url: /sdc2/rest
33318 variables: {}
33319 summary: Retrieve all propertyScopes
33320 tags:
33321 - SDCE-2 APIs
33322 /v1/screen:
33323 get:
33324 description: Retrieve catalog resources and services
33325 operationId: getCatalogComponents
33326 parameters:
33327 - in: header
33328 name: USER_ID
33329 schema:
33330 type: string
33331 - in: query
33332 name: excludeTypes
33333 schema:
33334 type: array
33335 items:
33336 type: string
33337 enum:
33338 - PRODUCT
33339 - SERVICE
33340 - VF
33341 - VFC
33342 - CP
33343 - VL
33344 - Configuration
33345 - VFCMT
33346 - CVFC
33347 - PNF
33348 - CR
33349 - ServiceProxy
33350 - ServiceSubstitution
33351 responses:
33352 "200":
33353 description: Returns resources and services Ok
33354 "404":
33355 description: User not found
33356 "500":
33357 description: Internal Server Error
33358 default:
33359 content:
33360 application/json:
33361 schema:
33362 type: array
33363 items:
33364 $ref: '#/components/schemas/User'
33365 servers:
33366 - url: /sdc2/rest
33367 variables: {}
33368 summary: Retrieve catalog resources and services
33369 tags:
33370 - SDCE-2 APIs
33371 /v1/setup/ui:
33372 get:
33373 description: "Retrieve all artifactTypes, ui configuration and sdc version"
33374 operationId: getConfCategoriesAndVersion_1
33375 parameters:
33376 - in: header
33377 name: USER_ID
33378 schema:
33379 type: string
33380 responses:
33381 "200":
33382 description: "Returns artifactTypes, ui configuration and sdc version Ok"
33383 "404":
33384 description: No artifactTypes were found/no ui configuration were found/no
33385 sdc version were found
33386 "500":
33387 description: Internal Server Error
33388 default:
33389 content:
33390 application/json:
33391 schema:
33392 type: array
33393 items:
33394 $ref: '#/components/schemas/User'
33395 servers:
33396 - url: /sdc2/rest
33397 variables: {}
33398 summary: "Retrieve all artifactTypes, ui configuration and sdc version"
33399 tags:
33400 - SDCE-2 APIs
33401 /v1/tags:
33402 get:
33403 description: Retrieve all tags
33404 operationId: getTags
33405 parameters:
33406 - in: header
33407 name: USER_ID
33408 schema:
33409 type: string
33410 responses:
33411 "200":
33412 description: Returns tags Ok
33413 "404":
33414 description: No tags were found
33415 "500":
33416 description: Internal Server Error
33417 default:
33418 content:
33419 application/json:
33420 schema:
33421 type: array
33422 items:
33423 $ref: '#/components/schemas/User'
33424 servers:
33425 - url: /sdc2/rest
33426 variables: {}
33427 summary: Retrieve all tags
33428 tags:
33429 - SDCE-2 APIs
33430 /v1/user:
33431 post:
33432 description: add user
33433 operationId: createUser
33434 parameters:
33435 - in: header
33436 name: USER_ID
33437 schema:
33438 type: string
33439 requestBody:
33440 content:
33441 application/json:
33442 schema:
33443 $ref: '#/components/schemas/User'
33444 description: json describe the user
33445 required: true
33446 responses:
33447 "201":
33448 description: New user created
33449 "400":
33450 description: Invalid Content.
33451 "403":
33452 description: Missing information
33453 "405":
33454 description: Method Not Allowed
33455 "409":
33456 description: User already exists
33457 "500":
33458 description: Internal Server Error
33459 default:
33460 content:
33461 application/json:
33462 schema:
33463 type: array
33464 items:
33465 $ref: '#/components/schemas/User'
33466 servers:
33467 - url: /sdc2/rest
33468 variables: {}
33469 summary: Provision new user
33470 tags:
33471 - SDCE-2 APIs
33472 /v1/user/admins:
33473 get:
33474 description: retrieve all administrators
33475 operationId: getAdminsUser
33476 responses:
33477 "200":
33478 description: Returns user Ok
33479 "405":
33480 description: Method Not Allowed
33481 "500":
33482 description: Internal Server Error
33483 default:
33484 content:
33485 application/json:
33486 schema:
33487 type: array
33488 items:
33489 $ref: '#/components/schemas/User'
33490 servers:
33491 - url: /sdc2/rest
33492 variables: {}
33493 summary: Returns all administrators
33494 tags:
33495 - SDCE-2 APIs
33496 /v1/user/authorize:
33497 get:
33498 description: authorize
33499 operationId: authorize
33500 parameters:
33501 - in: header
33502 name: USER_ID
33503 schema:
33504 type: string
33505 - in: header
33506 name: HTTP_CSP_FIRSTNAME
33507 schema:
33508 type: string
33509 - in: header
33510 name: HTTP_CSP_LASTNAME
33511 schema:
33512 type: string
33513 - in: header
33514 name: HTTP_CSP_EMAIL
33515 schema:
33516 type: string
33517 responses:
33518 "200":
33519 description: Returns user Ok
33520 "403":
33521 description: Restricted Access
33522 "500":
33523 description: Internal Server Error
33524 default:
33525 content:
33526 application/json:
33527 schema:
33528 type: array
33529 items:
33530 $ref: '#/components/schemas/User'
33531 servers:
33532 - url: /sdc2/rest
33533 variables: {}
33534 summary: authorize user
33535 tags:
33536 - SDCE-2 APIs
33537 /v1/user/users:
33538 get:
33539 description: Retrieve the list of all active ASDC users or only group of users
33540 having specific roles.
33541 operationId: getUsersList
33542 parameters:
33543 - description: 'Any active user''s USER_ID '
33544 in: header
33545 name: USER_ID
33546 schema:
33547 type: string
33548 - description: "TESTER,DESIGNER,PRODUCT_STRATEGIST,OPS,PRODUCT_MANAGER,GOVERNOR,\
33549 \ ADMIN OR all users by not typing anything"
33550 in: query
33551 name: roles
33552 schema:
33553 type: string
33554 responses:
33555 "200":
33556 description: Returns users Ok
33557 "204":
33558 description: No provisioned ASDC users of requested role
33559 "400":
33560 description: Missing content
33561 "403":
33562 description: Restricted Access
33563 "500":
33564 description: Internal Server Error
33565 default:
33566 content:
33567 application/json:
33568 schema:
33569 type: array
33570 items:
33571 $ref: '#/components/schemas/User'
33572 servers:
33573 - url: /sdc2/rest
33574 variables: {}
33575 summary: "Returns list of users with the specified roles, or all of users in\
33576 \ the case of empty 'roles' header"
33577 tags:
33578 - SDCE-2 APIs
33579 /v1/user/{userId}:
33580 delete:
33581 description: delete user
33582 operationId: deActivateUser
33583 parameters:
33584 - description: userId of user to get
33585 in: path
33586 name: userId
33587 required: true
33588 schema:
33589 type: string
33590 - in: header
33591 name: USER_ID
33592 schema:
33593 type: string
33594 responses:
33595 "200":
33596 description: Update deleted OK
33597 "400":
33598 description: Invalid Content.
33599 "403":
33600 description: Missing information
33601 "404":
33602 description: User not found
33603 "405":
33604 description: Method Not Allowed
33605 "409":
33606 description: Restricted operation
33607 "500":
33608 description: Internal Server Error
33609 default:
33610 content:
33611 application/json:
33612 schema:
33613 type: array
33614 items:
33615 $ref: '#/components/schemas/User'
33616 servers:
33617 - url: /sdc2/rest
33618 variables: {}
33619 summary: Delete user
33620 tags:
33621 - SDCE-2 APIs
33622 get:
33623 description: retrieve user details
33624 operationId: get
33625 parameters:
33626 - description: userId of user to get
33627 in: path
33628 name: userId
33629 required: true
33630 schema:
33631 type: string
33632 responses:
33633 "200":
33634 description: Returns user Ok
33635 "404":
33636 description: User not found
33637 "405":
33638 description: Method Not Allowed
33639 "500":
33640 description: Internal Server Error
33641 default:
33642 content:
33643 application/json:
33644 schema:
33645 type: array
33646 items:
33647 $ref: '#/components/schemas/User'
33648 servers:
33649 - url: /sdc2/rest
33650 variables: {}
33651 summary: Returns user details according to userId
33652 tags:
33653 - SDCE-2 APIs
33654 /v1/user/{userId}/role:
33655 get:
33656 description: retrieve user role
33657 operationId: getRole
33658 parameters:
33659 - description: userId of user to get
33660 in: path
33661 name: userId
33662 required: true
33663 schema:
33664 type: string
33665 responses:
33666 "200":
33667 description: Returns user role Ok
33668 "404":
33669 description: User not found
33670 "405":
33671 description: Method Not Allowed
33672 "500":
33673 description: Internal Server Error
33674 default:
33675 content:
33676 application/json:
33677 schema:
33678 type: array
33679 items:
33680 type: string
33681 servers:
33682 - url: /sdc2/rest
33683 variables: {}
33684 summary: Returns user role according to userId
33685 tags:
33686 - SDCE-2 APIs
33687 post:
33688 description: update user role
33689 operationId: updateUserRole
33690 parameters:
33691 - description: userId of user to get
33692 in: path
33693 name: userId
33694 required: true
33695 schema:
33696 type: string
33697 - in: header
33698 name: USER_ID
33699 schema:
33700 type: string
33701 requestBody:
33702 content:
33703 application/json:
33704 schema:
33705 $ref: '#/components/schemas/UserRole'
33706 description: json describe the update role
33707 required: true
33708 responses:
33709 "200":
33710 description: Update user OK
33711 "400":
33712 description: Invalid Content.
33713 "403":
33714 description: Missing information/Restricted operation
33715 "404":
33716 description: User not found
33717 "405":
33718 description: Method Not Allowed
33719 "409":
33720 description: User already exists
33721 "500":
33722 description: Internal Server Error
33723 default:
33724 content:
33725 application/json:
33726 schema:
33727 type: array
33728 items:
33729 $ref: '#/components/schemas/User'
33730 servers:
33731 - url: /sdc2/rest
33732 variables: {}
33733 summary: Update user role
33734 tags:
33735 - SDCE-2 APIs
33736components:
33737 schemas:
33738 AdditionalInfoParameterInfo:
33739 type: object
33740 properties:
33741 empty:
33742 type: boolean
33743 key:
33744 type: string
33745 ownerId:
33746 type: string
33747 ownerIdIfEmpty:
33748 type: string
33749 writeOnly: true
33750 type:
33751 type: string
33752 uniqueId:
33753 type: string
33754 value:
33755 type: string
33756 version:
33757 type: string
33758 AdditionalInformationDefinition:
33759 type: object
33760 properties:
33761 creationTime:
33762 type: integer
33763 format: int64
33764 empty:
33765 type: boolean
33766 lastCreatedCounter:
33767 type: integer
33768 format: int32
33769 modificationTime:
33770 type: integer
33771 format: int64
33772 ownerId:
33773 type: string
33774 ownerIdIfEmpty:
33775 type: string
33776 writeOnly: true
33777 parameters:
33778 type: array
33779 items:
33780 $ref: '#/components/schemas/AdditionalInfoParameterInfo'
33781 parentUniqueId:
33782 type: string
33783 type:
33784 type: string
33785 uniqueId:
33786 type: string
33787 version:
33788 type: string
33789 Annotation:
33790 type: object
33791 properties:
33792 description:
33793 type: string
33794 name:
33795 type: string
33796 properties:
33797 type: array
33798 items:
33799 $ref: '#/components/schemas/PropertyDataDefinition'
33800 type:
33801 type: string
33802 ApplicationL1CacheCatalogInfo:
33803 type: object
33804 properties:
33805 enabled:
33806 type: boolean
33807 productsSizeInCache:
33808 type: integer
33809 format: int32
33810 resourcesSizeInCache:
33811 type: integer
33812 format: int32
33813 servicesSizeInCache:
33814 type: integer
33815 format: int32
33816 ApplicationL1CacheConfig:
33817 type: object
33818 properties:
33819 datatypes:
33820 $ref: '#/components/schemas/ApplicationL1CacheInfo'
33821 ApplicationL1CacheInfo:
33822 type: object
33823 properties:
33824 enabled:
33825 type: boolean
33826 firstRunDelay:
33827 type: integer
33828 format: int32
33829 pollIntervalInSec:
33830 type: integer
33831 format: int32
33832 ApplicationL2CacheConfig:
33833 type: object
33834 properties:
33835 catalogL1Cache:
33836 $ref: '#/components/schemas/ApplicationL1CacheCatalogInfo'
33837 enabled:
33838 type: boolean
33839 queue:
33840 $ref: '#/components/schemas/QueueInfo'
33841 ArtifactConfiguration:
33842 type: object
33843 properties:
33844 acceptedTypes:
33845 type: array
33846 items:
33847 type: string
33848 categories:
33849 type: array
33850 items:
33851 type: string
33852 enum:
33853 - INFORMATIONAL
33854 - DEPLOYMENT
33855 - LIFE_CYCLE
33856 - SERVICE_API
33857 - TOSCA
33858 - OTHER
33859 componentTypes:
33860 type: array
33861 items:
33862 type: string
33863 enum:
33864 - RESOURCE
33865 - SERVICE
33866 - RESOURCE_INSTANCE
33867 - SERVICE_INSTANCE
33868 resourceTypes:
33869 type: array
33870 items:
33871 type: string
33872 type:
33873 type: string
33874 ArtifactDataDefinition:
33875 type: object
33876 properties:
33877 apiUrl:
33878 type: string
33879 artifactChecksum:
33880 type: string
33881 artifactCreator:
33882 type: string
33883 artifactDisplayName:
33884 type: string
33885 artifactGroupType:
33886 type: string
33887 enum:
33888 - INFORMATIONAL
33889 - DEPLOYMENT
33890 - LIFE_CYCLE
33891 - SERVICE_API
33892 - TOSCA
33893 - OTHER
33894 artifactLabel:
33895 type: string
33896 artifactName:
33897 type: string
33898 artifactRef:
33899 type: string
33900 artifactRepository:
33901 type: string
33902 artifactType:
33903 type: string
33904 artifactUUID:
33905 type: string
33906 artifactVersion:
33907 type: string
33908 creationDate:
33909 type: integer
33910 format: int64
33911 creatorFullName:
33912 type: string
33913 description:
33914 type: string
33915 duplicated:
33916 type: boolean
33917 empty:
33918 type: boolean
33919 esId:
33920 type: string
33921 generated:
33922 type: boolean
33923 generatedFromId:
33924 type: string
33925 heatEnvType:
33926 type: boolean
33927 heatParameters:
33928 type: array
33929 items:
33930 $ref: '#/components/schemas/HeatParameterDataDefinition'
33931 heatParamsUpdateDate:
33932 type: integer
33933 format: int64
33934 isFromCsar:
33935 type: boolean
33936 lastUpdateDate:
33937 type: integer
33938 format: int64
33939 mandatory:
33940 type: boolean
33941 ownerId:
33942 type: string
33943 ownerIdIfEmpty:
33944 type: string
33945 writeOnly: true
33946 payloadUpdateDate:
33947 type: integer
33948 format: int64
33949 properties:
33950 type: array
33951 items:
33952 $ref: '#/components/schemas/PropertyDataDefinition'
33953 requiredArtifacts:
33954 type: array
33955 items:
33956 type: string
33957 serviceApi:
33958 type: boolean
33959 timeout:
33960 type: integer
33961 format: int32
33962 type:
33963 type: string
33964 uniqueId:
33965 type: string
33966 updaterFullName:
33967 type: string
33968 userIdCreator:
33969 type: string
33970 userIdLastUpdater:
33971 type: string
33972 version:
33973 type: string
33974 ArtifactDefinition:
33975 type: object
33976 properties:
33977 apiUrl:
33978 type: string
33979 artifactChecksum:
33980 type: string
33981 artifactCreator:
33982 type: string
33983 artifactDisplayName:
33984 type: string
33985 artifactGroupType:
33986 type: string
33987 enum:
33988 - INFORMATIONAL
33989 - DEPLOYMENT
33990 - LIFE_CYCLE
33991 - SERVICE_API
33992 - TOSCA
33993 - OTHER
33994 artifactLabel:
33995 type: string
33996 artifactName:
33997 type: string
33998 artifactRef:
33999 type: string
34000 artifactRepository:
34001 type: string
34002 artifactType:
34003 type: string
34004 artifactUUID:
34005 type: string
34006 artifactVersion:
34007 type: string
34008 creationDate:
34009 type: integer
34010 format: int64
34011 creatorFullName:
34012 type: string
34013 description:
34014 type: string
34015 duplicated:
34016 type: boolean
34017 empty:
34018 type: boolean
34019 esId:
34020 type: string
34021 generated:
34022 type: boolean
34023 generatedFromId:
34024 type: string
34025 heatEnvType:
34026 type: boolean
34027 heatParamUpdated:
34028 type: boolean
34029 heatParameters:
34030 type: array
34031 items:
34032 $ref: '#/components/schemas/HeatParameterDataDefinition'
34033 heatParamsUpdateDate:
34034 type: integer
34035 format: int64
34036 isFromCsar:
34037 type: boolean
34038 lastUpdateDate:
34039 type: integer
34040 format: int64
34041 listHeatParameters:
34042 type: array
34043 items:
34044 $ref: '#/components/schemas/HeatParameterDefinition'
34045 mandatory:
34046 type: boolean
34047 ownerId:
34048 type: string
34049 ownerIdIfEmpty:
34050 type: string
34051 writeOnly: true
34052 payload:
34053 type: array
34054 items:
34055 type: string
34056 format: byte
34057 writeOnly: true
34058 payloadData:
34059 type: array
34060 items:
34061 type: string
34062 format: byte
34063 payloadUpdateDate:
34064 type: integer
34065 format: int64
34066 properties:
34067 type: array
34068 items:
34069 $ref: '#/components/schemas/PropertyDataDefinition'
34070 requiredArtifacts:
34071 type: array
34072 items:
34073 type: string
34074 serviceApi:
34075 type: boolean
34076 timeout:
34077 type: integer
34078 format: int32
34079 type:
34080 type: string
34081 uniqueId:
34082 type: string
34083 updaterFullName:
34084 type: string
34085 userIdCreator:
34086 type: string
34087 userIdLastUpdater:
34088 type: string
34089 version:
34090 type: string
34091 AttributeDefinition:
34092 type: object
34093 properties:
34094 attributeId:
34095 type: string
34096 defaultValue:
34097 type: string
34098 definition:
34099 type: boolean
34100 description:
34101 type: string
34102 empty:
34103 type: boolean
34104 entry_schema:
34105 $ref: '#/components/schemas/EntrySchema'
34106 getOutputAttribute:
34107 type: boolean
34108 getOutputValues:
34109 type: array
34110 items:
34111 $ref: '#/components/schemas/GetOutputValueDataDefinition'
34112 get_default:
34113 type: object
34114 instanceUniqueId:
34115 type: string
34116 model:
34117 type: string
34118 name:
34119 type: string
34120 outputId:
34121 type: string
34122 outputPath:
34123 type: string
34124 ownerId:
34125 type: string
34126 ownerIdIfEmpty:
34127 type: string
34128 writeOnly: true
34129 parentUniqueId:
34130 type: string
34131 schema:
34132 $ref: '#/components/schemas/SchemaDefinition'
34133 schemaType:
34134 type: string
34135 status:
34136 type: string
34137 type:
34138 type: string
34139 uniqueId:
34140 type: string
34141 value:
34142 type: string
34143 version:
34144 type: string
34145 BasicAuthConfig:
34146 type: object
34147 properties:
34148 enabled:
34149 type: boolean
34150 excludedUrls:
34151 type: string
34152 userName:
34153 type: string
34154 userPass:
34155 type: string
34156 BeMonitoringConfig:
34157 type: object
34158 properties:
34159 enabled:
34160 type: boolean
34161 isProxy:
34162 type: boolean
34163 probeIntervalInSeconds:
34164 type: integer
34165 format: int32
34166 CINodeFilterDataDefinition:
34167 type: object
34168 properties:
34169 capabilities:
34170 $ref: '#/components/schemas/ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition'
34171 empty:
34172 type: boolean
34173 id:
34174 type: string
34175 name:
34176 type: string
34177 ownerId:
34178 type: string
34179 ownerIdIfEmpty:
34180 type: string
34181 writeOnly: true
34182 properties:
34183 $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition'
34184 tosca_id:
34185 type: object
34186 type:
34187 type: string
34188 version:
34189 type: string
34190 CadiFilterParams:
34191 type: object
34192 properties:
34193 aafLocateUrl:
34194 type: string
34195 aaf_env:
34196 type: string
34197 aaf_id:
34198 type: string
34199 aaf_password:
34200 type: string
34201 aaf_url:
34202 type: string
34203 aft_ENVIRONMENT:
34204 type: string
34205 aft_LATITUDE:
34206 type: string
34207 aft_LONGITUDE:
34208 type: string
34209 cadiX509Issuers:
34210 type: string
34211 cadi_keyfile:
34212 type: string
34213 cadi_loglevel:
34214 type: string
34215 cadi_truststore:
34216 type: string
34217 cadi_truststore_password:
34218 type: string
34219 csp_domain:
34220 type: string
34221 hostname:
34222 type: string
34223 CapabilityDataDefinition:
34224 type: object
34225 properties:
34226 capabilitySources:
34227 type: array
34228 items:
34229 type: string
34230 description:
34231 type: string
34232 empty:
34233 type: boolean
34234 external:
34235 type: boolean
34236 externalName:
34237 type: string
34238 leftOccurrences:
34239 type: string
34240 maxOccurrences:
34241 type: string
34242 minOccurrences:
34243 type: string
34244 name:
34245 type: string
34246 ownerId:
34247 type: string
34248 ownerIdIfEmpty:
34249 type: string
34250 writeOnly: true
34251 ownerName:
34252 type: string
34253 ownerType:
34254 type: string
34255 enum:
34256 - GROUP
34257 - COMPONENT_INSTANCE
34258 - RESOURCE
34259 parentName:
34260 type: string
34261 path:
34262 type: array
34263 items:
34264 type: string
34265 previousName:
34266 type: string
34267 source:
34268 type: string
34269 type:
34270 type: string
34271 uniqueId:
34272 type: string
34273 validSourceTypes:
34274 type: array
34275 items:
34276 type: string
34277 version:
34278 type: string
34279 CapabilityDefinition:
34280 type: object
34281 properties:
34282 capabilitySources:
34283 type: array
34284 items:
34285 type: string
34286 description:
34287 type: string
34288 empty:
34289 type: boolean
34290 external:
34291 type: boolean
34292 externalName:
34293 type: string
34294 leftOccurrences:
34295 type: string
34296 maxOccurrences:
34297 type: string
34298 minOccurrences:
34299 type: string
34300 name:
34301 type: string
34302 ownerId:
34303 type: string
34304 ownerIdIfEmpty:
34305 type: string
34306 writeOnly: true
34307 ownerName:
34308 type: string
34309 ownerType:
34310 type: string
34311 enum:
34312 - GROUP
34313 - COMPONENT_INSTANCE
34314 - RESOURCE
34315 ownerTypeIfEmpty:
34316 type: string
34317 enum:
34318 - GROUP
34319 - COMPONENT_INSTANCE
34320 - RESOURCE
34321 writeOnly: true
34322 parentName:
34323 type: string
34324 path:
34325 type: array
34326 items:
34327 type: string
34328 previousName:
34329 type: string
34330 properties:
34331 type: array
34332 items:
34333 $ref: '#/components/schemas/ComponentInstanceProperty'
34334 source:
34335 type: string
34336 type:
34337 type: string
34338 uniqueId:
34339 type: string
34340 validSourceTypes:
34341 type: array
34342 items:
34343 type: string
34344 version:
34345 type: string
34346 CapabilityRequirementRelationship:
34347 type: object
34348 properties:
34349 capability:
34350 $ref: '#/components/schemas/CapabilityDataDefinition'
34351 operations:
34352 type: array
34353 items:
34354 $ref: '#/components/schemas/OperationUi'
34355 relation:
34356 $ref: '#/components/schemas/RelationshipInfo'
34357 requirement:
34358 $ref: '#/components/schemas/RequirementDataDefinition'
34359 CassandrConfig:
34360 type: object
34361 properties:
34362 authenticate:
34363 type: boolean
34364 cassandraHosts:
34365 type: array
34366 items:
34367 type: string
34368 cassandraPort:
34369 type: integer
34370 format: int32
34371 keySpaces:
34372 type: array
34373 items:
34374 $ref: '#/components/schemas/KeyspaceConfig'
34375 localDataCenter:
34376 type: string
34377 maxWaitSeconds:
34378 type: integer
34379 format: int32
34380 password:
34381 type: string
34382 reconnectTimeout:
34383 type: integer
34384 format: int64
34385 socketConnectTimeout:
34386 type: integer
34387 format: int32
34388 socketReadTimeout:
34389 type: integer
34390 format: int32
34391 ssl:
34392 type: boolean
34393 truststorePassword:
34394 type: string
34395 truststorePath:
34396 type: string
34397 username:
34398 type: string
34399 CatalogComponent:
34400 type: object
34401 properties:
34402 categories:
34403 type: array
34404 items:
34405 $ref: '#/components/schemas/CategoryDefinition'
34406 categoryNormalizedName:
34407 type: string
34408 componentType:
34409 type: string
34410 enum:
34411 - RESOURCE
34412 - SERVICE
34413 - RESOURCE_INSTANCE
34414 - PRODUCT
34415 - SERVICE_INSTANCE
34416 description:
34417 type: string
34418 distributionStatus:
34419 type: string
34420 icon:
34421 type: string
34422 invariantUUID:
34423 type: string
34424 isHighestVersion:
34425 type: boolean
34426 lastUpdateDate:
34427 type: integer
34428 format: int64
34429 lastUpdaterUserId:
34430 type: string
34431 lifecycleState:
34432 type: string
34433 model:
34434 type: string
34435 name:
34436 type: string
34437 resourceType:
34438 type: string
34439 subCategoryNormalizedName:
34440 type: string
34441 systemName:
34442 type: string
34443 tags:
34444 type: array
34445 items:
34446 type: string
34447 uniqueId:
34448 type: string
34449 uuid:
34450 type: string
34451 version:
34452 type: string
34453 Category:
34454 type: object
34455 properties:
34456 name:
34457 type: string
34458 CategoryBaseTypeConfig:
34459 type: object
34460 properties:
34461 baseTypes:
34462 type: array
34463 items:
34464 type: string
34465 defaultBaseType:
34466 type: string
34467 required:
34468 type: boolean
34469 CategoryDefinition:
34470 type: object
34471 properties:
34472 displayName:
34473 type: string
34474 empty:
34475 type: boolean
34476 icons:
34477 type: array
34478 items:
34479 type: string
34480 metadataKeys:
34481 type: array
34482 items:
34483 $ref: '#/components/schemas/MetadataKeyDataDefinition'
34484 models:
34485 type: array
34486 items:
34487 type: string
34488 name:
34489 type: string
34490 normalizedName:
34491 type: string
34492 ownerId:
34493 type: string
34494 ownerIdIfEmpty:
34495 type: string
34496 writeOnly: true
34497 subcategories:
34498 type: array
34499 items:
34500 $ref: '#/components/schemas/SubCategoryDefinition'
34501 type:
34502 type: string
34503 uniqueId:
34504 type: string
34505 useServiceSubstitutionForNestedServices:
34506 type: boolean
34507 version:
34508 type: string
34509 CleanComponentsConfiguration:
34510 type: object
34511 properties:
34512 cleanIntervalInMinutes:
34513 type: integer
34514 format: int64
34515 componentsToClean:
34516 type: array
34517 items:
34518 type: string
34519 ComponentInstance:
34520 type: object
34521 properties:
34522 actualComponentUid:
34523 type: string
34524 artifacts:
34525 type: object
34526 additionalProperties:
34527 $ref: '#/components/schemas/ArtifactDefinition'
34528 attributeValueCounter:
34529 type: integer
34530 format: int32
34531 attributes:
34532 type: array
34533 items:
34534 $ref: '#/components/schemas/AttributeDefinition'
34535 capabilities:
34536 type: object
34537 additionalProperties:
34538 type: array
34539 items:
34540 $ref: '#/components/schemas/CapabilityDefinition'
34541 componentMetadataForSupportLog:
34542 type: object
34543 additionalProperties:
34544 type: string
34545 componentName:
34546 type: string
34547 componentUid:
34548 type: string
34549 componentVersion:
34550 type: string
34551 createdFrom:
34552 type: string
34553 enum:
34554 - UI
34555 - CSAR
34556 createdFromCsar:
34557 type: boolean
34558 creationTime:
34559 type: integer
34560 format: int64
34561 customizationUUID:
34562 type: string
34563 deploymentArtifacts:
34564 type: object
34565 additionalProperties:
34566 $ref: '#/components/schemas/ArtifactDefinition'
34567 description:
34568 type: string
34569 directives:
34570 type: array
34571 items:
34572 type: string
34573 empty:
34574 type: boolean
34575 groupInstances:
34576 type: array
34577 items:
34578 $ref: '#/components/schemas/GroupInstance'
34579 icon:
34580 type: string
34581 inputValueCounter:
34582 type: integer
34583 format: int32
34584 inputs:
34585 type: array
34586 items:
34587 $ref: '#/components/schemas/InputDefinition'
34588 instanceCount:
34589 type: string
34590 interfaces:
34591 type: object
34592 additionalProperties:
34593 type: object
34594 invariantName:
34595 type: string
34596 isProxy:
34597 type: boolean
34598 maxOccurrences:
34599 type: string
34600 minOccurrences:
34601 type: string
34602 modificationTime:
34603 type: integer
34604 format: int64
34605 name:
34606 type: string
34607 nodeFilter:
34608 $ref: '#/components/schemas/CINodeFilterDataDefinition'
34609 normalizedName:
34610 type: string
34611 originArchived:
34612 type: boolean
34613 originType:
34614 type: string
34615 enum:
34616 - PRODUCT
34617 - SERVICE
34618 - VF
34619 - VFC
34620 - CP
34621 - VL
34622 - Configuration
34623 - VFCMT
34624 - CVFC
34625 - PNF
34626 - CR
34627 - ServiceProxy
34628 - ServiceSubstitution
34629 ownerId:
34630 type: string
34631 ownerIdIfEmpty:
34632 type: string
34633 writeOnly: true
34634 posX:
34635 type: string
34636 posY:
34637 type: string
34638 properties:
34639 type: array
34640 items:
34641 $ref: '#/components/schemas/PropertyDefinition'
34642 propertyValueCounter:
34643 type: integer
34644 format: int32
34645 requirements:
34646 type: object
34647 additionalProperties:
34648 type: array
34649 items:
34650 $ref: '#/components/schemas/RequirementDefinition'
34651 serviceSubstitution:
34652 type: boolean
34653 sourceModelInvariant:
34654 type: string
34655 sourceModelName:
34656 type: string
34657 sourceModelUid:
34658 type: string
34659 sourceModelUuid:
34660 type: string
34661 toscaArtifacts:
34662 type: object
34663 additionalProperties:
34664 $ref: '#/components/schemas/ToscaArtifactDataDefinition'
34665 toscaComponentName:
34666 type: string
34667 type:
34668 type: string
34669 uniqueId:
34670 type: string
34671 version:
34672 type: string
34673 ComponentInstanceAttribute:
34674 type: object
34675 properties:
34676 attributeId:
34677 type: string
34678 componentInstanceId:
34679 type: string
34680 componentInstanceName:
34681 type: string
34682 defaultValue:
34683 type: string
34684 definition:
34685 type: boolean
34686 description:
34687 type: string
34688 empty:
34689 type: boolean
34690 entry_schema:
34691 $ref: '#/components/schemas/EntrySchema'
34692 getOutputAttribute:
34693 type: boolean
34694 getOutputValues:
34695 type: array
34696 items:
34697 $ref: '#/components/schemas/GetOutputValueDataDefinition'
34698 get_default:
34699 type: object
34700 instanceUniqueId:
34701 type: string
34702 model:
34703 type: string
34704 name:
34705 type: string
34706 outputId:
34707 type: string
34708 outputPath:
34709 type: string
34710 ownerId:
34711 type: string
34712 ownerIdIfEmpty:
34713 type: string
34714 writeOnly: true
34715 parentUniqueId:
34716 type: string
34717 path:
34718 type: array
34719 items:
34720 type: string
34721 rules:
34722 type: array
34723 items:
34724 $ref: '#/components/schemas/PropertyRule'
34725 schema:
34726 $ref: '#/components/schemas/SchemaDefinition'
34727 schemaType:
34728 type: string
34729 status:
34730 type: string
34731 type:
34732 type: string
34733 uniqueId:
34734 type: string
34735 value:
34736 type: string
34737 valueUniqueUid:
34738 type: string
34739 version:
34740 type: string
34741 ComponentInstanceCapabilityUpdateModel:
34742 type: object
34743 properties:
34744 external:
34745 type: boolean
34746 name:
34747 type: string
34748 maxLength: 2147483647
34749 minLength: 1
34750 ownerId:
34751 type: string
34752 maxLength: 2147483647
34753 minLength: 1
34754 ownerName:
34755 type: string
34756 maxLength: 2147483647
34757 minLength: 1
34758 type:
34759 type: string
34760 maxLength: 2147483647
34761 minLength: 1
34762 uniqueId:
34763 type: string
34764 maxLength: 2147483647
34765 minLength: 1
34766 required:
34767 - external
34768 - name
34769 - ownerId
34770 - ownerName
34771 - type
34772 - uniqueId
34773 ComponentInstanceInput:
34774 type: object
34775 properties:
34776 annotations:
34777 type: array
34778 items:
34779 $ref: '#/components/schemas/Annotation'
34780 annotationsToInput:
34781 type: array
34782 items:
34783 $ref: '#/components/schemas/Annotation'
34784 writeOnly: true
34785 componentInstanceId:
34786 type: string
34787 componentInstanceName:
34788 type: string
34789 constraints:
34790 type: array
34791 items:
34792 $ref: '#/components/schemas/PropertyConstraint'
34793 defaultValue:
34794 type: string
34795 definition:
34796 type: boolean
34797 description:
34798 type: string
34799 empty:
34800 type: boolean
34801 getInputProperty:
34802 type: boolean
34803 getInputValues:
34804 type: array
34805 items:
34806 $ref: '#/components/schemas/GetInputValueDataDefinition'
34807 getPolicyValues:
34808 type: array
34809 items:
34810 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
34811 hidden:
34812 type: boolean
34813 immutable:
34814 type: boolean
34815 inputId:
34816 type: string
34817 inputPath:
34818 type: string
34819 instanceUniqueId:
34820 type: string
34821 isDeclaredListInput:
34822 type: boolean
34823 label:
34824 type: string
34825 mappedToComponentProperty:
34826 type: boolean
34827 metadata:
34828 type: object
34829 additionalProperties:
34830 type: string
34831 model:
34832 type: string
34833 name:
34834 type: string
34835 ownerId:
34836 type: string
34837 ownerIdIfEmpty:
34838 type: string
34839 writeOnly: true
34840 parentPropertyType:
34841 type: string
34842 parentUniqueId:
34843 type: string
34844 password:
34845 type: boolean
34846 path:
34847 type: array
34848 items:
34849 type: string
34850 properties:
34851 type: array
34852 items:
34853 $ref: '#/components/schemas/ComponentInstanceProperty'
34854 propertyConstraints:
34855 type: array
34856 items:
34857 type: string
34858 propertyId:
34859 type: string
34860 required:
34861 type: boolean
34862 rules:
34863 type: array
34864 items:
34865 $ref: '#/components/schemas/PropertyRule'
34866 schema:
34867 $ref: '#/components/schemas/SchemaDefinition'
34868 schemaProperty:
34869 $ref: '#/components/schemas/PropertyDataDefinition'
34870 schemaType:
34871 type: string
34872 status:
34873 type: string
34874 subPropertyInputPath:
34875 type: string
34876 subPropertyToscaFunctions:
34877 type: array
34878 items:
34879 $ref: '#/components/schemas/SubPropertyToscaFunction'
34880 toscaFunction:
34881 $ref: '#/components/schemas/ToscaFunction'
34882 toscaGetFunction:
34883 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
34884 toscaGetFunctionType:
34885 type: string
34886 enum:
34887 - GET_INPUT
34888 - GET_PROPERTY
34889 - GET_ATTRIBUTE
34890 type:
34891 type: string
34892 uniqueId:
34893 type: string
34894 userCreated:
34895 type: boolean
34896 value:
34897 type: string
34898 valueUniqueUid:
34899 type: string
34900 version:
34901 type: string
34902 ComponentInstanceInterface:
34903 type: object
34904 properties:
34905 creationDate:
34906 type: integer
34907 format: int64
34908 definition:
34909 type: boolean
34910 derivedFrom:
34911 type: string
34912 description:
34913 type: string
34914 empty:
34915 type: boolean
34916 inputs:
34917 type: object
34918 additionalProperties:
34919 $ref: '#/components/schemas/InputDataDefinition'
34920 interfaceId:
34921 type: string
34922 interfaceInstanceDataDefinition:
34923 $ref: '#/components/schemas/InterfaceInstanceDataDefinition'
34924 lastUpdateDate:
34925 type: integer
34926 format: int64
34927 model:
34928 type: string
34929 operations:
34930 type: object
34931 additionalProperties:
34932 $ref: '#/components/schemas/OperationDataDefinition'
34933 ownerId:
34934 type: string
34935 ownerIdIfEmpty:
34936 type: string
34937 writeOnly: true
34938 toscaResourceName:
34939 type: string
34940 type:
34941 type: string
34942 uniqueId:
34943 type: string
34944 userCreated:
34945 type: boolean
34946 version:
34947 type: string
34948 ComponentInstanceOutput:
34949 type: object
34950 properties:
34951 attribute:
34952 $ref: '#/components/schemas/ComponentInstanceAttribute'
34953 attributeId:
34954 type: string
34955 componentInstanceId:
34956 type: string
34957 componentInstanceName:
34958 type: string
34959 defaultValue:
34960 type: string
34961 definition:
34962 type: boolean
34963 description:
34964 type: string
34965 empty:
34966 type: boolean
34967 entry_schema:
34968 $ref: '#/components/schemas/EntrySchema'
34969 getOutputAttribute:
34970 type: boolean
34971 getOutputValues:
34972 type: array
34973 items:
34974 $ref: '#/components/schemas/GetOutputValueDataDefinition'
34975 get_default:
34976 type: object
34977 instanceUniqueId:
34978 type: string
34979 model:
34980 type: string
34981 name:
34982 type: string
34983 outputId:
34984 type: string
34985 outputPath:
34986 type: string
34987 ownerId:
34988 type: string
34989 ownerIdIfEmpty:
34990 type: string
34991 writeOnly: true
34992 parentUniqueId:
34993 type: string
34994 path:
34995 type: array
34996 items:
34997 type: string
34998 rules:
34999 type: array
35000 items:
35001 $ref: '#/components/schemas/PropertyRule'
35002 schema:
35003 $ref: '#/components/schemas/SchemaDefinition'
35004 schemaType:
35005 type: string
35006 status:
35007 type: string
35008 type:
35009 type: string
35010 uniqueId:
35011 type: string
35012 value:
35013 type: string
35014 valueUniqueUid:
35015 type: string
35016 version:
35017 type: string
35018 ComponentInstanceProperty:
35019 type: object
35020 properties:
35021 annotations:
35022 type: array
35023 items:
35024 $ref: '#/components/schemas/Annotation'
35025 componentInstanceId:
35026 type: string
35027 componentInstanceName:
35028 type: string
35029 constraints:
35030 type: array
35031 items:
35032 $ref: '#/components/schemas/PropertyConstraint'
35033 defaultValue:
35034 type: string
35035 definition:
35036 type: boolean
35037 description:
35038 type: string
35039 empty:
35040 type: boolean
35041 getInputProperty:
35042 type: boolean
35043 getInputValues:
35044 type: array
35045 items:
35046 $ref: '#/components/schemas/GetInputValueDataDefinition'
35047 getPolicyValues:
35048 type: array
35049 items:
35050 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
35051 hidden:
35052 type: boolean
35053 immutable:
35054 type: boolean
35055 inputId:
35056 type: string
35057 inputPath:
35058 type: string
35059 instanceUniqueId:
35060 type: string
35061 isDeclaredListInput:
35062 type: boolean
35063 label:
35064 type: string
35065 mappedToComponentProperty:
35066 type: boolean
35067 metadata:
35068 type: object
35069 additionalProperties:
35070 type: string
35071 model:
35072 type: string
35073 name:
35074 type: string
35075 ownerId:
35076 type: string
35077 ownerIdIfEmpty:
35078 type: string
35079 writeOnly: true
35080 parentPropertyType:
35081 type: string
35082 parentUniqueId:
35083 type: string
35084 password:
35085 type: boolean
35086 path:
35087 type: array
35088 items:
35089 type: string
35090 propertyConstraints:
35091 type: array
35092 items:
35093 type: string
35094 propertyId:
35095 type: string
35096 required:
35097 type: boolean
35098 rules:
35099 type: array
35100 items:
35101 $ref: '#/components/schemas/PropertyRule'
35102 schema:
35103 $ref: '#/components/schemas/SchemaDefinition'
35104 schemaProperty:
35105 $ref: '#/components/schemas/PropertyDataDefinition'
35106 schemaType:
35107 type: string
35108 status:
35109 type: string
35110 subPropertyInputPath:
35111 type: string
35112 subPropertyToscaFunctions:
35113 type: array
35114 items:
35115 $ref: '#/components/schemas/SubPropertyToscaFunction'
35116 toscaFunction:
35117 $ref: '#/components/schemas/ToscaFunction'
35118 toscaGetFunction:
35119 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
35120 toscaGetFunctionType:
35121 type: string
35122 enum:
35123 - GET_INPUT
35124 - GET_PROPERTY
35125 - GET_ATTRIBUTE
35126 type:
35127 type: string
35128 uniqueId:
35129 type: string
35130 userCreated:
35131 type: boolean
35132 value:
35133 type: string
35134 valueUniqueUid:
35135 type: string
35136 version:
35137 type: string
35138 Configuration:
35139 type: object
35140 properties:
35141 aafAuthNeeded:
35142 type: boolean
35143 aafNamespace:
35144 type: string
35145 additionalInformationMaxNumberOfKeys:
35146 type: integer
35147 format: int32
35148 appVersion:
35149 type: string
35150 applicationL1Cache:
35151 $ref: '#/components/schemas/ApplicationL1CacheConfig'
35152 applicationL2Cache:
35153 $ref: '#/components/schemas/ApplicationL2CacheConfig'
35154 artifactGeneratorConfig:
35155 type: string
35156 artifacts:
35157 type: array
35158 items:
35159 $ref: '#/components/schemas/ArtifactConfiguration'
35160 artifactsIndex:
35161 type: string
35162 authCookie:
35163 $ref: '#/components/schemas/CookieConfig'
35164 autoHealingOwner:
35165 type: string
35166 basicAuth:
35167 $ref: '#/components/schemas/BasicAuthConfig'
35168 beContext:
35169 type: string
35170 beFqdn:
35171 type: string
35172 beHttpPort:
35173 type: integer
35174 format: int32
35175 beProtocol:
35176 type: string
35177 beSslPort:
35178 type: integer
35179 format: int32
35180 cadiFilterParams:
35181 $ref: '#/components/schemas/CadiFilterParams'
35182 cassandraConfig:
35183 $ref: '#/components/schemas/CassandrConfig'
35184 cleanComponentsConfiguration:
35185 $ref: '#/components/schemas/CleanComponentsConfiguration'
35186 componentAllowedInstanceTypes:
35187 type: object
35188 additionalProperties:
35189 type: object
35190 additionalProperties:
35191 type: array
35192 items:
35193 type: string
35194 componentInstanceCounterDelimiter:
35195 type: string
35196 consumerBusinessLogic:
35197 type: boolean
35198 csarFormat:
35199 $ref: '#/components/schemas/CsarFormat'
35200 dataValidatorFilterExcludedUrls:
35201 type: string
35202 defaultImports:
35203 type: array
35204 items:
35205 type: object
35206 additionalProperties:
35207 type: object
35208 additionalProperties:
35209 type: string
35210 definedResourceNamespace:
35211 type: array
35212 items:
35213 type: string
35214 deleteLockTimeoutInSeconds:
35215 type: integer
35216 format: int32
35217 deploymentResourceArtifacts:
35218 type: object
35219 additionalProperties:
35220 type: object
35221 deploymentResourceInstanceArtifacts:
35222 type: object
35223 additionalProperties:
35224 type: object
35225 directives:
35226 type: array
35227 items:
35228 type: string
35229 disableAudit:
35230 type: boolean
35231 dmaapConsumerConfiguration:
35232 $ref: '#/components/schemas/DmaapConsumerConfiguration'
35233 dmaapProducerConfiguration:
35234 $ref: '#/components/schemas/DmaapProducerConfiguration'
35235 dmeConfiguration:
35236 $ref: '#/components/schemas/DmeConfiguration'
35237 ecompPortal:
35238 $ref: '#/components/schemas/EcompPortalConfig'
35239 enableAutoHealing:
35240 type: boolean
35241 environmentContext:
35242 $ref: '#/components/schemas/EnvironmentContext'
35243 excludeResourceCategory:
35244 type: array
35245 items:
35246 type: string
35247 excludeResourceType:
35248 type: array
35249 items:
35250 type: string
35251 excludeServiceCategory:
35252 type: array
35253 items:
35254 type: string
35255 excludedGroupTypesMapping:
35256 type: object
35257 additionalProperties:
35258 type: array
35259 items:
35260 type: string
35261 uniqueItems: true
35262 excludedPolicyTypesMapping:
35263 type: object
35264 additionalProperties:
35265 type: array
35266 items:
35267 type: string
35268 uniqueItems: true
35269 externalCsarStore:
35270 $ref: '#/components/schemas/ExternalCsarStore'
35271 gabConfig:
35272 type: array
35273 items:
35274 $ref: '#/components/schemas/GabConfig'
35275 genericAssetNodeTypes:
35276 type: object
35277 additionalProperties:
35278 type: string
35279 globalCsarImports:
35280 type: array
35281 items:
35282 type: string
35283 healthStatusExclude:
35284 type: array
35285 items:
35286 type: string
35287 heatArtifactDeploymentTimeout:
35288 $ref: '#/components/schemas/HeatDeploymentArtifactTimeout'
35289 heatEnvArtifactFooter:
35290 type: string
35291 heatEnvArtifactHeader:
35292 type: string
35293 heatTranslatorPath:
35294 type: string
35295 identificationHeaderFields:
35296 type: array
35297 items:
35298 type: string
35299 informationalResourceArtifacts:
35300 type: object
35301 additionalProperties:
35302 type: object
35303 informationalServiceArtifacts:
35304 type: object
35305 additionalProperties:
35306 type: object
35307 janusGraphCfgFile:
35308 type: string
35309 janusGraphHealthCheckReadTimeout:
35310 type: integer
35311 format: int64
35312 janusGraphInMemoryGraph:
35313 type: boolean
35314 janusGraphLockTimeout:
35315 type: integer
35316 format: int64
35317 janusGraphMigrationKeySpaceCfgFile:
35318 type: string
35319 janusGraphReconnectIntervalInSeconds:
35320 type: integer
35321 format: int64
35322 licenseTypes:
35323 type: array
35324 items:
35325 type: string
35326 maxDeleteComponents:
35327 type: integer
35328 format: int32
35329 minToscaConformanceLevel:
35330 type: string
35331 neo4j:
35332 type: object
35333 additionalProperties:
35334 type: object
35335 onboarding:
35336 $ref: '#/components/schemas/OnboardingConfig'
35337 permittedAncestors:
35338 type: string
35339 protocols:
35340 type: array
35341 items:
35342 type: string
35343 released:
35344 type: string
35345 format: date-time
35346 resourceNodeTypes:
35347 type: object
35348 additionalProperties:
35349 type: object
35350 additionalProperties:
35351 type: string
35352 resourceTypes:
35353 type: array
35354 items:
35355 type: string
35356 resourcesForUpgrade:
35357 type: object
35358 additionalProperties:
35359 type: array
35360 items:
35361 type: string
35362 serviceApiArtifacts:
35363 type: object
35364 additionalProperties:
35365 type: object
35366 serviceBaseNodeTypes:
35367 type: object
35368 additionalProperties:
35369 $ref: '#/components/schemas/CategoryBaseTypeConfig'
35370 skipUpgradeFailedVfs:
35371 type: boolean
35372 skipUpgradeVSPs:
35373 type: boolean
35374 startMigrationFrom:
35375 type: integer
35376 format: int32
35377 supportAllottedResourcesAndProxy:
35378 type: boolean
35379 switchoverDetector:
35380 $ref: '#/components/schemas/SwitchoverDetectorConfig'
35381 systemMonitoring:
35382 $ref: '#/components/schemas/BeMonitoringConfig'
35383 toscaArtifacts:
35384 type: object
35385 additionalProperties:
35386 type: object
35387 toscaConformanceLevel:
35388 type: string
35389 toscaFilesDir:
35390 type: string
35391 toscaValidators:
35392 $ref: '#/components/schemas/ToscaValidatorsConfig'
35393 uebHealthCheckReadTimeout:
35394 type: integer
35395 format: int64
35396 uebHealthCheckReconnectIntervalInSeconds:
35397 type: integer
35398 format: int64
35399 unLoggedUrls:
35400 type: array
35401 items:
35402 type: string
35403 users:
35404 type: object
35405 additionalProperties:
35406 type: string
35407 version:
35408 type: string
35409 vfModuleProperties:
35410 type: object
35411 additionalProperties:
35412 $ref: '#/components/schemas/VfModuleProperty'
35413 workloadContext:
35414 type: string
35415 Constraint:
35416 type: object
35417 properties:
35418 equal:
35419 type: object
35420 greater_or_equal:
35421 type: object
35422 greater_than:
35423 type: object
35424 in_range:
35425 type: array
35426 items:
35427 type: object
35428 length:
35429 type: integer
35430 format: int32
35431 less_or_equal:
35432 type: object
35433 less_than:
35434 type: object
35435 max_length:
35436 type: integer
35437 format: int32
35438 min_length:
35439 type: integer
35440 format: int32
35441 pattern:
35442 type: object
35443 valid_values:
35444 type: array
35445 items:
35446 type: object
35447 ConsumerDefinition:
35448 type: object
35449 properties:
35450 consumerDetailsLastupdatedtime:
35451 type: integer
35452 format: int64
35453 consumerLastAuthenticationTime:
35454 type: integer
35455 format: int64
35456 consumerName:
35457 type: string
35458 consumerPassword:
35459 type: string
35460 consumerSalt:
35461 type: string
35462 empty:
35463 type: boolean
35464 lastModfierAtuid:
35465 type: string
35466 ownerId:
35467 type: string
35468 ownerIdIfEmpty:
35469 type: string
35470 writeOnly: true
35471 type:
35472 type: string
35473 version:
35474 type: string
35475 CookieConfig:
35476 type: object
35477 properties:
35478 cookieName:
35479 type: string
35480 domain:
35481 type: string
35482 excludedUrls:
35483 type: array
35484 items:
35485 type: string
35486 httpOnly:
35487 type: boolean
35488 isHttpOnly:
35489 type: boolean
35490 writeOnly: true
35491 maxSessionTimeOut:
35492 type: integer
35493 format: int64
35494 onboardingExcludedUrls:
35495 type: array
35496 items:
35497 type: string
35498 path:
35499 type: string
35500 redirectURL:
35501 type: string
35502 securityKey:
35503 type: string
35504 sessionIdleTimeOut:
35505 type: integer
35506 format: int64
35507 Credential:
35508 type: object
35509 properties:
35510 password:
35511 type: string
35512 username:
35513 type: string
35514 Credentials:
35515 type: object
35516 properties:
35517 accessKey:
35518 type: string
35519 secretKey:
35520 type: string
35521 CsarFormat:
35522 type: object
35523 properties:
35524 defaultFormat:
35525 type: string
35526 DataTypeDataDefinition:
35527 type: object
35528 properties:
35529 creationTime:
35530 type: integer
35531 format: int64
35532 derivedFromName:
35533 type: string
35534 description:
35535 type: string
35536 empty:
35537 type: boolean
35538 model:
35539 type: string
35540 modificationTime:
35541 type: integer
35542 format: int64
35543 name:
35544 type: string
35545 ownerId:
35546 type: string
35547 ownerIdIfEmpty:
35548 type: string
35549 writeOnly: true
35550 propertiesData:
35551 type: array
35552 items:
35553 $ref: '#/components/schemas/PropertyDataDefinition'
35554 type:
35555 type: string
35556 uniqueId:
35557 type: string
35558 version:
35559 type: string
35560 DataTypeDefinition:
35561 type: object
35562 properties:
35563 constraints:
35564 type: array
35565 items:
35566 $ref: '#/components/schemas/PropertyConstraint'
35567 creationTime:
35568 type: integer
35569 format: int64
35570 derivedFrom:
35571 $ref: '#/components/schemas/DataTypeDefinition'
35572 derivedFromName:
35573 type: string
35574 description:
35575 type: string
35576 empty:
35577 type: boolean
35578 model:
35579 type: string
35580 modificationTime:
35581 type: integer
35582 format: int64
35583 name:
35584 type: string
35585 ownerId:
35586 type: string
35587 ownerIdIfEmpty:
35588 type: string
35589 writeOnly: true
35590 properties:
35591 type: array
35592 items:
35593 $ref: '#/components/schemas/PropertyDefinition'
35594 propertiesData:
35595 type: array
35596 items:
35597 $ref: '#/components/schemas/PropertyDataDefinition'
35598 type:
35599 type: string
35600 uniqueId:
35601 type: string
35602 version:
35603 type: string
35604 DistributionStatusInfo:
35605 type: object
35606 properties:
35607 errorReason:
35608 type: string
35609 omfComponentID:
35610 type: string
35611 status:
35612 type: string
35613 timestamp:
35614 type: string
35615 url:
35616 type: string
35617 DistributionStatusListResponse:
35618 type: object
35619 properties:
35620 distributionStatusList:
35621 type: array
35622 items:
35623 $ref: '#/components/schemas/DistributionStatusInfo'
35624 DmaapConsumerConfiguration:
35625 type: object
35626 properties:
35627 active:
35628 type: boolean
35629 aftDme2ClientIgnoreSslConfig:
35630 type: boolean
35631 aftDme2ClientKeystore:
35632 type: string
35633 aftDme2ClientKeystorePassword:
35634 type: string
35635 aftDme2ClientSslCertAlias:
35636 type: string
35637 aftDme2ConnectionTimeoutMs:
35638 type: integer
35639 format: int32
35640 aftDme2ReadTimeoutMs:
35641 type: integer
35642 format: int32
35643 aftDme2RoundtripTimeoutMs:
35644 type: integer
35645 format: int32
35646 aftDme2SslEnable:
35647 type: boolean
35648 aftEnvironment:
35649 type: string
35650 consumerGroup:
35651 type: string
35652 consumerId:
35653 type: string
35654 contenttype:
35655 type: string
35656 credential:
35657 $ref: '#/components/schemas/Credential'
35658 dme2TraceOn:
35659 type: boolean
35660 dme2preferredRouterFilePath:
35661 type: string
35662 environment:
35663 type: string
35664 hosts:
35665 type: string
35666 latitude:
35667 type: number
35668 format: double
35669 limit:
35670 type: integer
35671 format: int32
35672 longitude:
35673 type: number
35674 format: double
35675 partner:
35676 type: string
35677 pollingInterval:
35678 type: integer
35679 format: int32
35680 protocol:
35681 type: string
35682 routeOffer:
35683 type: string
35684 serviceName:
35685 type: string
35686 timeLimitForNotificationHandleMs:
35687 type: integer
35688 format: int32
35689 timeoutMs:
35690 type: integer
35691 format: int32
35692 topic:
35693 type: string
35694 version:
35695 type: string
35696 DmaapProducerConfiguration:
35697 type: object
35698 properties:
35699 active:
35700 type: boolean
35701 aftDme2ClientIgnoreSslConfig:
35702 type: boolean
35703 aftDme2ClientKeystore:
35704 type: string
35705 aftDme2ClientKeystorePassword:
35706 type: string
35707 aftDme2ClientSslCertAlias:
35708 type: string
35709 aftDme2ConnectionTimeoutMs:
35710 type: integer
35711 format: int32
35712 aftDme2ReadTimeoutMs:
35713 type: integer
35714 format: int32
35715 aftDme2RoundtripTimeoutMs:
35716 type: integer
35717 format: int32
35718 aftDme2SslEnable:
35719 type: boolean
35720 aftEnvironment:
35721 type: string
35722 consumerGroup:
35723 type: string
35724 consumerId:
35725 type: string
35726 contenttype:
35727 type: string
35728 credential:
35729 $ref: '#/components/schemas/Credential'
35730 dme2TraceOn:
35731 type: boolean
35732 dme2preferredRouterFilePath:
35733 type: string
35734 environment:
35735 type: string
35736 hosts:
35737 type: string
35738 latitude:
35739 type: number
35740 format: double
35741 limit:
35742 type: integer
35743 format: int32
35744 longitude:
35745 type: number
35746 format: double
35747 partner:
35748 type: string
35749 pollingInterval:
35750 type: integer
35751 format: int32
35752 protocol:
35753 type: string
35754 routeOffer:
35755 type: string
35756 serviceName:
35757 type: string
35758 timeLimitForNotificationHandleMs:
35759 type: integer
35760 format: int32
35761 timeoutMs:
35762 type: integer
35763 format: int32
35764 topic:
35765 type: string
35766 version:
35767 type: string
35768 DmeConfiguration:
35769 type: object
35770 properties:
35771 lookupUriFormat:
35772 type: string
35773 EcompPortalConfig:
35774 type: object
35775 properties:
35776 defaultFunctionalMenu:
35777 type: string
35778 healthCheckUri:
35779 type: string
35780 host:
35781 type: string
35782 pollingInterval:
35783 type: integer
35784 format: int32
35785 port:
35786 type: integer
35787 format: int32
35788 protocol:
35789 type: string
35790 timeoutMs:
35791 type: integer
35792 format: int32
35793 Endpoint:
35794 type: object
35795 properties:
35796 host:
35797 type: string
35798 port:
35799 type: integer
35800 format: int32
35801 secure:
35802 type: boolean
35803 EntrySchema:
35804 type: object
35805 properties:
35806 constraints:
35807 type: array
35808 items:
35809 $ref: '#/components/schemas/Constraint'
35810 description:
35811 type: string
35812 type:
35813 type: string
35814 EnvironmentContext:
35815 type: object
35816 properties:
35817 defaultValue:
35818 type: string
35819 validValues:
35820 type: array
35821 items:
35822 type: string
35823 ExternalCsarStore:
35824 type: object
35825 properties:
35826 credentials:
35827 $ref: '#/components/schemas/Credentials'
35828 endpoint:
35829 $ref: '#/components/schemas/Endpoint'
35830 storageType:
35831 type: string
35832 tempPath:
35833 type: string
35834 uploadPartSize:
35835 type: integer
35836 format: int32
35837 FormDataContentDisposition:
35838 type: object
35839 properties:
35840 creationDate:
35841 type: string
35842 format: date-time
35843 fileName:
35844 type: string
35845 modificationDate:
35846 type: string
35847 format: date-time
35848 name:
35849 type: string
35850 parameters:
35851 type: object
35852 additionalProperties:
35853 type: string
35854 readDate:
35855 type: string
35856 format: date-time
35857 size:
35858 type: integer
35859 format: int64
35860 type:
35861 type: string
35862 ForwardingPathDataDefinition:
35863 type: object
35864 properties:
35865 description:
35866 type: string
35867 destinationPortNumber:
35868 type: string
35869 empty:
35870 type: boolean
35871 name:
35872 type: string
35873 ownerId:
35874 type: string
35875 ownerIdIfEmpty:
35876 type: string
35877 writeOnly: true
35878 pathElements:
35879 $ref: '#/components/schemas/ListDataDefinitionForwardingPathElementDataDefinition'
35880 protocol:
35881 type: string
35882 toscaResourceName:
35883 type: string
35884 type:
35885 type: string
35886 uniqueId:
35887 type: string
35888 version:
35889 type: string
35890 ForwardingPathElementDataDefinition:
35891 type: object
35892 properties:
35893 empty:
35894 type: boolean
35895 fromCP:
35896 type: string
35897 fromCPOriginId:
35898 type: string
35899 fromNode:
35900 type: string
35901 ownerId:
35902 type: string
35903 ownerIdIfEmpty:
35904 type: string
35905 writeOnly: true
35906 toCP:
35907 type: string
35908 toCPOriginId:
35909 type: string
35910 toNode:
35911 type: string
35912 type:
35913 type: string
35914 version:
35915 type: string
35916 GabConfig:
35917 type: object
35918 properties:
35919 artifactType:
35920 type: string
35921 pathsAndNamesDefinitions:
35922 type: array
35923 items:
35924 $ref: '#/components/schemas/PathsAndNamesDefinition'
35925 GenericArtifactQueryInfo:
35926 type: object
35927 properties:
35928 artifactUniqueId:
35929 type: string
35930 fields:
35931 type: array
35932 items:
35933 type: string
35934 uniqueItems: true
35935 parentId:
35936 type: string
35937 GetInputValueDataDefinition:
35938 type: object
35939 properties:
35940 empty:
35941 type: boolean
35942 getInputIndex:
35943 $ref: '#/components/schemas/GetInputValueDataDefinition'
35944 indexValue:
35945 type: integer
35946 format: int32
35947 inputId:
35948 type: string
35949 inputName:
35950 type: string
35951 inputType:
35952 type: string
35953 list:
35954 type: boolean
35955 ownerId:
35956 type: string
35957 ownerIdIfEmpty:
35958 type: string
35959 writeOnly: true
35960 propName:
35961 type: string
35962 type:
35963 type: string
35964 version:
35965 type: string
35966 GetOutputValueDataDefinition:
35967 type: object
35968 properties:
35969 attribName:
35970 type: string
35971 empty:
35972 type: boolean
35973 getOutputIndex:
35974 $ref: '#/components/schemas/GetOutputValueDataDefinition'
35975 indexValue:
35976 type: integer
35977 format: int32
35978 list:
35979 type: boolean
35980 outputId:
35981 type: string
35982 outputName:
35983 type: string
35984 ownerId:
35985 type: string
35986 ownerIdIfEmpty:
35987 type: string
35988 writeOnly: true
35989 type:
35990 type: string
35991 version:
35992 type: string
35993 GetPolicyValueDataDefinition:
35994 type: object
35995 properties:
35996 origPropertyValue:
35997 type: string
35998 policyId:
35999 type: string
36000 propertyName:
36001 type: string
36002 GroupDefinition:
36003 type: object
36004 properties:
36005 artifacts:
36006 type: array
36007 items:
36008 type: string
36009 artifactsUuid:
36010 type: array
36011 items:
36012 type: string
36013 capabilities:
36014 type: object
36015 additionalProperties:
36016 type: array
36017 items:
36018 $ref: '#/components/schemas/CapabilityDefinition'
36019 createdFrom:
36020 type: string
36021 enum:
36022 - UI
36023 - CSAR
36024 description:
36025 type: string
36026 empty:
36027 type: boolean
36028 groupUUID:
36029 type: string
36030 invariantName:
36031 type: string
36032 invariantUUID:
36033 type: string
36034 members:
36035 type: object
36036 additionalProperties:
36037 type: string
36038 name:
36039 type: string
36040 normalizedName:
36041 type: string
36042 ownerId:
36043 type: string
36044 ownerIdIfEmpty:
36045 type: string
36046 writeOnly: true
36047 properties:
36048 type: array
36049 items:
36050 $ref: '#/components/schemas/PropertyDataDefinition'
36051 propertyValueCounter:
36052 type: integer
36053 format: int32
36054 type:
36055 type: string
36056 typeUid:
36057 type: string
36058 uniqueId:
36059 type: string
36060 userDefined:
36061 type: boolean
36062 version:
36063 type: string
36064 vspOriginated:
36065 type: boolean
36066 GroupInfo:
36067 type: object
36068 properties:
36069 changePriorityBody:
36070 type: string
36071 changePriorityUrl:
36072 type: string
36073 GroupInstance:
36074 type: object
36075 properties:
36076 artifacts:
36077 type: array
36078 items:
36079 type: string
36080 artifactsUuid:
36081 type: array
36082 items:
36083 type: string
36084 creationTime:
36085 type: integer
36086 format: int64
36087 customizationUUID:
36088 type: string
36089 description:
36090 type: string
36091 empty:
36092 type: boolean
36093 groupInstanceArtifacts:
36094 type: array
36095 items:
36096 type: string
36097 groupInstanceArtifactsUuid:
36098 type: array
36099 items:
36100 type: string
36101 groupName:
36102 type: string
36103 groupUUID:
36104 type: string
36105 groupUid:
36106 type: string
36107 invariantUUID:
36108 type: string
36109 modificationTime:
36110 type: integer
36111 format: int64
36112 name:
36113 type: string
36114 normalizedName:
36115 type: string
36116 ownerId:
36117 type: string
36118 ownerIdIfEmpty:
36119 type: string
36120 writeOnly: true
36121 posX:
36122 type: string
36123 posY:
36124 type: string
36125 properties:
36126 type: array
36127 items:
36128 $ref: '#/components/schemas/PropertyDataDefinition'
36129 propertyValueCounter:
36130 type: integer
36131 format: int32
36132 type:
36133 type: string
36134 uniqueId:
36135 type: string
36136 version:
36137 type: string
36138 GroupProperty:
36139 type: object
36140 properties:
36141 annotations:
36142 type: array
36143 items:
36144 $ref: '#/components/schemas/Annotation'
36145 constraints:
36146 type: array
36147 items:
36148 $ref: '#/components/schemas/PropertyConstraint'
36149 defaultValue:
36150 type: string
36151 definition:
36152 type: boolean
36153 description:
36154 type: string
36155 empty:
36156 type: boolean
36157 getInputProperty:
36158 type: boolean
36159 getInputValues:
36160 type: array
36161 items:
36162 $ref: '#/components/schemas/GetInputValueDataDefinition'
36163 getPolicyValues:
36164 type: array
36165 items:
36166 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
36167 hidden:
36168 type: boolean
36169 immutable:
36170 type: boolean
36171 inputId:
36172 type: string
36173 inputPath:
36174 type: string
36175 instanceUniqueId:
36176 type: string
36177 isDeclaredListInput:
36178 type: boolean
36179 label:
36180 type: string
36181 mappedToComponentProperty:
36182 type: boolean
36183 metadata:
36184 type: object
36185 additionalProperties:
36186 type: string
36187 model:
36188 type: string
36189 name:
36190 type: string
36191 ownerId:
36192 type: string
36193 ownerIdIfEmpty:
36194 type: string
36195 writeOnly: true
36196 parentPropertyType:
36197 type: string
36198 parentUniqueId:
36199 type: string
36200 password:
36201 type: boolean
36202 propertyConstraints:
36203 type: array
36204 items:
36205 type: string
36206 propertyId:
36207 type: string
36208 required:
36209 type: boolean
36210 schema:
36211 $ref: '#/components/schemas/SchemaDefinition'
36212 schemaProperty:
36213 $ref: '#/components/schemas/PropertyDataDefinition'
36214 schemaType:
36215 type: string
36216 status:
36217 type: string
36218 subPropertyInputPath:
36219 type: string
36220 subPropertyToscaFunctions:
36221 type: array
36222 items:
36223 $ref: '#/components/schemas/SubPropertyToscaFunction'
36224 toscaFunction:
36225 $ref: '#/components/schemas/ToscaFunction'
36226 toscaGetFunction:
36227 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
36228 toscaGetFunctionType:
36229 type: string
36230 enum:
36231 - GET_INPUT
36232 - GET_PROPERTY
36233 - GET_ATTRIBUTE
36234 type:
36235 type: string
36236 uniqueId:
36237 type: string
36238 userCreated:
36239 type: boolean
36240 value:
36241 type: string
36242 valueUniqueUid:
36243 type: string
36244 version:
36245 type: string
36246 GroupTypeDefinition:
36247 type: object
36248 properties:
36249 capabilities:
36250 type: object
36251 additionalProperties:
36252 $ref: '#/components/schemas/CapabilityDefinition'
36253 creationTime:
36254 type: integer
36255 format: int64
36256 derivedFrom:
36257 type: string
36258 description:
36259 type: string
36260 empty:
36261 type: boolean
36262 highestVersion:
36263 type: boolean
36264 icon:
36265 type: string
36266 members:
36267 type: array
36268 items:
36269 type: string
36270 metadata:
36271 type: object
36272 additionalProperties:
36273 type: string
36274 model:
36275 type: string
36276 modificationTime:
36277 type: integer
36278 format: int64
36279 name:
36280 type: string
36281 ownerId:
36282 type: string
36283 ownerIdIfEmpty:
36284 type: string
36285 writeOnly: true
36286 properties:
36287 type: array
36288 items:
36289 $ref: '#/components/schemas/PropertyDefinition'
36290 type:
36291 type: string
36292 uniqueId:
36293 type: string
36294 version:
36295 type: string
36296 GroupingDefinition:
36297 type: object
36298 properties:
36299 empty:
36300 type: boolean
36301 name:
36302 type: string
36303 normalizedName:
36304 type: string
36305 ownerId:
36306 type: string
36307 ownerIdIfEmpty:
36308 type: string
36309 writeOnly: true
36310 type:
36311 type: string
36312 uniqueId:
36313 type: string
36314 version:
36315 type: string
36316 HeatDeploymentArtifactTimeout:
36317 type: object
36318 properties:
36319 defaultMinutes:
36320 type: integer
36321 format: int32
36322 maxMinutes:
36323 type: integer
36324 format: int32
36325 minMinutes:
36326 type: integer
36327 format: int32
36328 HeatParameterDataDefinition:
36329 type: object
36330 properties:
36331 currentValue:
36332 type: string
36333 defaultValue:
36334 type: string
36335 description:
36336 type: string
36337 empty:
36338 type: boolean
36339 name:
36340 type: string
36341 ownerId:
36342 type: string
36343 ownerIdIfEmpty:
36344 type: string
36345 writeOnly: true
36346 type:
36347 type: string
36348 uniqueId:
36349 type: string
36350 version:
36351 type: string
36352 HeatParameterDefinition:
36353 type: object
36354 properties:
36355 currentValue:
36356 type: string
36357 defaultValue:
36358 type: string
36359 description:
36360 type: string
36361 empty:
36362 type: boolean
36363 name:
36364 type: string
36365 ownerId:
36366 type: string
36367 ownerIdIfEmpty:
36368 type: string
36369 writeOnly: true
36370 type:
36371 type: string
36372 uniqueId:
36373 type: string
36374 version:
36375 type: string
36376 InputDataDefinition:
36377 type: object
36378 properties:
36379 annotations:
36380 type: array
36381 items:
36382 $ref: '#/components/schemas/Annotation'
36383 defaultValue:
36384 type: string
36385 definition:
36386 type: boolean
36387 description:
36388 type: string
36389 empty:
36390 type: boolean
36391 getInputProperty:
36392 type: boolean
36393 getInputValues:
36394 type: array
36395 items:
36396 $ref: '#/components/schemas/GetInputValueDataDefinition'
36397 getPolicyValues:
36398 type: array
36399 items:
36400 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
36401 hidden:
36402 type: boolean
36403 immutable:
36404 type: boolean
36405 inputId:
36406 type: string
36407 inputPath:
36408 type: string
36409 instanceUniqueId:
36410 type: string
36411 isDeclaredListInput:
36412 type: boolean
36413 label:
36414 type: string
36415 mappedToComponentProperty:
36416 type: boolean
36417 metadata:
36418 type: object
36419 additionalProperties:
36420 type: string
36421 model:
36422 type: string
36423 name:
36424 type: string
36425 ownerId:
36426 type: string
36427 ownerIdIfEmpty:
36428 type: string
36429 writeOnly: true
36430 parentPropertyType:
36431 type: string
36432 parentUniqueId:
36433 type: string
36434 password:
36435 type: boolean
36436 propertyConstraints:
36437 type: array
36438 items:
36439 type: string
36440 propertyId:
36441 type: string
36442 required:
36443 type: boolean
36444 schema:
36445 $ref: '#/components/schemas/SchemaDefinition'
36446 schemaProperty:
36447 $ref: '#/components/schemas/PropertyDataDefinition'
36448 schemaType:
36449 type: string
36450 status:
36451 type: string
36452 subPropertyInputPath:
36453 type: string
36454 subPropertyToscaFunctions:
36455 type: array
36456 items:
36457 $ref: '#/components/schemas/SubPropertyToscaFunction'
36458 toscaFunction:
36459 $ref: '#/components/schemas/ToscaFunction'
36460 toscaGetFunction:
36461 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
36462 toscaGetFunctionType:
36463 type: string
36464 enum:
36465 - GET_INPUT
36466 - GET_PROPERTY
36467 - GET_ATTRIBUTE
36468 type:
36469 type: string
36470 uniqueId:
36471 type: string
36472 userCreated:
36473 type: boolean
36474 value:
36475 type: string
36476 version:
36477 type: string
36478 InputDefinition:
36479 type: object
36480 properties:
36481 annotations:
36482 type: array
36483 items:
36484 $ref: '#/components/schemas/Annotation'
36485 annotationsToInput:
36486 type: array
36487 items:
36488 $ref: '#/components/schemas/Annotation'
36489 writeOnly: true
36490 constraints:
36491 type: array
36492 items:
36493 $ref: '#/components/schemas/PropertyConstraint'
36494 defaultValue:
36495 type: string
36496 definition:
36497 type: boolean
36498 description:
36499 type: string
36500 empty:
36501 type: boolean
36502 getInputProperty:
36503 type: boolean
36504 getInputValues:
36505 type: array
36506 items:
36507 $ref: '#/components/schemas/GetInputValueDataDefinition'
36508 getPolicyValues:
36509 type: array
36510 items:
36511 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
36512 hidden:
36513 type: boolean
36514 immutable:
36515 type: boolean
36516 inputId:
36517 type: string
36518 inputPath:
36519 type: string
36520 inputs:
36521 type: array
36522 items:
36523 $ref: '#/components/schemas/ComponentInstanceInput'
36524 instanceUniqueId:
36525 type: string
36526 isDeclaredListInput:
36527 type: boolean
36528 label:
36529 type: string
36530 mappedToComponentProperty:
36531 type: boolean
36532 metadata:
36533 type: object
36534 additionalProperties:
36535 type: string
36536 model:
36537 type: string
36538 name:
36539 type: string
36540 ownerId:
36541 type: string
36542 ownerIdIfEmpty:
36543 type: string
36544 writeOnly: true
36545 parentPropertyType:
36546 type: string
36547 parentUniqueId:
36548 type: string
36549 password:
36550 type: boolean
36551 properties:
36552 type: array
36553 items:
36554 $ref: '#/components/schemas/ComponentInstanceProperty'
36555 propertyConstraints:
36556 type: array
36557 items:
36558 type: string
36559 propertyId:
36560 type: string
36561 required:
36562 type: boolean
36563 schema:
36564 $ref: '#/components/schemas/SchemaDefinition'
36565 schemaProperty:
36566 $ref: '#/components/schemas/PropertyDataDefinition'
36567 schemaType:
36568 type: string
36569 status:
36570 type: string
36571 subPropertyInputPath:
36572 type: string
36573 subPropertyToscaFunctions:
36574 type: array
36575 items:
36576 $ref: '#/components/schemas/SubPropertyToscaFunction'
36577 toscaFunction:
36578 $ref: '#/components/schemas/ToscaFunction'
36579 toscaGetFunction:
36580 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
36581 toscaGetFunctionType:
36582 type: string
36583 enum:
36584 - GET_INPUT
36585 - GET_PROPERTY
36586 - GET_ATTRIBUTE
36587 type:
36588 type: string
36589 uniqueId:
36590 type: string
36591 userCreated:
36592 type: boolean
36593 value:
36594 type: string
36595 version:
36596 type: string
36597 InterfaceDefinition:
36598 type: object
36599 properties:
36600 creationDate:
36601 type: integer
36602 format: int64
36603 definition:
36604 type: boolean
36605 derivedFrom:
36606 type: string
36607 description:
36608 type: string
36609 empty:
36610 type: boolean
36611 inputs:
36612 type: object
36613 additionalProperties:
36614 $ref: '#/components/schemas/InputDataDefinition'
36615 lastUpdateDate:
36616 type: integer
36617 format: int64
36618 model:
36619 type: string
36620 operations:
36621 type: object
36622 additionalProperties:
36623 $ref: '#/components/schemas/OperationDataDefinition'
36624 ownerId:
36625 type: string
36626 ownerIdIfEmpty:
36627 type: string
36628 writeOnly: true
36629 toscaResourceName:
36630 type: string
36631 type:
36632 type: string
36633 uniqueId:
36634 type: string
36635 userCreated:
36636 type: boolean
36637 version:
36638 type: string
36639 InterfaceInstanceDataDefinition:
36640 type: object
36641 properties:
36642 empty:
36643 type: boolean
36644 inputs:
36645 type: object
36646 additionalProperties:
36647 type: object
36648 operations:
36649 type: object
36650 additionalProperties:
36651 $ref: '#/components/schemas/OperationInstance'
36652 ownerId:
36653 type: string
36654 ownerIdIfEmpty:
36655 type: string
36656 writeOnly: true
36657 type:
36658 type: string
36659 version:
36660 type: string
36661 KeyspaceConfig:
36662 type: object
36663 properties:
36664 name:
36665 type: string
36666 replicationInfo:
36667 type: array
36668 items:
36669 type: string
36670 replicationStrategy:
36671 type: string
36672 ListDataDefinitionForwardingPathElementDataDefinition:
36673 type: object
36674 properties:
36675 empty:
36676 type: boolean
36677 listToscaDataDefinition:
36678 type: array
36679 items:
36680 $ref: '#/components/schemas/ForwardingPathElementDataDefinition'
36681 ownerId:
36682 type: string
36683 ownerIdIfEmpty:
36684 type: string
36685 writeOnly: true
36686 type:
36687 type: string
36688 version:
36689 type: string
36690 ListDataDefinitionOperationInputDefinition:
36691 type: object
36692 properties:
36693 empty:
36694 type: boolean
36695 listToscaDataDefinition:
36696 type: array
36697 items:
36698 $ref: '#/components/schemas/OperationInputDefinition'
36699 ownerId:
36700 type: string
36701 ownerIdIfEmpty:
36702 type: string
36703 writeOnly: true
36704 type:
36705 type: string
36706 version:
36707 type: string
36708 ListDataDefinitionOperationOutputDefinition:
36709 type: object
36710 properties:
36711 empty:
36712 type: boolean
36713 listToscaDataDefinition:
36714 type: array
36715 items:
36716 $ref: '#/components/schemas/OperationOutputDefinition'
36717 ownerId:
36718 type: string
36719 ownerIdIfEmpty:
36720 type: string
36721 writeOnly: true
36722 type:
36723 type: string
36724 version:
36725 type: string
36726 ListDataDefinitionPropertyFilterDataDefinition:
36727 type: object
36728 properties:
36729 empty:
36730 type: boolean
36731 listToscaDataDefinition:
36732 type: array
36733 items:
36734 $ref: '#/components/schemas/PropertyFilterDataDefinition'
36735 ownerId:
36736 type: string
36737 ownerIdIfEmpty:
36738 type: string
36739 writeOnly: true
36740 type:
36741 type: string
36742 version:
36743 type: string
36744 ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition:
36745 type: object
36746 properties:
36747 empty:
36748 type: boolean
36749 listToscaDataDefinition:
36750 type: array
36751 items:
36752 $ref: '#/components/schemas/RequirementNodeFilterCapabilityDataDefinition'
36753 ownerId:
36754 type: string
36755 ownerIdIfEmpty:
36756 type: string
36757 writeOnly: true
36758 type:
36759 type: string
36760 version:
36761 type: string
36762 ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition:
36763 type: object
36764 properties:
36765 empty:
36766 type: boolean
36767 listToscaDataDefinition:
36768 type: array
36769 items:
36770 $ref: '#/components/schemas/RequirementSubstitutionFilterCapabilityDataDefinition'
36771 ownerId:
36772 type: string
36773 ownerIdIfEmpty:
36774 type: string
36775 writeOnly: true
36776 type:
36777 type: string
36778 version:
36779 type: string
36780 ListDataDefinitionSubstitutionFilterPropertyDataDefinition:
36781 type: object
36782 properties:
36783 empty:
36784 type: boolean
36785 listToscaDataDefinition:
36786 type: array
36787 items:
36788 $ref: '#/components/schemas/SubstitutionFilterPropertyDataDefinition'
36789 ownerId:
36790 type: string
36791 ownerIdIfEmpty:
36792 type: string
36793 writeOnly: true
36794 type:
36795 type: string
36796 version:
36797 type: string
36798 MetadataKeyDataDefinition:
36799 type: object
36800 properties:
36801 defaultValue:
36802 type: string
36803 displayName:
36804 type: string
36805 empty:
36806 type: boolean
36807 mandatory:
36808 type: boolean
36809 name:
36810 type: string
36811 ownerId:
36812 type: string
36813 ownerIdIfEmpty:
36814 type: string
36815 writeOnly: true
36816 type:
36817 type: string
36818 validValues:
36819 type: array
36820 items:
36821 type: string
36822 version:
36823 type: string
36824 Model:
36825 type: object
36826 properties:
36827 derivedFrom:
36828 type: string
36829 modelType:
36830 type: string
36831 enum:
36832 - NORMATIVE
36833 - NORMATIVE_EXTENSION
36834 name:
36835 type: string
36836 ModelCreateRequest:
36837 type: object
36838 properties:
36839 derivedFrom:
36840 type: string
36841 modelType:
36842 type: string
36843 enum:
36844 - NORMATIVE
36845 - NORMATIVE_EXTENSION
36846 name:
36847 type: string
36848 maxLength: 2147483647
36849 minLength: 2
36850 required:
36851 - modelType
36852 - name
36853 NameIdPair:
36854 type: object
36855 additionalProperties:
36856 type: object
36857 properties:
36858 empty:
36859 type: boolean
36860 id:
36861 type: string
36862 name:
36863 type: string
36864 ownerId:
36865 type: string
36866 NameIdPairWrapper:
36867 type: object
36868 additionalProperties:
36869 type: object
36870 properties:
36871 data:
36872 type: object
36873 additionalProperties:
36874 type: object
36875 properties:
36876 empty:
36877 type: boolean
36878 id:
36879 type: string
36880 name:
36881 type: string
36882 ownerId:
36883 type: string
36884 empty:
36885 type: boolean
36886 id:
36887 type: string
36888 nameIdPair:
36889 type: object
36890 additionalProperties:
36891 type: object
36892 properties:
36893 empty:
36894 type: boolean
36895 id:
36896 type: string
36897 name:
36898 type: string
36899 ownerId:
36900 type: string
36901 NodeTypeMetadata:
36902 type: object
36903 properties:
36904 categories:
36905 type: array
36906 items:
36907 $ref: '#/components/schemas/CategoryDefinition'
36908 contactId:
36909 type: string
36910 description:
36911 type: string
36912 icon:
36913 type: string
36914 model:
36915 type: string
36916 name:
36917 type: string
36918 normative:
36919 type: boolean
36920 resourceIconPath:
36921 type: string
36922 resourceType:
36923 type: string
36924 resourceVendorModelNumber:
36925 type: string
36926 tags:
36927 type: array
36928 items:
36929 type: string
36930 toscaName:
36931 type: string
36932 vendorName:
36933 type: string
36934 vendorRelease:
36935 type: string
36936 NodeTypesMetadataList:
36937 type: object
36938 properties:
36939 nodeMetadataList:
36940 type: array
36941 items:
36942 $ref: '#/components/schemas/NodeTypeMetadata'
36943 OnboardingConfig:
36944 type: object
36945 properties:
36946 getLatestVspPackageUri:
36947 type: string
36948 getLatestVspUri:
36949 type: string
36950 getVspPackageUri:
36951 type: string
36952 getVspUri:
36953 type: string
36954 healthCheckUri:
36955 type: string
36956 host:
36957 type: string
36958 port:
36959 type: integer
36960 format: int32
36961 protocol:
36962 type: string
36963 OperationDataDefinition:
36964 type: object
36965 properties:
36966 creationDate:
36967 type: integer
36968 format: int64
36969 description:
36970 type: string
36971 empty:
36972 type: boolean
36973 implementation:
36974 $ref: '#/components/schemas/ArtifactDataDefinition'
36975 inputs:
36976 $ref: '#/components/schemas/ListDataDefinitionOperationInputDefinition'
36977 lastUpdateDate:
36978 type: integer
36979 format: int64
36980 name:
36981 type: string
36982 outputs:
36983 $ref: '#/components/schemas/ListDataDefinitionOperationOutputDefinition'
36984 ownerId:
36985 type: string
36986 ownerIdIfEmpty:
36987 type: string
36988 writeOnly: true
36989 type:
36990 type: string
36991 uniqueId:
36992 type: string
36993 version:
36994 type: string
36995 workflowAssociationType:
36996 type: string
36997 workflowId:
36998 type: string
36999 workflowName:
37000 type: string
37001 workflowVersion:
37002 type: string
37003 workflowVersionId:
37004 type: string
37005 OperationImplementation:
37006 type: object
37007 properties:
37008 dependencies:
37009 type: array
37010 items:
37011 type: string
37012 primary:
37013 type: string
37014 OperationInputDefinition:
37015 type: object
37016 properties:
37017 annotations:
37018 type: array
37019 items:
37020 $ref: '#/components/schemas/Annotation'
37021 defaultValue:
37022 type: string
37023 definition:
37024 type: boolean
37025 description:
37026 type: string
37027 empty:
37028 type: boolean
37029 getInputProperty:
37030 type: boolean
37031 getInputValues:
37032 type: array
37033 items:
37034 $ref: '#/components/schemas/GetInputValueDataDefinition'
37035 getPolicyValues:
37036 type: array
37037 items:
37038 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37039 hidden:
37040 type: boolean
37041 immutable:
37042 type: boolean
37043 inputId:
37044 type: string
37045 inputPath:
37046 type: string
37047 instanceUniqueId:
37048 type: string
37049 isDeclaredListInput:
37050 type: boolean
37051 label:
37052 type: string
37053 mappedToComponentProperty:
37054 type: boolean
37055 metadata:
37056 type: object
37057 additionalProperties:
37058 type: string
37059 model:
37060 type: string
37061 name:
37062 type: string
37063 ownerId:
37064 type: string
37065 ownerIdIfEmpty:
37066 type: string
37067 writeOnly: true
37068 parentPropertyType:
37069 type: string
37070 parentUniqueId:
37071 type: string
37072 password:
37073 type: boolean
37074 propertyConstraints:
37075 type: array
37076 items:
37077 type: string
37078 propertyId:
37079 type: string
37080 required:
37081 type: boolean
37082 schema:
37083 $ref: '#/components/schemas/SchemaDefinition'
37084 schemaProperty:
37085 $ref: '#/components/schemas/PropertyDataDefinition'
37086 schemaType:
37087 type: string
37088 source:
37089 type: string
37090 sourceProperty:
37091 type: string
37092 status:
37093 type: string
37094 subPropertyInputPath:
37095 type: string
37096 subPropertyToscaFunctions:
37097 type: array
37098 items:
37099 $ref: '#/components/schemas/SubPropertyToscaFunction'
37100 toscaDefaultValue:
37101 type: string
37102 toscaFunction:
37103 $ref: '#/components/schemas/ToscaFunction'
37104 toscaGetFunction:
37105 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37106 toscaGetFunctionType:
37107 type: string
37108 enum:
37109 - GET_INPUT
37110 - GET_PROPERTY
37111 - GET_ATTRIBUTE
37112 type:
37113 type: string
37114 uniqueId:
37115 type: string
37116 userCreated:
37117 type: boolean
37118 value:
37119 type: string
37120 version:
37121 type: string
37122 OperationInstance:
37123 type: object
37124 properties:
37125 implementation:
37126 $ref: '#/components/schemas/OperationImplementation'
37127 inputs:
37128 type: object
37129 additionalProperties:
37130 type: object
37131 OperationOutputDefinition:
37132 type: object
37133 properties:
37134 annotations:
37135 type: array
37136 items:
37137 $ref: '#/components/schemas/Annotation'
37138 defaultValue:
37139 type: string
37140 definition:
37141 type: boolean
37142 description:
37143 type: string
37144 empty:
37145 type: boolean
37146 getInputProperty:
37147 type: boolean
37148 getInputValues:
37149 type: array
37150 items:
37151 $ref: '#/components/schemas/GetInputValueDataDefinition'
37152 getPolicyValues:
37153 type: array
37154 items:
37155 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37156 hidden:
37157 type: boolean
37158 immutable:
37159 type: boolean
37160 inputId:
37161 type: string
37162 inputPath:
37163 type: string
37164 instanceUniqueId:
37165 type: string
37166 isDeclaredListInput:
37167 type: boolean
37168 label:
37169 type: string
37170 mappedToComponentProperty:
37171 type: boolean
37172 metadata:
37173 type: object
37174 additionalProperties:
37175 type: string
37176 model:
37177 type: string
37178 name:
37179 type: string
37180 ownerId:
37181 type: string
37182 ownerIdIfEmpty:
37183 type: string
37184 writeOnly: true
37185 parentPropertyType:
37186 type: string
37187 parentUniqueId:
37188 type: string
37189 password:
37190 type: boolean
37191 propertyConstraints:
37192 type: array
37193 items:
37194 type: string
37195 propertyId:
37196 type: string
37197 required:
37198 type: boolean
37199 schema:
37200 $ref: '#/components/schemas/SchemaDefinition'
37201 schemaProperty:
37202 $ref: '#/components/schemas/PropertyDataDefinition'
37203 schemaType:
37204 type: string
37205 status:
37206 type: string
37207 subPropertyInputPath:
37208 type: string
37209 subPropertyToscaFunctions:
37210 type: array
37211 items:
37212 $ref: '#/components/schemas/SubPropertyToscaFunction'
37213 toscaFunction:
37214 $ref: '#/components/schemas/ToscaFunction'
37215 toscaGetFunction:
37216 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37217 toscaGetFunctionType:
37218 type: string
37219 enum:
37220 - GET_INPUT
37221 - GET_PROPERTY
37222 - GET_ATTRIBUTE
37223 type:
37224 type: string
37225 uniqueId:
37226 type: string
37227 userCreated:
37228 type: boolean
37229 value:
37230 type: string
37231 version:
37232 type: string
37233 OperationUi:
37234 type: object
37235 properties:
37236 implementation:
37237 type: object
37238 inputs:
37239 type: array
37240 items:
37241 $ref: '#/components/schemas/PropertyAssignmentUi'
37242 interfaceType:
37243 type: string
37244 operationType:
37245 type: string
37246 OutputDefinition:
37247 type: object
37248 properties:
37249 attribute:
37250 $ref: '#/components/schemas/ComponentInstanceAttribute'
37251 attributeId:
37252 type: string
37253 defaultValue:
37254 type: string
37255 definition:
37256 type: boolean
37257 description:
37258 type: string
37259 empty:
37260 type: boolean
37261 entry_schema:
37262 $ref: '#/components/schemas/EntrySchema'
37263 getOutputAttribute:
37264 type: boolean
37265 getOutputValues:
37266 type: array
37267 items:
37268 $ref: '#/components/schemas/GetOutputValueDataDefinition'
37269 get_default:
37270 type: object
37271 instanceUniqueId:
37272 type: string
37273 model:
37274 type: string
37275 name:
37276 type: string
37277 outputId:
37278 type: string
37279 outputPath:
37280 type: string
37281 ownerId:
37282 type: string
37283 ownerIdIfEmpty:
37284 type: string
37285 writeOnly: true
37286 parentUniqueId:
37287 type: string
37288 schema:
37289 $ref: '#/components/schemas/SchemaDefinition'
37290 schemaType:
37291 type: string
37292 status:
37293 type: string
37294 type:
37295 type: string
37296 uniqueId:
37297 type: string
37298 value:
37299 type: string
37300 version:
37301 type: string
37302 PathsAndNamesDefinition:
37303 type: object
37304 properties:
37305 friendlyName:
37306 type: string
37307 path:
37308 type: string
37309 searchable:
37310 type: boolean
37311 PolicyDefinition:
37312 type: object
37313 properties:
37314 annotations:
37315 type: array
37316 items:
37317 $ref: '#/components/schemas/Annotation'
37318 componentName:
37319 type: string
37320 defaultValue:
37321 type: string
37322 definition:
37323 type: boolean
37324 derivedFrom:
37325 type: string
37326 description:
37327 type: string
37328 empty:
37329 type: boolean
37330 getInputProperty:
37331 type: boolean
37332 getInputValues:
37333 type: array
37334 items:
37335 $ref: '#/components/schemas/GetInputValueDataDefinition'
37336 getPolicyValues:
37337 type: array
37338 items:
37339 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37340 hidden:
37341 type: boolean
37342 immutable:
37343 type: boolean
37344 inputId:
37345 type: string
37346 inputPath:
37347 type: string
37348 instanceUniqueId:
37349 type: string
37350 invariantName:
37351 type: string
37352 invariantUUID:
37353 type: string
37354 isDeclaredListInput:
37355 type: boolean
37356 isFromCsar:
37357 type: boolean
37358 label:
37359 type: string
37360 mappedToComponentProperty:
37361 type: boolean
37362 metadata:
37363 type: object
37364 additionalProperties:
37365 type: string
37366 model:
37367 type: string
37368 name:
37369 type: string
37370 normalizedName:
37371 type: string
37372 ownerId:
37373 type: string
37374 ownerIdIfEmpty:
37375 type: string
37376 writeOnly: true
37377 parentPropertyType:
37378 type: string
37379 parentUniqueId:
37380 type: string
37381 password:
37382 type: boolean
37383 policyTypeName:
37384 type: string
37385 policyTypeUid:
37386 type: string
37387 policyUUID:
37388 type: string
37389 properties:
37390 type: array
37391 items:
37392 $ref: '#/components/schemas/PropertyDataDefinition'
37393 propertyConstraints:
37394 type: array
37395 items:
37396 type: string
37397 propertyId:
37398 type: string
37399 required:
37400 type: boolean
37401 schema:
37402 $ref: '#/components/schemas/SchemaDefinition'
37403 schemaProperty:
37404 $ref: '#/components/schemas/PropertyDataDefinition'
37405 schemaType:
37406 type: string
37407 status:
37408 type: string
37409 subPropertyInputPath:
37410 type: string
37411 subPropertyToscaFunctions:
37412 type: array
37413 items:
37414 $ref: '#/components/schemas/SubPropertyToscaFunction'
37415 targets:
37416 type: object
37417 additionalProperties:
37418 type: array
37419 items:
37420 type: string
37421 toscaFunction:
37422 $ref: '#/components/schemas/ToscaFunction'
37423 toscaGetFunction:
37424 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37425 toscaGetFunctionType:
37426 type: string
37427 enum:
37428 - GET_INPUT
37429 - GET_PROPERTY
37430 - GET_ATTRIBUTE
37431 type:
37432 type: string
37433 uniqueId:
37434 type: string
37435 userCreated:
37436 type: boolean
37437 value:
37438 type: string
37439 version:
37440 type: string
37441 PolicyTargetDTO:
37442 type: object
37443 properties:
37444 type:
37445 type: string
37446 uniqueIds:
37447 type: array
37448 items:
37449 type: string
37450 PolicyTypeDefinition:
37451 type: object
37452 properties:
37453 creationTime:
37454 type: integer
37455 format: int64
37456 derivedFrom:
37457 type: string
37458 description:
37459 type: string
37460 empty:
37461 type: boolean
37462 highestVersion:
37463 type: boolean
37464 icon:
37465 type: string
37466 metadata:
37467 type: object
37468 additionalProperties:
37469 type: string
37470 model:
37471 type: string
37472 modificationTime:
37473 type: integer
37474 format: int64
37475 name:
37476 type: string
37477 ownerId:
37478 type: string
37479 ownerIdIfEmpty:
37480 type: string
37481 writeOnly: true
37482 properties:
37483 type: array
37484 items:
37485 $ref: '#/components/schemas/PropertyDefinition'
37486 targets:
37487 type: array
37488 items:
37489 type: string
37490 type:
37491 type: string
37492 uniqueId:
37493 type: string
37494 version:
37495 type: string
37496 PropertyAssignmentUi:
37497 type: object
37498 properties:
37499 name:
37500 type: string
37501 type:
37502 type: string
37503 value:
37504 type: string
37505 PropertyConstraint:
37506 type: object
37507 PropertyDataDefinition:
37508 type: object
37509 properties:
37510 annotations:
37511 type: array
37512 items:
37513 $ref: '#/components/schemas/Annotation'
37514 defaultValue:
37515 type: string
37516 definition:
37517 type: boolean
37518 description:
37519 type: string
37520 empty:
37521 type: boolean
37522 getInputProperty:
37523 type: boolean
37524 getInputValues:
37525 type: array
37526 items:
37527 $ref: '#/components/schemas/GetInputValueDataDefinition'
37528 getPolicyValues:
37529 type: array
37530 items:
37531 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37532 hidden:
37533 type: boolean
37534 immutable:
37535 type: boolean
37536 inputId:
37537 type: string
37538 inputPath:
37539 type: string
37540 instanceUniqueId:
37541 type: string
37542 isDeclaredListInput:
37543 type: boolean
37544 label:
37545 type: string
37546 mappedToComponentProperty:
37547 type: boolean
37548 metadata:
37549 type: object
37550 additionalProperties:
37551 type: string
37552 model:
37553 type: string
37554 name:
37555 type: string
37556 ownerId:
37557 type: string
37558 ownerIdIfEmpty:
37559 type: string
37560 writeOnly: true
37561 parentPropertyType:
37562 type: string
37563 parentUniqueId:
37564 type: string
37565 password:
37566 type: boolean
37567 propertyConstraints:
37568 type: array
37569 items:
37570 type: string
37571 propertyId:
37572 type: string
37573 required:
37574 type: boolean
37575 schema:
37576 $ref: '#/components/schemas/SchemaDefinition'
37577 schemaProperty:
37578 $ref: '#/components/schemas/PropertyDataDefinition'
37579 schemaType:
37580 type: string
37581 status:
37582 type: string
37583 subPropertyInputPath:
37584 type: string
37585 subPropertyToscaFunctions:
37586 type: array
37587 items:
37588 $ref: '#/components/schemas/SubPropertyToscaFunction'
37589 toscaFunction:
37590 $ref: '#/components/schemas/ToscaFunction'
37591 toscaGetFunction:
37592 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37593 toscaGetFunctionType:
37594 type: string
37595 enum:
37596 - GET_INPUT
37597 - GET_PROPERTY
37598 - GET_ATTRIBUTE
37599 type:
37600 type: string
37601 uniqueId:
37602 type: string
37603 userCreated:
37604 type: boolean
37605 value:
37606 type: string
37607 version:
37608 type: string
37609 PropertyDefinition:
37610 type: object
37611 properties:
37612 annotations:
37613 type: array
37614 items:
37615 $ref: '#/components/schemas/Annotation'
37616 constraints:
37617 type: array
37618 items:
37619 $ref: '#/components/schemas/PropertyConstraint'
37620 defaultValue:
37621 type: string
37622 definition:
37623 type: boolean
37624 description:
37625 type: string
37626 empty:
37627 type: boolean
37628 getInputProperty:
37629 type: boolean
37630 getInputValues:
37631 type: array
37632 items:
37633 $ref: '#/components/schemas/GetInputValueDataDefinition'
37634 getPolicyValues:
37635 type: array
37636 items:
37637 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37638 hidden:
37639 type: boolean
37640 immutable:
37641 type: boolean
37642 inputId:
37643 type: string
37644 inputPath:
37645 type: string
37646 instanceUniqueId:
37647 type: string
37648 isDeclaredListInput:
37649 type: boolean
37650 label:
37651 type: string
37652 mappedToComponentProperty:
37653 type: boolean
37654 metadata:
37655 type: object
37656 additionalProperties:
37657 type: string
37658 model:
37659 type: string
37660 name:
37661 type: string
37662 ownerId:
37663 type: string
37664 ownerIdIfEmpty:
37665 type: string
37666 writeOnly: true
37667 parentPropertyType:
37668 type: string
37669 parentUniqueId:
37670 type: string
37671 password:
37672 type: boolean
37673 propertyConstraints:
37674 type: array
37675 items:
37676 type: string
37677 propertyId:
37678 type: string
37679 required:
37680 type: boolean
37681 schema:
37682 $ref: '#/components/schemas/SchemaDefinition'
37683 schemaProperty:
37684 $ref: '#/components/schemas/PropertyDataDefinition'
37685 schemaType:
37686 type: string
37687 status:
37688 type: string
37689 subPropertyInputPath:
37690 type: string
37691 subPropertyToscaFunctions:
37692 type: array
37693 items:
37694 $ref: '#/components/schemas/SubPropertyToscaFunction'
37695 toscaFunction:
37696 $ref: '#/components/schemas/ToscaFunction'
37697 toscaGetFunction:
37698 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37699 toscaGetFunctionType:
37700 type: string
37701 enum:
37702 - GET_INPUT
37703 - GET_PROPERTY
37704 - GET_ATTRIBUTE
37705 type:
37706 type: string
37707 uniqueId:
37708 type: string
37709 userCreated:
37710 type: boolean
37711 value:
37712 type: string
37713 version:
37714 type: string
37715 PropertyDefinitionDto:
37716 type: object
37717 properties:
37718 constraints:
37719 type: array
37720 items:
37721 $ref: '#/components/schemas/PropertyConstraint'
37722 defaultValue:
37723 type: object
37724 description:
37725 type: string
37726 name:
37727 type: string
37728 required:
37729 type: boolean
37730 schemaType:
37731 type: string
37732 type:
37733 type: string
37734 uniqueId:
37735 type: string
37736 value:
37737 type: object
37738 PropertyFilterConstraintDataDefinition:
37739 type: object
37740 properties:
37741 capabilityName:
37742 type: string
37743 operator:
37744 type: string
37745 enum:
37746 - EQUAL
37747 - IN_RANGE
37748 - GREATER_THAN
37749 - GREATER_OR_EQUAL
37750 - LESS_OR_EQUAL
37751 - LENGTH
37752 - MIN_LENGTH
37753 - MAX_LENGTH
37754 - VALID_VALUES
37755 - LESS_THAN
37756 - PATTERN
37757 - SCHEMA
37758 propertyName:
37759 type: string
37760 targetType:
37761 type: string
37762 enum:
37763 - CAPABILITY
37764 - PROPERTY
37765 value:
37766 type: object
37767 valueType:
37768 type: string
37769 enum:
37770 - STATIC
37771 - GET_PROPERTY
37772 - GET_INPUT
37773 - GET_ATTRIBUTE
37774 - YAML
37775 - CONCAT
37776 PropertyFilterDataDefinition:
37777 type: object
37778 properties:
37779 constraints:
37780 type: array
37781 items:
37782 $ref: '#/components/schemas/PropertyFilterConstraintDataDefinition'
37783 empty:
37784 type: boolean
37785 name:
37786 type: string
37787 ownerId:
37788 type: string
37789 ownerIdIfEmpty:
37790 type: string
37791 writeOnly: true
37792 type:
37793 type: string
37794 version:
37795 type: string
37796 PropertyRule:
37797 type: object
37798 properties:
37799 empty:
37800 type: boolean
37801 ownerId:
37802 type: string
37803 ownerIdIfEmpty:
37804 type: string
37805 writeOnly: true
37806 rule:
37807 type: array
37808 items:
37809 type: string
37810 type:
37811 type: string
37812 value:
37813 type: string
37814 version:
37815 type: string
37816 QueueInfo:
37817 type: object
37818 properties:
37819 numberOfCacheWorkers:
37820 type: integer
37821 format: int32
37822 syncIntervalInSecondes:
37823 type: integer
37824 format: int32
37825 waitOnShutDownInMinutes:
37826 type: integer
37827 format: int32
37828 RelationshipImpl:
37829 type: object
37830 properties:
37831 type:
37832 type: string
37833 RelationshipInfo:
37834 type: object
37835 properties:
37836 capability:
37837 type: string
37838 capabilityOwnerId:
37839 type: string
37840 capabilityUid:
37841 type: string
37842 id:
37843 type: string
37844 relationship:
37845 $ref: '#/components/schemas/RelationshipImpl'
37846 relationships:
37847 $ref: '#/components/schemas/RelationshipImpl'
37848 requirement:
37849 type: string
37850 requirementOwnerId:
37851 type: string
37852 requirementUid:
37853 type: string
37854 ReplaceVNFInfo:
37855 type: object
37856 properties:
37857 abstractResourceUniqueId:
37858 type: string
37859 realVNFComponentInstance:
37860 $ref: '#/components/schemas/ComponentInstance'
37861 serviceUniqueId:
37862 type: string
37863 RequirementCapabilityRelDef:
37864 type: object
37865 properties:
37866 fromNode:
37867 type: string
37868 originUI:
37869 type: boolean
37870 relationships:
37871 type: array
37872 items:
37873 $ref: '#/components/schemas/CapabilityRequirementRelationship'
37874 toNode:
37875 type: string
37876 uid:
37877 type: string
37878 RequirementDataDefinition:
37879 type: object
37880 properties:
37881 capability:
37882 type: string
37883 empty:
37884 type: boolean
37885 external:
37886 type: boolean
37887 externalName:
37888 type: string
37889 leftOccurrences:
37890 type: string
37891 maxOccurrences:
37892 type: string
37893 minOccurrences:
37894 type: string
37895 name:
37896 type: string
37897 node:
37898 type: string
37899 ownerId:
37900 type: string
37901 ownerIdIfEmpty:
37902 type: string
37903 writeOnly: true
37904 ownerName:
37905 type: string
37906 parentName:
37907 type: string
37908 path:
37909 type: array
37910 items:
37911 type: string
37912 previousName:
37913 type: string
37914 relationship:
37915 type: string
37916 source:
37917 type: string
37918 type:
37919 type: string
37920 uniqueId:
37921 type: string
37922 version:
37923 type: string
37924 RequirementDefinition:
37925 type: object
37926 properties:
37927 capability:
37928 type: string
37929 empty:
37930 type: boolean
37931 external:
37932 type: boolean
37933 externalName:
37934 type: string
37935 leftOccurrences:
37936 type: string
37937 maxOccurrences:
37938 type: string
37939 minOccurrences:
37940 type: string
37941 name:
37942 type: string
37943 node:
37944 type: string
37945 ownerId:
37946 type: string
37947 ownerIdIfEmpty:
37948 type: string
37949 writeOnly: true
37950 ownerName:
37951 type: string
37952 parentName:
37953 type: string
37954 path:
37955 type: array
37956 items:
37957 type: string
37958 previousName:
37959 type: string
37960 relationship:
37961 type: string
37962 source:
37963 type: string
37964 type:
37965 type: string
37966 uniqueId:
37967 type: string
37968 version:
37969 type: string
37970 RequirementNodeFilterCapabilityDataDefinition:
37971 type: object
37972 properties:
37973 empty:
37974 type: boolean
37975 name:
37976 type: string
37977 ownerId:
37978 type: string
37979 ownerIdIfEmpty:
37980 type: string
37981 writeOnly: true
37982 properties:
37983 $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition'
37984 type:
37985 type: string
37986 version:
37987 type: string
37988 RequirementSubstitutionFilterCapabilityDataDefinition:
37989 type: object
37990 properties:
37991 empty:
37992 type: boolean
37993 name:
37994 type: string
37995 ownerId:
37996 type: string
37997 ownerIdIfEmpty:
37998 type: string
37999 writeOnly: true
38000 properties:
38001 $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition'
38002 type:
38003 type: string
38004 version:
38005 type: string
38006 Resource:
38007 type: object
38008 properties:
38009 abstract:
38010 type: boolean
38011 actualComponentType:
38012 type: string
38013 additionalInformation:
38014 type: array
38015 items:
38016 $ref: '#/components/schemas/AdditionalInformationDefinition'
38017 allArtifacts:
38018 type: object
38019 additionalProperties:
38020 $ref: '#/components/schemas/ArtifactDefinition'
38021 allVersions:
38022 type: object
38023 additionalProperties:
38024 type: string
38025 archiveTime:
38026 type: integer
38027 format: int64
38028 archived:
38029 type: boolean
38030 artifacts:
38031 type: object
38032 additionalProperties:
38033 $ref: '#/components/schemas/ArtifactDefinition'
38034 attributes:
38035 type: array
38036 items:
38037 $ref: '#/components/schemas/AttributeDefinition'
38038 capabilities:
38039 type: object
38040 additionalProperties:
38041 type: array
38042 items:
38043 $ref: '#/components/schemas/CapabilityDefinition'
38044 categories:
38045 type: array
38046 items:
38047 $ref: '#/components/schemas/CategoryDefinition'
38048 categorySpecificMetadata:
38049 type: object
38050 additionalProperties:
38051 type: string
38052 componentInstances:
38053 type: array
38054 items:
38055 $ref: '#/components/schemas/ComponentInstance'
38056 componentInstancesAttributes:
38057 type: object
38058 additionalProperties:
38059 type: array
38060 items:
38061 $ref: '#/components/schemas/ComponentInstanceAttribute'
38062 componentInstancesInputs:
38063 type: object
38064 additionalProperties:
38065 type: array
38066 items:
38067 $ref: '#/components/schemas/ComponentInstanceInput'
38068 componentInstancesInterfaces:
38069 type: object
38070 additionalProperties:
38071 type: array
38072 items:
38073 $ref: '#/components/schemas/ComponentInstanceInterface'
38074 componentInstancesOutputs:
38075 type: object
38076 additionalProperties:
38077 type: array
38078 items:
38079 $ref: '#/components/schemas/ComponentInstanceOutput'
38080 componentInstancesProperties:
38081 type: object
38082 additionalProperties:
38083 type: array
38084 items:
38085 $ref: '#/components/schemas/ComponentInstanceProperty'
38086 componentInstancesRelations:
38087 type: array
38088 items:
38089 $ref: '#/components/schemas/RequirementCapabilityRelDef'
38090 componentMetadataForSupportLog:
38091 type: object
38092 additionalProperties:
38093 type: string
38094 componentType:
38095 type: string
38096 enum:
38097 - RESOURCE
38098 - SERVICE
38099 - RESOURCE_INSTANCE
38100 - PRODUCT
38101 - SERVICE_INSTANCE
38102 conformanceLevel:
38103 type: string
38104 contactId:
38105 type: string
38106 cost:
38107 type: string
38108 creationDate:
38109 type: integer
38110 format: int64
38111 creatorFullName:
38112 type: string
38113 creatorUserId:
38114 type: string
38115 csarUUID:
38116 type: string
38117 csarVersion:
38118 type: string
38119 csarVersionId:
38120 type: string
38121 dataTypes:
38122 type: array
38123 items:
38124 $ref: '#/components/schemas/DataTypeDefinition'
38125 deploymentArtifacts:
38126 type: object
38127 additionalProperties:
38128 $ref: '#/components/schemas/ArtifactDefinition'
38129 derivedFrom:
38130 type: array
38131 items:
38132 type: string
38133 derivedFromGenericInfo:
38134 $ref: '#/components/schemas/Resource'
38135 derivedFromGenericType:
38136 type: string
38137 derivedFromGenericVersion:
38138 type: string
38139 derivedFromMapOfIdToName:
38140 type: object
38141 additionalProperties:
38142 type: string
38143 derivedList:
38144 type: array
38145 items:
38146 type: string
38147 description:
38148 type: string
38149 groups:
38150 type: array
38151 items:
38152 $ref: '#/components/schemas/GroupDefinition'
38153 highestVersion:
38154 type: boolean
38155 icon:
38156 type: string
38157 importedToscaChecksum:
38158 type: string
38159 inputs:
38160 type: array
38161 items:
38162 $ref: '#/components/schemas/InputDefinition'
38163 interfaces:
38164 type: object
38165 additionalProperties:
38166 $ref: '#/components/schemas/InterfaceDefinition'
38167 invariantUUID:
38168 type: string
38169 isDeleted:
38170 type: boolean
38171 lastUpdateDate:
38172 type: integer
38173 format: int64
38174 lastUpdaterFullName:
38175 type: string
38176 lastUpdaterUserId:
38177 type: string
38178 licenseType:
38179 type: string
38180 lifecycleState:
38181 type: string
38182 enum:
38183 - CERTIFIED
38184 - NOT_CERTIFIED_CHECKIN
38185 - NOT_CERTIFIED_CHECKOUT
38186 model:
38187 type: string
38188 name:
38189 type: string
38190 nodeFilterComponents:
38191 type: object
38192 additionalProperties:
38193 $ref: '#/components/schemas/CINodeFilterDataDefinition'
38194 normalizedName:
38195 type: string
38196 outputs:
38197 type: array
38198 items:
38199 $ref: '#/components/schemas/OutputDefinition'
38200 policies:
38201 type: object
38202 additionalProperties:
38203 $ref: '#/components/schemas/PolicyDefinition'
38204 projectCode:
38205 type: string
38206 properties:
38207 type: array
38208 items:
38209 $ref: '#/components/schemas/PropertyDefinition'
38210 requirements:
38211 type: object
38212 additionalProperties:
38213 type: array
38214 items:
38215 $ref: '#/components/schemas/RequirementDefinition'
38216 resourceType:
38217 type: string
38218 enum:
38219 - VFC
38220 - VF
38221 - CR
38222 - CP
38223 - PNF
38224 - CVFC
38225 - VL
38226 - VFCMT
38227 - Configuration
38228 - ServiceProxy
38229 - ABSTRACT
38230 - SERVICE
38231 resourceVendorModelNumber:
38232 type: string
38233 service:
38234 type: boolean
38235 specificComponetTypeArtifacts:
38236 type: object
38237 additionalProperties:
38238 $ref: '#/components/schemas/ArtifactDefinition'
38239 writeOnly: true
38240 state:
38241 type: string
38242 enum:
38243 - CERTIFIED
38244 - NOT_CERTIFIED_CHECKIN
38245 - NOT_CERTIFIED_CHECKOUT
38246 writeOnly: true
38247 substitutionFilter:
38248 $ref: '#/components/schemas/SubstitutionFilterDataDefinition'
38249 systemName:
38250 type: string
38251 tags:
38252 type: array
38253 items:
38254 type: string
38255 topologyTemplate:
38256 type: boolean
38257 toscaArtifacts:
38258 type: object
38259 additionalProperties:
38260 $ref: '#/components/schemas/ArtifactDefinition'
38261 toscaResourceName:
38262 type: string
38263 toscaType:
38264 type: string
38265 toscaVersion:
38266 type: string
38267 uniqueId:
38268 type: string
38269 uuid:
38270 type: string
38271 vendorName:
38272 type: string
38273 vendorRelease:
38274 type: string
38275 version:
38276 type: string
38277 vspArchived:
38278 type: boolean
38279 SchemaDefinition:
38280 type: object
38281 properties:
38282 constraints:
38283 type: array
38284 items:
38285 type: string
38286 derivedFrom:
38287 type: string
38288 empty:
38289 type: boolean
38290 ownerId:
38291 type: string
38292 ownerIdIfEmpty:
38293 type: string
38294 writeOnly: true
38295 properties:
38296 type: object
38297 additionalProperties:
38298 $ref: '#/components/schemas/PropertyDataDefinition'
38299 property:
38300 $ref: '#/components/schemas/PropertyDataDefinition'
38301 type:
38302 type: string
38303 version:
38304 type: string
38305 Service:
38306 type: object
38307 properties:
38308 abstract:
38309 type: boolean
38310 writeOnly: true
38311 actualComponentType:
38312 type: string
38313 additionalInformation:
38314 type: array
38315 items:
38316 $ref: '#/components/schemas/AdditionalInformationDefinition'
38317 allArtifacts:
38318 type: object
38319 additionalProperties:
38320 $ref: '#/components/schemas/ArtifactDefinition'
38321 allVersions:
38322 type: object
38323 additionalProperties:
38324 type: string
38325 archiveTime:
38326 type: integer
38327 format: int64
38328 archived:
38329 type: boolean
38330 artifacts:
38331 type: object
38332 additionalProperties:
38333 $ref: '#/components/schemas/ArtifactDefinition'
38334 attributes:
38335 type: array
38336 items:
38337 $ref: '#/components/schemas/AttributeDefinition'
38338 capabilities:
38339 type: object
38340 additionalProperties:
38341 type: array
38342 items:
38343 $ref: '#/components/schemas/CapabilityDefinition'
38344 categories:
38345 type: array
38346 items:
38347 $ref: '#/components/schemas/CategoryDefinition'
38348 categorySpecificMetadata:
38349 type: object
38350 additionalProperties:
38351 type: string
38352 componentInstances:
38353 type: array
38354 items:
38355 $ref: '#/components/schemas/ComponentInstance'
38356 componentInstancesAttributes:
38357 type: object
38358 additionalProperties:
38359 type: array
38360 items:
38361 $ref: '#/components/schemas/ComponentInstanceAttribute'
38362 componentInstancesInputs:
38363 type: object
38364 additionalProperties:
38365 type: array
38366 items:
38367 $ref: '#/components/schemas/ComponentInstanceInput'
38368 componentInstancesInterfaces:
38369 type: object
38370 additionalProperties:
38371 type: array
38372 items:
38373 $ref: '#/components/schemas/ComponentInstanceInterface'
38374 componentInstancesOutputs:
38375 type: object
38376 additionalProperties:
38377 type: array
38378 items:
38379 $ref: '#/components/schemas/ComponentInstanceOutput'
38380 componentInstancesProperties:
38381 type: object
38382 additionalProperties:
38383 type: array
38384 items:
38385 $ref: '#/components/schemas/ComponentInstanceProperty'
38386 componentInstancesRelations:
38387 type: array
38388 items:
38389 $ref: '#/components/schemas/RequirementCapabilityRelDef'
38390 componentMetadataForSupportLog:
38391 type: object
38392 additionalProperties:
38393 type: string
38394 componentType:
38395 type: string
38396 enum:
38397 - RESOURCE
38398 - SERVICE
38399 - RESOURCE_INSTANCE
38400 - PRODUCT
38401 - SERVICE_INSTANCE
38402 conformanceLevel:
38403 type: string
38404 contactId:
38405 type: string
38406 creationDate:
38407 type: integer
38408 format: int64
38409 creatorFullName:
38410 type: string
38411 creatorUserId:
38412 type: string
38413 csarUUID:
38414 type: string
38415 csarVersion:
38416 type: string
38417 dataTypes:
38418 type: array
38419 items:
38420 $ref: '#/components/schemas/DataTypeDefinition'
38421 deploymentArtifacts:
38422 type: object
38423 additionalProperties:
38424 $ref: '#/components/schemas/ArtifactDefinition'
38425 derivedFromGenericInfo:
38426 $ref: '#/components/schemas/Resource'
38427 derivedFromGenericType:
38428 type: string
38429 derivedFromGenericVersion:
38430 type: string
38431 description:
38432 type: string
38433 distributionStatus:
38434 type: string
38435 enum:
38436 - DISTRIBUTION_NOT_APPROVED
38437 - DISTRIBUTED
38438 ecompGeneratedNaming:
38439 type: boolean
38440 environmentContext:
38441 type: string
38442 forwardingPaths:
38443 type: object
38444 additionalProperties:
38445 $ref: '#/components/schemas/ForwardingPathDataDefinition'
38446 groups:
38447 type: array
38448 items:
38449 $ref: '#/components/schemas/GroupDefinition'
38450 highestVersion:
38451 type: boolean
38452 icon:
38453 type: string
38454 importedToscaChecksum:
38455 type: string
38456 inputs:
38457 type: array
38458 items:
38459 $ref: '#/components/schemas/InputDefinition'
38460 instantiationType:
38461 type: string
38462 interfaces:
38463 type: object
38464 additionalProperties:
38465 $ref: '#/components/schemas/InterfaceDefinition'
38466 invariantUUID:
38467 type: string
38468 isDeleted:
38469 type: boolean
38470 lastUpdateDate:
38471 type: integer
38472 format: int64
38473 lastUpdaterFullName:
38474 type: string
38475 lastUpdaterUserId:
38476 type: string
38477 lifecycleState:
38478 type: string
38479 enum:
38480 - CERTIFIED
38481 - NOT_CERTIFIED_CHECKIN
38482 - NOT_CERTIFIED_CHECKOUT
38483 model:
38484 type: string
38485 name:
38486 type: string
38487 namingPolicy:
38488 type: string
38489 nodeFilterComponents:
38490 type: object
38491 additionalProperties:
38492 $ref: '#/components/schemas/CINodeFilterDataDefinition'
38493 normalizedName:
38494 type: string
38495 outputs:
38496 type: array
38497 items:
38498 $ref: '#/components/schemas/OutputDefinition'
38499 policies:
38500 type: object
38501 additionalProperties:
38502 $ref: '#/components/schemas/PolicyDefinition'
38503 projectCode:
38504 type: string
38505 properties:
38506 type: array
38507 items:
38508 $ref: '#/components/schemas/PropertyDefinition'
38509 requirements:
38510 type: object
38511 additionalProperties:
38512 type: array
38513 items:
38514 $ref: '#/components/schemas/RequirementDefinition'
38515 service:
38516 type: boolean
38517 serviceApiArtifacts:
38518 type: object
38519 additionalProperties:
38520 $ref: '#/components/schemas/ArtifactDefinition'
38521 serviceFunction:
38522 type: string
38523 serviceRole:
38524 type: string
38525 serviceType:
38526 type: string
38527 serviceVendorModelNumber:
38528 type: string
38529 writeOnly: true
38530 specificComponetTypeArtifacts:
38531 type: object
38532 additionalProperties:
38533 $ref: '#/components/schemas/ArtifactDefinition'
38534 writeOnly: true
38535 state:
38536 type: string
38537 enum:
38538 - CERTIFIED
38539 - NOT_CERTIFIED_CHECKIN
38540 - NOT_CERTIFIED_CHECKOUT
38541 writeOnly: true
38542 substituteCandidate:
38543 type: boolean
38544 substitutionFilter:
38545 $ref: '#/components/schemas/SubstitutionFilterDataDefinition'
38546 systemName:
38547 type: string
38548 tags:
38549 type: array
38550 items:
38551 type: string
38552 topologyTemplate:
38553 type: boolean
38554 toscaArtifacts:
38555 type: object
38556 additionalProperties:
38557 $ref: '#/components/schemas/ArtifactDefinition'
38558 toscaServiceName:
38559 type: string
38560 toscaType:
38561 type: string
38562 uniqueId:
38563 type: string
38564 uuid:
38565 type: string
38566 vendorName:
38567 type: string
38568 writeOnly: true
38569 vendorRelease:
38570 type: string
38571 writeOnly: true
38572 version:
38573 type: string
38574 vspArchived:
38575 type: boolean
38576 ServiceRelations:
38577 type: array
38578 items:
38579 $ref: '#/components/schemas/NameIdPairWrapper'
38580 properties:
38581 empty:
38582 type: boolean
38583 relations:
38584 type: array
38585 items:
38586 $ref: '#/components/schemas/NameIdPairWrapper'
38587 uniqueItems: true
38588 SubCategoryDefinition:
38589 type: object
38590 properties:
38591 empty:
38592 type: boolean
38593 groupings:
38594 type: array
38595 items:
38596 $ref: '#/components/schemas/GroupingDefinition'
38597 icons:
38598 type: array
38599 items:
38600 type: string
38601 metadataKeys:
38602 type: array
38603 items:
38604 $ref: '#/components/schemas/MetadataKeyDataDefinition'
38605 name:
38606 type: string
38607 normalizedName:
38608 type: string
38609 ownerId:
38610 type: string
38611 ownerIdIfEmpty:
38612 type: string
38613 writeOnly: true
38614 type:
38615 type: string
38616 uniqueId:
38617 type: string
38618 version:
38619 type: string
38620 SubPropertyToscaFunction:
38621 type: object
38622 properties:
38623 subPropertyPath:
38624 type: array
38625 items:
38626 type: string
38627 toscaFunction:
38628 $ref: '#/components/schemas/ToscaFunction'
38629 SubstitutionFilterDataDefinition:
38630 type: object
38631 properties:
38632 capabilities:
38633 $ref: '#/components/schemas/ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition'
38634 empty:
38635 type: boolean
38636 id:
38637 type: string
38638 name:
38639 type: string
38640 ownerId:
38641 type: string
38642 ownerIdIfEmpty:
38643 type: string
38644 writeOnly: true
38645 properties:
38646 $ref: '#/components/schemas/ListDataDefinitionSubstitutionFilterPropertyDataDefinition'
38647 tosca_id:
38648 type: object
38649 type:
38650 type: string
38651 version:
38652 type: string
38653 SubstitutionFilterPropertyDataDefinition:
38654 type: object
38655 properties:
38656 constraints:
38657 type: array
38658 items:
38659 $ref: '#/components/schemas/PropertyFilterConstraintDataDefinition'
38660 empty:
38661 type: boolean
38662 name:
38663 type: string
38664 ownerId:
38665 type: string
38666 ownerIdIfEmpty:
38667 type: string
38668 writeOnly: true
38669 type:
38670 type: string
38671 version:
38672 type: string
38673 SwitchoverDetectorConfig:
38674 type: object
38675 properties:
38676 beResolveAttempts:
38677 type: integer
38678 format: int32
38679 beVip:
38680 type: string
38681 changePriorityPassword:
38682 type: string
38683 changePriorityUser:
38684 type: string
38685 enabled:
38686 type: boolean
38687 feResolveAttempts:
38688 type: integer
38689 format: int32
38690 feVip:
38691 type: string
38692 getgBeFqdn:
38693 type: string
38694 getgFeFqdn:
38695 type: string
38696 groups:
38697 type: object
38698 additionalProperties:
38699 $ref: '#/components/schemas/GroupInfo'
38700 interval:
38701 type: integer
38702 format: int64
38703 publishNetworkBody:
38704 type: string
38705 publishNetworkUrl:
38706 type: string
38707 ToscaArtifactDataDefinition:
38708 type: object
38709 properties:
38710 file:
38711 type: string
38712 properties:
38713 type: object
38714 additionalProperties:
38715 type: object
38716 type:
38717 type: string
38718 ToscaFunction:
38719 type: object
38720 properties:
38721 jsonObjectValue:
38722 type: object
38723 type:
38724 type: string
38725 enum:
38726 - GET_INPUT
38727 - GET_PROPERTY
38728 - GET_ATTRIBUTE
38729 - CONCAT
38730 - YAML
38731 - STRING
38732 value:
38733 type: string
38734 ToscaGetFunctionDataDefinition:
38735 type: object
38736 properties:
38737 functionType:
38738 type: string
38739 enum:
38740 - GET_INPUT
38741 - GET_PROPERTY
38742 - GET_ATTRIBUTE
38743 propertyName:
38744 type: string
38745 propertyPathFromSource:
38746 type: array
38747 items:
38748 type: string
38749 propertySource:
38750 type: string
38751 enum:
38752 - SELF
38753 - INSTANCE
38754 propertyUniqueId:
38755 type: string
38756 sourceName:
38757 type: string
38758 sourceUniqueId:
38759 type: string
38760 type:
38761 type: string
38762 enum:
38763 - GET_INPUT
38764 - GET_PROPERTY
38765 - GET_ATTRIBUTE
38766 - CONCAT
38767 - YAML
38768 - STRING
38769 ToscaValidatorsConfig:
38770 type: object
38771 properties:
38772 stringMaxLength:
38773 type: integer
38774 format: int32
38775 UIConstraint:
38776 type: object
38777 properties:
38778 capabilityName:
38779 type: string
38780 constraintOperator:
38781 type: string
38782 servicePropertyName:
38783 type: string
38784 sourceName:
38785 type: string
38786 sourceType:
38787 type: string
38788 value:
38789 type: object
38790 User:
38791 type: object
38792 properties:
38793 email:
38794 type: string
38795 firstName:
38796 type: string
38797 fullName:
38798 type: string
38799 lastLoginTime:
38800 type: integer
38801 format: int64
38802 lastName:
38803 type: string
38804 role:
38805 type: string
38806 status:
38807 type: string
38808 enum:
38809 - ACTIVE
38810 - INACTIVE
38811 userId:
38812 type: string
38813 UserRole:
38814 type: object
38815 properties:
38816 role:
38817 type: string
38818 enum:
38819 - ADMIN
38820 - TESTER
38821 - DESIGNER
38822 - PRODUCT_MANAGER
38823 - PRODUCT_STRATEGIST
38824 VfModuleProperty:
38825 type: object
38826 properties:
38827 forBaseModule:
38828 type: string
38829 forNonBaseModule:
38830 type: string