Gitiles
Code Review Sign In
gerrit.nordix.org / onap / sdc / 38440b83f47aa3a461fd11955cf4c4ffd4505c65 / . / openecomp-be / tools / swagger-ui / api-docs / api.json
blob: efcb5e84abace270bf6944674916f44f76022463 [file] [log] [blame]
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]1{
2 "swagger" : "2.0",
3 "info" : {
4 "description" : "Rest API Documentation",
5 "version" : "v1.0, build #${buildNumber}",
6 "title" : "Rest API",
7 "termsOfService" : "http://www.github.com/kongchen/swagger-maven-plugin"
8 },
9 "basePath" : "/onboarding-api",
10 "tags" : [ {
Michael Landoefa037d2017-02-19 12:57:33 +0200[diff] [blame]11 "name" : "Vendor Software Product Component NICs"
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]12 }, {
13 "name" : "Vendor Software Product Component Processes"
14 }, {
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]15 "name" : "Vendor Software Product Component MIB Uploads"
16 }, {
Michael Landoefa037d2017-02-19 12:57:33 +0200[diff] [blame]17 "name" : "Vendor License Model - License Key Groups"
18 }, {
19 "name" : "Application Configuration"
20 }, {
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]21 "name" : "Vendor License Model - License Agreements"
22 }, {
Michael Landoefa037d2017-02-19 12:57:33 +0200[diff] [blame]23 "name" : "Vendor License Model - Feature Groups"
24 }, {
25 "name" : "Vendor Software Product Processes"
26 }, {
27 "name" : "Actions"
28 }, {
29 "name" : "Validation"
30 }, {
31 "name" : "Vendor Software Product Components"
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]32 }, {
33 "name" : "Vendor Software Products"
34 }, {
Michael Landoefa037d2017-02-19 12:57:33 +0200[diff] [blame]35 "name" : "Vendor Software Product Networks"
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]36 }, {
Michael Landoefa037d2017-02-19 12:57:33 +0200[diff] [blame]37 "name" : "Vendor License Model - Entitlement Pools"
38 }, {
39 "name" : "Vendor License Models"
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]40 } ],
41 "schemes" : [ "http" ],
42 "paths" : {
43 "/v1.0/application-configuration" : {
44 "post" : {
45 "tags" : [ "Application Configuration" ],
46 "summary" : "Insert JSON schema into application config table",
47 "description" : "",
48 "operationId" : "insertToTable",
49 "consumes" : [ "multipart/form-data" ],
50 "produces" : [ "application/json" ],
51 "parameters" : [ {
52 "name" : "namespace",
53 "in" : "query",
54 "required" : false,
55 "type" : "string"
56 }, {
57 "name" : "key",
58 "in" : "query",
59 "required" : false,
60 "type" : "string"
61 }, {
62 "in" : "body",
63 "name" : "body",
64 "required" : false,
65 "schema" : {
66 "$ref" : "#/definitions/InputStream"
67 }
68 } ],
69 "responses" : {
70 "default" : {
71 "description" : "successful operation"
72 }
73 }
74 }
75 },
76 "/v1.0/application-configuration/{namespace}" : {
77 "get" : {
78 "tags" : [ "Application Configuration" ],
79 "summary" : "Get List of keys and values by namespace",
80 "description" : "",
81 "operationId" : "getListOfConfigurationByNamespaceFromTable",
82 "consumes" : [ "application/json" ],
83 "produces" : [ "application/json" ],
84 "parameters" : [ {
85 "name" : "namespace",
86 "in" : "path",
87 "required" : true,
88 "type" : "string"
89 } ],
90 "responses" : {
91 "default" : {
92 "description" : "successful operation"
93 }
94 }
95 }
96 },
97 "/v1.0/application-configuration/{namespace}/{key}" : {
98 "get" : {
99 "tags" : [ "Application Configuration" ],
100 "summary" : "Get JSON schema by namespace and key",
101 "description" : "",
102 "operationId" : "getFromTable",
103 "consumes" : [ "application/json" ],
104 "produces" : [ "application/json" ],
105 "parameters" : [ {
106 "name" : "namespace",
107 "in" : "path",
108 "required" : true,
109 "type" : "string"
110 }, {
111 "name" : "key",
112 "in" : "path",
113 "required" : true,
114 "type" : "string"
115 } ],
116 "responses" : {
117 "200" : {
118 "description" : "successful operation",
119 "schema" : {
120 "$ref" : "#/definitions/ConfigurationDataDto"
121 }
122 }
123 }
124 }
125 },
126 "/v1.0/validation/{type}/validate" : {
127 "post" : {
128 "tags" : [ "Validation" ],
129 "summary" : "Validate a package",
130 "description" : "",
131 "operationId" : "validateFile",
132 "consumes" : [ "multipart/form-data" ],
133 "produces" : [ "application/json" ],
134 "parameters" : [ {
135 "name" : "type",
136 "in" : "path",
137 "required" : true,
138 "type" : "string"
139 }, {
140 "in" : "body",
141 "name" : "body",
142 "required" : false,
143 "schema" : {
144 "$ref" : "#/definitions/InputStream"
145 }
146 } ],
147 "responses" : {
148 "default" : {
149 "description" : "successful operation"
150 }
151 }
152 }
153 },
154 "/v1.0/vendor-license-models" : {
155 "get" : {
156 "tags" : [ "Vendor License Models" ],
157 "summary" : "List vendor license models",
158 "description" : "",
159 "operationId" : "listLicenseModels",
160 "consumes" : [ "application/json" ],
161 "produces" : [ "application/json" ],
162 "parameters" : [ {
163 "name" : "versionFilter",
164 "in" : "query",
165 "description" : "Currently supported value: 'Final' - only vendor License models with final versions will be return - with their latest final version",
166 "required" : false,
167 "type" : "string"
168 }, {
169 "name" : "USER_ID",
170 "in" : "header",
171 "required" : false,
172 "type" : "string",
173 "default" : ""
174 } ],
175 "responses" : {
176 "200" : {
177 "description" : "successful operation",
178 "schema" : {
179 "type" : "array",
180 "items" : {
181 "$ref" : "#/definitions/VendorLicenseModelEntity"
182 }
183 }
184 }
185 }
186 },
187 "post" : {
188 "tags" : [ "Vendor License Models" ],
189 "summary" : "Create vendor license model",
190 "description" : "",
191 "operationId" : "createLicenseModel",
192 "consumes" : [ "application/json" ],
193 "produces" : [ "application/json" ],
194 "parameters" : [ {
195 "in" : "body",
196 "name" : "body",
197 "required" : false,
198 "schema" : {
199 "$ref" : "#/definitions/VendorLicenseModelRequest"
200 }
201 }, {
202 "name" : "USER_ID",
203 "in" : "header",
204 "required" : false,
205 "type" : "string",
206 "default" : ""
207 } ],
208 "responses" : {
209 "default" : {
210 "description" : "successful operation"
211 }
212 }
213 }
214 },
215 "/v1.0/vendor-license-models/{vlmId}" : {
216 "get" : {
217 "tags" : [ "Vendor License Models" ],
218 "summary" : "Get vendor license model",
219 "description" : "",
220 "operationId" : "getLicenseModel",
221 "consumes" : [ "application/json" ],
222 "produces" : [ "application/json" ],
223 "parameters" : [ {
224 "name" : "vlmId",
225 "in" : "path",
226 "description" : "Vendor license model Id",
227 "required" : true,
228 "type" : "string"
229 }, {
230 "name" : "version",
231 "in" : "query",
232 "required" : false,
233 "type" : "string"
234 }, {
235 "name" : "USER_ID",
236 "in" : "header",
237 "required" : false,
238 "type" : "string",
239 "default" : ""
240 } ],
241 "responses" : {
242 "200" : {
243 "description" : "successful operation",
244 "schema" : {
245 "$ref" : "#/definitions/VendorLicenseModelEntity"
246 }
247 }
248 }
249 },
250 "put" : {
251 "tags" : [ "Vendor License Models" ],
252 "summary" : "Update vendor license model",
253 "description" : "",
254 "operationId" : "updateLicenseModel",
255 "consumes" : [ "application/json" ],
256 "produces" : [ "application/json" ],
257 "parameters" : [ {
258 "in" : "body",
259 "name" : "body",
260 "required" : false,
261 "schema" : {
262 "$ref" : "#/definitions/VendorLicenseModelRequest"
263 }
264 }, {
265 "name" : "vlmId",
266 "in" : "path",
267 "description" : "Vendor license model Id",
268 "required" : true,
269 "type" : "string"
270 }, {
271 "name" : "USER_ID",
272 "in" : "header",
273 "required" : false,
274 "type" : "string",
275 "default" : ""
276 } ],
277 "responses" : {
278 "default" : {
279 "description" : "successful operation"
280 }
281 }
282 },
283 "delete" : {
284 "tags" : [ "Vendor License Models" ],
285 "summary" : "Delete vendor license model",
286 "description" : "",
287 "operationId" : "deleteLicenseModel",
288 "consumes" : [ "application/json" ],
289 "produces" : [ "application/json" ],
290 "parameters" : [ {
291 "name" : "vlmId",
292 "in" : "path",
293 "description" : "Vendor license model Id",
294 "required" : true,
295 "type" : "string"
296 }, {
297 "name" : "USER_ID",
298 "in" : "header",
299 "required" : false,
300 "type" : "string",
301 "default" : ""
302 } ],
303 "responses" : {
304 "default" : {
305 "description" : "successful operation"
306 }
307 }
308 }
309 },
310 "/v1.0/vendor-license-models/{vlmId}/actions" : {
311 "put" : {
312 "tags" : [ "Vendor License Models" ],
313 "summary" : "Update vendor license model",
314 "description" : "",
315 "operationId" : "actOnLicenseModel",
316 "consumes" : [ "application/json" ],
317 "produces" : [ "application/json" ],
318 "parameters" : [ {
319 "in" : "body",
320 "name" : "body",
321 "required" : false,
322 "schema" : {
323 "$ref" : "#/definitions/VendorLicenseModelActionRequestDto"
324 }
325 }, {
326 "name" : "vlmId",
327 "in" : "path",
328 "description" : "Vendor license model Id",
329 "required" : true,
330 "type" : "string"
331 }, {
332 "name" : "USER_ID",
333 "in" : "header",
334 "required" : false,
335 "type" : "string",
336 "default" : ""
337 } ],
338 "responses" : {
339 "default" : {
340 "description" : "successful operation"
341 }
342 }
343 }
344 },
345 "/v1.0/vendor-license-models/{vlmId}/entitlement-pools" : {
346 "get" : {
347 "tags" : [ "Vendor License Model - Entitlement Pools" ],
348 "summary" : "List vendor entitlement pools",
349 "description" : "",
350 "operationId" : "listEntitlementPools",
351 "consumes" : [ "application/json" ],
352 "produces" : [ "application/json" ],
353 "parameters" : [ {
354 "name" : "vlmId",
355 "in" : "path",
356 "description" : "Vendor license model Id",
357 "required" : true,
358 "type" : "string"
359 }, {
360 "name" : "version",
361 "in" : "query",
362 "required" : false,
363 "type" : "string"
364 }, {
365 "name" : "USER_ID",
366 "in" : "header",
367 "required" : false,
368 "type" : "string",
369 "default" : ""
370 } ],
371 "responses" : {
372 "200" : {
373 "description" : "successful operation",
374 "schema" : {
375 "type" : "array",
376 "items" : {
377 "$ref" : "#/definitions/EntitlementPoolEntity"
378 }
379 }
380 }
381 }
382 },
383 "post" : {
384 "tags" : [ "Vendor License Model - Entitlement Pools" ],
385 "summary" : "Create vendor entitlement pool",
386 "description" : "",
387 "operationId" : "createEntitlementPool",
388 "consumes" : [ "application/json" ],
389 "produces" : [ "application/json" ],
390 "parameters" : [ {
391 "in" : "body",
392 "name" : "body",
393 "required" : false,
394 "schema" : {
395 "$ref" : "#/definitions/EntitlementPoolRequest"
396 }
397 }, {
398 "name" : "vlmId",
399 "in" : "path",
400 "description" : "Vendor license model Id",
401 "required" : true,
402 "type" : "string"
403 }, {
404 "name" : "USER_ID",
405 "in" : "header",
406 "required" : false,
407 "type" : "string",
408 "default" : ""
409 } ],
410 "responses" : {
411 "default" : {
412 "description" : "successful operation"
413 }
414 }
415 }
416 },
417 "/v1.0/vendor-license-models/{vlmId}/entitlement-pools/{entitlementPoolId}" : {
418 "get" : {
419 "tags" : [ "Vendor License Model - Entitlement Pools" ],
420 "summary" : "Get vendor entitlement pool",
421 "description" : "",
422 "operationId" : "getEntitlementPool",
423 "consumes" : [ "application/json" ],
424 "produces" : [ "application/json" ],
425 "parameters" : [ {
426 "name" : "vlmId",
427 "in" : "path",
428 "description" : "Vendor license model Id",
429 "required" : true,
430 "type" : "string"
431 }, {
432 "name" : "version",
433 "in" : "query",
434 "required" : false,
435 "type" : "string"
436 }, {
437 "name" : "entitlementPoolId",
438 "in" : "path",
439 "required" : true,
440 "type" : "string"
441 }, {
442 "name" : "USER_ID",
443 "in" : "header",
444 "required" : false,
445 "type" : "string",
446 "default" : ""
447 } ],
448 "responses" : {
449 "200" : {
450 "description" : "successful operation",
451 "schema" : {
452 "$ref" : "#/definitions/EntitlementPoolEntity"
453 }
454 }
455 }
456 },
457 "put" : {
458 "tags" : [ "Vendor License Model - Entitlement Pools" ],
459 "summary" : "Update vendor entitlement pool",
460 "description" : "",
461 "operationId" : "updateEntitlementPool",
462 "consumes" : [ "application/json" ],
463 "produces" : [ "application/json" ],
464 "parameters" : [ {
465 "in" : "body",
466 "name" : "body",
467 "required" : false,
468 "schema" : {
469 "$ref" : "#/definitions/EntitlementPoolRequest"
470 }
471 }, {
472 "name" : "vlmId",
473 "in" : "path",
474 "description" : "Vendor license model Id",
475 "required" : true,
476 "type" : "string"
477 }, {
478 "name" : "entitlementPoolId",
479 "in" : "path",
480 "required" : true,
481 "type" : "string"
482 }, {
483 "name" : "USER_ID",
484 "in" : "header",
485 "required" : false,
486 "type" : "string",
487 "default" : ""
488 } ],
489 "responses" : {
490 "default" : {
491 "description" : "successful operation"
492 }
493 }
494 },
495 "delete" : {
496 "tags" : [ "Vendor License Model - Entitlement Pools" ],
497 "summary" : "Delete vendor entitlement pool",
498 "description" : "",
499 "operationId" : "deleteEntitlementPool",
500 "consumes" : [ "application/json" ],
501 "produces" : [ "application/json" ],
502 "parameters" : [ {
503 "name" : "vlmId",
504 "in" : "path",
505 "description" : "Vendor license model Id",
506 "required" : true,
507 "type" : "string"
508 }, {
509 "name" : "entitlementPoolId",
510 "in" : "path",
511 "required" : true,
512 "type" : "string"
513 }, {
514 "name" : "USER_ID",
515 "in" : "header",
516 "required" : false,
517 "type" : "string",
518 "default" : ""
519 } ],
520 "responses" : {
521 "default" : {
522 "description" : "successful operation"
523 }
524 }
525 }
526 },
527 "/v1.0/vendor-license-models/{vlmId}/feature-groups" : {
528 "get" : {
529 "tags" : [ "Vendor License Model - Feature Groups" ],
530 "summary" : "List vendor feature groups",
531 "description" : "",
532 "operationId" : "listFeatureGroups",
533 "consumes" : [ "application/json" ],
534 "produces" : [ "application/json" ],
535 "parameters" : [ {
536 "name" : "vlmId",
537 "in" : "path",
538 "description" : "Vendor license model Id",
539 "required" : true,
540 "type" : "string"
541 }, {
542 "name" : "version",
543 "in" : "query",
544 "required" : false,
545 "type" : "string"
546 }, {
547 "name" : "USER_ID",
548 "in" : "header",
549 "required" : false,
550 "type" : "string",
551 "default" : ""
552 } ],
553 "responses" : {
554 "200" : {
555 "description" : "successful operation",
556 "schema" : {
557 "type" : "array",
558 "items" : {
559 "$ref" : "#/definitions/FeatureGroupEntity"
560 }
561 }
562 }
563 }
564 },
565 "post" : {
566 "tags" : [ "Vendor License Model - Feature Groups" ],
567 "summary" : "Create vendor feature group",
568 "description" : "",
569 "operationId" : "createFeatureGroup",
570 "consumes" : [ "application/json" ],
571 "produces" : [ "application/json" ],
572 "parameters" : [ {
573 "in" : "body",
574 "name" : "body",
575 "required" : false,
576 "schema" : {
577 "$ref" : "#/definitions/FeatureGroupRequest"
578 }
579 }, {
580 "name" : "vlmId",
581 "in" : "path",
582 "description" : "Vendor license model Id",
583 "required" : true,
584 "type" : "string"
585 }, {
586 "name" : "USER_ID",
587 "in" : "header",
588 "required" : false,
589 "type" : "string",
590 "default" : ""
591 } ],
592 "responses" : {
593 "default" : {
594 "description" : "successful operation"
595 }
596 }
597 }
598 },
599 "/v1.0/vendor-license-models/{vlmId}/feature-groups/{featureGroupId}" : {
600 "get" : {
601 "tags" : [ "Vendor License Model - Feature Groups" ],
602 "summary" : "Get vendor feature group",
603 "description" : "",
604 "operationId" : "getFeatureGroup",
605 "consumes" : [ "application/json" ],
606 "produces" : [ "application/json" ],
607 "parameters" : [ {
608 "name" : "vlmId",
609 "in" : "path",
610 "description" : "Vendor license model Id",
611 "required" : true,
612 "type" : "string"
613 }, {
614 "name" : "version",
615 "in" : "query",
616 "required" : false,
617 "type" : "string"
618 }, {
619 "name" : "featureGroupId",
620 "in" : "path",
621 "required" : true,
622 "type" : "string"
623 }, {
624 "name" : "USER_ID",
625 "in" : "header",
626 "required" : false,
627 "type" : "string",
628 "default" : ""
629 } ],
630 "responses" : {
631 "200" : {
632 "description" : "successful operation",
633 "schema" : {
634 "$ref" : "#/definitions/FeatureGroupModel"
635 }
636 }
637 }
638 },
639 "put" : {
640 "tags" : [ "Vendor License Model - Feature Groups" ],
641 "summary" : "Update vendor feature group",
642 "description" : "",
643 "operationId" : "updateFeatureGroup",
644 "consumes" : [ "application/json" ],
645 "produces" : [ "application/json" ],
646 "parameters" : [ {
647 "in" : "body",
648 "name" : "body",
649 "required" : false,
650 "schema" : {
651 "$ref" : "#/definitions/FeatureGroupUpdateRequest"
652 }
653 }, {
654 "name" : "vlmId",
655 "in" : "path",
656 "description" : "Vendor license model Id",
657 "required" : true,
658 "type" : "string"
659 }, {
660 "name" : "featureGroupId",
661 "in" : "path",
662 "required" : true,
663 "type" : "string"
664 }, {
665 "name" : "USER_ID",
666 "in" : "header",
667 "required" : false,
668 "type" : "string",
669 "default" : ""
670 } ],
671 "responses" : {
672 "default" : {
673 "description" : "successful operation"
674 }
675 }
676 },
677 "delete" : {
678 "tags" : [ "Vendor License Model - Feature Groups" ],
679 "summary" : "Delete vendor feature group",
680 "description" : "",
681 "operationId" : "deleteFeatureGroup",
682 "consumes" : [ "application/json" ],
683 "produces" : [ "application/json" ],
684 "parameters" : [ {
685 "name" : "vlmId",
686 "in" : "path",
687 "description" : "Vendor license model Id",
688 "required" : true,
689 "type" : "string"
690 }, {
691 "name" : "featureGroupId",
692 "in" : "path",
693 "required" : true,
694 "type" : "string"
695 }, {
696 "name" : "USER_ID",
697 "in" : "header",
698 "required" : false,
699 "type" : "string",
700 "default" : ""
701 } ],
702 "responses" : {
703 "default" : {
704 "description" : "successful operation"
705 }
706 }
707 }
708 },
709 "/v1.0/vendor-license-models/{vlmId}/license-agreements" : {
710 "get" : {
711 "tags" : [ "Vendor License Model - License Agreements" ],
712 "summary" : "List vendor license agreements",
713 "description" : "",
714 "operationId" : "listLicenseAgreements",
715 "consumes" : [ "application/json" ],
716 "produces" : [ "application/json" ],
717 "parameters" : [ {
718 "name" : "vlmId",
719 "in" : "path",
720 "description" : "Vendor license model Id",
721 "required" : true,
722 "type" : "string"
723 }, {
724 "name" : "version",
725 "in" : "query",
726 "required" : false,
727 "type" : "string"
728 }, {
729 "name" : "USER_ID",
730 "in" : "header",
731 "required" : false,
732 "type" : "string",
733 "default" : ""
734 } ],
735 "responses" : {
736 "200" : {
737 "description" : "successful operation",
738 "schema" : {
739 "type" : "array",
740 "items" : {
741 "$ref" : "#/definitions/LicenseAgreementEntity"
742 }
743 }
744 }
745 }
746 },
747 "post" : {
748 "tags" : [ "Vendor License Model - License Agreements" ],
749 "summary" : "Create vendor license agreement",
750 "description" : "",
751 "operationId" : "createLicenseAgreement",
752 "consumes" : [ "application/json" ],
753 "produces" : [ "application/json" ],
754 "parameters" : [ {
755 "in" : "body",
756 "name" : "body",
757 "required" : false,
758 "schema" : {
759 "$ref" : "#/definitions/LicenseAgreementRequest"
760 }
761 }, {
762 "name" : "vlmId",
763 "in" : "path",
764 "description" : "Vendor license model Id",
765 "required" : true,
766 "type" : "string"
767 }, {
768 "name" : "USER_ID",
769 "in" : "header",
770 "required" : false,
771 "type" : "string",
772 "default" : ""
773 } ],
774 "responses" : {
775 "default" : {
776 "description" : "successful operation"
777 }
778 }
779 }
780 },
781 "/v1.0/vendor-license-models/{vlmId}/license-agreements/{licenseAgreementId}" : {
782 "get" : {
783 "tags" : [ "Vendor License Model - License Agreements" ],
784 "summary" : "Get vendor license agreement",
785 "description" : "",
786 "operationId" : "getLicenseAgreement",
787 "consumes" : [ "application/json" ],
788 "produces" : [ "application/json" ],
789 "parameters" : [ {
790 "name" : "vlmId",
791 "in" : "path",
792 "description" : "Vendor license model Id",
793 "required" : true,
794 "type" : "string"
795 }, {
796 "name" : "version",
797 "in" : "query",
798 "required" : false,
799 "type" : "string"
800 }, {
801 "name" : "licenseAgreementId",
802 "in" : "path",
803 "required" : true,
804 "type" : "string"
805 }, {
806 "name" : "USER_ID",
807 "in" : "header",
808 "required" : false,
809 "type" : "string",
810 "default" : ""
811 } ],
812 "responses" : {
813 "200" : {
814 "description" : "successful operation",
815 "schema" : {
816 "$ref" : "#/definitions/LicenseAgreementModel"
817 }
818 }
819 }
820 },
821 "put" : {
822 "tags" : [ "Vendor License Model - License Agreements" ],
823 "summary" : "Update vendor license agreement",
824 "description" : "",
825 "operationId" : "updateLicenseAgreement",
826 "consumes" : [ "application/json" ],
827 "produces" : [ "application/json" ],
828 "parameters" : [ {
829 "in" : "body",
830 "name" : "body",
831 "required" : false,
832 "schema" : {
833 "$ref" : "#/definitions/LicenseAgreementUpdateRequest"
834 }
835 }, {
836 "name" : "vlmId",
837 "in" : "path",
838 "description" : "Vendor license model Id",
839 "required" : true,
840 "type" : "string"
841 }, {
842 "name" : "licenseAgreementId",
843 "in" : "path",
844 "required" : true,
845 "type" : "string"
846 }, {
847 "name" : "USER_ID",
848 "in" : "header",
849 "required" : false,
850 "type" : "string",
851 "default" : ""
852 } ],
853 "responses" : {
854 "default" : {
855 "description" : "successful operation"
856 }
857 }
858 },
859 "delete" : {
860 "tags" : [ "Vendor License Model - License Agreements" ],
861 "summary" : "Delete vendor license agreement",
862 "description" : "",
863 "operationId" : "deleteLicenseAgreement",
864 "consumes" : [ "application/json" ],
865 "produces" : [ "application/json" ],
866 "parameters" : [ {
867 "name" : "vlmId",
868 "in" : "path",
869 "description" : "Vendor license model Id",
870 "required" : true,
871 "type" : "string"
872 }, {
873 "name" : "licenseAgreementId",
874 "in" : "path",
875 "required" : true,
876 "type" : "string"
877 }, {
878 "name" : "USER_ID",
879 "in" : "header",
880 "required" : false,
881 "type" : "string",
882 "default" : ""
883 } ],
884 "responses" : {
885 "default" : {
886 "description" : "successful operation"
887 }
888 }
889 }
890 },
891 "/v1.0/vendor-license-models/{vlmId}/license-key-groups" : {
892 "get" : {
893 "tags" : [ "Vendor License Model - License Key Groups" ],
894 "summary" : "List vendor license key groups",
895 "description" : "",
896 "operationId" : "listLicenseKeyGroups",
897 "consumes" : [ "application/json" ],
898 "produces" : [ "application/json" ],
899 "parameters" : [ {
900 "name" : "vlmId",
901 "in" : "path",
902 "description" : "Vendor license model Id",
903 "required" : true,
904 "type" : "string"
905 }, {
906 "name" : "version",
907 "in" : "query",
908 "required" : false,
909 "type" : "string"
910 }, {
911 "name" : "USER_ID",
912 "in" : "header",
913 "required" : false,
914 "type" : "string",
915 "default" : ""
916 } ],
917 "responses" : {
918 "200" : {
919 "description" : "successful operation",
920 "schema" : {
921 "type" : "array",
922 "items" : {
923 "$ref" : "#/definitions/LicenseKeyGroupEntityDto"
924 }
925 }
926 }
927 }
928 },
929 "post" : {
930 "tags" : [ "Vendor License Model - License Key Groups" ],
931 "summary" : "Create vendor license key group",
932 "description" : "",
933 "operationId" : "createLicenseKeyGroup",
934 "consumes" : [ "application/json" ],
935 "produces" : [ "application/json" ],
936 "parameters" : [ {
937 "in" : "body",
938 "name" : "body",
939 "required" : false,
940 "schema" : {
941 "$ref" : "#/definitions/LicenseKeyGroupRequestDto"
942 }
943 }, {
944 "name" : "vlmId",
945 "in" : "path",
946 "description" : "Vendor license model Id",
947 "required" : true,
948 "type" : "string"
949 }, {
950 "name" : "USER_ID",
951 "in" : "header",
952 "required" : false,
953 "type" : "string",
954 "default" : ""
955 } ],
956 "responses" : {
957 "default" : {
958 "description" : "successful operation"
959 }
960 }
961 }
962 },
963 "/v1.0/vendor-license-models/{vlmId}/license-key-groups/{licenseKeyGroupId}" : {
964 "get" : {
965 "tags" : [ "Vendor License Model - License Key Groups" ],
966 "summary" : "Get vendor license key group",
967 "description" : "",
968 "operationId" : "getLicenseKeyGroup",
969 "consumes" : [ "application/json" ],
970 "produces" : [ "application/json" ],
971 "parameters" : [ {
972 "name" : "vlmId",
973 "in" : "path",
974 "description" : "Vendor license model Id",
975 "required" : true,
976 "type" : "string"
977 }, {
978 "name" : "version",
979 "in" : "query",
980 "required" : false,
981 "type" : "string"
982 }, {
983 "name" : "licenseKeyGroupId",
984 "in" : "path",
985 "required" : true,
986 "type" : "string"
987 }, {
988 "name" : "USER_ID",
989 "in" : "header",
990 "required" : false,
991 "type" : "string",
992 "default" : ""
993 } ],
994 "responses" : {
995 "200" : {
996 "description" : "successful operation",
997 "schema" : {
998 "$ref" : "#/definitions/LicenseKeyGroupEntityDto"
999 }
1000 }
1001 }
1002 },
1003 "put" : {
1004 "tags" : [ "Vendor License Model - License Key Groups" ],
1005 "summary" : "Update vendor license key group",
1006 "description" : "",
1007 "operationId" : "updateLicenseKeyGroup",
1008 "consumes" : [ "application/json" ],
1009 "produces" : [ "application/json" ],
1010 "parameters" : [ {
1011 "in" : "body",
1012 "name" : "body",
1013 "required" : false,
1014 "schema" : {
1015 "$ref" : "#/definitions/LicenseKeyGroupRequestDto"
1016 }
1017 }, {
1018 "name" : "vlmId",
1019 "in" : "path",
1020 "description" : "Vendor license model Id",
1021 "required" : true,
1022 "type" : "string"
1023 }, {
1024 "name" : "licenseKeyGroupId",
1025 "in" : "path",
1026 "required" : true,
1027 "type" : "string"
1028 }, {
1029 "name" : "USER_ID",
1030 "in" : "header",
1031 "required" : false,
1032 "type" : "string",
1033 "default" : ""
1034 } ],
1035 "responses" : {
1036 "default" : {
1037 "description" : "successful operation"
1038 }
1039 }
1040 },
1041 "delete" : {
1042 "tags" : [ "Vendor License Model - License Key Groups" ],
1043 "summary" : "Delete vendor license key group",
1044 "description" : "",
1045 "operationId" : "deleteLicenseKeyGroup",
1046 "consumes" : [ "application/json" ],
1047 "produces" : [ "application/json" ],
1048 "parameters" : [ {
1049 "name" : "vlmId",
1050 "in" : "path",
1051 "description" : "Vendor license model Id",
1052 "required" : true,
1053 "type" : "string"
1054 }, {
1055 "name" : "licenseKeyGroupId",
1056 "in" : "path",
1057 "required" : true,
1058 "type" : "string"
1059 }, {
1060 "name" : "USER_ID",
1061 "in" : "header",
1062 "required" : false,
1063 "type" : "string",
1064 "default" : ""
1065 } ],
1066 "responses" : {
1067 "default" : {
1068 "description" : "successful operation"
1069 }
1070 }
1071 }
1072 },
1073 "/v1.0/vendor-software-products" : {
1074 "get" : {
1075 "tags" : [ "Vendor Software Products" ],
1076 "summary" : "Get list of vendor software products and their description",
1077 "description" : "",
1078 "operationId" : "getVspList",
1079 "consumes" : [ "application/json" ],
1080 "produces" : [ "application/json" ],
1081 "parameters" : [ {
1082 "name" : "versionFilter",
1083 "in" : "query",
1084 "description" : "Currently supported values: 'Final' - only vendor software products with final version will be return - with their latest final version",
1085 "required" : false,
1086 "type" : "string"
1087 }, {
1088 "name" : "USER_ID",
1089 "in" : "header",
1090 "required" : false,
1091 "type" : "string",
1092 "default" : ""
1093 } ],
1094 "responses" : {
1095 "default" : {
1096 "description" : "successful operation"
1097 }
1098 }
1099 },
1100 "post" : {
1101 "tags" : [ "Vendor Software Products" ],
1102 "summary" : "Create a new vendor software product",
1103 "description" : "",
1104 "operationId" : "createNewVsp",
1105 "consumes" : [ "application/json" ],
1106 "produces" : [ "application/json" ],
1107 "parameters" : [ {
1108 "in" : "body",
1109 "name" : "body",
1110 "required" : false,
1111 "schema" : {
1112 "$ref" : "#/definitions/VspDescriptionDto"
1113 }
1114 }, {
1115 "name" : "USER_ID",
1116 "in" : "header",
1117 "required" : false,
1118 "type" : "string",
1119 "default" : ""
1120 } ],
1121 "responses" : {
1122 "200" : {
1123 "description" : "successful operation",
1124 "schema" : {
1125 "$ref" : "#/definitions/VspCreationDto"
1126 }
1127 }
1128 }
1129 }
1130 },
1131 "/v1.0/vendor-software-products/packages" : {
1132 "get" : {
1133 "tags" : [ "Vendor Software Products" ],
1134 "summary" : "Get list of translated CSAR files details",
1135 "description" : "",
1136 "operationId" : "listPackages",
1137 "consumes" : [ "application/json" ],
1138 "produces" : [ "application/json" ],
1139 "parameters" : [ {
1140 "name" : "category",
1141 "in" : "query",
1142 "description" : "Category",
1143 "required" : false,
1144 "type" : "string"
1145 }, {
1146 "name" : "subCategory",
1147 "in" : "query",
1148 "description" : "Sub-category",
1149 "required" : false,
1150 "type" : "string"
1151 }, {
1152 "name" : "USER_ID",
1153 "in" : "header",
1154 "required" : false,
1155 "type" : "string",
1156 "default" : ""
1157 } ],
1158 "responses" : {
1159 "200" : {
1160 "description" : "successful operation",
1161 "schema" : {
1162 "type" : "array",
1163 "items" : {
1164 "$ref" : "#/definitions/PackageInfoDto"
1165 }
1166 }
1167 }
1168 }
1169 }
1170 },
1171 "/v1.0/vendor-software-products/packages/{vspId}" : {
1172 "get" : {
1173 "tags" : [ "Vendor Software Products" ],
1174 "summary" : "Get translated CSAR file",
1175 "description" : "Exports translated file to a zip file",
1176 "operationId" : "getTranslatedFile",
1177 "consumes" : [ "application/json" ],
1178 "produces" : [ "application/octet-stream" ],
1179 "parameters" : [ {
1180 "name" : "vspId",
1181 "in" : "path",
1182 "required" : true,
1183 "type" : "string"
1184 }, {
1185 "name" : "version",
1186 "in" : "query",
1187 "required" : false,
1188 "type" : "string"
1189 }, {
1190 "name" : "USER_ID",
1191 "in" : "header",
1192 "required" : false,
1193 "type" : "string",
1194 "default" : ""
1195 } ],
1196 "responses" : {
1197 "200" : {
1198 "description" : "successful operation",
1199 "schema" : {
1200 "$ref" : "#/definitions/File"
1201 }
1202 }
1203 }
1204 }
1205 },
1206 "/v1.0/vendor-software-products/{vspId}" : {
1207 "get" : {
1208 "tags" : [ "Vendor Software Products" ],
1209 "summary" : "Get details of a vendor software product",
1210 "description" : "",
1211 "operationId" : "getVspDetails",
1212 "consumes" : [ "application/json" ],
1213 "produces" : [ "application/json" ],
1214 "parameters" : [ {
1215 "name" : "vspId",
1216 "in" : "path",
1217 "required" : true,
1218 "type" : "string"
1219 }, {
1220 "name" : "version",
1221 "in" : "query",
1222 "required" : false,
1223 "type" : "string"
1224 }, {
1225 "name" : "USER_ID",
1226 "in" : "header",
1227 "required" : false,
1228 "type" : "string",
1229 "default" : ""
1230 } ],
1231 "responses" : {
1232 "default" : {
1233 "description" : "successful operation"
1234 }
1235 }
1236 },
1237 "put" : {
1238 "tags" : [ "Vendor Software Products" ],
1239 "summary" : "Update an existing vendor software product",
1240 "description" : "",
1241 "operationId" : "updateVsp",
1242 "consumes" : [ "application/json" ],
1243 "produces" : [ "application/json" ],
1244 "parameters" : [ {
1245 "name" : "vspId",
1246 "in" : "path",
1247 "required" : true,
1248 "type" : "string"
1249 }, {
1250 "in" : "body",
1251 "name" : "body",
1252 "required" : false,
1253 "schema" : {
1254 "$ref" : "#/definitions/VspDescriptionDto"
1255 }
1256 }, {
1257 "name" : "USER_ID",
1258 "in" : "header",
1259 "required" : false,
1260 "type" : "string",
1261 "default" : ""
1262 } ],
1263 "responses" : {
1264 "default" : {
1265 "description" : "successful operation"
1266 }
1267 }
1268 },
1269 "delete" : {
1270 "tags" : [ "Vendor Software Products" ],
1271 "summary" : "Deletes vendor software product by given id",
1272 "description" : "",
1273 "operationId" : "deleteVsp",
1274 "consumes" : [ "application/json" ],
1275 "produces" : [ "application/json" ],
1276 "parameters" : [ {
1277 "name" : "vspId",
1278 "in" : "path",
1279 "required" : true,
1280 "type" : "string"
1281 }, {
1282 "name" : "USER_ID",
1283 "in" : "header",
1284 "required" : false,
1285 "type" : "string",
1286 "default" : ""
1287 } ],
1288 "responses" : {
1289 "default" : {
1290 "description" : "successful operation"
1291 }
1292 }
1293 }
1294 },
1295 "/v1.0/vendor-software-products/{vspId}/actions" : {
1296 "put" : {
1297 "tags" : [ "Vendor Software Products" ],
1298 "summary" : "Actions on a vendor software product",
1299 "description" : "Performs one of the following actions on a vendor software product: |Checkout: Locks it for edits by other users. Only the locking user sees the edited version.|Undo_Checkout: Unlocks it and deletes the edits that were done.|Checkin: Unlocks it and activates the edited version to all users.| Submit: Finalize its active version.|Create_Package: Creates a CSAR zip file.|",
1300 "operationId" : "actOnVendorSoftwareProduct",
1301 "consumes" : [ "application/json" ],
1302 "produces" : [ "application/json" ],
1303 "parameters" : [ {
1304 "name" : "vspId",
1305 "in" : "path",
1306 "required" : true,
1307 "type" : "string"
1308 }, {
1309 "in" : "body",
1310 "name" : "body",
1311 "required" : false,
1312 "schema" : {
1313 "$ref" : "#/definitions/VersionSoftwareProductActionRequestDto"
1314 }
1315 }, {
1316 "name" : "USER_ID",
1317 "in" : "header",
1318 "required" : false,
1319 "type" : "string",
1320 "default" : ""
1321 } ],
1322 "responses" : {
1323 "default" : {
1324 "description" : "successful operation"
1325 }
1326 }
1327 }
1328 },
1329 "/v1.0/vendor-software-products/{vspId}/components" : {
1330 "get" : {
1331 "tags" : [ "Vendor Software Product Components" ],
1332 "summary" : "List vendor software product components",
1333 "description" : "",
1334 "operationId" : "list",
1335 "consumes" : [ "application/json" ],
1336 "produces" : [ "application/json" ],
1337 "parameters" : [ {
1338 "name" : "vspId",
1339 "in" : "path",
1340 "description" : "Vendor software product Id",
1341 "required" : true,
1342 "type" : "string"
1343 }, {
1344 "name" : "version",
1345 "in" : "query",
1346 "required" : false,
1347 "type" : "string"
1348 }, {
1349 "name" : "USER_ID",
1350 "in" : "header",
1351 "required" : false,
1352 "type" : "string",
1353 "default" : ""
1354 } ],
1355 "responses" : {
1356 "200" : {
1357 "description" : "successful operation",
1358 "schema" : {
1359 "type" : "array",
1360 "items" : {
1361 "$ref" : "#/definitions/ComponentDto"
1362 }
1363 }
1364 }
1365 }
1366 },
1367 "post" : {
1368 "tags" : [ "Vendor Software Product Components" ],
1369 "summary" : "Create a vendor software product component",
1370 "description" : "",
1371 "operationId" : "create",
1372 "consumes" : [ "application/json" ],
1373 "produces" : [ "application/json" ],
1374 "parameters" : [ {
1375 "in" : "body",
1376 "name" : "body",
1377 "required" : false,
1378 "schema" : {
1379 "$ref" : "#/definitions/ComponentRequestDto"
1380 }
1381 }, {
1382 "name" : "vspId",
1383 "in" : "path",
1384 "description" : "Vendor software product Id",
1385 "required" : true,
1386 "type" : "string"
1387 }, {
1388 "name" : "USER_ID",
1389 "in" : "header",
1390 "required" : false,
1391 "type" : "string",
1392 "default" : ""
1393 } ],
1394 "responses" : {
1395 "default" : {
1396 "description" : "successful operation"
1397 }
1398 }
1399 },
1400 "delete" : {
1401 "tags" : [ "Vendor Software Product Components" ],
1402 "summary" : "Delete vendor software product components",
1403 "description" : "",
1404 "operationId" : "deleteList",
1405 "consumes" : [ "application/json" ],
1406 "produces" : [ "application/json" ],
1407 "parameters" : [ {
1408 "name" : "vspId",
1409 "in" : "path",
1410 "description" : "Vendor software product Id",
1411 "required" : true,
1412 "type" : "string"
1413 }, {
1414 "name" : "USER_ID",
1415 "in" : "header",
1416 "required" : false,
1417 "type" : "string",
1418 "default" : ""
1419 } ],
1420 "responses" : {
1421 "default" : {
1422 "description" : "successful operation"
1423 }
1424 }
1425 }
1426 },
1427 "/v1.0/vendor-software-products/{vspId}/components/{componentId}" : {
1428 "get" : {
1429 "tags" : [ "Vendor Software Product Components" ],
1430 "summary" : "Get vendor software product component",
1431 "description" : "",
1432 "operationId" : "get",
1433 "consumes" : [ "application/json" ],
1434 "produces" : [ "application/json" ],
1435 "parameters" : [ {
1436 "name" : "vspId",
1437 "in" : "path",
1438 "description" : "Vendor software product Id",
1439 "required" : true,
1440 "type" : "string"
1441 }, {
1442 "name" : "componentId",
1443 "in" : "path",
1444 "description" : "Vendor software product component Id",
1445 "required" : true,
1446 "type" : "string"
1447 }, {
1448 "name" : "version",
1449 "in" : "query",
1450 "required" : false,
1451 "type" : "string"
1452 }, {
1453 "name" : "USER_ID",
1454 "in" : "header",
1455 "required" : false,
1456 "type" : "string",
1457 "default" : ""
1458 } ],
1459 "responses" : {
1460 "200" : {
1461 "description" : "successful operation",
1462 "schema" : {
1463 "$ref" : "#/definitions/ComponentData"
1464 }
1465 }
1466 }
1467 },
1468 "put" : {
1469 "tags" : [ "Vendor Software Product Components" ],
1470 "summary" : "Update vendor software product component",
1471 "description" : "",
1472 "operationId" : "update",
1473 "consumes" : [ "application/json" ],
1474 "produces" : [ "application/json" ],
1475 "parameters" : [ {
1476 "in" : "body",
1477 "name" : "body",
1478 "required" : false,
1479 "schema" : {
1480 "$ref" : "#/definitions/ComponentRequestDto"
1481 }
1482 }, {
1483 "name" : "vspId",
1484 "in" : "path",
1485 "description" : "Vendor software product Id",
1486 "required" : true,
1487 "type" : "string"
1488 }, {
1489 "name" : "componentId",
1490 "in" : "path",
1491 "description" : "Vendor software product component Id",
1492 "required" : true,
1493 "type" : "string"
1494 }, {
1495 "name" : "USER_ID",
1496 "in" : "header",
1497 "required" : false,
1498 "type" : "string",
1499 "default" : ""
1500 } ],
1501 "responses" : {
1502 "default" : {
1503 "description" : "successful operation"
1504 }
1505 }
1506 },
1507 "delete" : {
1508 "tags" : [ "Vendor Software Product Components" ],
1509 "summary" : "Delete vendor software product component",
1510 "description" : "",
1511 "operationId" : "delete",
1512 "consumes" : [ "application/json" ],
1513 "produces" : [ "application/json" ],
1514 "parameters" : [ {
1515 "name" : "vspId",
1516 "in" : "path",
1517 "description" : "Vendor software product Id",
1518 "required" : true,
1519 "type" : "string"
1520 }, {
1521 "name" : "componentId",
1522 "in" : "path",
1523 "description" : "Vendor software product component Id",
1524 "required" : true,
1525 "type" : "string"
1526 }, {
1527 "name" : "USER_ID",
1528 "in" : "header",
1529 "required" : false,
1530 "type" : "string",
1531 "default" : ""
1532 } ],
1533 "responses" : {
1534 "default" : {
1535 "description" : "successful operation"
1536 }
1537 }
1538 }
1539 },
1540 "/v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp" : {
1541 "get" : {
1542 "tags" : [ "Vendor Software Product Component MIB Uploads" ],
1543 "summary" : "Get the filenames of uploaded MIB definitions",
1544 "description" : "",
1545 "operationId" : "list",
1546 "consumes" : [ "application/json" ],
1547 "produces" : [ "application/json" ],
1548 "parameters" : [ {
1549 "name" : "vspId",
1550 "in" : "path",
1551 "description" : "Vendor software product Id",
1552 "required" : true,
1553 "type" : "string"
1554 }, {
1555 "name" : "componentId",
1556 "in" : "path",
1557 "description" : "Vendor software product component Id",
1558 "required" : true,
1559 "type" : "string"
1560 }, {
1561 "name" : "USER_ID",
1562 "in" : "header",
1563 "required" : false,
1564 "type" : "string",
1565 "default" : ""
1566 } ],
1567 "responses" : {
1568 "200" : {
1569 "description" : "successful operation",
1570 "schema" : {
1571 "$ref" : "#/definitions/MibUploadStatusDto"
1572 }
1573 }
1574 }
1575 },
1576 "delete" : {
1577 "tags" : [ "Vendor Software Product Component MIB Uploads" ],
1578 "summary" : "Delete vendor software product MIB Poll Definitions file",
1579 "description" : "",
1580 "operationId" : "deletePollMibFile",
1581 "consumes" : [ "application/json" ],
1582 "produces" : [ "application/json" ],
1583 "parameters" : [ {
1584 "name" : "vspId",
1585 "in" : "path",
1586 "description" : "Vendor software product Id",
1587 "required" : true,
1588 "type" : "string"
1589 }, {
1590 "name" : "componentId",
1591 "in" : "path",
1592 "description" : "Vendor software product component Id",
1593 "required" : true,
1594 "type" : "string"
1595 }, {
1596 "name" : "USER_ID",
1597 "in" : "header",
1598 "required" : false,
1599 "type" : "string",
1600 "default" : ""
1601 } ],
1602 "responses" : {
1603 "default" : {
1604 "description" : "successful operation"
1605 }
1606 }
1607 }
1608 },
1609 "/v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp-trap" : {
1610 "delete" : {
1611 "tags" : [ "Vendor Software Product Component MIB Uploads" ],
1612 "summary" : "Delete vendor software product MIB Trap Definitions file",
1613 "description" : "",
1614 "operationId" : "deleteTrapMibFile",
1615 "consumes" : [ "application/json" ],
1616 "produces" : [ "application/json" ],
1617 "parameters" : [ {
1618 "name" : "vspId",
1619 "in" : "path",
1620 "description" : "Vendor software product Id",
1621 "required" : true,
1622 "type" : "string"
1623 }, {
1624 "name" : "componentId",
1625 "in" : "path",
1626 "description" : "Vendor software product component Id",
1627 "required" : true,
1628 "type" : "string"
1629 }, {
1630 "name" : "USER_ID",
1631 "in" : "header",
1632 "required" : false,
1633 "type" : "string",
1634 "default" : ""
1635 } ],
1636 "responses" : {
1637 "default" : {
1638 "description" : "successful operation"
1639 }
1640 }
1641 }
1642 },
1643 "/v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp-trap/upload" : {
1644 "post" : {
1645 "tags" : [ "Vendor Software Product Component MIB Uploads" ],
1646 "summary" : "Upload vendor software product MIB Trap Definitions file",
1647 "description" : "",
1648 "operationId" : "uploadTrapMibFile",
1649 "consumes" : [ "multipart/form-data" ],
1650 "produces" : [ "application/json" ],
1651 "parameters" : [ {
1652 "in" : "body",
1653 "name" : "body",
1654 "required" : false,
1655 "schema" : {
1656 "$ref" : "#/definitions/Attachment"
1657 }
1658 }, {
1659 "name" : "vspId",
1660 "in" : "path",
1661 "description" : "Vendor software product Id",
1662 "required" : true,
1663 "type" : "string"
1664 }, {
1665 "name" : "componentId",
1666 "in" : "path",
1667 "description" : "Vendor software product component Id",
1668 "required" : true,
1669 "type" : "string"
1670 }, {
1671 "name" : "USER_ID",
1672 "in" : "header",
1673 "required" : false,
1674 "type" : "string",
1675 "default" : ""
1676 } ],
1677 "responses" : {
1678 "default" : {
1679 "description" : "successful operation"
1680 }
1681 }
1682 }
1683 },
1684 "/v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp/upload" : {
1685 "post" : {
1686 "tags" : [ "Vendor Software Product Component MIB Uploads" ],
1687 "summary" : "Upload vendor software product MIB Poll Definitions file",
1688 "description" : "",
1689 "operationId" : "uploadPollMibFile",
1690 "consumes" : [ "multipart/form-data" ],
1691 "produces" : [ "application/json" ],
1692 "parameters" : [ {
1693 "in" : "body",
1694 "name" : "body",
1695 "required" : false,
1696 "schema" : {
1697 "$ref" : "#/definitions/Attachment"
1698 }
1699 }, {
1700 "name" : "vspId",
1701 "in" : "path",
1702 "description" : "Vendor software product Id",
1703 "required" : true,
1704 "type" : "string"
1705 }, {
1706 "name" : "componentId",
1707 "in" : "path",
1708 "description" : "Vendor software product component Id",
1709 "required" : true,
1710 "type" : "string"
1711 }, {
1712 "name" : "USER_ID",
1713 "in" : "header",
1714 "required" : false,
1715 "type" : "string",
1716 "default" : ""
1717 } ],
1718 "responses" : {
1719 "default" : {
1720 "description" : "successful operation"
1721 }
1722 }
1723 }
1724 },
1725 "/v1.0/vendor-software-products/{vspId}/components/{componentId}/nics" : {
1726 "get" : {
1727 "tags" : [ "Vendor Software Product Component NICs" ],
1728 "summary" : "List vendor software product component NICs",
1729 "description" : "",
1730 "operationId" : "list",
1731 "consumes" : [ "application/json" ],
1732 "produces" : [ "application/json" ],
1733 "parameters" : [ {
1734 "name" : "vspId",
1735 "in" : "path",
1736 "description" : "Vendor software product Id",
1737 "required" : true,
1738 "type" : "string"
1739 }, {
1740 "name" : "componentId",
1741 "in" : "path",
1742 "description" : "Vendor software product component Id",
1743 "required" : true,
1744 "type" : "string"
1745 }, {
1746 "name" : "version",
1747 "in" : "query",
1748 "required" : false,
1749 "type" : "string"
1750 }, {
1751 "name" : "USER_ID",
1752 "in" : "header",
1753 "required" : false,
1754 "type" : "string",
1755 "default" : ""
1756 } ],
1757 "responses" : {
1758 "200" : {
1759 "description" : "successful operation",
1760 "schema" : {
1761 "type" : "array",
1762 "items" : {
1763 "$ref" : "#/definitions/NicDto"
1764 }
1765 }
1766 }
1767 }
1768 },
1769 "post" : {
1770 "tags" : [ "Vendor Software Product Component NICs" ],
1771 "summary" : "Create a vendor software product NIC",
1772 "description" : "",
1773 "operationId" : "create",
1774 "consumes" : [ "application/json" ],
1775 "produces" : [ "application/json" ],
1776 "parameters" : [ {
1777 "in" : "body",
1778 "name" : "body",
1779 "required" : false,
1780 "schema" : {
1781 "$ref" : "#/definitions/NicRequestDto"
1782 }
1783 }, {
1784 "name" : "vspId",
1785 "in" : "path",
1786 "description" : "Vendor software product Id",
1787 "required" : true,
1788 "type" : "string"
1789 }, {
1790 "name" : "componentId",
1791 "in" : "path",
1792 "description" : "Vendor software product component Id",
1793 "required" : true,
1794 "type" : "string"
1795 }, {
1796 "name" : "USER_ID",
1797 "in" : "header",
1798 "required" : false,
1799 "type" : "string",
1800 "default" : ""
1801 } ],
1802 "responses" : {
1803 "default" : {
1804 "description" : "successful operation"
1805 }
1806 }
1807 }
1808 },
1809 "/v1.0/vendor-software-products/{vspId}/components/{componentId}/nics/{nicId}" : {
1810 "get" : {
1811 "tags" : [ "Vendor Software Product Component NICs" ],
1812 "summary" : "Get vendor software product NIC",
1813 "description" : "",
1814 "operationId" : "get",
1815 "consumes" : [ "application/json" ],
1816 "produces" : [ "application/json" ],
1817 "parameters" : [ {
1818 "name" : "vspId",
1819 "in" : "path",
1820 "description" : "Vendor software product Id",
1821 "required" : true,
1822 "type" : "string"
1823 }, {
1824 "name" : "componentId",
1825 "in" : "path",
1826 "description" : "Vendor software product component Id",
1827 "required" : true,
1828 "type" : "string"
1829 }, {
1830 "name" : "nicId",
1831 "in" : "path",
1832 "description" : "Vendor software product NIC Id",
1833 "required" : true,
1834 "type" : "string"
1835 }, {
1836 "name" : "version",
1837 "in" : "query",
1838 "required" : false,
1839 "type" : "string"
1840 }, {
1841 "name" : "USER_ID",
1842 "in" : "header",
1843 "required" : false,
1844 "type" : "string",
1845 "default" : ""
1846 } ],
1847 "responses" : {
1848 "200" : {
1849 "description" : "successful operation",
1850 "schema" : {
1851 "$ref" : "#/definitions/NicDto"
1852 }
1853 }
1854 }
1855 },
1856 "put" : {
1857 "tags" : [ "Vendor Software Product Component NICs" ],
1858 "summary" : "Update vendor software product NIC",
1859 "description" : "",
1860 "operationId" : "update",
1861 "consumes" : [ "application/json" ],
1862 "produces" : [ "application/json" ],
1863 "parameters" : [ {
1864 "in" : "body",
1865 "name" : "body",
1866 "required" : false,
1867 "schema" : {
1868 "$ref" : "#/definitions/NicRequestDto"
1869 }
1870 }, {
1871 "name" : "vspId",
1872 "in" : "path",
1873 "description" : "Vendor software product Id",
1874 "required" : true,
1875 "type" : "string"
1876 }, {
1877 "name" : "componentId",
1878 "in" : "path",
1879 "description" : "Vendor software product component Id",
1880 "required" : true,
1881 "type" : "string"
1882 }, {
1883 "name" : "nicId",
1884 "in" : "path",
1885 "description" : "Vendor software product NIC Id",
1886 "required" : true,
1887 "type" : "string"
1888 }, {
1889 "name" : "USER_ID",
1890 "in" : "header",
1891 "required" : false,
1892 "type" : "string",
1893 "default" : ""
1894 } ],
1895 "responses" : {
1896 "default" : {
1897 "description" : "successful operation"
1898 }
1899 }
1900 },
1901 "delete" : {
1902 "tags" : [ "Vendor Software Product Component NICs" ],
1903 "summary" : "Delete vendor software product NIC",
1904 "description" : "",
1905 "operationId" : "delete",
1906 "consumes" : [ "application/json" ],
1907 "produces" : [ "application/json" ],
1908 "parameters" : [ {
1909 "name" : "vspId",
1910 "in" : "path",
1911 "description" : "Vendor software product Id",
1912 "required" : true,
1913 "type" : "string"
1914 }, {
1915 "name" : "componentId",
1916 "in" : "path",
1917 "description" : "Vendor software product component Id",
1918 "required" : true,
1919 "type" : "string"
1920 }, {
1921 "name" : "nicId",
1922 "in" : "path",
1923 "description" : "Vendor software product NIC Id",
1924 "required" : true,
1925 "type" : "string"
1926 }, {
1927 "name" : "USER_ID",
1928 "in" : "header",
1929 "required" : false,
1930 "type" : "string",
1931 "default" : ""
1932 } ],
1933 "responses" : {
1934 "default" : {
1935 "description" : "successful operation"
1936 }
1937 }
1938 }
1939 },
1940 "/v1.0/vendor-software-products/{vspId}/components/{componentId}/nics/{nicId}/questionnaire" : {
1941 "get" : {
1942 "tags" : [ "Vendor Software Product Component NICs" ],
1943 "summary" : "Get vendor software product component NIC questionnaire",
1944 "description" : "",
1945 "operationId" : "getQuestionnaire",
1946 "consumes" : [ "application/json" ],
1947 "produces" : [ "application/json" ],
1948 "parameters" : [ {
1949 "name" : "vspId",
1950 "in" : "path",
1951 "description" : "Vendor software product Id",
1952 "required" : true,
1953 "type" : "string"
1954 }, {
1955 "name" : "componentId",
1956 "in" : "path",
1957 "description" : "Vendor software product component Id",
1958 "required" : true,
1959 "type" : "string"
1960 }, {
1961 "name" : "nicId",
1962 "in" : "path",
1963 "description" : "Vendor software product NIC Id",
1964 "required" : true,
1965 "type" : "string"
1966 }, {
1967 "name" : "version",
1968 "in" : "query",
1969 "required" : false,
1970 "type" : "string"
1971 }, {
1972 "name" : "USER_ID",
1973 "in" : "header",
1974 "required" : false,
1975 "type" : "string",
1976 "default" : ""
1977 } ],
1978 "responses" : {
1979 "200" : {
1980 "description" : "successful operation",
1981 "schema" : {
1982 "$ref" : "#/definitions/QuestionnaireResponseDto"
1983 }
1984 }
1985 }
1986 },
1987 "put" : {
1988 "tags" : [ "Vendor Software Product Component NICs" ],
1989 "summary" : "Update vendor software product component NIC questionnaire",
1990 "description" : "",
1991 "operationId" : "updateQuestionnaire",
1992 "consumes" : [ "application/json" ],
1993 "produces" : [ "application/json" ],
1994 "parameters" : [ {
1995 "in" : "body",
1996 "name" : "body",
1997 "required" : false,
1998 "schema" : {
1999 "type" : "string"
2000 }
2001 }, {
2002 "name" : "vspId",
2003 "in" : "path",
2004 "description" : "Vendor software product Id",
2005 "required" : true,
2006 "type" : "string"
2007 }, {
2008 "name" : "componentId",
2009 "in" : "path",
2010 "description" : "Vendor software product component Id",
2011 "required" : true,
2012 "type" : "string"
2013 }, {
2014 "name" : "nicId",
2015 "in" : "path",
2016 "description" : "Vendor software product NIC Id",
2017 "required" : true,
2018 "type" : "string"
2019 }, {
2020 "name" : "USER_ID",
2021 "in" : "header",
2022 "required" : false,
2023 "type" : "string",
2024 "default" : ""
2025 } ],
2026 "responses" : {
2027 "default" : {
2028 "description" : "successful operation"
2029 }
2030 }
2031 }
2032 },
2033 "/v1.0/vendor-software-products/{vspId}/components/{componentId}/processes" : {
2034 "get" : {
2035 "tags" : [ "Vendor Software Product Component Processes" ],
2036 "summary" : "List vendor software product component processes",
2037 "description" : "",
2038 "operationId" : "list",
2039 "consumes" : [ "application/json" ],
2040 "produces" : [ "application/json" ],
2041 "parameters" : [ {
2042 "name" : "vspId",
2043 "in" : "path",
2044 "description" : "Vendor software product Id",
2045 "required" : true,
2046 "type" : "string"
2047 }, {
2048 "name" : "componentId",
2049 "in" : "path",
2050 "description" : "Vendor software product component Id",
2051 "required" : true,
2052 "type" : "string"
2053 }, {
2054 "name" : "version",
2055 "in" : "query",
2056 "required" : false,
2057 "type" : "string"
2058 }, {
2059 "name" : "USER_ID",
2060 "in" : "header",
2061 "required" : false,
2062 "type" : "string",
2063 "default" : ""
2064 } ],
2065 "responses" : {
2066 "200" : {
2067 "description" : "successful operation",
2068 "schema" : {
2069 "type" : "array",
2070 "items" : {
2071 "$ref" : "#/definitions/ProcessEntityDto"
2072 }
2073 }
2074 }
2075 }
2076 },
2077 "post" : {
2078 "tags" : [ "Vendor Software Product Component Processes" ],
2079 "summary" : "Create a vendor software product process",
2080 "description" : "",
2081 "operationId" : "create",
2082 "consumes" : [ "application/json" ],
2083 "produces" : [ "application/json" ],
2084 "parameters" : [ {
2085 "in" : "body",
2086 "name" : "body",
2087 "required" : false,
2088 "schema" : {
2089 "$ref" : "#/definitions/ProcessRequestDto"
2090 }
2091 }, {
2092 "name" : "vspId",
2093 "in" : "path",
2094 "description" : "Vendor software product Id",
2095 "required" : true,
2096 "type" : "string"
2097 }, {
2098 "name" : "componentId",
2099 "in" : "path",
2100 "description" : "Vendor software product component Id",
2101 "required" : true,
2102 "type" : "string"
2103 }, {
2104 "name" : "USER_ID",
2105 "in" : "header",
2106 "required" : false,
2107 "type" : "string",
2108 "default" : ""
2109 } ],
2110 "responses" : {
2111 "default" : {
2112 "description" : "successful operation"
2113 }
2114 }
2115 },
2116 "delete" : {
2117 "tags" : [ "Vendor Software Product Component Processes" ],
2118 "summary" : "Delete vendor software product processes",
2119 "description" : "",
2120 "operationId" : "deleteList",
2121 "consumes" : [ "application/json" ],
2122 "produces" : [ "application/json" ],
2123 "parameters" : [ {
2124 "name" : "vspId",
2125 "in" : "path",
2126 "description" : "Vendor software product Id",
2127 "required" : true,
2128 "type" : "string"
2129 }, {
2130 "name" : "componentId",
2131 "in" : "path",
2132 "description" : "Vendor software product component Id",
2133 "required" : true,
2134 "type" : "string"
2135 }, {
2136 "name" : "USER_ID",
2137 "in" : "header",
2138 "required" : false,
2139 "type" : "string",
2140 "default" : ""
2141 } ],
2142 "responses" : {
2143 "default" : {
2144 "description" : "successful operation"
2145 }
2146 }
2147 }
2148 },
2149 "/v1.0/vendor-software-products/{vspId}/components/{componentId}/processes/{processId}" : {
2150 "get" : {
2151 "tags" : [ "Vendor Software Product Component Processes" ],
2152 "summary" : "Get vendor software product process",
2153 "description" : "",
2154 "operationId" : "get",
2155 "consumes" : [ "application/json" ],
2156 "produces" : [ "application/json" ],
2157 "parameters" : [ {
2158 "name" : "vspId",
2159 "in" : "path",
2160 "description" : "Vendor software product Id",
2161 "required" : true,
2162 "type" : "string"
2163 }, {
2164 "name" : "componentId",
2165 "in" : "path",
2166 "description" : "Vendor software product component Id",
2167 "required" : true,
2168 "type" : "string"
2169 }, {
2170 "name" : "processId",
2171 "in" : "path",
2172 "description" : "Vendor software product process Id",
2173 "required" : true,
2174 "type" : "string"
2175 }, {
2176 "name" : "version",
2177 "in" : "query",
2178 "required" : false,
2179 "type" : "string"
2180 }, {
2181 "name" : "USER_ID",
2182 "in" : "header",
2183 "required" : false,
2184 "type" : "string",
2185 "default" : ""
2186 } ],
2187 "responses" : {
2188 "200" : {
2189 "description" : "successful operation",
2190 "schema" : {
2191 "$ref" : "#/definitions/ProcessEntityDto"
2192 }
2193 }
2194 }
2195 },
2196 "put" : {
2197 "tags" : [ "Vendor Software Product Component Processes" ],
2198 "summary" : "Update vendor software product process",
2199 "description" : "",
2200 "operationId" : "update",
2201 "consumes" : [ "application/json" ],
2202 "produces" : [ "application/json" ],
2203 "parameters" : [ {
2204 "in" : "body",
2205 "name" : "body",
2206 "required" : false,
2207 "schema" : {
2208 "$ref" : "#/definitions/ProcessRequestDto"
2209 }
2210 }, {
2211 "name" : "vspId",
2212 "in" : "path",
2213 "description" : "Vendor software product Id",
2214 "required" : true,
2215 "type" : "string"
2216 }, {
2217 "name" : "componentId",
2218 "in" : "path",
2219 "description" : "Vendor software product component Id",
2220 "required" : true,
2221 "type" : "string"
2222 }, {
2223 "name" : "processId",
2224 "in" : "path",
2225 "description" : "Vendor software product process Id",
2226 "required" : true,
2227 "type" : "string"
2228 }, {
2229 "name" : "USER_ID",
2230 "in" : "header",
2231 "required" : false,
2232 "type" : "string",
2233 "default" : ""
2234 } ],
2235 "responses" : {
2236 "default" : {
2237 "description" : "successful operation"
2238 }
2239 }
2240 },
2241 "delete" : {
2242 "tags" : [ "Vendor Software Product Component Processes" ],
2243 "summary" : "Delete vendor software product process",
2244 "description" : "",
2245 "operationId" : "delete",
2246 "consumes" : [ "application/json" ],
2247 "produces" : [ "application/json" ],
2248 "parameters" : [ {
2249 "name" : "vspId",
2250 "in" : "path",
2251 "description" : "Vendor software product Id",
2252 "required" : true,
2253 "type" : "string"
2254 }, {
2255 "name" : "componentId",
2256 "in" : "path",
2257 "description" : "Vendor software product component Id",
2258 "required" : true,
2259 "type" : "string"
2260 }, {
2261 "name" : "processId",
2262 "in" : "path",
2263 "description" : "Vendor software product process Id",
2264 "required" : true,
2265 "type" : "string"
2266 }, {
2267 "name" : "USER_ID",
2268 "in" : "header",
2269 "required" : false,
2270 "type" : "string",
2271 "default" : ""
2272 } ],
2273 "responses" : {
2274 "default" : {
2275 "description" : "successful operation"
2276 }
2277 }
2278 }
2279 },
2280 "/v1.0/vendor-software-products/{vspId}/components/{componentId}/processes/{processId}/upload" : {
2281 "get" : {
2282 "tags" : [ "Vendor Software Product Component Processes" ],
2283 "summary" : "Get vendor software product process uploaded file",
2284 "description" : "",
2285 "operationId" : "getUploadedFile",
2286 "consumes" : [ "application/json" ],
2287 "produces" : [ "application/octet-stream" ],
2288 "parameters" : [ {
2289 "name" : "vspId",
2290 "in" : "path",
2291 "description" : "Vendor software product Id",
2292 "required" : true,
2293 "type" : "string"
2294 }, {
2295 "name" : "componentId",
2296 "in" : "path",
2297 "description" : "Vendor software product component Id",
2298 "required" : true,
2299 "type" : "string"
2300 }, {
2301 "name" : "processId",
2302 "in" : "path",
2303 "description" : "Vendor software product process Id",
2304 "required" : true,
2305 "type" : "string"
2306 }, {
2307 "name" : "version",
2308 "in" : "query",
2309 "required" : false,
2310 "type" : "string"
2311 }, {
2312 "name" : "USER_ID",
2313 "in" : "header",
2314 "required" : false,
2315 "type" : "string",
2316 "default" : ""
2317 } ],
2318 "responses" : {
2319 "default" : {
2320 "description" : "successful operation"
2321 }
2322 }
2323 },
2324 "post" : {
2325 "tags" : [ "Vendor Software Product Component Processes" ],
2326 "summary" : "Update vendor software product process upload",
2327 "description" : "",
2328 "operationId" : "uploadFile",
2329 "consumes" : [ "multipart/form-data" ],
2330 "produces" : [ "application/json" ],
2331 "parameters" : [ {
2332 "in" : "body",
2333 "name" : "body",
2334 "required" : false,
2335 "schema" : {
2336 "$ref" : "#/definitions/Attachment"
2337 }
2338 }, {
2339 "name" : "vspId",
2340 "in" : "path",
2341 "description" : "Vendor software product Id",
2342 "required" : true,
2343 "type" : "string"
2344 }, {
2345 "name" : "componentId",
2346 "in" : "path",
2347 "description" : "Vendor software product component Id",
2348 "required" : true,
2349 "type" : "string"
2350 }, {
2351 "name" : "processId",
2352 "in" : "path",
2353 "description" : "Vendor software product process Id",
2354 "required" : true,
2355 "type" : "string"
2356 }, {
2357 "name" : "USER_ID",
2358 "in" : "header",
2359 "required" : false,
2360 "type" : "string",
2361 "default" : ""
2362 } ],
2363 "responses" : {
2364 "default" : {
2365 "description" : "successful operation"
2366 }
2367 }
2368 },
2369 "delete" : {
2370 "tags" : [ "Vendor Software Product Component Processes" ],
2371 "summary" : "Delete vendor software product process uploaded file",
2372 "description" : "",
2373 "operationId" : "deleteUploadedFile",
2374 "consumes" : [ "application/json" ],
2375 "produces" : [ "application/json" ],
2376 "parameters" : [ {
2377 "name" : "vspId",
2378 "in" : "path",
2379 "description" : "Vendor software product Id",
2380 "required" : true,
2381 "type" : "string"
2382 }, {
2383 "name" : "componentId",
2384 "in" : "path",
2385 "description" : "Vendor software product component Id",
2386 "required" : true,
2387 "type" : "string"
2388 }, {
2389 "name" : "processId",
2390 "in" : "path",
2391 "description" : "Vendor software product process Id",
2392 "required" : true,
2393 "type" : "string"
2394 }, {
2395 "name" : "USER_ID",
2396 "in" : "header",
2397 "required" : false,
2398 "type" : "string",
2399 "default" : ""
2400 } ],
2401 "responses" : {
2402 "default" : {
2403 "description" : "successful operation"
2404 }
2405 }
2406 }
2407 },
2408 "/v1.0/vendor-software-products/{vspId}/components/{componentId}/questionnaire" : {
2409 "get" : {
2410 "tags" : [ "Vendor Software Product Components" ],
2411 "summary" : "Get vendor software product component questionnaire",
2412 "description" : "",
2413 "operationId" : "getQuestionnaire",
2414 "consumes" : [ "application/json" ],
2415 "produces" : [ "application/json" ],
2416 "parameters" : [ {
2417 "name" : "vspId",
2418 "in" : "path",
2419 "description" : "Vendor software product Id",
2420 "required" : true,
2421 "type" : "string"
2422 }, {
2423 "name" : "componentId",
2424 "in" : "path",
2425 "description" : "Vendor software product component Id",
2426 "required" : true,
2427 "type" : "string"
2428 }, {
2429 "name" : "version",
2430 "in" : "query",
2431 "required" : false,
2432 "type" : "string"
2433 }, {
2434 "name" : "USER_ID",
2435 "in" : "header",
2436 "required" : false,
2437 "type" : "string",
2438 "default" : ""
2439 } ],
2440 "responses" : {
2441 "200" : {
2442 "description" : "successful operation",
2443 "schema" : {
2444 "$ref" : "#/definitions/QuestionnaireResponseDto"
2445 }
2446 }
2447 }
2448 },
2449 "put" : {
2450 "tags" : [ "Vendor Software Product Components" ],
2451 "summary" : "Update vendor software product component questionnaire",
2452 "description" : "",
2453 "operationId" : "updateQuestionnaire",
2454 "consumes" : [ "application/json" ],
2455 "produces" : [ "application/json" ],
2456 "parameters" : [ {
2457 "in" : "body",
2458 "name" : "body",
2459 "required" : false,
2460 "schema" : {
2461 "type" : "string"
2462 }
2463 }, {
2464 "name" : "vspId",
2465 "in" : "path",
2466 "description" : "Vendor software product Id",
2467 "required" : true,
2468 "type" : "string"
2469 }, {
2470 "name" : "componentId",
2471 "in" : "path",
2472 "description" : "Vendor software product component Id",
2473 "required" : true,
2474 "type" : "string"
2475 }, {
2476 "name" : "USER_ID",
2477 "in" : "header",
2478 "required" : false,
2479 "type" : "string",
2480 "default" : ""
2481 } ],
2482 "responses" : {
2483 "default" : {
2484 "description" : "successful operation"
2485 }
2486 }
2487 }
2488 },
2489 "/v1.0/vendor-software-products/{vspId}/downloadHeat" : {
2490 "get" : {
2491 "tags" : [ "Vendor Software Products" ],
2492 "summary" : "Get uploaded HEAT file",
2493 "description" : "Downloads the latest HEAT package",
2494 "operationId" : "getLatestHeatPackage",
2495 "consumes" : [ "application/json" ],
2496 "produces" : [ "application/octet-stream" ],
2497 "parameters" : [ {
2498 "name" : "vspId",
2499 "in" : "path",
2500 "required" : true,
2501 "type" : "string"
2502 }, {
2503 "name" : "USER_ID",
2504 "in" : "header",
2505 "required" : false,
2506 "type" : "string",
2507 "default" : ""
2508 } ],
2509 "responses" : {
2510 "200" : {
2511 "description" : "successful operation",
2512 "schema" : {
2513 "$ref" : "#/definitions/File"
2514 }
2515 }
2516 }
2517 }
2518 },
2519 "/v1.0/vendor-software-products/{vspId}/networks" : {
2520 "get" : {
2521 "tags" : [ "Vendor Software Product Networks" ],
2522 "summary" : "List vendor software product networks",
2523 "description" : "",
2524 "operationId" : "list",
2525 "consumes" : [ "application/json" ],
2526 "produces" : [ "application/json" ],
2527 "parameters" : [ {
2528 "name" : "vspId",
2529 "in" : "path",
2530 "description" : "Vendor software product Id",
2531 "required" : true,
2532 "type" : "string"
2533 }, {
2534 "name" : "version",
2535 "in" : "query",
2536 "required" : false,
2537 "type" : "string"
2538 }, {
2539 "name" : "USER_ID",
2540 "in" : "header",
2541 "required" : false,
2542 "type" : "string",
2543 "default" : ""
2544 } ],
2545 "responses" : {
2546 "200" : {
2547 "description" : "successful operation",
2548 "schema" : {
2549 "type" : "array",
2550 "items" : {
2551 "$ref" : "#/definitions/NetworkDto"
2552 }
2553 }
2554 }
2555 }
2556 },
2557 "post" : {
2558 "tags" : [ "Vendor Software Product Networks" ],
2559 "summary" : "Create a vendor software product network",
2560 "description" : "",
2561 "operationId" : "create",
2562 "consumes" : [ "application/json" ],
2563 "produces" : [ "application/json" ],
2564 "parameters" : [ {
2565 "in" : "body",
2566 "name" : "body",
2567 "required" : false,
2568 "schema" : {
2569 "$ref" : "#/definitions/NetworkRequestDto"
2570 }
2571 }, {
2572 "name" : "vspId",
2573 "in" : "path",
2574 "description" : "Vendor software product Id",
2575 "required" : true,
2576 "type" : "string"
2577 }, {
2578 "name" : "USER_ID",
2579 "in" : "header",
2580 "required" : false,
2581 "type" : "string",
2582 "default" : ""
2583 } ],
2584 "responses" : {
2585 "default" : {
2586 "description" : "successful operation"
2587 }
2588 }
2589 }
2590 },
2591 "/v1.0/vendor-software-products/{vspId}/networks/{networkId}" : {
2592 "get" : {
2593 "tags" : [ "Vendor Software Product Networks" ],
2594 "summary" : "Get vendor software product network",
2595 "description" : "",
2596 "operationId" : "get",
2597 "consumes" : [ "application/json" ],
2598 "produces" : [ "application/json" ],
2599 "parameters" : [ {
2600 "name" : "vspId",
2601 "in" : "path",
2602 "description" : "Vendor software product Id",
2603 "required" : true,
2604 "type" : "string"
2605 }, {
2606 "name" : "networkId",
2607 "in" : "path",
2608 "description" : "Vendor software product network Id",
2609 "required" : true,
2610 "type" : "string"
2611 }, {
2612 "name" : "version",
2613 "in" : "query",
2614 "required" : false,
2615 "type" : "string"
2616 }, {
2617 "name" : "USER_ID",
2618 "in" : "header",
2619 "required" : false,
2620 "type" : "string",
2621 "default" : ""
2622 } ],
2623 "responses" : {
2624 "200" : {
2625 "description" : "successful operation",
2626 "schema" : {
2627 "$ref" : "#/definitions/NetworkDto"
2628 }
2629 }
2630 }
2631 },
2632 "put" : {
2633 "tags" : [ "Vendor Software Product Networks" ],
2634 "summary" : "Update vendor software product network",
2635 "description" : "",
2636 "operationId" : "update",
2637 "consumes" : [ "application/json" ],
2638 "produces" : [ "application/json" ],
2639 "parameters" : [ {
2640 "in" : "body",
2641 "name" : "body",
2642 "required" : false,
2643 "schema" : {
2644 "$ref" : "#/definitions/NetworkRequestDto"
2645 }
2646 }, {
2647 "name" : "vspId",
2648 "in" : "path",
2649 "description" : "Vendor software product Id",
2650 "required" : true,
2651 "type" : "string"
2652 }, {
2653 "name" : "networkId",
2654 "in" : "path",
2655 "description" : "Vendor software product network Id",
2656 "required" : true,
2657 "type" : "string"
2658 }, {
2659 "name" : "USER_ID",
2660 "in" : "header",
2661 "required" : false,
2662 "type" : "string",
2663 "default" : ""
2664 } ],
2665 "responses" : {
2666 "default" : {
2667 "description" : "successful operation"
2668 }
2669 }
2670 },
2671 "delete" : {
2672 "tags" : [ "Vendor Software Product Networks" ],
2673 "summary" : "Delete vendor software product network",
2674 "description" : "",
2675 "operationId" : "delete",
2676 "consumes" : [ "application/json" ],
2677 "produces" : [ "application/json" ],
2678 "parameters" : [ {
2679 "name" : "vspId",
2680 "in" : "path",
2681 "description" : "Vendor software product Id",
2682 "required" : true,
2683 "type" : "string"
2684 }, {
2685 "name" : "networkId",
2686 "in" : "path",
2687 "description" : "Vendor software product network Id",
2688 "required" : true,
2689 "type" : "string"
2690 }, {
2691 "name" : "USER_ID",
2692 "in" : "header",
2693 "required" : false,
2694 "type" : "string",
2695 "default" : ""
2696 } ],
2697 "responses" : {
2698 "default" : {
2699 "description" : "successful operation"
2700 }
2701 }
2702 }
2703 },
2704 "/v1.0/vendor-software-products/{vspId}/processes" : {
2705 "get" : {
2706 "tags" : [ "Vendor Software Product Processes" ],
2707 "summary" : "List vendor software product processes",
2708 "description" : "",
2709 "operationId" : "list",
2710 "consumes" : [ "application/json" ],
2711 "produces" : [ "application/json" ],
2712 "parameters" : [ {
2713 "name" : "vspId",
2714 "in" : "path",
2715 "description" : "Vendor software product Id",
2716 "required" : true,
2717 "type" : "string"
2718 }, {
2719 "name" : "version",
2720 "in" : "query",
2721 "required" : false,
2722 "type" : "string"
2723 }, {
2724 "name" : "USER_ID",
2725 "in" : "header",
2726 "required" : false,
2727 "type" : "string",
2728 "default" : ""
2729 } ],
2730 "responses" : {
2731 "200" : {
2732 "description" : "successful operation",
2733 "schema" : {
2734 "type" : "array",
2735 "items" : {
2736 "$ref" : "#/definitions/ProcessEntityDto"
2737 }
2738 }
2739 }
2740 }
2741 },
2742 "post" : {
2743 "tags" : [ "Vendor Software Product Processes" ],
2744 "summary" : "Create a vendor software product process",
2745 "description" : "",
2746 "operationId" : "create",
2747 "consumes" : [ "application/json" ],
2748 "produces" : [ "application/json" ],
2749 "parameters" : [ {
2750 "in" : "body",
2751 "name" : "body",
2752 "required" : false,
2753 "schema" : {
2754 "$ref" : "#/definitions/ProcessRequestDto"
2755 }
2756 }, {
2757 "name" : "vspId",
2758 "in" : "path",
2759 "description" : "Vendor software product Id",
2760 "required" : true,
2761 "type" : "string"
2762 }, {
2763 "name" : "USER_ID",
2764 "in" : "header",
2765 "required" : false,
2766 "type" : "string",
2767 "default" : ""
2768 } ],
2769 "responses" : {
2770 "default" : {
2771 "description" : "successful operation"
2772 }
2773 }
2774 },
2775 "delete" : {
2776 "tags" : [ "Vendor Software Product Processes" ],
2777 "summary" : "Delete vendor software product processes",
2778 "description" : "",
2779 "operationId" : "deleteList",
2780 "consumes" : [ "application/json" ],
2781 "produces" : [ "application/json" ],
2782 "parameters" : [ {
2783 "name" : "vspId",
2784 "in" : "path",
2785 "description" : "Vendor software product Id",
2786 "required" : true,
2787 "type" : "string"
2788 }, {
2789 "name" : "USER_ID",
2790 "in" : "header",
2791 "required" : false,
2792 "type" : "string",
2793 "default" : ""
2794 } ],
2795 "responses" : {
2796 "default" : {
2797 "description" : "successful operation"
2798 }
2799 }
2800 }
2801 },
2802 "/v1.0/vendor-software-products/{vspId}/processes/{processId}" : {
2803 "get" : {
2804 "tags" : [ "Vendor Software Product Processes" ],
2805 "summary" : "Get vendor software product process",
2806 "description" : "",
2807 "operationId" : "get",
2808 "consumes" : [ "application/json" ],
2809 "produces" : [ "application/json" ],
2810 "parameters" : [ {
2811 "name" : "vspId",
2812 "in" : "path",
2813 "description" : "Vendor software product Id",
2814 "required" : true,
2815 "type" : "string"
2816 }, {
2817 "name" : "processId",
2818 "in" : "path",
2819 "description" : "Vendor software product process Id",
2820 "required" : true,
2821 "type" : "string"
2822 }, {
2823 "name" : "version",
2824 "in" : "query",
2825 "required" : false,
2826 "type" : "string"
2827 }, {
2828 "name" : "USER_ID",
2829 "in" : "header",
2830 "required" : false,
2831 "type" : "string",
2832 "default" : ""
2833 } ],
2834 "responses" : {
2835 "200" : {
2836 "description" : "successful operation",
2837 "schema" : {
2838 "$ref" : "#/definitions/ProcessEntityDto"
2839 }
2840 }
2841 }
2842 },
2843 "put" : {
2844 "tags" : [ "Vendor Software Product Processes" ],
2845 "summary" : "Update vendor software product process",
2846 "description" : "",
2847 "operationId" : "update",
2848 "consumes" : [ "application/json" ],
2849 "produces" : [ "application/json" ],
2850 "parameters" : [ {
2851 "in" : "body",
2852 "name" : "body",
2853 "required" : false,
2854 "schema" : {
2855 "$ref" : "#/definitions/ProcessRequestDto"
2856 }
2857 }, {
2858 "name" : "vspId",
2859 "in" : "path",
2860 "description" : "Vendor software product Id",
2861 "required" : true,
2862 "type" : "string"
2863 }, {
2864 "name" : "processId",
2865 "in" : "path",
2866 "description" : "Vendor software product process Id",
2867 "required" : true,
2868 "type" : "string"
2869 }, {
2870 "name" : "USER_ID",
2871 "in" : "header",
2872 "required" : false,
2873 "type" : "string",
2874 "default" : ""
2875 } ],
2876 "responses" : {
2877 "default" : {
2878 "description" : "successful operation"
2879 }
2880 }
2881 },
2882 "delete" : {
2883 "tags" : [ "Vendor Software Product Processes" ],
2884 "summary" : "Delete vendor software product process",
2885 "description" : "",
2886 "operationId" : "delete",
2887 "consumes" : [ "application/json" ],
2888 "produces" : [ "application/json" ],
2889 "parameters" : [ {
2890 "name" : "vspId",
2891 "in" : "path",
2892 "description" : "Vendor software product Id",
2893 "required" : true,
2894 "type" : "string"
2895 }, {
2896 "name" : "processId",
2897 "in" : "path",
2898 "description" : "Vendor software product process Id",
2899 "required" : true,
2900 "type" : "string"
2901 }, {
2902 "name" : "USER_ID",
2903 "in" : "header",
2904 "required" : false,
2905 "type" : "string",
2906 "default" : ""
2907 } ],
2908 "responses" : {
2909 "default" : {
2910 "description" : "successful operation"
2911 }
2912 }
2913 }
2914 },
2915 "/v1.0/vendor-software-products/{vspId}/processes/{processId}/upload" : {
2916 "get" : {
2917 "tags" : [ "Vendor Software Product Processes" ],
2918 "summary" : "Get vendor software product process uploaded file",
2919 "description" : "",
2920 "operationId" : "getUploadedFile",
2921 "consumes" : [ "application/json" ],
2922 "produces" : [ "application/octet-stream" ],
2923 "parameters" : [ {
2924 "name" : "vspId",
2925 "in" : "path",
2926 "description" : "Vendor software product Id",
2927 "required" : true,
2928 "type" : "string"
2929 }, {
2930 "name" : "processId",
2931 "in" : "path",
2932 "description" : "Vendor software product process Id",
2933 "required" : true,
2934 "type" : "string"
2935 }, {
2936 "name" : "version",
2937 "in" : "query",
2938 "required" : false,
2939 "type" : "string"
2940 }, {
2941 "name" : "USER_ID",
2942 "in" : "header",
2943 "required" : false,
2944 "type" : "string",
2945 "default" : ""
2946 } ],
2947 "responses" : {
2948 "default" : {
2949 "description" : "successful operation"
2950 }
2951 }
2952 },
2953 "post" : {
2954 "tags" : [ "Vendor Software Product Processes" ],
2955 "summary" : "Update vendor software product process upload",
2956 "description" : "",
2957 "operationId" : "uploadFile",
2958 "consumes" : [ "multipart/form-data" ],
2959 "produces" : [ "application/json" ],
2960 "parameters" : [ {
2961 "in" : "body",
2962 "name" : "body",
2963 "required" : false,
2964 "schema" : {
2965 "$ref" : "#/definitions/Attachment"
2966 }
2967 }, {
2968 "name" : "vspId",
2969 "in" : "path",
2970 "description" : "Vendor software product Id",
2971 "required" : true,
2972 "type" : "string"
2973 }, {
2974 "name" : "processId",
2975 "in" : "path",
2976 "description" : "Vendor software product process Id",
2977 "required" : true,
2978 "type" : "string"
2979 }, {
2980 "name" : "USER_ID",
2981 "in" : "header",
2982 "required" : false,
2983 "type" : "string",
2984 "default" : ""
2985 } ],
2986 "responses" : {
2987 "default" : {
2988 "description" : "successful operation"
2989 }
2990 }
2991 },
2992 "delete" : {
2993 "tags" : [ "Vendor Software Product Processes" ],
2994 "summary" : "Delete vendor software product process uploaded file",
2995 "description" : "",
2996 "operationId" : "deleteUploadedFile",
2997 "consumes" : [ "application/json" ],
2998 "produces" : [ "application/json" ],
2999 "parameters" : [ {
3000 "name" : "vspId",
3001 "in" : "path",
3002 "description" : "Vendor software product Id",
3003 "required" : true,
3004 "type" : "string"
3005 }, {
3006 "name" : "processId",
3007 "in" : "path",
3008 "description" : "Vendor software product process Id",
3009 "required" : true,
3010 "type" : "string"
3011 }, {
3012 "name" : "USER_ID",
3013 "in" : "header",
3014 "required" : false,
3015 "type" : "string",
3016 "default" : ""
3017 } ],
3018 "responses" : {
3019 "default" : {
3020 "description" : "successful operation"
3021 }
3022 }
3023 }
3024 },
3025 "/v1.0/vendor-software-products/{vspId}/questionnaire" : {
3026 "get" : {
3027 "tags" : [ "Vendor Software Products" ],
3028 "summary" : "Get vendor software product questionnaire",
3029 "description" : "",
3030 "operationId" : "getQuestionnaire",
3031 "consumes" : [ "application/json" ],
3032 "produces" : [ "application/json" ],
3033 "parameters" : [ {
3034 "name" : "vspId",
3035 "in" : "path",
3036 "required" : true,
3037 "type" : "string"
3038 }, {
3039 "name" : "version",
3040 "in" : "query",
3041 "required" : false,
3042 "type" : "string"
3043 }, {
3044 "name" : "USER_ID",
3045 "in" : "header",
3046 "required" : false,
3047 "type" : "string",
3048 "default" : ""
3049 } ],
3050 "responses" : {
3051 "200" : {
3052 "description" : "successful operation",
3053 "schema" : {
3054 "$ref" : "#/definitions/QuestionnaireResponseDto"
3055 }
3056 }
3057 }
3058 },
3059 "put" : {
3060 "tags" : [ "Vendor Software Products" ],
3061 "summary" : "Update vendor software product questionnaire",
3062 "description" : "",
3063 "operationId" : "updateQuestionnaire",
3064 "consumes" : [ "application/json" ],
3065 "produces" : [ "application/json" ],
3066 "parameters" : [ {
3067 "in" : "body",
3068 "name" : "body",
3069 "required" : false,
3070 "schema" : {
3071 "type" : "string"
3072 }
3073 }, {
3074 "name" : "vspId",
3075 "in" : "path",
3076 "required" : true,
3077 "type" : "string"
3078 }, {
3079 "name" : "USER_ID",
3080 "in" : "header",
3081 "required" : false,
3082 "type" : "string",
3083 "default" : ""
3084 } ],
3085 "responses" : {
3086 "default" : {
3087 "description" : "successful operation"
3088 }
3089 }
3090 }
3091 },
3092 "/v1.0/vendor-software-products/{vspId}/upload" : {
3093 "post" : {
3094 "tags" : [ "Vendor Software Products" ],
3095 "summary" : "Uploads a HEAT package to translate",
3096 "description" : "",
3097 "operationId" : "uploadFile",
3098 "consumes" : [ "multipart/form-data" ],
3099 "produces" : [ "application/json" ],
3100 "parameters" : [ {
3101 "name" : "vspId",
3102 "in" : "path",
3103 "required" : true,
3104 "type" : "string"
3105 }, {
3106 "in" : "body",
3107 "name" : "body",
3108 "required" : false,
3109 "schema" : {
3110 "$ref" : "#/definitions/InputStream"
3111 }
3112 }, {
3113 "name" : "USER_ID",
3114 "in" : "header",
3115 "required" : false,
3116 "type" : "string",
3117 "default" : ""
3118 } ],
3119 "responses" : {
3120 "200" : {
3121 "description" : "successful operation",
3122 "schema" : {
3123 "$ref" : "#/definitions/UploadFileResponseDto"
3124 }
3125 }
3126 }
3127 }
3128 },
3129 "/workflow/v1.0/actions" : {
3130 "get" : {
3131 "tags" : [ "Actions" ],
3132 "summary" : "List Filtered Actions ",
3133 "description" : "Get list of actions based on a filter criteria | If no filter is sent all actions will be returned",
3134 "operationId" : "getFilteredActions",
3135 "consumes" : [ "application/json" ],
3136 "produces" : [ "application/json" ],
3137 "parameters" : [ {
3138 "name" : "vendor",
3139 "in" : "query",
3140 "required" : false,
3141 "type" : "string"
3142 }, {
3143 "name" : "category",
3144 "in" : "query",
3145 "required" : false,
3146 "type" : "string"
3147 }, {
3148 "name" : "name",
3149 "in" : "query",
3150 "required" : false,
3151 "type" : "string"
3152 }, {
3153 "name" : "modelId",
3154 "in" : "query",
3155 "required" : false,
3156 "type" : "string"
3157 }, {
3158 "name" : "componentId",
3159 "in" : "query",
3160 "required" : false,
3161 "type" : "string"
3162 } ],
3163 "responses" : {
3164 "default" : {
3165 "description" : "successful operation"
3166 }
3167 }
3168 },
3169 "post" : {
3170 "tags" : [ "Actions" ],
3171 "summary" : "Create a new Action",
3172 "description" : "",
3173 "operationId" : "createAction",
3174 "consumes" : [ "application/json" ],
3175 "produces" : [ "application/json" ],
3176 "parameters" : [ {
3177 "in" : "body",
3178 "name" : "body",
3179 "required" : false,
3180 "schema" : {
3181 "type" : "string"
3182 }
3183 } ],
3184 "responses" : {
3185 "default" : {
3186 "description" : "successful operation"
3187 }
3188 }
3189 }
3190 },
3191 "/workflow/v1.0/actions/components" : {
3192 "get" : {
3193 "tags" : [ "Actions" ],
3194 "summary" : "List ECOMP Components supported by Action Library",
3195 "description" : "",
3196 "operationId" : "getEcompComponents",
3197 "consumes" : [ "application/json" ],
3198 "produces" : [ "application/json" ],
3199 "responses" : {
3200 "default" : {
3201 "description" : "successful operation"
3202 }
3203 }
3204 }
3205 },
3206 "/workflow/v1.0/actions/{actionInvariantUUID}" : {
3207 "get" : {
3208 "tags" : [ "Actions" ],
3209 "summary" : "List Actions For Given Action Invariant UUID",
3210 "description" : "",
3211 "operationId" : "getActionsByActionInvariantUuId",
3212 "consumes" : [ "application/json" ],
3213 "produces" : [ "application/json" ],
3214 "parameters" : [ {
3215 "name" : "actionInvariantUUID",
3216 "in" : "path",
3217 "required" : true,
3218 "type" : "string"
3219 }, {
3220 "name" : "version",
3221 "in" : "query",
3222 "required" : false,
3223 "type" : "string"
3224 } ],
3225 "responses" : {
3226 "default" : {
3227 "description" : "successful operation"
3228 }
3229 }
3230 },
3231 "post" : {
3232 "tags" : [ "Actions" ],
3233 "summary" : "Actions on a action",
3234 "description" : "Performs one of the following actions on a action: |Checkout: Locks it for edits by other users. Only the locking user sees the edited version.|Undo_Checkout: Unlocks it and deletes the edits that were done.|Checkin: Unlocks it and activates the edited version to all users.| Submit: Finalize its active version.|",
3235 "operationId" : "actOnAction",
3236 "consumes" : [ "application/json" ],
3237 "produces" : [ "application/json" ],
3238 "parameters" : [ {
3239 "name" : "actionInvariantUUID",
3240 "in" : "path",
3241 "required" : true,
3242 "type" : "string"
3243 }, {
3244 "in" : "body",
3245 "name" : "body",
3246 "required" : false,
3247 "schema" : {
3248 "type" : "string"
3249 }
3250 } ],
3251 "responses" : {
3252 "default" : {
3253 "description" : "successful operation"
3254 }
3255 }
3256 },
3257 "put" : {
3258 "tags" : [ "Actions" ],
3259 "summary" : "Update an existing action",
3260 "description" : "",
3261 "operationId" : "updateAction",
3262 "consumes" : [ "application/json" ],
3263 "produces" : [ "application/json" ],
3264 "parameters" : [ {
3265 "name" : "actionInvariantUUID",
3266 "in" : "path",
3267 "required" : true,
3268 "type" : "string"
3269 }, {
3270 "in" : "body",
3271 "name" : "body",
3272 "required" : false,
3273 "schema" : {
3274 "type" : "string"
3275 }
3276 } ],
3277 "responses" : {
3278 "default" : {
3279 "description" : "successful operation"
3280 }
3281 }
3282 },
3283 "delete" : {
3284 "tags" : [ "Actions" ],
3285 "summary" : "Delete Action",
3286 "description" : "",
3287 "operationId" : "deleteAction",
3288 "consumes" : [ "application/json" ],
3289 "produces" : [ "application/json" ],
3290 "parameters" : [ {
3291 "name" : "actionInvariantUUID",
3292 "in" : "path",
3293 "required" : true,
3294 "type" : "string"
3295 } ],
3296 "responses" : {
3297 "default" : {
3298 "description" : "successful operation"
3299 }
3300 }
3301 }
3302 },
3303 "/workflow/v1.0/actions/{actionInvariantUUID}/artifacts" : {
3304 "post" : {
3305 "tags" : [ "Actions" ],
3306 "summary" : "Upload new Artifact",
3307 "description" : "",
3308 "operationId" : "uploadArtifact",
3309 "consumes" : [ "multipart/form-data" ],
3310 "produces" : [ "application/json" ],
3311 "parameters" : [ {
3312 "name" : "actionInvariantUUID",
3313 "in" : "path",
3314 "required" : true,
3315 "type" : "string"
3316 }, {
3317 "in" : "body",
3318 "name" : "body",
3319 "required" : false,
3320 "schema" : {
3321 "type" : "string"
3322 }
3323 }, {
3324 "in" : "body",
3325 "name" : "body",
3326 "required" : false,
3327 "schema" : {
3328 "type" : "string"
3329 }
3330 }, {
3331 "in" : "body",
3332 "name" : "body",
3333 "required" : false,
3334 "schema" : {
3335 "type" : "string"
3336 }
3337 }, {
3338 "in" : "body",
3339 "name" : "body",
3340 "required" : false,
3341 "schema" : {
3342 "type" : "string"
3343 }
3344 }, {
3345 "in" : "body",
3346 "name" : "body",
3347 "required" : false,
3348 "schema" : {
3349 "type" : "string"
3350 }
3351 }, {
3352 "name" : "Content-MD5",
3353 "in" : "header",
3354 "required" : false,
3355 "type" : "string",
3356 "default" : ""
3357 }, {
3358 "in" : "body",
3359 "name" : "body",
3360 "required" : false,
3361 "schema" : {
3362 "$ref" : "#/definitions/Attachment"
3363 }
3364 } ],
3365 "responses" : {
3366 "default" : {
3367 "description" : "successful operation"
3368 }
3369 }
3370 }
3371 },
3372 "/workflow/v1.0/actions/{actionInvariantUUID}/artifacts/{artifactUUID}" : {
3373 "put" : {
3374 "tags" : [ "Actions" ],
3375 "summary" : "Update an existing artifact",
3376 "description" : "",
3377 "operationId" : "updateArtifact",
3378 "consumes" : [ "multipart/form-data" ],
3379 "produces" : [ "application/json" ],
3380 "parameters" : [ {
3381 "name" : "actionInvariantUUID",
3382 "in" : "path",
3383 "required" : true,
3384 "type" : "string"
3385 }, {
3386 "name" : "artifactUUID",
3387 "in" : "path",
3388 "required" : true,
3389 "type" : "string"
3390 }, {
3391 "in" : "body",
3392 "name" : "body",
3393 "required" : false,
3394 "schema" : {
3395 "type" : "string"
3396 }
3397 }, {
3398 "in" : "body",
3399 "name" : "body",
3400 "required" : false,
3401 "schema" : {
3402 "type" : "string"
3403 }
3404 }, {
3405 "in" : "body",
3406 "name" : "body",
3407 "required" : false,
3408 "schema" : {
3409 "type" : "string"
3410 }
3411 }, {
3412 "in" : "body",
3413 "name" : "body",
3414 "required" : false,
3415 "schema" : {
3416 "type" : "string"
3417 }
3418 }, {
3419 "in" : "body",
3420 "name" : "body",
3421 "required" : false,
3422 "schema" : {
3423 "type" : "string"
3424 }
3425 }, {
3426 "name" : "Content-MD5",
3427 "in" : "header",
3428 "required" : false,
3429 "type" : "string",
3430 "default" : ""
3431 }, {
3432 "in" : "body",
3433 "name" : "body",
3434 "required" : false,
3435 "schema" : {
3436 "$ref" : "#/definitions/Attachment"
3437 }
3438 } ],
3439 "responses" : {
3440 "default" : {
3441 "description" : "successful operation"
3442 }
3443 }
3444 },
3445 "delete" : {
3446 "tags" : [ "Actions" ],
3447 "summary" : "Delete Artifact",
3448 "description" : "",
3449 "operationId" : "deleteArtifact",
3450 "consumes" : [ "application/json" ],
3451 "produces" : [ "application/json" ],
3452 "parameters" : [ {
3453 "name" : "actionInvariantUUID",
3454 "in" : "path",
3455 "required" : true,
3456 "type" : "string"
3457 }, {
3458 "name" : "artifactUUID",
3459 "in" : "path",
3460 "required" : true,
3461 "type" : "string"
3462 } ],
3463 "responses" : {
3464 "default" : {
3465 "description" : "successful operation"
3466 }
3467 }
3468 }
3469 },
3470 "/workflow/v1.0/actions/{actionUUID}/artifacts/{artifactUUID}" : {
3471 "get" : {
3472 "tags" : [ "Actions" ],
3473 "summary" : "Downloads artifact for action",
3474 "description" : "",
3475 "operationId" : "downloadArtifact",
3476 "consumes" : [ "application/json" ],
3477 "produces" : [ "application/octet-stream" ],
3478 "parameters" : [ {
3479 "name" : "actionUUID",
3480 "in" : "path",
3481 "required" : true,
3482 "type" : "string"
3483 }, {
3484 "name" : "artifactUUID",
3485 "in" : "path",
3486 "required" : true,
3487 "type" : "string"
3488 } ],
3489 "responses" : {
3490 "default" : {
3491 "description" : "successful operation"
3492 }
3493 }
3494 }
3495 }
3496 },
3497 "definitions" : {
3498 "Attachment" : {
3499 "type" : "object",
3500 "properties" : {
3501 "headers" : {
3502 "type" : "object",
3503 "additionalProperties" : {
3504 "type" : "array",
3505 "items" : {
3506 "type" : "string"
3507 }
3508 }
3509 },
3510 "object" : {
3511 "type" : "object"
3512 },
3513 "contentType" : {
3514 "$ref" : "#/definitions/MediaType"
3515 },
Michael Landoefa037d2017-02-19 12:57:33 +0200[diff] [blame]3516 "contentId" : {
3517 "type" : "string"
3518 },
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]3519 "contentDisposition" : {
3520 "$ref" : "#/definitions/ContentDisposition"
3521 },
3522 "dataHandler" : {
3523 "$ref" : "#/definitions/DataHandler"
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]3524 }
3525 }
3526 },
3527 "ChoiceOrOtherDtoAggregationFunction" : {
3528 "type" : "object",
3529 "required" : [ "choice", "other" ],
3530 "properties" : {
3531 "choice" : {
3532 "type" : "string",
3533 "enum" : [ "Peak", "Average", "Other" ]
3534 },
3535 "other" : {
3536 "type" : "string"
3537 }
3538 }
3539 },
3540 "ChoiceOrOtherDtoEntitlementMetric" : {
3541 "type" : "object",
3542 "required" : [ "choice", "other" ],
3543 "properties" : {
3544 "choice" : {
3545 "type" : "string",
3546 "enum" : [ "Software_Instances_Count", "Core", "CPU", "Trunks", "User", "Subscribers", "Tenants", "Tokens", "Seats", "Units_TB", "Units_MB", "Units_GB", "Other" ]
3547 },
3548 "other" : {
3549 "type" : "string"
3550 }
3551 }
3552 },
3553 "ChoiceOrOtherDtoEntitlementTime" : {
3554 "type" : "object",
3555 "required" : [ "choice", "other" ],
3556 "properties" : {
3557 "choice" : {
3558 "type" : "string",
3559 "enum" : [ "Hour", "Day", "Month", "Quarter", "Year", "Other" ]
3560 },
3561 "other" : {
3562 "type" : "string"
3563 }
3564 }
3565 },
3566 "ChoiceOrOtherDtoLicenseTerm" : {
3567 "type" : "object",
3568 "required" : [ "choice", "other" ],
3569 "properties" : {
3570 "choice" : {
3571 "type" : "string",
3572 "enum" : [ "Fixed_Term", "Perpetual", "Unlimited", "Other" ]
3573 },
3574 "other" : {
3575 "type" : "string"
3576 }
3577 }
3578 },
3579 "CommandInfo" : {
3580 "type" : "object",
3581 "properties" : {
3582 "commandClass" : {
3583 "type" : "string"
3584 },
3585 "commandName" : {
3586 "type" : "string"
3587 }
3588 }
3589 },
3590 "ComponentData" : {
3591 "type" : "object",
3592 "properties" : {
3593 "name" : {
3594 "type" : "string"
3595 },
3596 "description" : {
3597 "type" : "string"
3598 },
3599 "displayName" : {
3600 "type" : "string"
3601 }
3602 }
3603 },
3604 "ComponentDto" : {
3605 "type" : "object",
3606 "properties" : {
3607 "name" : {
3608 "type" : "string"
3609 },
3610 "displayName" : {
3611 "type" : "string"
3612 },
3613 "description" : {
3614 "type" : "string"
3615 },
3616 "id" : {
3617 "type" : "string"
3618 }
3619 }
3620 },
3621 "ComponentRequestDto" : {
3622 "type" : "object",
3623 "properties" : {
3624 "name" : {
3625 "type" : "string"
3626 },
3627 "displayName" : {
3628 "type" : "string"
3629 },
3630 "description" : {
3631 "type" : "string"
3632 }
3633 }
3634 },
3635 "ConfigurationDataDto" : {
3636 "type" : "object",
3637 "properties" : {
3638 "value" : {
3639 "type" : "string"
3640 },
3641 "timeStamp" : {
3642 "type" : "integer",
3643 "format" : "int64"
3644 }
3645 }
3646 },
3647 "ContentDisposition" : {
3648 "type" : "object",
3649 "properties" : {
3650 "type" : {
3651 "type" : "string"
3652 },
3653 "parameters" : {
3654 "type" : "object",
3655 "additionalProperties" : {
3656 "type" : "string"
3657 }
3658 },
3659 "filename" : {
3660 "type" : "string"
3661 }
3662 }
3663 },
3664 "DataFlavor" : {
3665 "type" : "object",
3666 "properties" : {
3667 "mimeType" : {
3668 "type" : "string"
3669 },
3670 "humanPresentableName" : {
3671 "type" : "string"
3672 },
3673 "subType" : {
3674 "type" : "string"
3675 },
3676 "defaultRepresentationClassAsString" : {
3677 "type" : "string"
3678 },
3679 "primaryType" : {
3680 "type" : "string"
3681 },
3682 "flavorJavaFileListType" : {
3683 "type" : "boolean",
3684 "default" : false
3685 },
3686 "flavorRemoteObjectType" : {
3687 "type" : "boolean",
3688 "default" : false
3689 },
3690 "flavorSerializedObjectType" : {
3691 "type" : "boolean",
3692 "default" : false
3693 },
3694 "flavorTextType" : {
3695 "type" : "boolean",
3696 "default" : false
3697 },
3698 "mimeTypeSerializedObject" : {
3699 "type" : "boolean",
3700 "default" : false
3701 },
3702 "representationClassByteBuffer" : {
3703 "type" : "boolean",
3704 "default" : false
3705 },
3706 "representationClassCharBuffer" : {
3707 "type" : "boolean",
3708 "default" : false
3709 },
3710 "representationClassInputStream" : {
3711 "type" : "boolean",
3712 "default" : false
3713 },
3714 "representationClassReader" : {
3715 "type" : "boolean",
3716 "default" : false
3717 },
3718 "representationClassRemote" : {
3719 "type" : "boolean",
3720 "default" : false
3721 },
3722 "representationClassSerializable" : {
3723 "type" : "boolean",
3724 "default" : false
3725 }
3726 }
3727 },
3728 "DataHandler" : {
3729 "type" : "object",
3730 "properties" : {
3731 "dataSource" : {
3732 "$ref" : "#/definitions/DataSource"
3733 },
3734 "name" : {
3735 "type" : "string"
3736 },
3737 "inputStream" : {
3738 "$ref" : "#/definitions/InputStream"
3739 },
3740 "content" : {
3741 "type" : "object"
3742 },
3743 "contentType" : {
3744 "type" : "string"
3745 },
3746 "outputStream" : {
3747 "$ref" : "#/definitions/OutputStream"
3748 },
3749 "allCommands" : {
3750 "type" : "array",
3751 "items" : {
3752 "$ref" : "#/definitions/CommandInfo"
3753 }
3754 },
3755 "preferredCommands" : {
3756 "type" : "array",
3757 "items" : {
3758 "$ref" : "#/definitions/CommandInfo"
3759 }
3760 },
3761 "transferDataFlavors" : {
3762 "type" : "array",
3763 "items" : {
3764 "$ref" : "#/definitions/DataFlavor"
3765 }
3766 }
3767 }
3768 },
3769 "DataSource" : {
3770 "type" : "object",
3771 "properties" : {
3772 "name" : {
3773 "type" : "string"
3774 },
3775 "inputStream" : {
3776 "$ref" : "#/definitions/InputStream"
3777 },
3778 "contentType" : {
3779 "type" : "string"
3780 },
3781 "outputStream" : {
3782 "$ref" : "#/definitions/OutputStream"
3783 }
3784 }
3785 },
3786 "EntitlementPoolEntity" : {
3787 "type" : "object",
3788 "required" : [ "aggregationFunction", "description", "entitlementMetric", "manufacturerReferenceNumber", "name", "operationalScope", "thresholdUnits", "thresholdValue", "time" ],
3789 "properties" : {
3790 "name" : {
3791 "type" : "string",
3792 "minLength" : 0,
3793 "maxLength" : 120
3794 },
3795 "description" : {
3796 "type" : "string",
3797 "minLength" : 0,
3798 "maxLength" : 1000
3799 },
3800 "thresholdValue" : {
3801 "type" : "integer",
3802 "format" : "int32"
3803 },
3804 "thresholdUnits" : {
3805 "type" : "string",
3806 "enum" : [ "Absolute", "Percentage" ]
3807 },
3808 "entitlementMetric" : {
3809 "$ref" : "#/definitions/ChoiceOrOtherDtoEntitlementMetric"
3810 },
3811 "increments" : {
3812 "type" : "string",
3813 "minLength" : 0,
3814 "maxLength" : 120
3815 },
3816 "aggregationFunction" : {
3817 "$ref" : "#/definitions/ChoiceOrOtherDtoAggregationFunction"
3818 },
3819 "operationalScope" : {
3820 "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope"
3821 },
3822 "time" : {
3823 "$ref" : "#/definitions/ChoiceOrOtherDtoEntitlementTime"
3824 },
3825 "manufacturerReferenceNumber" : {
3826 "type" : "string",
3827 "minLength" : 0,
3828 "maxLength" : 100
3829 },
3830 "id" : {
3831 "type" : "string"
3832 },
3833 "referencingFeatureGroups" : {
3834 "type" : "array",
3835 "uniqueItems" : true,
3836 "items" : {
3837 "type" : "string"
3838 }
3839 }
3840 }
3841 },
3842 "EntitlementPoolRequest" : {
3843 "type" : "object",
3844 "required" : [ "aggregationFunction", "description", "entitlementMetric", "manufacturerReferenceNumber", "name", "operationalScope", "thresholdUnits", "thresholdValue", "time" ],
3845 "properties" : {
3846 "name" : {
3847 "type" : "string",
3848 "minLength" : 0,
3849 "maxLength" : 120
3850 },
3851 "description" : {
3852 "type" : "string",
3853 "minLength" : 0,
3854 "maxLength" : 1000
3855 },
3856 "thresholdValue" : {
3857 "type" : "integer",
3858 "format" : "int32"
3859 },
3860 "thresholdUnits" : {
3861 "type" : "string",
3862 "enum" : [ "Absolute", "Percentage" ]
3863 },
3864 "entitlementMetric" : {
3865 "$ref" : "#/definitions/ChoiceOrOtherDtoEntitlementMetric"
3866 },
3867 "increments" : {
3868 "type" : "string",
3869 "minLength" : 0,
3870 "maxLength" : 120
3871 },
3872 "aggregationFunction" : {
3873 "$ref" : "#/definitions/ChoiceOrOtherDtoAggregationFunction"
3874 },
3875 "operationalScope" : {
3876 "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope"
3877 },
3878 "time" : {
3879 "$ref" : "#/definitions/ChoiceOrOtherDtoEntitlementTime"
3880 },
3881 "manufacturerReferenceNumber" : {
3882 "type" : "string",
3883 "minLength" : 0,
3884 "maxLength" : 100
3885 }
3886 }
3887 },
3888 "ErrorMessage" : {
3889 "type" : "object",
3890 "properties" : {
3891 "level" : {
3892 "type" : "string",
3893 "enum" : [ "ERROR", "WARNING", "INFO" ]
3894 },
3895 "message" : {
3896 "type" : "string"
3897 }
3898 }
3899 },
3900 "FeatureGroupEntity" : {
3901 "type" : "object",
3902 "required" : [ "description", "name", "partNumber" ],
3903 "properties" : {
3904 "name" : {
3905 "type" : "string",
3906 "minLength" : 0,
3907 "maxLength" : 120
3908 },
3909 "description" : {
3910 "type" : "string",
3911 "minLength" : 0,
3912 "maxLength" : 1000
3913 },
3914 "partNumber" : {
3915 "type" : "string"
3916 },
3917 "id" : {
3918 "type" : "string"
3919 },
3920 "licenseKeyGroupsIds" : {
3921 "type" : "array",
3922 "uniqueItems" : true,
3923 "items" : {
3924 "type" : "string"
3925 }
3926 },
3927 "entitlementPoolsIds" : {
3928 "type" : "array",
3929 "uniqueItems" : true,
3930 "items" : {
3931 "type" : "string"
3932 }
3933 },
3934 "referencingLicenseAgreements" : {
3935 "type" : "array",
3936 "uniqueItems" : true,
3937 "items" : {
3938 "type" : "string"
3939 }
3940 }
3941 }
3942 },
3943 "FeatureGroupModel" : {
3944 "type" : "object",
3945 "required" : [ "description", "name", "partNumber" ],
3946 "properties" : {
3947 "name" : {
3948 "type" : "string",
3949 "minLength" : 0,
3950 "maxLength" : 120
3951 },
3952 "description" : {
3953 "type" : "string",
3954 "minLength" : 0,
3955 "maxLength" : 1000
3956 },
3957 "partNumber" : {
3958 "type" : "string"
3959 },
3960 "id" : {
3961 "type" : "string"
3962 },
3963 "referencingLicenseAgreements" : {
3964 "type" : "array",
3965 "uniqueItems" : true,
3966 "items" : {
3967 "type" : "string"
3968 }
3969 },
3970 "licenseKeyGroups" : {
3971 "type" : "array",
3972 "items" : {
3973 "$ref" : "#/definitions/LicenseKeyGroupEntityDto"
3974 }
3975 },
3976 "entitlementPools" : {
3977 "type" : "array",
3978 "items" : {
3979 "$ref" : "#/definitions/EntitlementPoolEntity"
3980 }
3981 }
3982 }
3983 },
3984 "FeatureGroupRequest" : {
3985 "type" : "object",
3986 "required" : [ "description", "name", "partNumber" ],
3987 "properties" : {
3988 "name" : {
3989 "type" : "string",
3990 "minLength" : 0,
3991 "maxLength" : 120
3992 },
3993 "description" : {
3994 "type" : "string",
3995 "minLength" : 0,
3996 "maxLength" : 1000
3997 },
3998 "partNumber" : {
3999 "type" : "string"
4000 },
4001 "addedLicenseKeyGroupsIds" : {
4002 "type" : "array",
4003 "uniqueItems" : true,
4004 "items" : {
4005 "type" : "string"
4006 }
4007 },
4008 "addedEntitlementPoolsIds" : {
4009 "type" : "array",
4010 "uniqueItems" : true,
4011 "items" : {
4012 "type" : "string"
4013 }
4014 }
4015 }
4016 },
4017 "FeatureGroupUpdateRequest" : {
4018 "type" : "object",
4019 "required" : [ "description", "name", "partNumber" ],
4020 "properties" : {
4021 "name" : {
4022 "type" : "string",
4023 "minLength" : 0,
4024 "maxLength" : 120
4025 },
4026 "description" : {
4027 "type" : "string",
4028 "minLength" : 0,
4029 "maxLength" : 1000
4030 },
4031 "partNumber" : {
4032 "type" : "string"
4033 },
4034 "addedLicenseKeyGroupsIds" : {
4035 "type" : "array",
4036 "uniqueItems" : true,
4037 "items" : {
4038 "type" : "string"
4039 }
4040 },
4041 "addedEntitlementPoolsIds" : {
4042 "type" : "array",
4043 "uniqueItems" : true,
4044 "items" : {
4045 "type" : "string"
4046 }
4047 },
4048 "removedLicenseKeyGroupsIds" : {
4049 "type" : "array",
4050 "uniqueItems" : true,
4051 "items" : {
4052 "type" : "string"
4053 }
4054 },
4055 "removedEntitlementPoolsIds" : {
4056 "type" : "array",
4057 "uniqueItems" : true,
4058 "items" : {
4059 "type" : "string"
4060 }
4061 }
4062 }
4063 },
4064 "File" : {
4065 "type" : "object",
4066 "properties" : {
4067 "path" : {
4068 "type" : "string"
4069 },
4070 "name" : {
4071 "type" : "string"
4072 },
4073 "canonicalPath" : {
4074 "type" : "string"
4075 },
4076 "parent" : {
4077 "type" : "string"
4078 },
4079 "absolute" : {
4080 "type" : "boolean",
4081 "default" : false
4082 },
4083 "absoluteFile" : {
4084 "$ref" : "#/definitions/File"
4085 },
4086 "absolutePath" : {
4087 "type" : "string"
4088 },
4089 "canonicalFile" : {
4090 "$ref" : "#/definitions/File"
4091 },
4092 "freeSpace" : {
4093 "type" : "integer",
4094 "format" : "int64"
4095 },
4096 "parentFile" : {
4097 "$ref" : "#/definitions/File"
4098 },
4099 "totalSpace" : {
4100 "type" : "integer",
4101 "format" : "int64"
4102 },
4103 "usableSpace" : {
4104 "type" : "integer",
4105 "format" : "int64"
4106 },
4107 "directory" : {
4108 "type" : "boolean",
4109 "default" : false
4110 },
4111 "file" : {
4112 "type" : "boolean",
4113 "default" : false
4114 },
4115 "hidden" : {
4116 "type" : "boolean",
4117 "default" : false
4118 }
4119 }
4120 },
4121 "InputStream" : {
4122 "type" : "object"
4123 },
4124 "LicenseAgreementEntity" : {
4125 "type" : "object",
4126 "required" : [ "description", "licenseTerm", "name" ],
4127 "properties" : {
4128 "name" : {
4129 "type" : "string",
4130 "minLength" : 0,
4131 "maxLength" : 120
4132 },
4133 "description" : {
4134 "type" : "string",
4135 "minLength" : 0,
4136 "maxLength" : 1000
4137 },
4138 "licenseTerm" : {
4139 "$ref" : "#/definitions/ChoiceOrOtherDtoLicenseTerm"
4140 },
4141 "requirementsAndConstrains" : {
4142 "type" : "string",
4143 "minLength" : 0,
4144 "maxLength" : 1000
4145 },
4146 "id" : {
4147 "type" : "string"
4148 },
4149 "featureGroupsIds" : {
4150 "type" : "array",
4151 "uniqueItems" : true,
4152 "items" : {
4153 "type" : "string"
4154 }
4155 }
4156 }
4157 },
4158 "LicenseAgreementModel" : {
4159 "type" : "object",
4160 "required" : [ "description", "licenseTerm", "name" ],
4161 "properties" : {
4162 "name" : {
4163 "type" : "string",
4164 "minLength" : 0,
4165 "maxLength" : 120
4166 },
4167 "description" : {
4168 "type" : "string",
4169 "minLength" : 0,
4170 "maxLength" : 1000
4171 },
4172 "licenseTerm" : {
4173 "$ref" : "#/definitions/ChoiceOrOtherDtoLicenseTerm"
4174 },
4175 "requirementsAndConstrains" : {
4176 "type" : "string",
4177 "minLength" : 0,
4178 "maxLength" : 1000
4179 },
4180 "id" : {
4181 "type" : "string"
4182 },
4183 "featureGroups" : {
4184 "type" : "array",
4185 "uniqueItems" : true,
4186 "items" : {
4187 "$ref" : "#/definitions/FeatureGroupEntity"
4188 }
4189 }
4190 }
4191 },
4192 "LicenseAgreementRequest" : {
4193 "type" : "object",
4194 "required" : [ "description", "licenseTerm", "name" ],
4195 "properties" : {
4196 "name" : {
4197 "type" : "string",
4198 "minLength" : 0,
4199 "maxLength" : 120
4200 },
4201 "description" : {
4202 "type" : "string",
4203 "minLength" : 0,
4204 "maxLength" : 1000
4205 },
4206 "licenseTerm" : {
4207 "$ref" : "#/definitions/ChoiceOrOtherDtoLicenseTerm"
4208 },
4209 "requirementsAndConstrains" : {
4210 "type" : "string",
4211 "minLength" : 0,
4212 "maxLength" : 1000
4213 },
4214 "addedFeatureGroupsIds" : {
4215 "type" : "array",
4216 "uniqueItems" : true,
4217 "items" : {
4218 "type" : "string"
4219 }
4220 }
4221 }
4222 },
4223 "LicenseAgreementUpdateRequest" : {
4224 "type" : "object",
4225 "required" : [ "description", "licenseTerm", "name" ],
4226 "properties" : {
4227 "name" : {
4228 "type" : "string",
4229 "minLength" : 0,
4230 "maxLength" : 120
4231 },
4232 "description" : {
4233 "type" : "string",
4234 "minLength" : 0,
4235 "maxLength" : 1000
4236 },
4237 "licenseTerm" : {
4238 "$ref" : "#/definitions/ChoiceOrOtherDtoLicenseTerm"
4239 },
4240 "requirementsAndConstrains" : {
4241 "type" : "string",
4242 "minLength" : 0,
4243 "maxLength" : 1000
4244 },
4245 "addedFeatureGroupsIds" : {
4246 "type" : "array",
4247 "uniqueItems" : true,
4248 "items" : {
4249 "type" : "string"
4250 }
4251 },
4252 "removedFeatureGroupsIds" : {
4253 "type" : "array",
4254 "uniqueItems" : true,
4255 "items" : {
4256 "type" : "string"
4257 }
4258 }
4259 }
4260 },
4261 "LicenseKeyGroupEntityDto" : {
4262 "type" : "object",
4263 "required" : [ "description", "name", "operationalScope", "type" ],
4264 "properties" : {
4265 "name" : {
4266 "type" : "string",
4267 "minLength" : 0,
4268 "maxLength" : 120
4269 },
4270 "description" : {
4271 "type" : "string",
4272 "minLength" : 0,
4273 "maxLength" : 1000
4274 },
4275 "type" : {
4276 "type" : "string",
4277 "enum" : [ "Universal", "Unique", "One_Time" ]
4278 },
4279 "operationalScope" : {
4280 "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope"
4281 },
4282 "id" : {
4283 "type" : "string"
4284 },
4285 "referencingFeatureGroups" : {
4286 "type" : "array",
4287 "uniqueItems" : true,
4288 "items" : {
4289 "type" : "string"
4290 }
4291 }
4292 }
4293 },
4294 "LicenseKeyGroupRequestDto" : {
4295 "type" : "object",
4296 "required" : [ "description", "name", "operationalScope", "type" ],
4297 "properties" : {
4298 "name" : {
4299 "type" : "string",
4300 "minLength" : 0,
4301 "maxLength" : 120
4302 },
4303 "description" : {
4304 "type" : "string",
4305 "minLength" : 0,
4306 "maxLength" : 1000
4307 },
4308 "type" : {
4309 "type" : "string",
4310 "enum" : [ "Universal", "Unique", "One_Time" ]
4311 },
4312 "operationalScope" : {
4313 "$ref" : "#/definitions/MultiChoiceOrOtherDtoOperationalScope"
4314 }
4315 }
4316 },
4317 "LicensingData" : {
4318 "type" : "object",
4319 "properties" : {
4320 "licenseAgreement" : {
4321 "type" : "string"
4322 },
4323 "featureGroups" : {
4324 "type" : "array",
4325 "items" : {
4326 "type" : "string"
4327 }
4328 }
4329 }
4330 },
4331 "MediaType" : {
4332 "type" : "object",
4333 "properties" : {
4334 "type" : {
4335 "type" : "string"
4336 },
4337 "subtype" : {
4338 "type" : "string"
4339 },
4340 "parameters" : {
4341 "type" : "object",
4342 "additionalProperties" : {
4343 "type" : "string"
4344 }
4345 },
Michael Landoefa037d2017-02-19 12:57:33 +0200[diff] [blame]4346 "wildcardType" : {
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]4347 "type" : "boolean",
4348 "default" : false
4349 },
Michael Landoefa037d2017-02-19 12:57:33 +0200[diff] [blame]4350 "wildcardSubtype" : {
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]4351 "type" : "boolean",
4352 "default" : false
4353 }
4354 }
4355 },
4356 "MibUploadStatusDto" : {
4357 "type" : "object",
4358 "properties" : {
4359 "snmpTrap" : {
4360 "type" : "string"
4361 },
4362 "snmpPoll" : {
4363 "type" : "string"
4364 }
4365 }
4366 },
4367 "MultiChoiceOrOtherDtoOperationalScope" : {
4368 "type" : "object",
4369 "required" : [ "choices", "other" ],
4370 "properties" : {
4371 "choices" : {
4372 "type" : "array",
4373 "uniqueItems" : true,
4374 "items" : {
4375 "type" : "string",
4376 "enum" : [ "Network_Wide", "Availability_Zone", "Data_Center", "Tenant", "VM", "CPU", "Core", "Other" ]
4377 }
4378 },
4379 "other" : {
4380 "type" : "string"
4381 }
4382 }
4383 },
4384 "NetworkDto" : {
4385 "type" : "object",
4386 "required" : [ "dhcp", "name" ],
4387 "properties" : {
4388 "name" : {
4389 "type" : "string"
4390 },
4391 "dhcp" : {
4392 "type" : "boolean",
4393 "default" : false
4394 },
4395 "id" : {
4396 "type" : "string"
4397 }
4398 }
4399 },
4400 "NetworkRequestDto" : {
4401 "type" : "object",
4402 "required" : [ "dhcp", "name" ],
4403 "properties" : {
4404 "name" : {
4405 "type" : "string"
4406 },
4407 "dhcp" : {
4408 "type" : "boolean",
4409 "default" : false
4410 }
4411 }
4412 },
4413 "NicDto" : {
4414 "type" : "object",
4415 "properties" : {
4416 "name" : {
4417 "type" : "string"
4418 },
4419 "description" : {
4420 "type" : "string"
4421 },
4422 "networkId" : {
4423 "type" : "string"
4424 },
4425 "id" : {
4426 "type" : "string"
4427 },
4428 "networkName" : {
4429 "type" : "string"
4430 }
4431 }
4432 },
4433 "NicRequestDto" : {
4434 "type" : "object",
4435 "properties" : {
4436 "name" : {
4437 "type" : "string"
4438 },
4439 "description" : {
4440 "type" : "string"
4441 },
4442 "networkId" : {
4443 "type" : "string"
4444 }
4445 }
4446 },
4447 "OutputStream" : {
4448 "type" : "object"
4449 },
4450 "PackageInfoDto" : {
4451 "type" : "object",
4452 "properties" : {
4453 "displayName" : {
4454 "type" : "string"
4455 },
4456 "description" : {
4457 "type" : "string"
4458 },
4459 "vspName" : {
4460 "type" : "string"
4461 },
4462 "version" : {
4463 "type" : "string"
4464 },
4465 "packageId" : {
4466 "type" : "string"
4467 },
4468 "category" : {
4469 "type" : "string"
4470 },
4471 "subCategory" : {
4472 "type" : "string"
4473 },
4474 "vendorName" : {
4475 "type" : "string"
4476 },
4477 "vendorRelease" : {
4478 "type" : "string"
4479 },
4480 "packageChecksum" : {
4481 "type" : "string"
4482 },
4483 "packageType" : {
4484 "type" : "string"
4485 }
4486 }
4487 },
4488 "ProcessEntityDto" : {
4489 "type" : "object",
4490 "required" : [ "name" ],
4491 "properties" : {
4492 "name" : {
4493 "type" : "string"
4494 },
4495 "description" : {
4496 "type" : "string"
4497 },
4498 "id" : {
4499 "type" : "string"
4500 },
4501 "artifactName" : {
4502 "type" : "string"
4503 }
4504 }
4505 },
4506 "ProcessRequestDto" : {
4507 "type" : "object",
4508 "required" : [ "name" ],
4509 "properties" : {
4510 "name" : {
4511 "type" : "string"
4512 },
4513 "description" : {
4514 "type" : "string"
4515 }
4516 }
4517 },
4518 "QuestionnaireResponseDto" : {
4519 "type" : "object",
4520 "properties" : {
4521 "schema" : {
4522 "type" : "string"
4523 },
4524 "data" : {
4525 "type" : "string"
4526 }
4527 }
4528 },
4529 "UploadFileResponseDto" : {
4530 "type" : "object",
4531 "properties" : {
4532 "fileNames" : {
4533 "type" : "array",
4534 "items" : {
4535 "type" : "string"
4536 }
4537 },
4538 "errors" : {
4539 "type" : "object",
4540 "additionalProperties" : {
4541 "type" : "array",
4542 "items" : {
4543 "$ref" : "#/definitions/ErrorMessage"
4544 }
4545 }
4546 },
4547 "status" : {
4548 "type" : "string",
4549 "enum" : [ "Success", "Failure" ]
4550 }
4551 }
4552 },
4553 "VendorLicenseModelActionRequestDto" : {
4554 "type" : "object",
4555 "properties" : {
4556 "action" : {
4557 "type" : "string",
4558 "enum" : [ "Checkout", "Undo_Checkout", "Checkin", "Submit" ]
4559 }
4560 }
4561 },
4562 "VendorLicenseModelEntity" : {
4563 "type" : "object",
4564 "required" : [ "description", "iconRef", "vendorName" ],
4565 "properties" : {
4566 "vendorName" : {
4567 "type" : "string",
4568 "minLength" : 0,
4569 "maxLength" : 25
4570 },
4571 "description" : {
4572 "type" : "string",
4573 "minLength" : 0,
4574 "maxLength" : 1000
4575 },
4576 "iconRef" : {
4577 "type" : "string"
4578 },
4579 "id" : {
4580 "type" : "string"
4581 },
4582 "version" : {
4583 "type" : "string"
4584 },
4585 "status" : {
4586 "type" : "string",
4587 "enum" : [ "Available", "Locked", "Final" ]
4588 },
4589 "lockingUser" : {
4590 "type" : "string"
4591 },
4592 "viewableVersions" : {
4593 "type" : "array",
4594 "items" : {
4595 "type" : "string"
4596 }
4597 },
4598 "finalVersions" : {
4599 "type" : "array",
4600 "items" : {
4601 "type" : "string"
4602 }
4603 }
4604 }
4605 },
4606 "VendorLicenseModelRequest" : {
4607 "type" : "object",
4608 "required" : [ "description", "iconRef", "vendorName" ],
4609 "properties" : {
4610 "vendorName" : {
4611 "type" : "string",
4612 "minLength" : 0,
4613 "maxLength" : 25
4614 },
4615 "description" : {
4616 "type" : "string",
4617 "minLength" : 0,
4618 "maxLength" : 1000
4619 },
4620 "iconRef" : {
4621 "type" : "string"
4622 }
4623 }
4624 },
4625 "VersionSoftwareProductActionRequestDto" : {
4626 "type" : "object",
4627 "properties" : {
4628 "action" : {
4629 "type" : "string",
4630 "enum" : [ "Checkout", "Undo_Checkout", "Checkin", "Submit", "Create_Package" ]
4631 }
4632 }
4633 },
4634 "VspCreationDto" : {
4635 "type" : "object",
4636 "properties" : {
4637 "vspId" : {
4638 "type" : "string"
4639 }
4640 }
4641 },
4642 "VspDescriptionDto" : {
4643 "type" : "object",
4644 "required" : [ "category", "description", "name", "subCategory", "vendorId", "vendorName" ],
4645 "properties" : {
4646 "name" : {
4647 "type" : "string"
4648 },
4649 "description" : {
4650 "type" : "string"
4651 },
4652 "icon" : {
4653 "type" : "string"
4654 },
4655 "category" : {
4656 "type" : "string"
4657 },
4658 "subCategory" : {
4659 "type" : "string"
4660 },
4661 "vendorName" : {
4662 "type" : "string"
4663 },
4664 "vendorId" : {
4665 "type" : "string"
4666 },
4667 "licensingVersion" : {
4668 "type" : "string"
4669 },
4670 "licensingData" : {
4671 "$ref" : "#/definitions/LicensingData"
4672 }
4673 }
4674 }
4675 }
4676}