Gitiles
Code Review Sign In
gerrit.nordix.org / onap / sdc / 38440b83f47aa3a461fd11955cf4c4ffd4505c65 / . / openecomp-be / tools / swagger-ui / api-docs / api.html
blob: b89547e308f7b9721d35a5e04cc276c04886b87e [file] [log] [blame]
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]1<!DOCTYPE html>
2<html>
3<title>API Document</title>
4
5<!--xmp theme="united" style="display:none;"-->
6<xmp theme="united" style="display:none;">
7#Rest API
8
9
10## HTTP:///onboarding-api
11
12
13Rest API Documentation
14
15
16
17**Version** v1.0, build #${buildNumber}
18
19
20
21
22
23
24
25
26
27
28
29
30# APIs
31
32
33## /v1.0/application-configuration
34
35
36
37
38
39
40### POST
41
42
43<a id="insertToTable">Insert JSON schema into application config table</a>
44
45
46
47
48
49
50
51
52
53#### Request
54
55
56**Content-Type: ** multipart/form-data
57
58##### Parameters
59
60<table border="1">
61 <tr>
62 <th>Name</th>
63 <th>Located in</th>
64 <th>Required</th>
65 <th>Description</th>
66 <th>Default</th>
67 <th>Schema</th>
68 </tr>
69
70
71
72<tr>
73 <th>namespace</th>
74 <td>query</td>
75 <td>no</td>
76 <td></td>
77 <td> - </td>
78
79
80 <td>string </td>
81
82
83</tr>
84
85<tr>
86 <th>key</th>
87 <td>query</td>
88 <td>no</td>
89 <td></td>
90 <td> - </td>
91
92
93 <td>string </td>
94
95
96</tr>
97
98<tr>
99 <th>body</th>
100 <td>body</td>
101 <td>no</td>
102 <td></td>
103 <td> - </td>
104
105 <td>
106
107 <a href="#/definitions/InputStream">InputStream</a>
108 </td>
109
110</tr>
111
112
113</table>
114
115
116
117#### Response
118
119**Content-Type: ** application/json
120
121
122| Status Code | Reason | Response Model |
123|-------------|-------------|----------------|
124| default | successful operation | - |
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139## /v1.0/application-configuration/{namespace}
140
141
142### GET
143
144<a id="getListOfConfigurationByNamespaceFromTable">Get List of keys and values by namespace</a>
145
146
147
148
149
150
151
152
153
154#### Request
155
156
157**Content-Type: ** application/json
158
159##### Parameters
160
161<table border="1">
162 <tr>
163 <th>Name</th>
164 <th>Located in</th>
165 <th>Required</th>
166 <th>Description</th>
167 <th>Default</th>
168 <th>Schema</th>
169 </tr>
170
171
172
173<tr>
174 <th>namespace</th>
175 <td>path</td>
176 <td>yes</td>
177 <td></td>
178 <td> - </td>
179
180
181 <td>string </td>
182
183
184</tr>
185
186
187</table>
188
189
190
191#### Response
192
193**Content-Type: ** application/json
194
195
196| Status Code | Reason | Response Model |
197|-------------|-------------|----------------|
198| default | successful operation | - |
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216## /v1.0/application-configuration/{namespace}/{key}
217
218
219### GET
220
221<a id="getFromTable">Get JSON schema by namespace and key</a>
222
223
224
225
226
227
228
229
230
231#### Request
232
233
234**Content-Type: ** application/json
235
236##### Parameters
237
238<table border="1">
239 <tr>
240 <th>Name</th>
241 <th>Located in</th>
242 <th>Required</th>
243 <th>Description</th>
244 <th>Default</th>
245 <th>Schema</th>
246 </tr>
247
248
249
250<tr>
251 <th>namespace</th>
252 <td>path</td>
253 <td>yes</td>
254 <td></td>
255 <td> - </td>
256
257
258 <td>string </td>
259
260
261</tr>
262
263<tr>
264 <th>key</th>
265 <td>path</td>
266 <td>yes</td>
267 <td></td>
268 <td> - </td>
269
270
271 <td>string </td>
272
273
274</tr>
275
276
277</table>
278
279
280
281#### Response
282
283**Content-Type: ** application/json
284
285
286| Status Code | Reason | Response Model |
287|-------------|-------------|----------------|
288| 200 | successful operation | <a href="#/definitions/ConfigurationDataDto">ConfigurationDataDto</a>|
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306## /v1.0/validation/{type}/validate
307
308
309
310
311
312
313### POST
314
315
316<a id="validateFile">Validate a package</a>
317
318
319
320
321
322
323
324
325
326#### Request
327
328
329**Content-Type: ** multipart/form-data
330
331##### Parameters
332
333<table border="1">
334 <tr>
335 <th>Name</th>
336 <th>Located in</th>
337 <th>Required</th>
338 <th>Description</th>
339 <th>Default</th>
340 <th>Schema</th>
341 </tr>
342
343
344
345<tr>
346 <th>type</th>
347 <td>path</td>
348 <td>yes</td>
349 <td></td>
350 <td> - </td>
351
352
353 <td>string </td>
354
355
356</tr>
357
358<tr>
359 <th>body</th>
360 <td>body</td>
361 <td>no</td>
362 <td></td>
363 <td> - </td>
364
365 <td>
366
367 <a href="#/definitions/InputStream">InputStream</a>
368 </td>
369
370</tr>
371
372
373</table>
374
375
376
377#### Response
378
379**Content-Type: ** application/json
380
381
382| Status Code | Reason | Response Model |
383|-------------|-------------|----------------|
384| default | successful operation | - |
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399## /v1.0/vendor-license-models
400
401
402### GET
403
404<a id="listLicenseModels">List vendor license models</a>
405
406
407
408
409
410
411
412
413
414#### Request
415
416
417**Content-Type: ** application/json
418
419##### Parameters
420
421<table border="1">
422 <tr>
423 <th>Name</th>
424 <th>Located in</th>
425 <th>Required</th>
426 <th>Description</th>
427 <th>Default</th>
428 <th>Schema</th>
429 </tr>
430
431
432
433<tr>
434 <th>versionFilter</th>
435 <td>query</td>
436 <td>no</td>
437 <td>Currently supported value: &#x27;Final&#x27; - only vendor License models with final versions will be return - with their latest final version</td>
438 <td> - </td>
439
440
441 <td>string </td>
442
443
444</tr>
445
446<tr>
447 <th>USER_ID</th>
448 <td>header</td>
449 <td>no</td>
450 <td></td>
451 <td> - </td>
452
453
454 <td>string </td>
455
456
457</tr>
458
459
460</table>
461
462
463
464#### Response
465
466**Content-Type: ** application/json
467
468
469| Status Code | Reason | Response Model |
470|-------------|-------------|----------------|
471| 200 | successful operation | Array[<a href="#/definitions/VendorLicenseModelEntity">VendorLicenseModelEntity</a>]|
472
473
474
475
476
477
478### POST
479
480
481<a id="createLicenseModel">Create vendor license model</a>
482
483
484
485
486
487
488
489
490
491#### Request
492
493
494**Content-Type: ** application/json
495
496##### Parameters
497
498<table border="1">
499 <tr>
500 <th>Name</th>
501 <th>Located in</th>
502 <th>Required</th>
503 <th>Description</th>
504 <th>Default</th>
505 <th>Schema</th>
506 </tr>
507
508
509
510<tr>
511 <th>body</th>
512 <td>body</td>
513 <td>no</td>
514 <td></td>
515 <td> - </td>
516
517 <td>
518
519 <a href="#/definitions/VendorLicenseModelRequest">VendorLicenseModelRequest</a>
520 </td>
521
522</tr>
523
524<tr>
525 <th>USER_ID</th>
526 <td>header</td>
527 <td>no</td>
528 <td></td>
529 <td> - </td>
530
531
532 <td>string </td>
533
534
535</tr>
536
537
538</table>
539
540
541
542#### Response
543
544**Content-Type: ** application/json
545
546
547| Status Code | Reason | Response Model |
548|-------------|-------------|----------------|
549| default | successful operation | - |
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564## /v1.0/vendor-license-models/{vlmId}
565
566
567### GET
568
569<a id="getLicenseModel">Get vendor license model</a>
570
571
572
573
574
575
576
577
578
579#### Request
580
581
582**Content-Type: ** application/json
583
584##### Parameters
585
586<table border="1">
587 <tr>
588 <th>Name</th>
589 <th>Located in</th>
590 <th>Required</th>
591 <th>Description</th>
592 <th>Default</th>
593 <th>Schema</th>
594 </tr>
595
596
597
598<tr>
599 <th>vlmId</th>
600 <td>path</td>
601 <td>yes</td>
602 <td>Vendor license model Id</td>
603 <td> - </td>
604
605
606 <td>string </td>
607
608
609</tr>
610
611<tr>
612 <th>version</th>
613 <td>query</td>
614 <td>no</td>
615 <td></td>
616 <td> - </td>
617
618
619 <td>string </td>
620
621
622</tr>
623
624<tr>
625 <th>USER_ID</th>
626 <td>header</td>
627 <td>no</td>
628 <td></td>
629 <td> - </td>
630
631
632 <td>string </td>
633
634
635</tr>
636
637
638</table>
639
640
641
642#### Response
643
644**Content-Type: ** application/json
645
646
647| Status Code | Reason | Response Model |
648|-------------|-------------|----------------|
649| 200 | successful operation | <a href="#/definitions/VendorLicenseModelEntity">VendorLicenseModelEntity</a>|
650
651
652
653
654### PUT
655
656<a id="updateLicenseModel">Update vendor license model</a>
657
658
659
660
661
662
663
664
665
666#### Request
667
668
669**Content-Type: ** application/json
670
671##### Parameters
672
673<table border="1">
674 <tr>
675 <th>Name</th>
676 <th>Located in</th>
677 <th>Required</th>
678 <th>Description</th>
679 <th>Default</th>
680 <th>Schema</th>
681 </tr>
682
683
684
685<tr>
686 <th>body</th>
687 <td>body</td>
688 <td>no</td>
689 <td></td>
690 <td> - </td>
691
692 <td>
693
694 <a href="#/definitions/VendorLicenseModelRequest">VendorLicenseModelRequest</a>
695 </td>
696
697</tr>
698
699<tr>
700 <th>vlmId</th>
701 <td>path</td>
702 <td>yes</td>
703 <td>Vendor license model Id</td>
704 <td> - </td>
705
706
707 <td>string </td>
708
709
710</tr>
711
712<tr>
713 <th>USER_ID</th>
714 <td>header</td>
715 <td>no</td>
716 <td></td>
717 <td> - </td>
718
719
720 <td>string </td>
721
722
723</tr>
724
725
726</table>
727
728
729
730#### Response
731
732**Content-Type: ** application/json
733
734
735| Status Code | Reason | Response Model |
736|-------------|-------------|----------------|
737| default | successful operation | - |
738
739
740
741
742
743
744### DELETE
745
746<a id="deleteLicenseModel">Delete vendor license model</a>
747
748
749
750
751
752
753
754
755
756#### Request
757
758
759**Content-Type: ** application/json
760
761##### Parameters
762
763<table border="1">
764 <tr>
765 <th>Name</th>
766 <th>Located in</th>
767 <th>Required</th>
768 <th>Description</th>
769 <th>Default</th>
770 <th>Schema</th>
771 </tr>
772
773
774
775<tr>
776 <th>vlmId</th>
777 <td>path</td>
778 <td>yes</td>
779 <td>Vendor license model Id</td>
780 <td> - </td>
781
782
783 <td>string </td>
784
785
786</tr>
787
788<tr>
789 <th>USER_ID</th>
790 <td>header</td>
791 <td>no</td>
792 <td></td>
793 <td> - </td>
794
795
796 <td>string </td>
797
798
799</tr>
800
801
802</table>
803
804
805
806#### Response
807
808**Content-Type: ** application/json
809
810
811| Status Code | Reason | Response Model |
812|-------------|-------------|----------------|
813| default | successful operation | - |
814
815
816
817
818
819
820
821
822
823
824
825## /v1.0/vendor-license-models/{vlmId}/actions
826
827
828
829
830### PUT
831
832<a id="actOnLicenseModel">Update vendor license model</a>
833
834
835
836
837
838
839
840
841
842#### Request
843
844
845**Content-Type: ** application/json
846
847##### Parameters
848
849<table border="1">
850 <tr>
851 <th>Name</th>
852 <th>Located in</th>
853 <th>Required</th>
854 <th>Description</th>
855 <th>Default</th>
856 <th>Schema</th>
857 </tr>
858
859
860
861<tr>
862 <th>body</th>
863 <td>body</td>
864 <td>no</td>
865 <td></td>
866 <td> - </td>
867
868 <td>
869
870 <a href="#/definitions/VendorLicenseModelActionRequestDto">VendorLicenseModelActionRequestDto</a>
871 </td>
872
873</tr>
874
875<tr>
876 <th>vlmId</th>
877 <td>path</td>
878 <td>yes</td>
879 <td>Vendor license model Id</td>
880 <td> - </td>
881
882
883 <td>string </td>
884
885
886</tr>
887
888<tr>
889 <th>USER_ID</th>
890 <td>header</td>
891 <td>no</td>
892 <td></td>
893 <td> - </td>
894
895
896 <td>string </td>
897
898
899</tr>
900
901
902</table>
903
904
905
906#### Response
907
908**Content-Type: ** application/json
909
910
911| Status Code | Reason | Response Model |
912|-------------|-------------|----------------|
913| default | successful operation | - |
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929## /v1.0/vendor-license-models/{vlmId}/entitlement-pools
930
931
932### GET
933
934<a id="listEntitlementPools">List vendor entitlement pools</a>
935
936
937
938
939
940
941
942
943
944#### Request
945
946
947**Content-Type: ** application/json
948
949##### Parameters
950
951<table border="1">
952 <tr>
953 <th>Name</th>
954 <th>Located in</th>
955 <th>Required</th>
956 <th>Description</th>
957 <th>Default</th>
958 <th>Schema</th>
959 </tr>
960
961
962
963<tr>
964 <th>vlmId</th>
965 <td>path</td>
966 <td>yes</td>
967 <td>Vendor license model Id</td>
968 <td> - </td>
969
970
971 <td>string </td>
972
973
974</tr>
975
976<tr>
977 <th>version</th>
978 <td>query</td>
979 <td>no</td>
980 <td></td>
981 <td> - </td>
982
983
984 <td>string </td>
985
986
987</tr>
988
989<tr>
990 <th>USER_ID</th>
991 <td>header</td>
992 <td>no</td>
993 <td></td>
994 <td> - </td>
995
996
997 <td>string </td>
998
999
1000</tr>
1001
1002
1003</table>
1004
1005
1006
1007#### Response
1008
1009**Content-Type: ** application/json
1010
1011
1012| Status Code | Reason | Response Model |
1013|-------------|-------------|----------------|
1014| 200 | successful operation | Array[<a href="#/definitions/EntitlementPoolEntity">EntitlementPoolEntity</a>]|
1015
1016
1017
1018
1019
1020
1021### POST
1022
1023
1024<a id="createEntitlementPool">Create vendor entitlement pool</a>
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034#### Request
1035
1036
1037**Content-Type: ** application/json
1038
1039##### Parameters
1040
1041<table border="1">
1042 <tr>
1043 <th>Name</th>
1044 <th>Located in</th>
1045 <th>Required</th>
1046 <th>Description</th>
1047 <th>Default</th>
1048 <th>Schema</th>
1049 </tr>
1050
1051
1052
1053<tr>
1054 <th>body</th>
1055 <td>body</td>
1056 <td>no</td>
1057 <td></td>
1058 <td> - </td>
1059
1060 <td>
1061
1062 <a href="#/definitions/EntitlementPoolRequest">EntitlementPoolRequest</a>
1063 </td>
1064
1065</tr>
1066
1067<tr>
1068 <th>vlmId</th>
1069 <td>path</td>
1070 <td>yes</td>
1071 <td>Vendor license model Id</td>
1072 <td> - </td>
1073
1074
1075 <td>string </td>
1076
1077
1078</tr>
1079
1080<tr>
1081 <th>USER_ID</th>
1082 <td>header</td>
1083 <td>no</td>
1084 <td></td>
1085 <td> - </td>
1086
1087
1088 <td>string </td>
1089
1090
1091</tr>
1092
1093
1094</table>
1095
1096
1097
1098#### Response
1099
1100**Content-Type: ** application/json
1101
1102
1103| Status Code | Reason | Response Model |
1104|-------------|-------------|----------------|
1105| default | successful operation | - |
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120## /v1.0/vendor-license-models/{vlmId}/entitlement-pools/{entitlementPoolId}
1121
1122
1123### GET
1124
1125<a id="getEntitlementPool">Get vendor entitlement pool</a>
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135#### Request
1136
1137
1138**Content-Type: ** application/json
1139
1140##### Parameters
1141
1142<table border="1">
1143 <tr>
1144 <th>Name</th>
1145 <th>Located in</th>
1146 <th>Required</th>
1147 <th>Description</th>
1148 <th>Default</th>
1149 <th>Schema</th>
1150 </tr>
1151
1152
1153
1154<tr>
1155 <th>vlmId</th>
1156 <td>path</td>
1157 <td>yes</td>
1158 <td>Vendor license model Id</td>
1159 <td> - </td>
1160
1161
1162 <td>string </td>
1163
1164
1165</tr>
1166
1167<tr>
1168 <th>version</th>
1169 <td>query</td>
1170 <td>no</td>
1171 <td></td>
1172 <td> - </td>
1173
1174
1175 <td>string </td>
1176
1177
1178</tr>
1179
1180<tr>
1181 <th>entitlementPoolId</th>
1182 <td>path</td>
1183 <td>yes</td>
1184 <td></td>
1185 <td> - </td>
1186
1187
1188 <td>string </td>
1189
1190
1191</tr>
1192
1193<tr>
1194 <th>USER_ID</th>
1195 <td>header</td>
1196 <td>no</td>
1197 <td></td>
1198 <td> - </td>
1199
1200
1201 <td>string </td>
1202
1203
1204</tr>
1205
1206
1207</table>
1208
1209
1210
1211#### Response
1212
1213**Content-Type: ** application/json
1214
1215
1216| Status Code | Reason | Response Model |
1217|-------------|-------------|----------------|
1218| 200 | successful operation | <a href="#/definitions/EntitlementPoolEntity">EntitlementPoolEntity</a>|
1219
1220
1221
1222
1223### PUT
1224
1225<a id="updateEntitlementPool">Update vendor entitlement pool</a>
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235#### Request
1236
1237
1238**Content-Type: ** application/json
1239
1240##### Parameters
1241
1242<table border="1">
1243 <tr>
1244 <th>Name</th>
1245 <th>Located in</th>
1246 <th>Required</th>
1247 <th>Description</th>
1248 <th>Default</th>
1249 <th>Schema</th>
1250 </tr>
1251
1252
1253
1254<tr>
1255 <th>body</th>
1256 <td>body</td>
1257 <td>no</td>
1258 <td></td>
1259 <td> - </td>
1260
1261 <td>
1262
1263 <a href="#/definitions/EntitlementPoolRequest">EntitlementPoolRequest</a>
1264 </td>
1265
1266</tr>
1267
1268<tr>
1269 <th>vlmId</th>
1270 <td>path</td>
1271 <td>yes</td>
1272 <td>Vendor license model Id</td>
1273 <td> - </td>
1274
1275
1276 <td>string </td>
1277
1278
1279</tr>
1280
1281<tr>
1282 <th>entitlementPoolId</th>
1283 <td>path</td>
1284 <td>yes</td>
1285 <td></td>
1286 <td> - </td>
1287
1288
1289 <td>string </td>
1290
1291
1292</tr>
1293
1294<tr>
1295 <th>USER_ID</th>
1296 <td>header</td>
1297 <td>no</td>
1298 <td></td>
1299 <td> - </td>
1300
1301
1302 <td>string </td>
1303
1304
1305</tr>
1306
1307
1308</table>
1309
1310
1311
1312#### Response
1313
1314**Content-Type: ** application/json
1315
1316
1317| Status Code | Reason | Response Model |
1318|-------------|-------------|----------------|
1319| default | successful operation | - |
1320
1321
1322
1323
1324
1325
1326### DELETE
1327
1328<a id="deleteEntitlementPool">Delete vendor entitlement pool</a>
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338#### Request
1339
1340
1341**Content-Type: ** application/json
1342
1343##### Parameters
1344
1345<table border="1">
1346 <tr>
1347 <th>Name</th>
1348 <th>Located in</th>
1349 <th>Required</th>
1350 <th>Description</th>
1351 <th>Default</th>
1352 <th>Schema</th>
1353 </tr>
1354
1355
1356
1357<tr>
1358 <th>vlmId</th>
1359 <td>path</td>
1360 <td>yes</td>
1361 <td>Vendor license model Id</td>
1362 <td> - </td>
1363
1364
1365 <td>string </td>
1366
1367
1368</tr>
1369
1370<tr>
1371 <th>entitlementPoolId</th>
1372 <td>path</td>
1373 <td>yes</td>
1374 <td></td>
1375 <td> - </td>
1376
1377
1378 <td>string </td>
1379
1380
1381</tr>
1382
1383<tr>
1384 <th>USER_ID</th>
1385 <td>header</td>
1386 <td>no</td>
1387 <td></td>
1388 <td> - </td>
1389
1390
1391 <td>string </td>
1392
1393
1394</tr>
1395
1396
1397</table>
1398
1399
1400
1401#### Response
1402
1403**Content-Type: ** application/json
1404
1405
1406| Status Code | Reason | Response Model |
1407|-------------|-------------|----------------|
1408| default | successful operation | - |
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420## /v1.0/vendor-license-models/{vlmId}/feature-groups
1421
1422
1423### GET
1424
1425<a id="listFeatureGroups">List vendor feature groups</a>
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435#### Request
1436
1437
1438**Content-Type: ** application/json
1439
1440##### Parameters
1441
1442<table border="1">
1443 <tr>
1444 <th>Name</th>
1445 <th>Located in</th>
1446 <th>Required</th>
1447 <th>Description</th>
1448 <th>Default</th>
1449 <th>Schema</th>
1450 </tr>
1451
1452
1453
1454<tr>
1455 <th>vlmId</th>
1456 <td>path</td>
1457 <td>yes</td>
1458 <td>Vendor license model Id</td>
1459 <td> - </td>
1460
1461
1462 <td>string </td>
1463
1464
1465</tr>
1466
1467<tr>
1468 <th>version</th>
1469 <td>query</td>
1470 <td>no</td>
1471 <td></td>
1472 <td> - </td>
1473
1474
1475 <td>string </td>
1476
1477
1478</tr>
1479
1480<tr>
1481 <th>USER_ID</th>
1482 <td>header</td>
1483 <td>no</td>
1484 <td></td>
1485 <td> - </td>
1486
1487
1488 <td>string </td>
1489
1490
1491</tr>
1492
1493
1494</table>
1495
1496
1497
1498#### Response
1499
1500**Content-Type: ** application/json
1501
1502
1503| Status Code | Reason | Response Model |
1504|-------------|-------------|----------------|
1505| 200 | successful operation | Array[<a href="#/definitions/FeatureGroupEntity">FeatureGroupEntity</a>]|
1506
1507
1508
1509
1510
1511
1512### POST
1513
1514
1515<a id="createFeatureGroup">Create vendor feature group</a>
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525#### Request
1526
1527
1528**Content-Type: ** application/json
1529
1530##### Parameters
1531
1532<table border="1">
1533 <tr>
1534 <th>Name</th>
1535 <th>Located in</th>
1536 <th>Required</th>
1537 <th>Description</th>
1538 <th>Default</th>
1539 <th>Schema</th>
1540 </tr>
1541
1542
1543
1544<tr>
1545 <th>body</th>
1546 <td>body</td>
1547 <td>no</td>
1548 <td></td>
1549 <td> - </td>
1550
1551 <td>
1552
1553 <a href="#/definitions/FeatureGroupRequest">FeatureGroupRequest</a>
1554 </td>
1555
1556</tr>
1557
1558<tr>
1559 <th>vlmId</th>
1560 <td>path</td>
1561 <td>yes</td>
1562 <td>Vendor license model Id</td>
1563 <td> - </td>
1564
1565
1566 <td>string </td>
1567
1568
1569</tr>
1570
1571<tr>
1572 <th>USER_ID</th>
1573 <td>header</td>
1574 <td>no</td>
1575 <td></td>
1576 <td> - </td>
1577
1578
1579 <td>string </td>
1580
1581
1582</tr>
1583
1584
1585</table>
1586
1587
1588
1589#### Response
1590
1591**Content-Type: ** application/json
1592
1593
1594| Status Code | Reason | Response Model |
1595|-------------|-------------|----------------|
1596| default | successful operation | - |
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611## /v1.0/vendor-license-models/{vlmId}/feature-groups/{featureGroupId}
1612
1613
1614### GET
1615
1616<a id="getFeatureGroup">Get vendor feature group</a>
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626#### Request
1627
1628
1629**Content-Type: ** application/json
1630
1631##### Parameters
1632
1633<table border="1">
1634 <tr>
1635 <th>Name</th>
1636 <th>Located in</th>
1637 <th>Required</th>
1638 <th>Description</th>
1639 <th>Default</th>
1640 <th>Schema</th>
1641 </tr>
1642
1643
1644
1645<tr>
1646 <th>vlmId</th>
1647 <td>path</td>
1648 <td>yes</td>
1649 <td>Vendor license model Id</td>
1650 <td> - </td>
1651
1652
1653 <td>string </td>
1654
1655
1656</tr>
1657
1658<tr>
1659 <th>version</th>
1660 <td>query</td>
1661 <td>no</td>
1662 <td></td>
1663 <td> - </td>
1664
1665
1666 <td>string </td>
1667
1668
1669</tr>
1670
1671<tr>
1672 <th>featureGroupId</th>
1673 <td>path</td>
1674 <td>yes</td>
1675 <td></td>
1676 <td> - </td>
1677
1678
1679 <td>string </td>
1680
1681
1682</tr>
1683
1684<tr>
1685 <th>USER_ID</th>
1686 <td>header</td>
1687 <td>no</td>
1688 <td></td>
1689 <td> - </td>
1690
1691
1692 <td>string </td>
1693
1694
1695</tr>
1696
1697
1698</table>
1699
1700
1701
1702#### Response
1703
1704**Content-Type: ** application/json
1705
1706
1707| Status Code | Reason | Response Model |
1708|-------------|-------------|----------------|
1709| 200 | successful operation | <a href="#/definitions/FeatureGroupModel">FeatureGroupModel</a>|
1710
1711
1712
1713
1714### PUT
1715
1716<a id="updateFeatureGroup">Update vendor feature group</a>
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726#### Request
1727
1728
1729**Content-Type: ** application/json
1730
1731##### Parameters
1732
1733<table border="1">
1734 <tr>
1735 <th>Name</th>
1736 <th>Located in</th>
1737 <th>Required</th>
1738 <th>Description</th>
1739 <th>Default</th>
1740 <th>Schema</th>
1741 </tr>
1742
1743
1744
1745<tr>
1746 <th>body</th>
1747 <td>body</td>
1748 <td>no</td>
1749 <td></td>
1750 <td> - </td>
1751
1752 <td>
1753
1754 <a href="#/definitions/FeatureGroupUpdateRequest">FeatureGroupUpdateRequest</a>
1755 </td>
1756
1757</tr>
1758
1759<tr>
1760 <th>vlmId</th>
1761 <td>path</td>
1762 <td>yes</td>
1763 <td>Vendor license model Id</td>
1764 <td> - </td>
1765
1766
1767 <td>string </td>
1768
1769
1770</tr>
1771
1772<tr>
1773 <th>featureGroupId</th>
1774 <td>path</td>
1775 <td>yes</td>
1776 <td></td>
1777 <td> - </td>
1778
1779
1780 <td>string </td>
1781
1782
1783</tr>
1784
1785<tr>
1786 <th>USER_ID</th>
1787 <td>header</td>
1788 <td>no</td>
1789 <td></td>
1790 <td> - </td>
1791
1792
1793 <td>string </td>
1794
1795
1796</tr>
1797
1798
1799</table>
1800
1801
1802
1803#### Response
1804
1805**Content-Type: ** application/json
1806
1807
1808| Status Code | Reason | Response Model |
1809|-------------|-------------|----------------|
1810| default | successful operation | - |
1811
1812
1813
1814
1815
1816
1817### DELETE
1818
1819<a id="deleteFeatureGroup">Delete vendor feature group</a>
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829#### Request
1830
1831
1832**Content-Type: ** application/json
1833
1834##### Parameters
1835
1836<table border="1">
1837 <tr>
1838 <th>Name</th>
1839 <th>Located in</th>
1840 <th>Required</th>
1841 <th>Description</th>
1842 <th>Default</th>
1843 <th>Schema</th>
1844 </tr>
1845
1846
1847
1848<tr>
1849 <th>vlmId</th>
1850 <td>path</td>
1851 <td>yes</td>
1852 <td>Vendor license model Id</td>
1853 <td> - </td>
1854
1855
1856 <td>string </td>
1857
1858
1859</tr>
1860
1861<tr>
1862 <th>featureGroupId</th>
1863 <td>path</td>
1864 <td>yes</td>
1865 <td></td>
1866 <td> - </td>
1867
1868
1869 <td>string </td>
1870
1871
1872</tr>
1873
1874<tr>
1875 <th>USER_ID</th>
1876 <td>header</td>
1877 <td>no</td>
1878 <td></td>
1879 <td> - </td>
1880
1881
1882 <td>string </td>
1883
1884
1885</tr>
1886
1887
1888</table>
1889
1890
1891
1892#### Response
1893
1894**Content-Type: ** application/json
1895
1896
1897| Status Code | Reason | Response Model |
1898|-------------|-------------|----------------|
1899| default | successful operation | - |
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911## /v1.0/vendor-license-models/{vlmId}/license-agreements
1912
1913
1914### GET
1915
1916<a id="listLicenseAgreements">List vendor license agreements</a>
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926#### Request
1927
1928
1929**Content-Type: ** application/json
1930
1931##### Parameters
1932
1933<table border="1">
1934 <tr>
1935 <th>Name</th>
1936 <th>Located in</th>
1937 <th>Required</th>
1938 <th>Description</th>
1939 <th>Default</th>
1940 <th>Schema</th>
1941 </tr>
1942
1943
1944
1945<tr>
1946 <th>vlmId</th>
1947 <td>path</td>
1948 <td>yes</td>
1949 <td>Vendor license model Id</td>
1950 <td> - </td>
1951
1952
1953 <td>string </td>
1954
1955
1956</tr>
1957
1958<tr>
1959 <th>version</th>
1960 <td>query</td>
1961 <td>no</td>
1962 <td></td>
1963 <td> - </td>
1964
1965
1966 <td>string </td>
1967
1968
1969</tr>
1970
1971<tr>
1972 <th>USER_ID</th>
1973 <td>header</td>
1974 <td>no</td>
1975 <td></td>
1976 <td> - </td>
1977
1978
1979 <td>string </td>
1980
1981
1982</tr>
1983
1984
1985</table>
1986
1987
1988
1989#### Response
1990
1991**Content-Type: ** application/json
1992
1993
1994| Status Code | Reason | Response Model |
1995|-------------|-------------|----------------|
1996| 200 | successful operation | Array[<a href="#/definitions/LicenseAgreementEntity">LicenseAgreementEntity</a>]|
1997
1998
1999
2000
2001
2002
2003### POST
2004
2005
2006<a id="createLicenseAgreement">Create vendor license agreement</a>
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016#### Request
2017
2018
2019**Content-Type: ** application/json
2020
2021##### Parameters
2022
2023<table border="1">
2024 <tr>
2025 <th>Name</th>
2026 <th>Located in</th>
2027 <th>Required</th>
2028 <th>Description</th>
2029 <th>Default</th>
2030 <th>Schema</th>
2031 </tr>
2032
2033
2034
2035<tr>
2036 <th>body</th>
2037 <td>body</td>
2038 <td>no</td>
2039 <td></td>
2040 <td> - </td>
2041
2042 <td>
2043
2044 <a href="#/definitions/LicenseAgreementRequest">LicenseAgreementRequest</a>
2045 </td>
2046
2047</tr>
2048
2049<tr>
2050 <th>vlmId</th>
2051 <td>path</td>
2052 <td>yes</td>
2053 <td>Vendor license model Id</td>
2054 <td> - </td>
2055
2056
2057 <td>string </td>
2058
2059
2060</tr>
2061
2062<tr>
2063 <th>USER_ID</th>
2064 <td>header</td>
2065 <td>no</td>
2066 <td></td>
2067 <td> - </td>
2068
2069
2070 <td>string </td>
2071
2072
2073</tr>
2074
2075
2076</table>
2077
2078
2079
2080#### Response
2081
2082**Content-Type: ** application/json
2083
2084
2085| Status Code | Reason | Response Model |
2086|-------------|-------------|----------------|
2087| default | successful operation | - |
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102## /v1.0/vendor-license-models/{vlmId}/license-agreements/{licenseAgreementId}
2103
2104
2105### GET
2106
2107<a id="getLicenseAgreement">Get vendor license agreement</a>
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117#### Request
2118
2119
2120**Content-Type: ** application/json
2121
2122##### Parameters
2123
2124<table border="1">
2125 <tr>
2126 <th>Name</th>
2127 <th>Located in</th>
2128 <th>Required</th>
2129 <th>Description</th>
2130 <th>Default</th>
2131 <th>Schema</th>
2132 </tr>
2133
2134
2135
2136<tr>
2137 <th>vlmId</th>
2138 <td>path</td>
2139 <td>yes</td>
2140 <td>Vendor license model Id</td>
2141 <td> - </td>
2142
2143
2144 <td>string </td>
2145
2146
2147</tr>
2148
2149<tr>
2150 <th>version</th>
2151 <td>query</td>
2152 <td>no</td>
2153 <td></td>
2154 <td> - </td>
2155
2156
2157 <td>string </td>
2158
2159
2160</tr>
2161
2162<tr>
2163 <th>licenseAgreementId</th>
2164 <td>path</td>
2165 <td>yes</td>
2166 <td></td>
2167 <td> - </td>
2168
2169
2170 <td>string </td>
2171
2172
2173</tr>
2174
2175<tr>
2176 <th>USER_ID</th>
2177 <td>header</td>
2178 <td>no</td>
2179 <td></td>
2180 <td> - </td>
2181
2182
2183 <td>string </td>
2184
2185
2186</tr>
2187
2188
2189</table>
2190
2191
2192
2193#### Response
2194
2195**Content-Type: ** application/json
2196
2197
2198| Status Code | Reason | Response Model |
2199|-------------|-------------|----------------|
2200| 200 | successful operation | <a href="#/definitions/LicenseAgreementModel">LicenseAgreementModel</a>|
2201
2202
2203
2204
2205### PUT
2206
2207<a id="updateLicenseAgreement">Update vendor license agreement</a>
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217#### Request
2218
2219
2220**Content-Type: ** application/json
2221
2222##### Parameters
2223
2224<table border="1">
2225 <tr>
2226 <th>Name</th>
2227 <th>Located in</th>
2228 <th>Required</th>
2229 <th>Description</th>
2230 <th>Default</th>
2231 <th>Schema</th>
2232 </tr>
2233
2234
2235
2236<tr>
2237 <th>body</th>
2238 <td>body</td>
2239 <td>no</td>
2240 <td></td>
2241 <td> - </td>
2242
2243 <td>
2244
2245 <a href="#/definitions/LicenseAgreementUpdateRequest">LicenseAgreementUpdateRequest</a>
2246 </td>
2247
2248</tr>
2249
2250<tr>
2251 <th>vlmId</th>
2252 <td>path</td>
2253 <td>yes</td>
2254 <td>Vendor license model Id</td>
2255 <td> - </td>
2256
2257
2258 <td>string </td>
2259
2260
2261</tr>
2262
2263<tr>
2264 <th>licenseAgreementId</th>
2265 <td>path</td>
2266 <td>yes</td>
2267 <td></td>
2268 <td> - </td>
2269
2270
2271 <td>string </td>
2272
2273
2274</tr>
2275
2276<tr>
2277 <th>USER_ID</th>
2278 <td>header</td>
2279 <td>no</td>
2280 <td></td>
2281 <td> - </td>
2282
2283
2284 <td>string </td>
2285
2286
2287</tr>
2288
2289
2290</table>
2291
2292
2293
2294#### Response
2295
2296**Content-Type: ** application/json
2297
2298
2299| Status Code | Reason | Response Model |
2300|-------------|-------------|----------------|
2301| default | successful operation | - |
2302
2303
2304
2305
2306
2307
2308### DELETE
2309
2310<a id="deleteLicenseAgreement">Delete vendor license agreement</a>
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320#### Request
2321
2322
2323**Content-Type: ** application/json
2324
2325##### Parameters
2326
2327<table border="1">
2328 <tr>
2329 <th>Name</th>
2330 <th>Located in</th>
2331 <th>Required</th>
2332 <th>Description</th>
2333 <th>Default</th>
2334 <th>Schema</th>
2335 </tr>
2336
2337
2338
2339<tr>
2340 <th>vlmId</th>
2341 <td>path</td>
2342 <td>yes</td>
2343 <td>Vendor license model Id</td>
2344 <td> - </td>
2345
2346
2347 <td>string </td>
2348
2349
2350</tr>
2351
2352<tr>
2353 <th>licenseAgreementId</th>
2354 <td>path</td>
2355 <td>yes</td>
2356 <td></td>
2357 <td> - </td>
2358
2359
2360 <td>string </td>
2361
2362
2363</tr>
2364
2365<tr>
2366 <th>USER_ID</th>
2367 <td>header</td>
2368 <td>no</td>
2369 <td></td>
2370 <td> - </td>
2371
2372
2373 <td>string </td>
2374
2375
2376</tr>
2377
2378
2379</table>
2380
2381
2382
2383#### Response
2384
2385**Content-Type: ** application/json
2386
2387
2388| Status Code | Reason | Response Model |
2389|-------------|-------------|----------------|
2390| default | successful operation | - |
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402## /v1.0/vendor-license-models/{vlmId}/license-key-groups
2403
2404
2405### GET
2406
2407<a id="listLicenseKeyGroups">List vendor license key groups</a>
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417#### Request
2418
2419
2420**Content-Type: ** application/json
2421
2422##### Parameters
2423
2424<table border="1">
2425 <tr>
2426 <th>Name</th>
2427 <th>Located in</th>
2428 <th>Required</th>
2429 <th>Description</th>
2430 <th>Default</th>
2431 <th>Schema</th>
2432 </tr>
2433
2434
2435
2436<tr>
2437 <th>vlmId</th>
2438 <td>path</td>
2439 <td>yes</td>
2440 <td>Vendor license model Id</td>
2441 <td> - </td>
2442
2443
2444 <td>string </td>
2445
2446
2447</tr>
2448
2449<tr>
2450 <th>version</th>
2451 <td>query</td>
2452 <td>no</td>
2453 <td></td>
2454 <td> - </td>
2455
2456
2457 <td>string </td>
2458
2459
2460</tr>
2461
2462<tr>
2463 <th>USER_ID</th>
2464 <td>header</td>
2465 <td>no</td>
2466 <td></td>
2467 <td> - </td>
2468
2469
2470 <td>string </td>
2471
2472
2473</tr>
2474
2475
2476</table>
2477
2478
2479
2480#### Response
2481
2482**Content-Type: ** application/json
2483
2484
2485| Status Code | Reason | Response Model |
2486|-------------|-------------|----------------|
2487| 200 | successful operation | Array[<a href="#/definitions/LicenseKeyGroupEntityDto">LicenseKeyGroupEntityDto</a>]|
2488
2489
2490
2491
2492
2493
2494### POST
2495
2496
2497<a id="createLicenseKeyGroup">Create vendor license key group</a>
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507#### Request
2508
2509
2510**Content-Type: ** application/json
2511
2512##### Parameters
2513
2514<table border="1">
2515 <tr>
2516 <th>Name</th>
2517 <th>Located in</th>
2518 <th>Required</th>
2519 <th>Description</th>
2520 <th>Default</th>
2521 <th>Schema</th>
2522 </tr>
2523
2524
2525
2526<tr>
2527 <th>body</th>
2528 <td>body</td>
2529 <td>no</td>
2530 <td></td>
2531 <td> - </td>
2532
2533 <td>
2534
2535 <a href="#/definitions/LicenseKeyGroupRequestDto">LicenseKeyGroupRequestDto</a>
2536 </td>
2537
2538</tr>
2539
2540<tr>
2541 <th>vlmId</th>
2542 <td>path</td>
2543 <td>yes</td>
2544 <td>Vendor license model Id</td>
2545 <td> - </td>
2546
2547
2548 <td>string </td>
2549
2550
2551</tr>
2552
2553<tr>
2554 <th>USER_ID</th>
2555 <td>header</td>
2556 <td>no</td>
2557 <td></td>
2558 <td> - </td>
2559
2560
2561 <td>string </td>
2562
2563
2564</tr>
2565
2566
2567</table>
2568
2569
2570
2571#### Response
2572
2573**Content-Type: ** application/json
2574
2575
2576| Status Code | Reason | Response Model |
2577|-------------|-------------|----------------|
2578| default | successful operation | - |
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593## /v1.0/vendor-license-models/{vlmId}/license-key-groups/{licenseKeyGroupId}
2594
2595
2596### GET
2597
2598<a id="getLicenseKeyGroup">Get vendor license key group</a>
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608#### Request
2609
2610
2611**Content-Type: ** application/json
2612
2613##### Parameters
2614
2615<table border="1">
2616 <tr>
2617 <th>Name</th>
2618 <th>Located in</th>
2619 <th>Required</th>
2620 <th>Description</th>
2621 <th>Default</th>
2622 <th>Schema</th>
2623 </tr>
2624
2625
2626
2627<tr>
2628 <th>vlmId</th>
2629 <td>path</td>
2630 <td>yes</td>
2631 <td>Vendor license model Id</td>
2632 <td> - </td>
2633
2634
2635 <td>string </td>
2636
2637
2638</tr>
2639
2640<tr>
2641 <th>version</th>
2642 <td>query</td>
2643 <td>no</td>
2644 <td></td>
2645 <td> - </td>
2646
2647
2648 <td>string </td>
2649
2650
2651</tr>
2652
2653<tr>
2654 <th>licenseKeyGroupId</th>
2655 <td>path</td>
2656 <td>yes</td>
2657 <td></td>
2658 <td> - </td>
2659
2660
2661 <td>string </td>
2662
2663
2664</tr>
2665
2666<tr>
2667 <th>USER_ID</th>
2668 <td>header</td>
2669 <td>no</td>
2670 <td></td>
2671 <td> - </td>
2672
2673
2674 <td>string </td>
2675
2676
2677</tr>
2678
2679
2680</table>
2681
2682
2683
2684#### Response
2685
2686**Content-Type: ** application/json
2687
2688
2689| Status Code | Reason | Response Model |
2690|-------------|-------------|----------------|
2691| 200 | successful operation | <a href="#/definitions/LicenseKeyGroupEntityDto">LicenseKeyGroupEntityDto</a>|
2692
2693
2694
2695
2696### PUT
2697
2698<a id="updateLicenseKeyGroup">Update vendor license key group</a>
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708#### Request
2709
2710
2711**Content-Type: ** application/json
2712
2713##### Parameters
2714
2715<table border="1">
2716 <tr>
2717 <th>Name</th>
2718 <th>Located in</th>
2719 <th>Required</th>
2720 <th>Description</th>
2721 <th>Default</th>
2722 <th>Schema</th>
2723 </tr>
2724
2725
2726
2727<tr>
2728 <th>body</th>
2729 <td>body</td>
2730 <td>no</td>
2731 <td></td>
2732 <td> - </td>
2733
2734 <td>
2735
2736 <a href="#/definitions/LicenseKeyGroupRequestDto">LicenseKeyGroupRequestDto</a>
2737 </td>
2738
2739</tr>
2740
2741<tr>
2742 <th>vlmId</th>
2743 <td>path</td>
2744 <td>yes</td>
2745 <td>Vendor license model Id</td>
2746 <td> - </td>
2747
2748
2749 <td>string </td>
2750
2751
2752</tr>
2753
2754<tr>
2755 <th>licenseKeyGroupId</th>
2756 <td>path</td>
2757 <td>yes</td>
2758 <td></td>
2759 <td> - </td>
2760
2761
2762 <td>string </td>
2763
2764
2765</tr>
2766
2767<tr>
2768 <th>USER_ID</th>
2769 <td>header</td>
2770 <td>no</td>
2771 <td></td>
2772 <td> - </td>
2773
2774
2775 <td>string </td>
2776
2777
2778</tr>
2779
2780
2781</table>
2782
2783
2784
2785#### Response
2786
2787**Content-Type: ** application/json
2788
2789
2790| Status Code | Reason | Response Model |
2791|-------------|-------------|----------------|
2792| default | successful operation | - |
2793
2794
2795
2796
2797
2798
2799### DELETE
2800
2801<a id="deleteLicenseKeyGroup">Delete vendor license key group</a>
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811#### Request
2812
2813
2814**Content-Type: ** application/json
2815
2816##### Parameters
2817
2818<table border="1">
2819 <tr>
2820 <th>Name</th>
2821 <th>Located in</th>
2822 <th>Required</th>
2823 <th>Description</th>
2824 <th>Default</th>
2825 <th>Schema</th>
2826 </tr>
2827
2828
2829
2830<tr>
2831 <th>vlmId</th>
2832 <td>path</td>
2833 <td>yes</td>
2834 <td>Vendor license model Id</td>
2835 <td> - </td>
2836
2837
2838 <td>string </td>
2839
2840
2841</tr>
2842
2843<tr>
2844 <th>licenseKeyGroupId</th>
2845 <td>path</td>
2846 <td>yes</td>
2847 <td></td>
2848 <td> - </td>
2849
2850
2851 <td>string </td>
2852
2853
2854</tr>
2855
2856<tr>
2857 <th>USER_ID</th>
2858 <td>header</td>
2859 <td>no</td>
2860 <td></td>
2861 <td> - </td>
2862
2863
2864 <td>string </td>
2865
2866
2867</tr>
2868
2869
2870</table>
2871
2872
2873
2874#### Response
2875
2876**Content-Type: ** application/json
2877
2878
2879| Status Code | Reason | Response Model |
2880|-------------|-------------|----------------|
2881| default | successful operation | - |
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893## /v1.0/vendor-software-products
2894
2895
2896### GET
2897
2898<a id="getVspList">Get list of vendor software products and their description</a>
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908#### Request
2909
2910
2911**Content-Type: ** application/json
2912
2913##### Parameters
2914
2915<table border="1">
2916 <tr>
2917 <th>Name</th>
2918 <th>Located in</th>
2919 <th>Required</th>
2920 <th>Description</th>
2921 <th>Default</th>
2922 <th>Schema</th>
2923 </tr>
2924
2925
2926
2927<tr>
2928 <th>versionFilter</th>
2929 <td>query</td>
2930 <td>no</td>
2931 <td>Currently supported values: &#x27;Final&#x27; - only vendor software products with final version will be return - with their latest final version</td>
2932 <td> - </td>
2933
2934
2935 <td>string </td>
2936
2937
2938</tr>
2939
2940<tr>
2941 <th>USER_ID</th>
2942 <td>header</td>
2943 <td>no</td>
2944 <td></td>
2945 <td> - </td>
2946
2947
2948 <td>string </td>
2949
2950
2951</tr>
2952
2953
2954</table>
2955
2956
2957
2958#### Response
2959
2960**Content-Type: ** application/json
2961
2962
2963| Status Code | Reason | Response Model |
2964|-------------|-------------|----------------|
2965| default | successful operation | - |
2966
2967
2968
2969
2970
2971
2972### POST
2973
2974
2975<a id="createNewVsp">Create a new vendor software product</a>
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985#### Request
2986
2987
2988**Content-Type: ** application/json
2989
2990##### Parameters
2991
2992<table border="1">
2993 <tr>
2994 <th>Name</th>
2995 <th>Located in</th>
2996 <th>Required</th>
2997 <th>Description</th>
2998 <th>Default</th>
2999 <th>Schema</th>
3000 </tr>
3001
3002
3003
3004<tr>
3005 <th>body</th>
3006 <td>body</td>
3007 <td>no</td>
3008 <td></td>
3009 <td> - </td>
3010
3011 <td>
3012
3013 <a href="#/definitions/VspDescriptionDto">VspDescriptionDto</a>
3014 </td>
3015
3016</tr>
3017
3018<tr>
3019 <th>USER_ID</th>
3020 <td>header</td>
3021 <td>no</td>
3022 <td></td>
3023 <td> - </td>
3024
3025
3026 <td>string </td>
3027
3028
3029</tr>
3030
3031
3032</table>
3033
3034
3035
3036#### Response
3037
3038**Content-Type: ** application/json
3039
3040
3041| Status Code | Reason | Response Model |
3042|-------------|-------------|----------------|
3043| 200 | successful operation | <a href="#/definitions/VspCreationDto">VspCreationDto</a>|
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058## /v1.0/vendor-software-products/packages
3059
3060
3061### GET
3062
3063<a id="listPackages">Get list of translated CSAR files details</a>
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073#### Request
3074
3075
3076**Content-Type: ** application/json
3077
3078##### Parameters
3079
3080<table border="1">
3081 <tr>
3082 <th>Name</th>
3083 <th>Located in</th>
3084 <th>Required</th>
3085 <th>Description</th>
3086 <th>Default</th>
3087 <th>Schema</th>
3088 </tr>
3089
3090
3091
3092<tr>
3093 <th>category</th>
3094 <td>query</td>
3095 <td>no</td>
3096 <td>Category</td>
3097 <td> - </td>
3098
3099
3100 <td>string </td>
3101
3102
3103</tr>
3104
3105<tr>
3106 <th>subCategory</th>
3107 <td>query</td>
3108 <td>no</td>
3109 <td>Sub-category</td>
3110 <td> - </td>
3111
3112
3113 <td>string </td>
3114
3115
3116</tr>
3117
3118<tr>
3119 <th>USER_ID</th>
3120 <td>header</td>
3121 <td>no</td>
3122 <td></td>
3123 <td> - </td>
3124
3125
3126 <td>string </td>
3127
3128
3129</tr>
3130
3131
3132</table>
3133
3134
3135
3136#### Response
3137
3138**Content-Type: ** application/json
3139
3140
3141| Status Code | Reason | Response Model |
3142|-------------|-------------|----------------|
3143| 200 | successful operation | Array[<a href="#/definitions/PackageInfoDto">PackageInfoDto</a>]|
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161## /v1.0/vendor-software-products/packages/{vspId}
3162
3163
3164### GET
3165
3166<a id="getTranslatedFile">Get translated CSAR file</a>
3167
3168Exports translated file to a zip file
3169
3170
3171
3172
3173
3174
3175
3176#### Request
3177
3178
3179**Content-Type: ** application/json
3180
3181##### Parameters
3182
3183<table border="1">
3184 <tr>
3185 <th>Name</th>
3186 <th>Located in</th>
3187 <th>Required</th>
3188 <th>Description</th>
3189 <th>Default</th>
3190 <th>Schema</th>
3191 </tr>
3192
3193
3194
3195<tr>
3196 <th>vspId</th>
3197 <td>path</td>
3198 <td>yes</td>
3199 <td></td>
3200 <td> - </td>
3201
3202
3203 <td>string </td>
3204
3205
3206</tr>
3207
3208<tr>
3209 <th>version</th>
3210 <td>query</td>
3211 <td>no</td>
3212 <td></td>
3213 <td> - </td>
3214
3215
3216 <td>string </td>
3217
3218
3219</tr>
3220
3221<tr>
3222 <th>USER_ID</th>
3223 <td>header</td>
3224 <td>no</td>
3225 <td></td>
3226 <td> - </td>
3227
3228
3229 <td>string </td>
3230
3231
3232</tr>
3233
3234
3235</table>
3236
3237
3238
3239#### Response
3240
3241**Content-Type: ** application/octet-stream
3242
3243
3244| Status Code | Reason | Response Model |
3245|-------------|-------------|----------------|
3246| 200 | successful operation | <a href="#/definitions/File">File</a>|
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264## /v1.0/vendor-software-products/{vspId}
3265
3266
3267### GET
3268
3269<a id="getVspDetails">Get details of a vendor software product</a>
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279#### Request
3280
3281
3282**Content-Type: ** application/json
3283
3284##### Parameters
3285
3286<table border="1">
3287 <tr>
3288 <th>Name</th>
3289 <th>Located in</th>
3290 <th>Required</th>
3291 <th>Description</th>
3292 <th>Default</th>
3293 <th>Schema</th>
3294 </tr>
3295
3296
3297
3298<tr>
3299 <th>vspId</th>
3300 <td>path</td>
3301 <td>yes</td>
3302 <td></td>
3303 <td> - </td>
3304
3305
3306 <td>string </td>
3307
3308
3309</tr>
3310
3311<tr>
3312 <th>version</th>
3313 <td>query</td>
3314 <td>no</td>
3315 <td></td>
3316 <td> - </td>
3317
3318
3319 <td>string </td>
3320
3321
3322</tr>
3323
3324<tr>
3325 <th>USER_ID</th>
3326 <td>header</td>
3327 <td>no</td>
3328 <td></td>
3329 <td> - </td>
3330
3331
3332 <td>string </td>
3333
3334
3335</tr>
3336
3337
3338</table>
3339
3340
3341
3342#### Response
3343
3344**Content-Type: ** application/json
3345
3346
3347| Status Code | Reason | Response Model |
3348|-------------|-------------|----------------|
3349| default | successful operation | - |
3350
3351
3352
3353
3354### PUT
3355
3356<a id="updateVsp">Update an existing vendor software product</a>
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366#### Request
3367
3368
3369**Content-Type: ** application/json
3370
3371##### Parameters
3372
3373<table border="1">
3374 <tr>
3375 <th>Name</th>
3376 <th>Located in</th>
3377 <th>Required</th>
3378 <th>Description</th>
3379 <th>Default</th>
3380 <th>Schema</th>
3381 </tr>
3382
3383
3384
3385<tr>
3386 <th>vspId</th>
3387 <td>path</td>
3388 <td>yes</td>
3389 <td></td>
3390 <td> - </td>
3391
3392
3393 <td>string </td>
3394
3395
3396</tr>
3397
3398<tr>
3399 <th>body</th>
3400 <td>body</td>
3401 <td>no</td>
3402 <td></td>
3403 <td> - </td>
3404
3405 <td>
3406
3407 <a href="#/definitions/VspDescriptionDto">VspDescriptionDto</a>
3408 </td>
3409
3410</tr>
3411
3412<tr>
3413 <th>USER_ID</th>
3414 <td>header</td>
3415 <td>no</td>
3416 <td></td>
3417 <td> - </td>
3418
3419
3420 <td>string </td>
3421
3422
3423</tr>
3424
3425
3426</table>
3427
3428
3429
3430#### Response
3431
3432**Content-Type: ** application/json
3433
3434
3435| Status Code | Reason | Response Model |
3436|-------------|-------------|----------------|
3437| default | successful operation | - |
3438
3439
3440
3441
3442
3443
3444### DELETE
3445
3446<a id="deleteVsp">Deletes vendor software product by given id</a>
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456#### Request
3457
3458
3459**Content-Type: ** application/json
3460
3461##### Parameters
3462
3463<table border="1">
3464 <tr>
3465 <th>Name</th>
3466 <th>Located in</th>
3467 <th>Required</th>
3468 <th>Description</th>
3469 <th>Default</th>
3470 <th>Schema</th>
3471 </tr>
3472
3473
3474
3475<tr>
3476 <th>vspId</th>
3477 <td>path</td>
3478 <td>yes</td>
3479 <td></td>
3480 <td> - </td>
3481
3482
3483 <td>string </td>
3484
3485
3486</tr>
3487
3488<tr>
3489 <th>USER_ID</th>
3490 <td>header</td>
3491 <td>no</td>
3492 <td></td>
3493 <td> - </td>
3494
3495
3496 <td>string </td>
3497
3498
3499</tr>
3500
3501
3502</table>
3503
3504
3505
3506#### Response
3507
3508**Content-Type: ** application/json
3509
3510
3511| Status Code | Reason | Response Model |
3512|-------------|-------------|----------------|
3513| default | successful operation | - |
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525## /v1.0/vendor-software-products/{vspId}/actions
3526
3527
3528
3529
3530### PUT
3531
3532<a id="actOnVendorSoftwareProduct">Actions on a vendor software product</a>
3533
3534Performs 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.|
3535
3536
3537
3538
3539
3540
3541
3542#### Request
3543
3544
3545**Content-Type: ** application/json
3546
3547##### Parameters
3548
3549<table border="1">
3550 <tr>
3551 <th>Name</th>
3552 <th>Located in</th>
3553 <th>Required</th>
3554 <th>Description</th>
3555 <th>Default</th>
3556 <th>Schema</th>
3557 </tr>
3558
3559
3560
3561<tr>
3562 <th>vspId</th>
3563 <td>path</td>
3564 <td>yes</td>
3565 <td></td>
3566 <td> - </td>
3567
3568
3569 <td>string </td>
3570
3571
3572</tr>
3573
3574<tr>
3575 <th>body</th>
3576 <td>body</td>
3577 <td>no</td>
3578 <td></td>
3579 <td> - </td>
3580
3581 <td>
3582
3583 <a href="#/definitions/VersionSoftwareProductActionRequestDto">VersionSoftwareProductActionRequestDto</a>
3584 </td>
3585
3586</tr>
3587
3588<tr>
3589 <th>USER_ID</th>
3590 <td>header</td>
3591 <td>no</td>
3592 <td></td>
3593 <td> - </td>
3594
3595
3596 <td>string </td>
3597
3598
3599</tr>
3600
3601
3602</table>
3603
3604
3605
3606#### Response
3607
3608**Content-Type: ** application/json
3609
3610
3611| Status Code | Reason | Response Model |
3612|-------------|-------------|----------------|
3613| default | successful operation | - |
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629## /v1.0/vendor-software-products/{vspId}/components
3630
3631
3632### GET
3633
3634<a id="list">List vendor software product components</a>
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644#### Request
3645
3646
3647**Content-Type: ** application/json
3648
3649##### Parameters
3650
3651<table border="1">
3652 <tr>
3653 <th>Name</th>
3654 <th>Located in</th>
3655 <th>Required</th>
3656 <th>Description</th>
3657 <th>Default</th>
3658 <th>Schema</th>
3659 </tr>
3660
3661
3662
3663<tr>
3664 <th>vspId</th>
3665 <td>path</td>
3666 <td>yes</td>
3667 <td>Vendor software product Id</td>
3668 <td> - </td>
3669
3670
3671 <td>string </td>
3672
3673
3674</tr>
3675
3676<tr>
3677 <th>version</th>
3678 <td>query</td>
3679 <td>no</td>
3680 <td></td>
3681 <td> - </td>
3682
3683
3684 <td>string </td>
3685
3686
3687</tr>
3688
3689<tr>
3690 <th>USER_ID</th>
3691 <td>header</td>
3692 <td>no</td>
3693 <td></td>
3694 <td> - </td>
3695
3696
3697 <td>string </td>
3698
3699
3700</tr>
3701
3702
3703</table>
3704
3705
3706
3707#### Response
3708
3709**Content-Type: ** application/json
3710
3711
3712| Status Code | Reason | Response Model |
3713|-------------|-------------|----------------|
3714| 200 | successful operation | Array[<a href="#/definitions/ComponentDto">ComponentDto</a>]|
3715
3716
3717
3718
3719
3720
3721### POST
3722
3723
3724<a id="create">Create a vendor software product component</a>
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734#### Request
3735
3736
3737**Content-Type: ** application/json
3738
3739##### Parameters
3740
3741<table border="1">
3742 <tr>
3743 <th>Name</th>
3744 <th>Located in</th>
3745 <th>Required</th>
3746 <th>Description</th>
3747 <th>Default</th>
3748 <th>Schema</th>
3749 </tr>
3750
3751
3752
3753<tr>
3754 <th>body</th>
3755 <td>body</td>
3756 <td>no</td>
3757 <td></td>
3758 <td> - </td>
3759
3760 <td>
3761
3762 <a href="#/definitions/ComponentRequestDto">ComponentRequestDto</a>
3763 </td>
3764
3765</tr>
3766
3767<tr>
3768 <th>vspId</th>
3769 <td>path</td>
3770 <td>yes</td>
3771 <td>Vendor software product Id</td>
3772 <td> - </td>
3773
3774
3775 <td>string </td>
3776
3777
3778</tr>
3779
3780<tr>
3781 <th>USER_ID</th>
3782 <td>header</td>
3783 <td>no</td>
3784 <td></td>
3785 <td> - </td>
3786
3787
3788 <td>string </td>
3789
3790
3791</tr>
3792
3793
3794</table>
3795
3796
3797
3798#### Response
3799
3800**Content-Type: ** application/json
3801
3802
3803| Status Code | Reason | Response Model |
3804|-------------|-------------|----------------|
3805| default | successful operation | - |
3806
3807
3808
3809
3810
3811### DELETE
3812
3813<a id="deleteList">Delete vendor software product components</a>
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823#### Request
3824
3825
3826**Content-Type: ** application/json
3827
3828##### Parameters
3829
3830<table border="1">
3831 <tr>
3832 <th>Name</th>
3833 <th>Located in</th>
3834 <th>Required</th>
3835 <th>Description</th>
3836 <th>Default</th>
3837 <th>Schema</th>
3838 </tr>
3839
3840
3841
3842<tr>
3843 <th>vspId</th>
3844 <td>path</td>
3845 <td>yes</td>
3846 <td>Vendor software product Id</td>
3847 <td> - </td>
3848
3849
3850 <td>string </td>
3851
3852
3853</tr>
3854
3855<tr>
3856 <th>USER_ID</th>
3857 <td>header</td>
3858 <td>no</td>
3859 <td></td>
3860 <td> - </td>
3861
3862
3863 <td>string </td>
3864
3865
3866</tr>
3867
3868
3869</table>
3870
3871
3872
3873#### Response
3874
3875**Content-Type: ** application/json
3876
3877
3878| Status Code | Reason | Response Model |
3879|-------------|-------------|----------------|
3880| default | successful operation | - |
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892## /v1.0/vendor-software-products/{vspId}/components/{componentId}
3893
3894
3895### GET
3896
3897<a id="get">Get vendor software product component</a>
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907#### Request
3908
3909
3910**Content-Type: ** application/json
3911
3912##### Parameters
3913
3914<table border="1">
3915 <tr>
3916 <th>Name</th>
3917 <th>Located in</th>
3918 <th>Required</th>
3919 <th>Description</th>
3920 <th>Default</th>
3921 <th>Schema</th>
3922 </tr>
3923
3924
3925
3926<tr>
3927 <th>vspId</th>
3928 <td>path</td>
3929 <td>yes</td>
3930 <td>Vendor software product Id</td>
3931 <td> - </td>
3932
3933
3934 <td>string </td>
3935
3936
3937</tr>
3938
3939<tr>
3940 <th>componentId</th>
3941 <td>path</td>
3942 <td>yes</td>
3943 <td>Vendor software product component Id</td>
3944 <td> - </td>
3945
3946
3947 <td>string </td>
3948
3949
3950</tr>
3951
3952<tr>
3953 <th>version</th>
3954 <td>query</td>
3955 <td>no</td>
3956 <td></td>
3957 <td> - </td>
3958
3959
3960 <td>string </td>
3961
3962
3963</tr>
3964
3965<tr>
3966 <th>USER_ID</th>
3967 <td>header</td>
3968 <td>no</td>
3969 <td></td>
3970 <td> - </td>
3971
3972
3973 <td>string </td>
3974
3975
3976</tr>
3977
3978
3979</table>
3980
3981
3982
3983#### Response
3984
3985**Content-Type: ** application/json
3986
3987
3988| Status Code | Reason | Response Model |
3989|-------------|-------------|----------------|
3990| 200 | successful operation | <a href="#/definitions/ComponentData">ComponentData</a>|
3991
3992
3993
3994
3995### PUT
3996
3997<a id="update">Update vendor software product component</a>
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007#### Request
4008
4009
4010**Content-Type: ** application/json
4011
4012##### Parameters
4013
4014<table border="1">
4015 <tr>
4016 <th>Name</th>
4017 <th>Located in</th>
4018 <th>Required</th>
4019 <th>Description</th>
4020 <th>Default</th>
4021 <th>Schema</th>
4022 </tr>
4023
4024
4025
4026<tr>
4027 <th>body</th>
4028 <td>body</td>
4029 <td>no</td>
4030 <td></td>
4031 <td> - </td>
4032
4033 <td>
4034
4035 <a href="#/definitions/ComponentRequestDto">ComponentRequestDto</a>
4036 </td>
4037
4038</tr>
4039
4040<tr>
4041 <th>vspId</th>
4042 <td>path</td>
4043 <td>yes</td>
4044 <td>Vendor software product Id</td>
4045 <td> - </td>
4046
4047
4048 <td>string </td>
4049
4050
4051</tr>
4052
4053<tr>
4054 <th>componentId</th>
4055 <td>path</td>
4056 <td>yes</td>
4057 <td>Vendor software product component Id</td>
4058 <td> - </td>
4059
4060
4061 <td>string </td>
4062
4063
4064</tr>
4065
4066<tr>
4067 <th>USER_ID</th>
4068 <td>header</td>
4069 <td>no</td>
4070 <td></td>
4071 <td> - </td>
4072
4073
4074 <td>string </td>
4075
4076
4077</tr>
4078
4079
4080</table>
4081
4082
4083
4084#### Response
4085
4086**Content-Type: ** application/json
4087
4088
4089| Status Code | Reason | Response Model |
4090|-------------|-------------|----------------|
4091| default | successful operation | - |
4092
4093
4094
4095
4096
4097
4098### DELETE
4099
4100<a id="delete">Delete vendor software product component</a>
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110#### Request
4111
4112
4113**Content-Type: ** application/json
4114
4115##### Parameters
4116
4117<table border="1">
4118 <tr>
4119 <th>Name</th>
4120 <th>Located in</th>
4121 <th>Required</th>
4122 <th>Description</th>
4123 <th>Default</th>
4124 <th>Schema</th>
4125 </tr>
4126
4127
4128
4129<tr>
4130 <th>vspId</th>
4131 <td>path</td>
4132 <td>yes</td>
4133 <td>Vendor software product Id</td>
4134 <td> - </td>
4135
4136
4137 <td>string </td>
4138
4139
4140</tr>
4141
4142<tr>
4143 <th>componentId</th>
4144 <td>path</td>
4145 <td>yes</td>
4146 <td>Vendor software product component Id</td>
4147 <td> - </td>
4148
4149
4150 <td>string </td>
4151
4152
4153</tr>
4154
4155<tr>
4156 <th>USER_ID</th>
4157 <td>header</td>
4158 <td>no</td>
4159 <td></td>
4160 <td> - </td>
4161
4162
4163 <td>string </td>
4164
4165
4166</tr>
4167
4168
4169</table>
4170
4171
4172
4173#### Response
4174
4175**Content-Type: ** application/json
4176
4177
4178| Status Code | Reason | Response Model |
4179|-------------|-------------|----------------|
4180| default | successful operation | - |
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192## /v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp
4193
4194
4195### GET
4196
4197<a id="list">Get the filenames of uploaded MIB definitions</a>
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207#### Request
4208
4209
4210**Content-Type: ** application/json
4211
4212##### Parameters
4213
4214<table border="1">
4215 <tr>
4216 <th>Name</th>
4217 <th>Located in</th>
4218 <th>Required</th>
4219 <th>Description</th>
4220 <th>Default</th>
4221 <th>Schema</th>
4222 </tr>
4223
4224
4225
4226<tr>
4227 <th>vspId</th>
4228 <td>path</td>
4229 <td>yes</td>
4230 <td>Vendor software product Id</td>
4231 <td> - </td>
4232
4233
4234 <td>string </td>
4235
4236
4237</tr>
4238
4239<tr>
4240 <th>componentId</th>
4241 <td>path</td>
4242 <td>yes</td>
4243 <td>Vendor software product component Id</td>
4244 <td> - </td>
4245
4246
4247 <td>string </td>
4248
4249
4250</tr>
4251
4252<tr>
4253 <th>USER_ID</th>
4254 <td>header</td>
4255 <td>no</td>
4256 <td></td>
4257 <td> - </td>
4258
4259
4260 <td>string </td>
4261
4262
4263</tr>
4264
4265
4266</table>
4267
4268
4269
4270#### Response
4271
4272**Content-Type: ** application/json
4273
4274
4275| Status Code | Reason | Response Model |
4276|-------------|-------------|----------------|
4277| 200 | successful operation | <a href="#/definitions/MibUploadStatusDto">MibUploadStatusDto</a>|
4278
4279
4280
4281
4282
4283
4284
4285
4286### DELETE
4287
4288<a id="deletePollMibFile">Delete vendor software product MIB Poll Definitions file</a>
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298#### Request
4299
4300
4301**Content-Type: ** application/json
4302
4303##### Parameters
4304
4305<table border="1">
4306 <tr>
4307 <th>Name</th>
4308 <th>Located in</th>
4309 <th>Required</th>
4310 <th>Description</th>
4311 <th>Default</th>
4312 <th>Schema</th>
4313 </tr>
4314
4315
4316
4317<tr>
4318 <th>vspId</th>
4319 <td>path</td>
4320 <td>yes</td>
4321 <td>Vendor software product Id</td>
4322 <td> - </td>
4323
4324
4325 <td>string </td>
4326
4327
4328</tr>
4329
4330<tr>
4331 <th>componentId</th>
4332 <td>path</td>
4333 <td>yes</td>
4334 <td>Vendor software product component Id</td>
4335 <td> - </td>
4336
4337
4338 <td>string </td>
4339
4340
4341</tr>
4342
4343<tr>
4344 <th>USER_ID</th>
4345 <td>header</td>
4346 <td>no</td>
4347 <td></td>
4348 <td> - </td>
4349
4350
4351 <td>string </td>
4352
4353
4354</tr>
4355
4356
4357</table>
4358
4359
4360
4361#### Response
4362
4363**Content-Type: ** application/json
4364
4365
4366| Status Code | Reason | Response Model |
4367|-------------|-------------|----------------|
4368| default | successful operation | - |
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380## /v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp-trap
4381
4382
4383
4384
4385
4386
4387
4388
4389### DELETE
4390
4391<a id="deleteTrapMibFile">Delete vendor software product MIB Trap Definitions file</a>
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401#### Request
4402
4403
4404**Content-Type: ** application/json
4405
4406##### Parameters
4407
4408<table border="1">
4409 <tr>
4410 <th>Name</th>
4411 <th>Located in</th>
4412 <th>Required</th>
4413 <th>Description</th>
4414 <th>Default</th>
4415 <th>Schema</th>
4416 </tr>
4417
4418
4419
4420<tr>
4421 <th>vspId</th>
4422 <td>path</td>
4423 <td>yes</td>
4424 <td>Vendor software product Id</td>
4425 <td> - </td>
4426
4427
4428 <td>string </td>
4429
4430
4431</tr>
4432
4433<tr>
4434 <th>componentId</th>
4435 <td>path</td>
4436 <td>yes</td>
4437 <td>Vendor software product component Id</td>
4438 <td> - </td>
4439
4440
4441 <td>string </td>
4442
4443
4444</tr>
4445
4446<tr>
4447 <th>USER_ID</th>
4448 <td>header</td>
4449 <td>no</td>
4450 <td></td>
4451 <td> - </td>
4452
4453
4454 <td>string </td>
4455
4456
4457</tr>
4458
4459
4460</table>
4461
4462
4463
4464#### Response
4465
4466**Content-Type: ** application/json
4467
4468
4469| Status Code | Reason | Response Model |
4470|-------------|-------------|----------------|
4471| default | successful operation | - |
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483## /v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp-trap/upload
4484
4485
4486
4487
4488
4489
4490### POST
4491
4492
4493<a id="uploadTrapMibFile">Upload vendor software product MIB Trap Definitions file</a>
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503#### Request
4504
4505
4506**Content-Type: ** multipart/form-data
4507
4508##### Parameters
4509
4510<table border="1">
4511 <tr>
4512 <th>Name</th>
4513 <th>Located in</th>
4514 <th>Required</th>
4515 <th>Description</th>
4516 <th>Default</th>
4517 <th>Schema</th>
4518 </tr>
4519
4520
4521
4522<tr>
4523 <th>body</th>
4524 <td>body</td>
4525 <td>no</td>
4526 <td></td>
4527 <td> - </td>
4528
4529 <td>
4530
4531 <a href="#/definitions/Attachment">Attachment</a>
4532 </td>
4533
4534</tr>
4535
4536<tr>
4537 <th>vspId</th>
4538 <td>path</td>
4539 <td>yes</td>
4540 <td>Vendor software product Id</td>
4541 <td> - </td>
4542
4543
4544 <td>string </td>
4545
4546
4547</tr>
4548
4549<tr>
4550 <th>componentId</th>
4551 <td>path</td>
4552 <td>yes</td>
4553 <td>Vendor software product component Id</td>
4554 <td> - </td>
4555
4556
4557 <td>string </td>
4558
4559
4560</tr>
4561
4562<tr>
4563 <th>USER_ID</th>
4564 <td>header</td>
4565 <td>no</td>
4566 <td></td>
4567 <td> - </td>
4568
4569
4570 <td>string </td>
4571
4572
4573</tr>
4574
4575
4576</table>
4577
4578
4579
4580#### Response
4581
4582**Content-Type: ** application/json
4583
4584
4585| Status Code | Reason | Response Model |
4586|-------------|-------------|----------------|
4587| default | successful operation | - |
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602## /v1.0/vendor-software-products/{vspId}/components/{componentId}/monitors/snmp/upload
4603
4604
4605
4606
4607
4608
4609### POST
4610
4611
4612<a id="uploadPollMibFile">Upload vendor software product MIB Poll Definitions file</a>
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622#### Request
4623
4624
4625**Content-Type: ** multipart/form-data
4626
4627##### Parameters
4628
4629<table border="1">
4630 <tr>
4631 <th>Name</th>
4632 <th>Located in</th>
4633 <th>Required</th>
4634 <th>Description</th>
4635 <th>Default</th>
4636 <th>Schema</th>
4637 </tr>
4638
4639
4640
4641<tr>
4642 <th>body</th>
4643 <td>body</td>
4644 <td>no</td>
4645 <td></td>
4646 <td> - </td>
4647
4648 <td>
4649
4650 <a href="#/definitions/Attachment">Attachment</a>
4651 </td>
4652
4653</tr>
4654
4655<tr>
4656 <th>vspId</th>
4657 <td>path</td>
4658 <td>yes</td>
4659 <td>Vendor software product Id</td>
4660 <td> - </td>
4661
4662
4663 <td>string </td>
4664
4665
4666</tr>
4667
4668<tr>
4669 <th>componentId</th>
4670 <td>path</td>
4671 <td>yes</td>
4672 <td>Vendor software product component Id</td>
4673 <td> - </td>
4674
4675
4676 <td>string </td>
4677
4678
4679</tr>
4680
4681<tr>
4682 <th>USER_ID</th>
4683 <td>header</td>
4684 <td>no</td>
4685 <td></td>
4686 <td> - </td>
4687
4688
4689 <td>string </td>
4690
4691
4692</tr>
4693
4694
4695</table>
4696
4697
4698
4699#### Response
4700
4701**Content-Type: ** application/json
4702
4703
4704| Status Code | Reason | Response Model |
4705|-------------|-------------|----------------|
4706| default | successful operation | - |
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721## /v1.0/vendor-software-products/{vspId}/components/{componentId}/nics
4722
4723
4724### GET
4725
4726<a id="list">List vendor software product component NICs</a>
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736#### Request
4737
4738
4739**Content-Type: ** application/json
4740
4741##### Parameters
4742
4743<table border="1">
4744 <tr>
4745 <th>Name</th>
4746 <th>Located in</th>
4747 <th>Required</th>
4748 <th>Description</th>
4749 <th>Default</th>
4750 <th>Schema</th>
4751 </tr>
4752
4753
4754
4755<tr>
4756 <th>vspId</th>
4757 <td>path</td>
4758 <td>yes</td>
4759 <td>Vendor software product Id</td>
4760 <td> - </td>
4761
4762
4763 <td>string </td>
4764
4765
4766</tr>
4767
4768<tr>
4769 <th>componentId</th>
4770 <td>path</td>
4771 <td>yes</td>
4772 <td>Vendor software product component Id</td>
4773 <td> - </td>
4774
4775
4776 <td>string </td>
4777
4778
4779</tr>
4780
4781<tr>
4782 <th>version</th>
4783 <td>query</td>
4784 <td>no</td>
4785 <td></td>
4786 <td> - </td>
4787
4788
4789 <td>string </td>
4790
4791
4792</tr>
4793
4794<tr>
4795 <th>USER_ID</th>
4796 <td>header</td>
4797 <td>no</td>
4798 <td></td>
4799 <td> - </td>
4800
4801
4802 <td>string </td>
4803
4804
4805</tr>
4806
4807
4808</table>
4809
4810
4811
4812#### Response
4813
4814**Content-Type: ** application/json
4815
4816
4817| Status Code | Reason | Response Model |
4818|-------------|-------------|----------------|
4819| 200 | successful operation | Array[<a href="#/definitions/NicDto">NicDto</a>]|
4820
4821
4822
4823
4824
4825
4826### POST
4827
4828
4829<a id="create">Create a vendor software product NIC</a>
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839#### Request
4840
4841
4842**Content-Type: ** application/json
4843
4844##### Parameters
4845
4846<table border="1">
4847 <tr>
4848 <th>Name</th>
4849 <th>Located in</th>
4850 <th>Required</th>
4851 <th>Description</th>
4852 <th>Default</th>
4853 <th>Schema</th>
4854 </tr>
4855
4856
4857
4858<tr>
4859 <th>body</th>
4860 <td>body</td>
4861 <td>no</td>
4862 <td></td>
4863 <td> - </td>
4864
4865 <td>
4866
4867 <a href="#/definitions/NicRequestDto">NicRequestDto</a>
4868 </td>
4869
4870</tr>
4871
4872<tr>
4873 <th>vspId</th>
4874 <td>path</td>
4875 <td>yes</td>
4876 <td>Vendor software product Id</td>
4877 <td> - </td>
4878
4879
4880 <td>string </td>
4881
4882
4883</tr>
4884
4885<tr>
4886 <th>componentId</th>
4887 <td>path</td>
4888 <td>yes</td>
4889 <td>Vendor software product component Id</td>
4890 <td> - </td>
4891
4892
4893 <td>string </td>
4894
4895
4896</tr>
4897
4898<tr>
4899 <th>USER_ID</th>
4900 <td>header</td>
4901 <td>no</td>
4902 <td></td>
4903 <td> - </td>
4904
4905
4906 <td>string </td>
4907
4908
4909</tr>
4910
4911
4912</table>
4913
4914
4915
4916#### Response
4917
4918**Content-Type: ** application/json
4919
4920
4921| Status Code | Reason | Response Model |
4922|-------------|-------------|----------------|
4923| default | successful operation | - |
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938## /v1.0/vendor-software-products/{vspId}/components/{componentId}/nics/{nicId}
4939
4940
4941### GET
4942
4943<a id="get">Get vendor software product NIC</a>
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953#### Request
4954
4955
4956**Content-Type: ** application/json
4957
4958##### Parameters
4959
4960<table border="1">
4961 <tr>
4962 <th>Name</th>
4963 <th>Located in</th>
4964 <th>Required</th>
4965 <th>Description</th>
4966 <th>Default</th>
4967 <th>Schema</th>
4968 </tr>
4969
4970
4971
4972<tr>
4973 <th>vspId</th>
4974 <td>path</td>
4975 <td>yes</td>
4976 <td>Vendor software product Id</td>
4977 <td> - </td>
4978
4979
4980 <td>string </td>
4981
4982
4983</tr>
4984
4985<tr>
4986 <th>componentId</th>
4987 <td>path</td>
4988 <td>yes</td>
4989 <td>Vendor software product component Id</td>
4990 <td> - </td>
4991
4992
4993 <td>string </td>
4994
4995
4996</tr>
4997
4998<tr>
4999 <th>nicId</th>
5000 <td>path</td>
5001 <td>yes</td>
5002 <td>Vendor software product NIC Id</td>
5003 <td> - </td>
5004
5005
5006 <td>string </td>
5007
5008
5009</tr>
5010
5011<tr>
5012 <th>version</th>
5013 <td>query</td>
5014 <td>no</td>
5015 <td></td>
5016 <td> - </td>
5017
5018
5019 <td>string </td>
5020
5021
5022</tr>
5023
5024<tr>
5025 <th>USER_ID</th>
5026 <td>header</td>
5027 <td>no</td>
5028 <td></td>
5029 <td> - </td>
5030
5031
5032 <td>string </td>
5033
5034
5035</tr>
5036
5037
5038</table>
5039
5040
5041
5042#### Response
5043
5044**Content-Type: ** application/json
5045
5046
5047| Status Code | Reason | Response Model |
5048|-------------|-------------|----------------|
5049| 200 | successful operation | <a href="#/definitions/NicDto">NicDto</a>|
5050
5051
5052
5053
5054### PUT
5055
5056<a id="update">Update vendor software product NIC</a>
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066#### Request
5067
5068
5069**Content-Type: ** application/json
5070
5071##### Parameters
5072
5073<table border="1">
5074 <tr>
5075 <th>Name</th>
5076 <th>Located in</th>
5077 <th>Required</th>
5078 <th>Description</th>
5079 <th>Default</th>
5080 <th>Schema</th>
5081 </tr>
5082
5083
5084
5085<tr>
5086 <th>body</th>
5087 <td>body</td>
5088 <td>no</td>
5089 <td></td>
5090 <td> - </td>
5091
5092 <td>
5093
5094 <a href="#/definitions/NicRequestDto">NicRequestDto</a>
5095 </td>
5096
5097</tr>
5098
5099<tr>
5100 <th>vspId</th>
5101 <td>path</td>
5102 <td>yes</td>
5103 <td>Vendor software product Id</td>
5104 <td> - </td>
5105
5106
5107 <td>string </td>
5108
5109
5110</tr>
5111
5112<tr>
5113 <th>componentId</th>
5114 <td>path</td>
5115 <td>yes</td>
5116 <td>Vendor software product component Id</td>
5117 <td> - </td>
5118
5119
5120 <td>string </td>
5121
5122
5123</tr>
5124
5125<tr>
5126 <th>nicId</th>
5127 <td>path</td>
5128 <td>yes</td>
5129 <td>Vendor software product NIC Id</td>
5130 <td> - </td>
5131
5132
5133 <td>string </td>
5134
5135
5136</tr>
5137
5138<tr>
5139 <th>USER_ID</th>
5140 <td>header</td>
5141 <td>no</td>
5142 <td></td>
5143 <td> - </td>
5144
5145
5146 <td>string </td>
5147
5148
5149</tr>
5150
5151
5152</table>
5153
5154
5155
5156#### Response
5157
5158**Content-Type: ** application/json
5159
5160
5161| Status Code | Reason | Response Model |
5162|-------------|-------------|----------------|
5163| default | successful operation | - |
5164
5165
5166
5167
5168
5169
5170### DELETE
5171
5172<a id="delete">Delete vendor software product NIC</a>
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182#### Request
5183
5184
5185**Content-Type: ** application/json
5186
5187##### Parameters
5188
5189<table border="1">
5190 <tr>
5191 <th>Name</th>
5192 <th>Located in</th>
5193 <th>Required</th>
5194 <th>Description</th>
5195 <th>Default</th>
5196 <th>Schema</th>
5197 </tr>
5198
5199
5200
5201<tr>
5202 <th>vspId</th>
5203 <td>path</td>
5204 <td>yes</td>
5205 <td>Vendor software product Id</td>
5206 <td> - </td>
5207
5208
5209 <td>string </td>
5210
5211
5212</tr>
5213
5214<tr>
5215 <th>componentId</th>
5216 <td>path</td>
5217 <td>yes</td>
5218 <td>Vendor software product component Id</td>
5219 <td> - </td>
5220
5221
5222 <td>string </td>
5223
5224
5225</tr>
5226
5227<tr>
5228 <th>nicId</th>
5229 <td>path</td>
5230 <td>yes</td>
5231 <td>Vendor software product NIC Id</td>
5232 <td> - </td>
5233
5234
5235 <td>string </td>
5236
5237
5238</tr>
5239
5240<tr>
5241 <th>USER_ID</th>
5242 <td>header</td>
5243 <td>no</td>
5244 <td></td>
5245 <td> - </td>
5246
5247
5248 <td>string </td>
5249
5250
5251</tr>
5252
5253
5254</table>
5255
5256
5257
5258#### Response
5259
5260**Content-Type: ** application/json
5261
5262
5263| Status Code | Reason | Response Model |
5264|-------------|-------------|----------------|
5265| default | successful operation | - |
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277## /v1.0/vendor-software-products/{vspId}/components/{componentId}/nics/{nicId}/questionnaire
5278
5279
5280### GET
5281
5282<a id="getQuestionnaire">Get vendor software product component NIC questionnaire</a>
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292#### Request
5293
5294
5295**Content-Type: ** application/json
5296
5297##### Parameters
5298
5299<table border="1">
5300 <tr>
5301 <th>Name</th>
5302 <th>Located in</th>
5303 <th>Required</th>
5304 <th>Description</th>
5305 <th>Default</th>
5306 <th>Schema</th>
5307 </tr>
5308
5309
5310
5311<tr>
5312 <th>vspId</th>
5313 <td>path</td>
5314 <td>yes</td>
5315 <td>Vendor software product Id</td>
5316 <td> - </td>
5317
5318
5319 <td>string </td>
5320
5321
5322</tr>
5323
5324<tr>
5325 <th>componentId</th>
5326 <td>path</td>
5327 <td>yes</td>
5328 <td>Vendor software product component Id</td>
5329 <td> - </td>
5330
5331
5332 <td>string </td>
5333
5334
5335</tr>
5336
5337<tr>
5338 <th>nicId</th>
5339 <td>path</td>
5340 <td>yes</td>
5341 <td>Vendor software product NIC Id</td>
5342 <td> - </td>
5343
5344
5345 <td>string </td>
5346
5347
5348</tr>
5349
5350<tr>
5351 <th>version</th>
5352 <td>query</td>
5353 <td>no</td>
5354 <td></td>
5355 <td> - </td>
5356
5357
5358 <td>string </td>
5359
5360
5361</tr>
5362
5363<tr>
5364 <th>USER_ID</th>
5365 <td>header</td>
5366 <td>no</td>
5367 <td></td>
5368 <td> - </td>
5369
5370
5371 <td>string </td>
5372
5373
5374</tr>
5375
5376
5377</table>
5378
5379
5380
5381#### Response
5382
5383**Content-Type: ** application/json
5384
5385
5386| Status Code | Reason | Response Model |
5387|-------------|-------------|----------------|
5388| 200 | successful operation | <a href="#/definitions/QuestionnaireResponseDto">QuestionnaireResponseDto</a>|
5389
5390
5391
5392
5393### PUT
5394
5395<a id="updateQuestionnaire">Update vendor software product component NIC questionnaire</a>
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405#### Request
5406
5407
5408**Content-Type: ** application/json
5409
5410##### Parameters
5411
5412<table border="1">
5413 <tr>
5414 <th>Name</th>
5415 <th>Located in</th>
5416 <th>Required</th>
5417 <th>Description</th>
5418 <th>Default</th>
5419 <th>Schema</th>
5420 </tr>
5421
5422
5423
5424<tr>
5425 <th>body</th>
5426 <td>body</td>
5427 <td>no</td>
5428 <td></td>
5429 <td> - </td>
5430
5431 <td>
5432
5433
5434 </td>
5435
5436</tr>
5437
5438<tr>
5439 <th>vspId</th>
5440 <td>path</td>
5441 <td>yes</td>
5442 <td>Vendor software product Id</td>
5443 <td> - </td>
5444
5445
5446 <td>string </td>
5447
5448
5449</tr>
5450
5451<tr>
5452 <th>componentId</th>
5453 <td>path</td>
5454 <td>yes</td>
5455 <td>Vendor software product component Id</td>
5456 <td> - </td>
5457
5458
5459 <td>string </td>
5460
5461
5462</tr>
5463
5464<tr>
5465 <th>nicId</th>
5466 <td>path</td>
5467 <td>yes</td>
5468 <td>Vendor software product NIC Id</td>
5469 <td> - </td>
5470
5471
5472 <td>string </td>
5473
5474
5475</tr>
5476
5477<tr>
5478 <th>USER_ID</th>
5479 <td>header</td>
5480 <td>no</td>
5481 <td></td>
5482 <td> - </td>
5483
5484
5485 <td>string </td>
5486
5487
5488</tr>
5489
5490
5491</table>
5492
5493
5494
5495#### Response
5496
5497**Content-Type: ** application/json
5498
5499
5500| Status Code | Reason | Response Model |
5501|-------------|-------------|----------------|
5502| default | successful operation | - |
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518## /v1.0/vendor-software-products/{vspId}/components/{componentId}/processes
5519
5520
5521### GET
5522
5523<a id="list">List vendor software product component processes</a>
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533#### Request
5534
5535
5536**Content-Type: ** application/json
5537
5538##### Parameters
5539
5540<table border="1">
5541 <tr>
5542 <th>Name</th>
5543 <th>Located in</th>
5544 <th>Required</th>
5545 <th>Description</th>
5546 <th>Default</th>
5547 <th>Schema</th>
5548 </tr>
5549
5550
5551
5552<tr>
5553 <th>vspId</th>
5554 <td>path</td>
5555 <td>yes</td>
5556 <td>Vendor software product Id</td>
5557 <td> - </td>
5558
5559
5560 <td>string </td>
5561
5562
5563</tr>
5564
5565<tr>
5566 <th>componentId</th>
5567 <td>path</td>
5568 <td>yes</td>
5569 <td>Vendor software product component Id</td>
5570 <td> - </td>
5571
5572
5573 <td>string </td>
5574
5575
5576</tr>
5577
5578<tr>
5579 <th>version</th>
5580 <td>query</td>
5581 <td>no</td>
5582 <td></td>
5583 <td> - </td>
5584
5585
5586 <td>string </td>
5587
5588
5589</tr>
5590
5591<tr>
5592 <th>USER_ID</th>
5593 <td>header</td>
5594 <td>no</td>
5595 <td></td>
5596 <td> - </td>
5597
5598
5599 <td>string </td>
5600
5601
5602</tr>
5603
5604
5605</table>
5606
5607
5608
5609#### Response
5610
5611**Content-Type: ** application/json
5612
5613
5614| Status Code | Reason | Response Model |
5615|-------------|-------------|----------------|
5616| 200 | successful operation | Array[<a href="#/definitions/ProcessEntityDto">ProcessEntityDto</a>]|
5617
5618
5619
5620
5621
5622
5623### POST
5624
5625
5626<a id="create">Create a vendor software product process</a>
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636#### Request
5637
5638
5639**Content-Type: ** application/json
5640
5641##### Parameters
5642
5643<table border="1">
5644 <tr>
5645 <th>Name</th>
5646 <th>Located in</th>
5647 <th>Required</th>
5648 <th>Description</th>
5649 <th>Default</th>
5650 <th>Schema</th>
5651 </tr>
5652
5653
5654
5655<tr>
5656 <th>body</th>
5657 <td>body</td>
5658 <td>no</td>
5659 <td></td>
5660 <td> - </td>
5661
5662 <td>
5663
5664 <a href="#/definitions/ProcessRequestDto">ProcessRequestDto</a>
5665 </td>
5666
5667</tr>
5668
5669<tr>
5670 <th>vspId</th>
5671 <td>path</td>
5672 <td>yes</td>
5673 <td>Vendor software product Id</td>
5674 <td> - </td>
5675
5676
5677 <td>string </td>
5678
5679
5680</tr>
5681
5682<tr>
5683 <th>componentId</th>
5684 <td>path</td>
5685 <td>yes</td>
5686 <td>Vendor software product component Id</td>
5687 <td> - </td>
5688
5689
5690 <td>string </td>
5691
5692
5693</tr>
5694
5695<tr>
5696 <th>USER_ID</th>
5697 <td>header</td>
5698 <td>no</td>
5699 <td></td>
5700 <td> - </td>
5701
5702
5703 <td>string </td>
5704
5705
5706</tr>
5707
5708
5709</table>
5710
5711
5712
5713#### Response
5714
5715**Content-Type: ** application/json
5716
5717
5718| Status Code | Reason | Response Model |
5719|-------------|-------------|----------------|
5720| default | successful operation | - |
5721
5722
5723
5724
5725
5726### DELETE
5727
5728<a id="deleteList">Delete vendor software product processes</a>
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738#### Request
5739
5740
5741**Content-Type: ** application/json
5742
5743##### Parameters
5744
5745<table border="1">
5746 <tr>
5747 <th>Name</th>
5748 <th>Located in</th>
5749 <th>Required</th>
5750 <th>Description</th>
5751 <th>Default</th>
5752 <th>Schema</th>
5753 </tr>
5754
5755
5756
5757<tr>
5758 <th>vspId</th>
5759 <td>path</td>
5760 <td>yes</td>
5761 <td>Vendor software product Id</td>
5762 <td> - </td>
5763
5764
5765 <td>string </td>
5766
5767
5768</tr>
5769
5770<tr>
5771 <th>componentId</th>
5772 <td>path</td>
5773 <td>yes</td>
5774 <td>Vendor software product component Id</td>
5775 <td> - </td>
5776
5777
5778 <td>string </td>
5779
5780
5781</tr>
5782
5783<tr>
5784 <th>USER_ID</th>
5785 <td>header</td>
5786 <td>no</td>
5787 <td></td>
5788 <td> - </td>
5789
5790
5791 <td>string </td>
5792
5793
5794</tr>
5795
5796
5797</table>
5798
5799
5800
5801#### Response
5802
5803**Content-Type: ** application/json
5804
5805
5806| Status Code | Reason | Response Model |
5807|-------------|-------------|----------------|
5808| default | successful operation | - |
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820## /v1.0/vendor-software-products/{vspId}/components/{componentId}/processes/{processId}
5821
5822
5823### GET
5824
5825<a id="get">Get vendor software product process</a>
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835#### Request
5836
5837
5838**Content-Type: ** application/json
5839
5840##### Parameters
5841
5842<table border="1">
5843 <tr>
5844 <th>Name</th>
5845 <th>Located in</th>
5846 <th>Required</th>
5847 <th>Description</th>
5848 <th>Default</th>
5849 <th>Schema</th>
5850 </tr>
5851
5852
5853
5854<tr>
5855 <th>vspId</th>
5856 <td>path</td>
5857 <td>yes</td>
5858 <td>Vendor software product Id</td>
5859 <td> - </td>
5860
5861
5862 <td>string </td>
5863
5864
5865</tr>
5866
5867<tr>
5868 <th>componentId</th>
5869 <td>path</td>
5870 <td>yes</td>
5871 <td>Vendor software product component Id</td>
5872 <td> - </td>
5873
5874
5875 <td>string </td>
5876
5877
5878</tr>
5879
5880<tr>
5881 <th>processId</th>
5882 <td>path</td>
5883 <td>yes</td>
5884 <td>Vendor software product process Id</td>
5885 <td> - </td>
5886
5887
5888 <td>string </td>
5889
5890
5891</tr>
5892
5893<tr>
5894 <th>version</th>
5895 <td>query</td>
5896 <td>no</td>
5897 <td></td>
5898 <td> - </td>
5899
5900
5901 <td>string </td>
5902
5903
5904</tr>
5905
5906<tr>
5907 <th>USER_ID</th>
5908 <td>header</td>
5909 <td>no</td>
5910 <td></td>
5911 <td> - </td>
5912
5913
5914 <td>string </td>
5915
5916
5917</tr>
5918
5919
5920</table>
5921
5922
5923
5924#### Response
5925
5926**Content-Type: ** application/json
5927
5928
5929| Status Code | Reason | Response Model |
5930|-------------|-------------|----------------|
5931| 200 | successful operation | <a href="#/definitions/ProcessEntityDto">ProcessEntityDto</a>|
5932
5933
5934
5935
5936### PUT
5937
5938<a id="update">Update vendor software product process</a>
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948#### Request
5949
5950
5951**Content-Type: ** application/json
5952
5953##### Parameters
5954
5955<table border="1">
5956 <tr>
5957 <th>Name</th>
5958 <th>Located in</th>
5959 <th>Required</th>
5960 <th>Description</th>
5961 <th>Default</th>
5962 <th>Schema</th>
5963 </tr>
5964
5965
5966
5967<tr>
5968 <th>body</th>
5969 <td>body</td>
5970 <td>no</td>
5971 <td></td>
5972 <td> - </td>
5973
5974 <td>
5975
5976 <a href="#/definitions/ProcessRequestDto">ProcessRequestDto</a>
5977 </td>
5978
5979</tr>
5980
5981<tr>
5982 <th>vspId</th>
5983 <td>path</td>
5984 <td>yes</td>
5985 <td>Vendor software product Id</td>
5986 <td> - </td>
5987
5988
5989 <td>string </td>
5990
5991
5992</tr>
5993
5994<tr>
5995 <th>componentId</th>
5996 <td>path</td>
5997 <td>yes</td>
5998 <td>Vendor software product component Id</td>
5999 <td> - </td>
6000
6001
6002 <td>string </td>
6003
6004
6005</tr>
6006
6007<tr>
6008 <th>processId</th>
6009 <td>path</td>
6010 <td>yes</td>
6011 <td>Vendor software product process Id</td>
6012 <td> - </td>
6013
6014
6015 <td>string </td>
6016
6017
6018</tr>
6019
6020<tr>
6021 <th>USER_ID</th>
6022 <td>header</td>
6023 <td>no</td>
6024 <td></td>
6025 <td> - </td>
6026
6027
6028 <td>string </td>
6029
6030
6031</tr>
6032
6033
6034</table>
6035
6036
6037
6038#### Response
6039
6040**Content-Type: ** application/json
6041
6042
6043| Status Code | Reason | Response Model |
6044|-------------|-------------|----------------|
6045| default | successful operation | - |
6046
6047
6048
6049
6050
6051
6052### DELETE
6053
6054<a id="delete">Delete vendor software product process</a>
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064#### Request
6065
6066
6067**Content-Type: ** application/json
6068
6069##### Parameters
6070
6071<table border="1">
6072 <tr>
6073 <th>Name</th>
6074 <th>Located in</th>
6075 <th>Required</th>
6076 <th>Description</th>
6077 <th>Default</th>
6078 <th>Schema</th>
6079 </tr>
6080
6081
6082
6083<tr>
6084 <th>vspId</th>
6085 <td>path</td>
6086 <td>yes</td>
6087 <td>Vendor software product Id</td>
6088 <td> - </td>
6089
6090
6091 <td>string </td>
6092
6093
6094</tr>
6095
6096<tr>
6097 <th>componentId</th>
6098 <td>path</td>
6099 <td>yes</td>
6100 <td>Vendor software product component Id</td>
6101 <td> - </td>
6102
6103
6104 <td>string </td>
6105
6106
6107</tr>
6108
6109<tr>
6110 <th>processId</th>
6111 <td>path</td>
6112 <td>yes</td>
6113 <td>Vendor software product process Id</td>
6114 <td> - </td>
6115
6116
6117 <td>string </td>
6118
6119
6120</tr>
6121
6122<tr>
6123 <th>USER_ID</th>
6124 <td>header</td>
6125 <td>no</td>
6126 <td></td>
6127 <td> - </td>
6128
6129
6130 <td>string </td>
6131
6132
6133</tr>
6134
6135
6136</table>
6137
6138
6139
6140#### Response
6141
6142**Content-Type: ** application/json
6143
6144
6145| Status Code | Reason | Response Model |
6146|-------------|-------------|----------------|
6147| default | successful operation | - |
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159## /v1.0/vendor-software-products/{vspId}/components/{componentId}/processes/{processId}/upload
6160
6161
6162### GET
6163
6164<a id="getUploadedFile">Get vendor software product process uploaded file</a>
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174#### Request
6175
6176
6177**Content-Type: ** application/json
6178
6179##### Parameters
6180
6181<table border="1">
6182 <tr>
6183 <th>Name</th>
6184 <th>Located in</th>
6185 <th>Required</th>
6186 <th>Description</th>
6187 <th>Default</th>
6188 <th>Schema</th>
6189 </tr>
6190
6191
6192
6193<tr>
6194 <th>vspId</th>
6195 <td>path</td>
6196 <td>yes</td>
6197 <td>Vendor software product Id</td>
6198 <td> - </td>
6199
6200
6201 <td>string </td>
6202
6203
6204</tr>
6205
6206<tr>
6207 <th>componentId</th>
6208 <td>path</td>
6209 <td>yes</td>
6210 <td>Vendor software product component Id</td>
6211 <td> - </td>
6212
6213
6214 <td>string </td>
6215
6216
6217</tr>
6218
6219<tr>
6220 <th>processId</th>
6221 <td>path</td>
6222 <td>yes</td>
6223 <td>Vendor software product process Id</td>
6224 <td> - </td>
6225
6226
6227 <td>string </td>
6228
6229
6230</tr>
6231
6232<tr>
6233 <th>version</th>
6234 <td>query</td>
6235 <td>no</td>
6236 <td></td>
6237 <td> - </td>
6238
6239
6240 <td>string </td>
6241
6242
6243</tr>
6244
6245<tr>
6246 <th>USER_ID</th>
6247 <td>header</td>
6248 <td>no</td>
6249 <td></td>
6250 <td> - </td>
6251
6252
6253 <td>string </td>
6254
6255
6256</tr>
6257
6258
6259</table>
6260
6261
6262
6263#### Response
6264
6265**Content-Type: ** application/octet-stream
6266
6267
6268| Status Code | Reason | Response Model |
6269|-------------|-------------|----------------|
6270| default | successful operation | - |
6271
6272
6273
6274
6275
6276
6277### POST
6278
6279
6280<a id="uploadFile">Update vendor software product process upload</a>
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290#### Request
6291
6292
6293**Content-Type: ** multipart/form-data
6294
6295##### Parameters
6296
6297<table border="1">
6298 <tr>
6299 <th>Name</th>
6300 <th>Located in</th>
6301 <th>Required</th>
6302 <th>Description</th>
6303 <th>Default</th>
6304 <th>Schema</th>
6305 </tr>
6306
6307
6308
6309<tr>
6310 <th>body</th>
6311 <td>body</td>
6312 <td>no</td>
6313 <td></td>
6314 <td> - </td>
6315
6316 <td>
6317
6318 <a href="#/definitions/Attachment">Attachment</a>
6319 </td>
6320
6321</tr>
6322
6323<tr>
6324 <th>vspId</th>
6325 <td>path</td>
6326 <td>yes</td>
6327 <td>Vendor software product Id</td>
6328 <td> - </td>
6329
6330
6331 <td>string </td>
6332
6333
6334</tr>
6335
6336<tr>
6337 <th>componentId</th>
6338 <td>path</td>
6339 <td>yes</td>
6340 <td>Vendor software product component Id</td>
6341 <td> - </td>
6342
6343
6344 <td>string </td>
6345
6346
6347</tr>
6348
6349<tr>
6350 <th>processId</th>
6351 <td>path</td>
6352 <td>yes</td>
6353 <td>Vendor software product process Id</td>
6354 <td> - </td>
6355
6356
6357 <td>string </td>
6358
6359
6360</tr>
6361
6362<tr>
6363 <th>USER_ID</th>
6364 <td>header</td>
6365 <td>no</td>
6366 <td></td>
6367 <td> - </td>
6368
6369
6370 <td>string </td>
6371
6372
6373</tr>
6374
6375
6376</table>
6377
6378
6379
6380#### Response
6381
6382**Content-Type: ** application/json
6383
6384
6385| Status Code | Reason | Response Model |
6386|-------------|-------------|----------------|
6387| default | successful operation | - |
6388
6389
6390
6391
6392
6393### DELETE
6394
6395<a id="deleteUploadedFile">Delete vendor software product process uploaded file</a>
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405#### Request
6406
6407
6408**Content-Type: ** application/json
6409
6410##### Parameters
6411
6412<table border="1">
6413 <tr>
6414 <th>Name</th>
6415 <th>Located in</th>
6416 <th>Required</th>
6417 <th>Description</th>
6418 <th>Default</th>
6419 <th>Schema</th>
6420 </tr>
6421
6422
6423
6424<tr>
6425 <th>vspId</th>
6426 <td>path</td>
6427 <td>yes</td>
6428 <td>Vendor software product Id</td>
6429 <td> - </td>
6430
6431
6432 <td>string </td>
6433
6434
6435</tr>
6436
6437<tr>
6438 <th>componentId</th>
6439 <td>path</td>
6440 <td>yes</td>
6441 <td>Vendor software product component Id</td>
6442 <td> - </td>
6443
6444
6445 <td>string </td>
6446
6447
6448</tr>
6449
6450<tr>
6451 <th>processId</th>
6452 <td>path</td>
6453 <td>yes</td>
6454 <td>Vendor software product process Id</td>
6455 <td> - </td>
6456
6457
6458 <td>string </td>
6459
6460
6461</tr>
6462
6463<tr>
6464 <th>USER_ID</th>
6465 <td>header</td>
6466 <td>no</td>
6467 <td></td>
6468 <td> - </td>
6469
6470
6471 <td>string </td>
6472
6473
6474</tr>
6475
6476
6477</table>
6478
6479
6480
6481#### Response
6482
6483**Content-Type: ** application/json
6484
6485
6486| Status Code | Reason | Response Model |
6487|-------------|-------------|----------------|
6488| default | successful operation | - |
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500## /v1.0/vendor-software-products/{vspId}/components/{componentId}/questionnaire
6501
6502
6503### GET
6504
6505<a id="getQuestionnaire">Get vendor software product component questionnaire</a>
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515#### Request
6516
6517
6518**Content-Type: ** application/json
6519
6520##### Parameters
6521
6522<table border="1">
6523 <tr>
6524 <th>Name</th>
6525 <th>Located in</th>
6526 <th>Required</th>
6527 <th>Description</th>
6528 <th>Default</th>
6529 <th>Schema</th>
6530 </tr>
6531
6532
6533
6534<tr>
6535 <th>vspId</th>
6536 <td>path</td>
6537 <td>yes</td>
6538 <td>Vendor software product Id</td>
6539 <td> - </td>
6540
6541
6542 <td>string </td>
6543
6544
6545</tr>
6546
6547<tr>
6548 <th>componentId</th>
6549 <td>path</td>
6550 <td>yes</td>
6551 <td>Vendor software product component Id</td>
6552 <td> - </td>
6553
6554
6555 <td>string </td>
6556
6557
6558</tr>
6559
6560<tr>
6561 <th>version</th>
6562 <td>query</td>
6563 <td>no</td>
6564 <td></td>
6565 <td> - </td>
6566
6567
6568 <td>string </td>
6569
6570
6571</tr>
6572
6573<tr>
6574 <th>USER_ID</th>
6575 <td>header</td>
6576 <td>no</td>
6577 <td></td>
6578 <td> - </td>
6579
6580
6581 <td>string </td>
6582
6583
6584</tr>
6585
6586
6587</table>
6588
6589
6590
6591#### Response
6592
6593**Content-Type: ** application/json
6594
6595
6596| Status Code | Reason | Response Model |
6597|-------------|-------------|----------------|
6598| 200 | successful operation | <a href="#/definitions/QuestionnaireResponseDto">QuestionnaireResponseDto</a>|
6599
6600
6601
6602
6603### PUT
6604
6605<a id="updateQuestionnaire">Update vendor software product component questionnaire</a>
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615#### Request
6616
6617
6618**Content-Type: ** application/json
6619
6620##### Parameters
6621
6622<table border="1">
6623 <tr>
6624 <th>Name</th>
6625 <th>Located in</th>
6626 <th>Required</th>
6627 <th>Description</th>
6628 <th>Default</th>
6629 <th>Schema</th>
6630 </tr>
6631
6632
6633
6634<tr>
6635 <th>body</th>
6636 <td>body</td>
6637 <td>no</td>
6638 <td></td>
6639 <td> - </td>
6640
6641 <td>
6642
6643
6644 </td>
6645
6646</tr>
6647
6648<tr>
6649 <th>vspId</th>
6650 <td>path</td>
6651 <td>yes</td>
6652 <td>Vendor software product Id</td>
6653 <td> - </td>
6654
6655
6656 <td>string </td>
6657
6658
6659</tr>
6660
6661<tr>
6662 <th>componentId</th>
6663 <td>path</td>
6664 <td>yes</td>
6665 <td>Vendor software product component Id</td>
6666 <td> - </td>
6667
6668
6669 <td>string </td>
6670
6671
6672</tr>
6673
6674<tr>
6675 <th>USER_ID</th>
6676 <td>header</td>
6677 <td>no</td>
6678 <td></td>
6679 <td> - </td>
6680
6681
6682 <td>string </td>
6683
6684
6685</tr>
6686
6687
6688</table>
6689
6690
6691
6692#### Response
6693
6694**Content-Type: ** application/json
6695
6696
6697| Status Code | Reason | Response Model |
6698|-------------|-------------|----------------|
6699| default | successful operation | - |
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715## /v1.0/vendor-software-products/{vspId}/downloadHeat
6716
6717
6718### GET
6719
6720<a id="getLatestHeatPackage">Get uploaded HEAT file</a>
6721
6722Downloads the latest HEAT package
6723
6724
6725
6726
6727
6728
6729
6730#### Request
6731
6732
6733**Content-Type: ** application/json
6734
6735##### Parameters
6736
6737<table border="1">
6738 <tr>
6739 <th>Name</th>
6740 <th>Located in</th>
6741 <th>Required</th>
6742 <th>Description</th>
6743 <th>Default</th>
6744 <th>Schema</th>
6745 </tr>
6746
6747
6748
6749<tr>
6750 <th>vspId</th>
6751 <td>path</td>
6752 <td>yes</td>
6753 <td></td>
6754 <td> - </td>
6755
6756
6757 <td>string </td>
6758
6759
6760</tr>
6761
6762<tr>
6763 <th>USER_ID</th>
6764 <td>header</td>
6765 <td>no</td>
6766 <td></td>
6767 <td> - </td>
6768
6769
6770 <td>string </td>
6771
6772
6773</tr>
6774
6775
6776</table>
6777
6778
6779
6780#### Response
6781
6782**Content-Type: ** application/octet-stream
6783
6784
6785| Status Code | Reason | Response Model |
6786|-------------|-------------|----------------|
6787| 200 | successful operation | <a href="#/definitions/File">File</a>|
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805## /v1.0/vendor-software-products/{vspId}/networks
6806
6807
6808### GET
6809
6810<a id="list">List vendor software product networks</a>
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820#### Request
6821
6822
6823**Content-Type: ** application/json
6824
6825##### Parameters
6826
6827<table border="1">
6828 <tr>
6829 <th>Name</th>
6830 <th>Located in</th>
6831 <th>Required</th>
6832 <th>Description</th>
6833 <th>Default</th>
6834 <th>Schema</th>
6835 </tr>
6836
6837
6838
6839<tr>
6840 <th>vspId</th>
6841 <td>path</td>
6842 <td>yes</td>
6843 <td>Vendor software product Id</td>
6844 <td> - </td>
6845
6846
6847 <td>string </td>
6848
6849
6850</tr>
6851
6852<tr>
6853 <th>version</th>
6854 <td>query</td>
6855 <td>no</td>
6856 <td></td>
6857 <td> - </td>
6858
6859
6860 <td>string </td>
6861
6862
6863</tr>
6864
6865<tr>
6866 <th>USER_ID</th>
6867 <td>header</td>
6868 <td>no</td>
6869 <td></td>
6870 <td> - </td>
6871
6872
6873 <td>string </td>
6874
6875
6876</tr>
6877
6878
6879</table>
6880
6881
6882
6883#### Response
6884
6885**Content-Type: ** application/json
6886
6887
6888| Status Code | Reason | Response Model |
6889|-------------|-------------|----------------|
6890| 200 | successful operation | Array[<a href="#/definitions/NetworkDto">NetworkDto</a>]|
6891
6892
6893
6894
6895
6896
6897### POST
6898
6899
6900<a id="create">Create a vendor software product network</a>
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910#### Request
6911
6912
6913**Content-Type: ** application/json
6914
6915##### Parameters
6916
6917<table border="1">
6918 <tr>
6919 <th>Name</th>
6920 <th>Located in</th>
6921 <th>Required</th>
6922 <th>Description</th>
6923 <th>Default</th>
6924 <th>Schema</th>
6925 </tr>
6926
6927
6928
6929<tr>
6930 <th>body</th>
6931 <td>body</td>
6932 <td>no</td>
6933 <td></td>
6934 <td> - </td>
6935
6936 <td>
6937
6938 <a href="#/definitions/NetworkRequestDto">NetworkRequestDto</a>
6939 </td>
6940
6941</tr>
6942
6943<tr>
6944 <th>vspId</th>
6945 <td>path</td>
6946 <td>yes</td>
6947 <td>Vendor software product Id</td>
6948 <td> - </td>
6949
6950
6951 <td>string </td>
6952
6953
6954</tr>
6955
6956<tr>
6957 <th>USER_ID</th>
6958 <td>header</td>
6959 <td>no</td>
6960 <td></td>
6961 <td> - </td>
6962
6963
6964 <td>string </td>
6965
6966
6967</tr>
6968
6969
6970</table>
6971
6972
6973
6974#### Response
6975
6976**Content-Type: ** application/json
6977
6978
6979| Status Code | Reason | Response Model |
6980|-------------|-------------|----------------|
6981| default | successful operation | - |
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996## /v1.0/vendor-software-products/{vspId}/networks/{networkId}
6997
6998
6999### GET
7000
7001<a id="get">Get vendor software product network</a>
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011#### Request
7012
7013
7014**Content-Type: ** application/json
7015
7016##### Parameters
7017
7018<table border="1">
7019 <tr>
7020 <th>Name</th>
7021 <th>Located in</th>
7022 <th>Required</th>
7023 <th>Description</th>
7024 <th>Default</th>
7025 <th>Schema</th>
7026 </tr>
7027
7028
7029
7030<tr>
7031 <th>vspId</th>
7032 <td>path</td>
7033 <td>yes</td>
7034 <td>Vendor software product Id</td>
7035 <td> - </td>
7036
7037
7038 <td>string </td>
7039
7040
7041</tr>
7042
7043<tr>
7044 <th>networkId</th>
7045 <td>path</td>
7046 <td>yes</td>
7047 <td>Vendor software product network Id</td>
7048 <td> - </td>
7049
7050
7051 <td>string </td>
7052
7053
7054</tr>
7055
7056<tr>
7057 <th>version</th>
7058 <td>query</td>
7059 <td>no</td>
7060 <td></td>
7061 <td> - </td>
7062
7063
7064 <td>string </td>
7065
7066
7067</tr>
7068
7069<tr>
7070 <th>USER_ID</th>
7071 <td>header</td>
7072 <td>no</td>
7073 <td></td>
7074 <td> - </td>
7075
7076
7077 <td>string </td>
7078
7079
7080</tr>
7081
7082
7083</table>
7084
7085
7086
7087#### Response
7088
7089**Content-Type: ** application/json
7090
7091
7092| Status Code | Reason | Response Model |
7093|-------------|-------------|----------------|
7094| 200 | successful operation | <a href="#/definitions/NetworkDto">NetworkDto</a>|
7095
7096
7097
7098
7099### PUT
7100
7101<a id="update">Update vendor software product network</a>
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111#### Request
7112
7113
7114**Content-Type: ** application/json
7115
7116##### Parameters
7117
7118<table border="1">
7119 <tr>
7120 <th>Name</th>
7121 <th>Located in</th>
7122 <th>Required</th>
7123 <th>Description</th>
7124 <th>Default</th>
7125 <th>Schema</th>
7126 </tr>
7127
7128
7129
7130<tr>
7131 <th>body</th>
7132 <td>body</td>
7133 <td>no</td>
7134 <td></td>
7135 <td> - </td>
7136
7137 <td>
7138
7139 <a href="#/definitions/NetworkRequestDto">NetworkRequestDto</a>
7140 </td>
7141
7142</tr>
7143
7144<tr>
7145 <th>vspId</th>
7146 <td>path</td>
7147 <td>yes</td>
7148 <td>Vendor software product Id</td>
7149 <td> - </td>
7150
7151
7152 <td>string </td>
7153
7154
7155</tr>
7156
7157<tr>
7158 <th>networkId</th>
7159 <td>path</td>
7160 <td>yes</td>
7161 <td>Vendor software product network Id</td>
7162 <td> - </td>
7163
7164
7165 <td>string </td>
7166
7167
7168</tr>
7169
7170<tr>
7171 <th>USER_ID</th>
7172 <td>header</td>
7173 <td>no</td>
7174 <td></td>
7175 <td> - </td>
7176
7177
7178 <td>string </td>
7179
7180
7181</tr>
7182
7183
7184</table>
7185
7186
7187
7188#### Response
7189
7190**Content-Type: ** application/json
7191
7192
7193| Status Code | Reason | Response Model |
7194|-------------|-------------|----------------|
7195| default | successful operation | - |
7196
7197
7198
7199
7200
7201
7202### DELETE
7203
7204<a id="delete">Delete vendor software product network</a>
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214#### Request
7215
7216
7217**Content-Type: ** application/json
7218
7219##### Parameters
7220
7221<table border="1">
7222 <tr>
7223 <th>Name</th>
7224 <th>Located in</th>
7225 <th>Required</th>
7226 <th>Description</th>
7227 <th>Default</th>
7228 <th>Schema</th>
7229 </tr>
7230
7231
7232
7233<tr>
7234 <th>vspId</th>
7235 <td>path</td>
7236 <td>yes</td>
7237 <td>Vendor software product Id</td>
7238 <td> - </td>
7239
7240
7241 <td>string </td>
7242
7243
7244</tr>
7245
7246<tr>
7247 <th>networkId</th>
7248 <td>path</td>
7249 <td>yes</td>
7250 <td>Vendor software product network Id</td>
7251 <td> - </td>
7252
7253
7254 <td>string </td>
7255
7256
7257</tr>
7258
7259<tr>
7260 <th>USER_ID</th>
7261 <td>header</td>
7262 <td>no</td>
7263 <td></td>
7264 <td> - </td>
7265
7266
7267 <td>string </td>
7268
7269
7270</tr>
7271
7272
7273</table>
7274
7275
7276
7277#### Response
7278
7279**Content-Type: ** application/json
7280
7281
7282| Status Code | Reason | Response Model |
7283|-------------|-------------|----------------|
7284| default | successful operation | - |
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296## /v1.0/vendor-software-products/{vspId}/processes
7297
7298
7299### GET
7300
7301<a id="list">List vendor software product processes</a>
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311#### Request
7312
7313
7314**Content-Type: ** application/json
7315
7316##### Parameters
7317
7318<table border="1">
7319 <tr>
7320 <th>Name</th>
7321 <th>Located in</th>
7322 <th>Required</th>
7323 <th>Description</th>
7324 <th>Default</th>
7325 <th>Schema</th>
7326 </tr>
7327
7328
7329
7330<tr>
7331 <th>vspId</th>
7332 <td>path</td>
7333 <td>yes</td>
7334 <td>Vendor software product Id</td>
7335 <td> - </td>
7336
7337
7338 <td>string </td>
7339
7340
7341</tr>
7342
7343<tr>
7344 <th>version</th>
7345 <td>query</td>
7346 <td>no</td>
7347 <td></td>
7348 <td> - </td>
7349
7350
7351 <td>string </td>
7352
7353
7354</tr>
7355
7356<tr>
7357 <th>USER_ID</th>
7358 <td>header</td>
7359 <td>no</td>
7360 <td></td>
7361 <td> - </td>
7362
7363
7364 <td>string </td>
7365
7366
7367</tr>
7368
7369
7370</table>
7371
7372
7373
7374#### Response
7375
7376**Content-Type: ** application/json
7377
7378
7379| Status Code | Reason | Response Model |
7380|-------------|-------------|----------------|
7381| 200 | successful operation | Array[<a href="#/definitions/ProcessEntityDto">ProcessEntityDto</a>]|
7382
7383
7384
7385
7386
7387
7388### POST
7389
7390
7391<a id="create">Create a vendor software product process</a>
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401#### Request
7402
7403
7404**Content-Type: ** application/json
7405
7406##### Parameters
7407
7408<table border="1">
7409 <tr>
7410 <th>Name</th>
7411 <th>Located in</th>
7412 <th>Required</th>
7413 <th>Description</th>
7414 <th>Default</th>
7415 <th>Schema</th>
7416 </tr>
7417
7418
7419
7420<tr>
7421 <th>body</th>
7422 <td>body</td>
7423 <td>no</td>
7424 <td></td>
7425 <td> - </td>
7426
7427 <td>
7428
7429 <a href="#/definitions/ProcessRequestDto">ProcessRequestDto</a>
7430 </td>
7431
7432</tr>
7433
7434<tr>
7435 <th>vspId</th>
7436 <td>path</td>
7437 <td>yes</td>
7438 <td>Vendor software product Id</td>
7439 <td> - </td>
7440
7441
7442 <td>string </td>
7443
7444
7445</tr>
7446
7447<tr>
7448 <th>USER_ID</th>
7449 <td>header</td>
7450 <td>no</td>
7451 <td></td>
7452 <td> - </td>
7453
7454
7455 <td>string </td>
7456
7457
7458</tr>
7459
7460
7461</table>
7462
7463
7464
7465#### Response
7466
7467**Content-Type: ** application/json
7468
7469
7470| Status Code | Reason | Response Model |
7471|-------------|-------------|----------------|
7472| default | successful operation | - |
7473
7474
7475
7476
7477
7478### DELETE
7479
7480<a id="deleteList">Delete vendor software product processes</a>
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490#### Request
7491
7492
7493**Content-Type: ** application/json
7494
7495##### Parameters
7496
7497<table border="1">
7498 <tr>
7499 <th>Name</th>
7500 <th>Located in</th>
7501 <th>Required</th>
7502 <th>Description</th>
7503 <th>Default</th>
7504 <th>Schema</th>
7505 </tr>
7506
7507
7508
7509<tr>
7510 <th>vspId</th>
7511 <td>path</td>
7512 <td>yes</td>
7513 <td>Vendor software product Id</td>
7514 <td> - </td>
7515
7516
7517 <td>string </td>
7518
7519
7520</tr>
7521
7522<tr>
7523 <th>USER_ID</th>
7524 <td>header</td>
7525 <td>no</td>
7526 <td></td>
7527 <td> - </td>
7528
7529
7530 <td>string </td>
7531
7532
7533</tr>
7534
7535
7536</table>
7537
7538
7539
7540#### Response
7541
7542**Content-Type: ** application/json
7543
7544
7545| Status Code | Reason | Response Model |
7546|-------------|-------------|----------------|
7547| default | successful operation | - |
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559## /v1.0/vendor-software-products/{vspId}/processes/{processId}
7560
7561
7562### GET
7563
7564<a id="get">Get vendor software product process</a>
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574#### Request
7575
7576
7577**Content-Type: ** application/json
7578
7579##### Parameters
7580
7581<table border="1">
7582 <tr>
7583 <th>Name</th>
7584 <th>Located in</th>
7585 <th>Required</th>
7586 <th>Description</th>
7587 <th>Default</th>
7588 <th>Schema</th>
7589 </tr>
7590
7591
7592
7593<tr>
7594 <th>vspId</th>
7595 <td>path</td>
7596 <td>yes</td>
7597 <td>Vendor software product Id</td>
7598 <td> - </td>
7599
7600
7601 <td>string </td>
7602
7603
7604</tr>
7605
7606<tr>
7607 <th>processId</th>
7608 <td>path</td>
7609 <td>yes</td>
7610 <td>Vendor software product process Id</td>
7611 <td> - </td>
7612
7613
7614 <td>string </td>
7615
7616
7617</tr>
7618
7619<tr>
7620 <th>version</th>
7621 <td>query</td>
7622 <td>no</td>
7623 <td></td>
7624 <td> - </td>
7625
7626
7627 <td>string </td>
7628
7629
7630</tr>
7631
7632<tr>
7633 <th>USER_ID</th>
7634 <td>header</td>
7635 <td>no</td>
7636 <td></td>
7637 <td> - </td>
7638
7639
7640 <td>string </td>
7641
7642
7643</tr>
7644
7645
7646</table>
7647
7648
7649
7650#### Response
7651
7652**Content-Type: ** application/json
7653
7654
7655| Status Code | Reason | Response Model |
7656|-------------|-------------|----------------|
7657| 200 | successful operation | <a href="#/definitions/ProcessEntityDto">ProcessEntityDto</a>|
7658
7659
7660
7661
7662### PUT
7663
7664<a id="update">Update vendor software product process</a>
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674#### Request
7675
7676
7677**Content-Type: ** application/json
7678
7679##### Parameters
7680
7681<table border="1">
7682 <tr>
7683 <th>Name</th>
7684 <th>Located in</th>
7685 <th>Required</th>
7686 <th>Description</th>
7687 <th>Default</th>
7688 <th>Schema</th>
7689 </tr>
7690
7691
7692
7693<tr>
7694 <th>body</th>
7695 <td>body</td>
7696 <td>no</td>
7697 <td></td>
7698 <td> - </td>
7699
7700 <td>
7701
7702 <a href="#/definitions/ProcessRequestDto">ProcessRequestDto</a>
7703 </td>
7704
7705</tr>
7706
7707<tr>
7708 <th>vspId</th>
7709 <td>path</td>
7710 <td>yes</td>
7711 <td>Vendor software product Id</td>
7712 <td> - </td>
7713
7714
7715 <td>string </td>
7716
7717
7718</tr>
7719
7720<tr>
7721 <th>processId</th>
7722 <td>path</td>
7723 <td>yes</td>
7724 <td>Vendor software product process Id</td>
7725 <td> - </td>
7726
7727
7728 <td>string </td>
7729
7730
7731</tr>
7732
7733<tr>
7734 <th>USER_ID</th>
7735 <td>header</td>
7736 <td>no</td>
7737 <td></td>
7738 <td> - </td>
7739
7740
7741 <td>string </td>
7742
7743
7744</tr>
7745
7746
7747</table>
7748
7749
7750
7751#### Response
7752
7753**Content-Type: ** application/json
7754
7755
7756| Status Code | Reason | Response Model |
7757|-------------|-------------|----------------|
7758| default | successful operation | - |
7759
7760
7761
7762
7763
7764
7765### DELETE
7766
7767<a id="delete">Delete vendor software product process</a>
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777#### Request
7778
7779
7780**Content-Type: ** application/json
7781
7782##### Parameters
7783
7784<table border="1">
7785 <tr>
7786 <th>Name</th>
7787 <th>Located in</th>
7788 <th>Required</th>
7789 <th>Description</th>
7790 <th>Default</th>
7791 <th>Schema</th>
7792 </tr>
7793
7794
7795
7796<tr>
7797 <th>vspId</th>
7798 <td>path</td>
7799 <td>yes</td>
7800 <td>Vendor software product Id</td>
7801 <td> - </td>
7802
7803
7804 <td>string </td>
7805
7806
7807</tr>
7808
7809<tr>
7810 <th>processId</th>
7811 <td>path</td>
7812 <td>yes</td>
7813 <td>Vendor software product process Id</td>
7814 <td> - </td>
7815
7816
7817 <td>string </td>
7818
7819
7820</tr>
7821
7822<tr>
7823 <th>USER_ID</th>
7824 <td>header</td>
7825 <td>no</td>
7826 <td></td>
7827 <td> - </td>
7828
7829
7830 <td>string </td>
7831
7832
7833</tr>
7834
7835
7836</table>
7837
7838
7839
7840#### Response
7841
7842**Content-Type: ** application/json
7843
7844
7845| Status Code | Reason | Response Model |
7846|-------------|-------------|----------------|
7847| default | successful operation | - |
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859## /v1.0/vendor-software-products/{vspId}/processes/{processId}/upload
7860
7861
7862### GET
7863
7864<a id="getUploadedFile">Get vendor software product process uploaded file</a>
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874#### Request
7875
7876
7877**Content-Type: ** application/json
7878
7879##### Parameters
7880
7881<table border="1">
7882 <tr>
7883 <th>Name</th>
7884 <th>Located in</th>
7885 <th>Required</th>
7886 <th>Description</th>
7887 <th>Default</th>
7888 <th>Schema</th>
7889 </tr>
7890
7891
7892
7893<tr>
7894 <th>vspId</th>
7895 <td>path</td>
7896 <td>yes</td>
7897 <td>Vendor software product Id</td>
7898 <td> - </td>
7899
7900
7901 <td>string </td>
7902
7903
7904</tr>
7905
7906<tr>
7907 <th>processId</th>
7908 <td>path</td>
7909 <td>yes</td>
7910 <td>Vendor software product process Id</td>
7911 <td> - </td>
7912
7913
7914 <td>string </td>
7915
7916
7917</tr>
7918
7919<tr>
7920 <th>version</th>
7921 <td>query</td>
7922 <td>no</td>
7923 <td></td>
7924 <td> - </td>
7925
7926
7927 <td>string </td>
7928
7929
7930</tr>
7931
7932<tr>
7933 <th>USER_ID</th>
7934 <td>header</td>
7935 <td>no</td>
7936 <td></td>
7937 <td> - </td>
7938
7939
7940 <td>string </td>
7941
7942
7943</tr>
7944
7945
7946</table>
7947
7948
7949
7950#### Response
7951
7952**Content-Type: ** application/octet-stream
7953
7954
7955| Status Code | Reason | Response Model |
7956|-------------|-------------|----------------|
7957| default | successful operation | - |
7958
7959
7960
7961
7962
7963
7964### POST
7965
7966
7967<a id="uploadFile">Update vendor software product process upload</a>
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977#### Request
7978
7979
7980**Content-Type: ** multipart/form-data
7981
7982##### Parameters
7983
7984<table border="1">
7985 <tr>
7986 <th>Name</th>
7987 <th>Located in</th>
7988 <th>Required</th>
7989 <th>Description</th>
7990 <th>Default</th>
7991 <th>Schema</th>
7992 </tr>
7993
7994
7995
7996<tr>
7997 <th>body</th>
7998 <td>body</td>
7999 <td>no</td>
8000 <td></td>
8001 <td> - </td>
8002
8003 <td>
8004
8005 <a href="#/definitions/Attachment">Attachment</a>
8006 </td>
8007
8008</tr>
8009
8010<tr>
8011 <th>vspId</th>
8012 <td>path</td>
8013 <td>yes</td>
8014 <td>Vendor software product Id</td>
8015 <td> - </td>
8016
8017
8018 <td>string </td>
8019
8020
8021</tr>
8022
8023<tr>
8024 <th>processId</th>
8025 <td>path</td>
8026 <td>yes</td>
8027 <td>Vendor software product process Id</td>
8028 <td> - </td>
8029
8030
8031 <td>string </td>
8032
8033
8034</tr>
8035
8036<tr>
8037 <th>USER_ID</th>
8038 <td>header</td>
8039 <td>no</td>
8040 <td></td>
8041 <td> - </td>
8042
8043
8044 <td>string </td>
8045
8046
8047</tr>
8048
8049
8050</table>
8051
8052
8053
8054#### Response
8055
8056**Content-Type: ** application/json
8057
8058
8059| Status Code | Reason | Response Model |
8060|-------------|-------------|----------------|
8061| default | successful operation | - |
8062
8063
8064
8065
8066
8067### DELETE
8068
8069<a id="deleteUploadedFile">Delete vendor software product process uploaded file</a>
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079#### Request
8080
8081
8082**Content-Type: ** application/json
8083
8084##### Parameters
8085
8086<table border="1">
8087 <tr>
8088 <th>Name</th>
8089 <th>Located in</th>
8090 <th>Required</th>
8091 <th>Description</th>
8092 <th>Default</th>
8093 <th>Schema</th>
8094 </tr>
8095
8096
8097
8098<tr>
8099 <th>vspId</th>
8100 <td>path</td>
8101 <td>yes</td>
8102 <td>Vendor software product Id</td>
8103 <td> - </td>
8104
8105
8106 <td>string </td>
8107
8108
8109</tr>
8110
8111<tr>
8112 <th>processId</th>
8113 <td>path</td>
8114 <td>yes</td>
8115 <td>Vendor software product process Id</td>
8116 <td> - </td>
8117
8118
8119 <td>string </td>
8120
8121
8122</tr>
8123
8124<tr>
8125 <th>USER_ID</th>
8126 <td>header</td>
8127 <td>no</td>
8128 <td></td>
8129 <td> - </td>
8130
8131
8132 <td>string </td>
8133
8134
8135</tr>
8136
8137
8138</table>
8139
8140
8141
8142#### Response
8143
8144**Content-Type: ** application/json
8145
8146
8147| Status Code | Reason | Response Model |
8148|-------------|-------------|----------------|
8149| default | successful operation | - |
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161## /v1.0/vendor-software-products/{vspId}/questionnaire
8162
8163
8164### GET
8165
8166<a id="getQuestionnaire">Get vendor software product questionnaire</a>
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176#### Request
8177
8178
8179**Content-Type: ** application/json
8180
8181##### Parameters
8182
8183<table border="1">
8184 <tr>
8185 <th>Name</th>
8186 <th>Located in</th>
8187 <th>Required</th>
8188 <th>Description</th>
8189 <th>Default</th>
8190 <th>Schema</th>
8191 </tr>
8192
8193
8194
8195<tr>
8196 <th>vspId</th>
8197 <td>path</td>
8198 <td>yes</td>
8199 <td></td>
8200 <td> - </td>
8201
8202
8203 <td>string </td>
8204
8205
8206</tr>
8207
8208<tr>
8209 <th>version</th>
8210 <td>query</td>
8211 <td>no</td>
8212 <td></td>
8213 <td> - </td>
8214
8215
8216 <td>string </td>
8217
8218
8219</tr>
8220
8221<tr>
8222 <th>USER_ID</th>
8223 <td>header</td>
8224 <td>no</td>
8225 <td></td>
8226 <td> - </td>
8227
8228
8229 <td>string </td>
8230
8231
8232</tr>
8233
8234
8235</table>
8236
8237
8238
8239#### Response
8240
8241**Content-Type: ** application/json
8242
8243
8244| Status Code | Reason | Response Model |
8245|-------------|-------------|----------------|
8246| 200 | successful operation | <a href="#/definitions/QuestionnaireResponseDto">QuestionnaireResponseDto</a>|
8247
8248
8249
8250
8251### PUT
8252
8253<a id="updateQuestionnaire">Update vendor software product questionnaire</a>
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263#### Request
8264
8265
8266**Content-Type: ** application/json
8267
8268##### Parameters
8269
8270<table border="1">
8271 <tr>
8272 <th>Name</th>
8273 <th>Located in</th>
8274 <th>Required</th>
8275 <th>Description</th>
8276 <th>Default</th>
8277 <th>Schema</th>
8278 </tr>
8279
8280
8281
8282<tr>
8283 <th>body</th>
8284 <td>body</td>
8285 <td>no</td>
8286 <td></td>
8287 <td> - </td>
8288
8289 <td>
8290
8291
8292 </td>
8293
8294</tr>
8295
8296<tr>
8297 <th>vspId</th>
8298 <td>path</td>
8299 <td>yes</td>
8300 <td></td>
8301 <td> - </td>
8302
8303
8304 <td>string </td>
8305
8306
8307</tr>
8308
8309<tr>
8310 <th>USER_ID</th>
8311 <td>header</td>
8312 <td>no</td>
8313 <td></td>
8314 <td> - </td>
8315
8316
8317 <td>string </td>
8318
8319
8320</tr>
8321
8322
8323</table>
8324
8325
8326
8327#### Response
8328
8329**Content-Type: ** application/json
8330
8331
8332| Status Code | Reason | Response Model |
8333|-------------|-------------|----------------|
8334| default | successful operation | - |
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350## /v1.0/vendor-software-products/{vspId}/upload
8351
8352
8353
8354
8355
8356
8357### POST
8358
8359
8360<a id="uploadFile">Uploads a HEAT package to translate</a>
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370#### Request
8371
8372
8373**Content-Type: ** multipart/form-data
8374
8375##### Parameters
8376
8377<table border="1">
8378 <tr>
8379 <th>Name</th>
8380 <th>Located in</th>
8381 <th>Required</th>
8382 <th>Description</th>
8383 <th>Default</th>
8384 <th>Schema</th>
8385 </tr>
8386
8387
8388
8389<tr>
8390 <th>vspId</th>
8391 <td>path</td>
8392 <td>yes</td>
8393 <td></td>
8394 <td> - </td>
8395
8396
8397 <td>string </td>
8398
8399
8400</tr>
8401
8402<tr>
8403 <th>body</th>
8404 <td>body</td>
8405 <td>no</td>
8406 <td></td>
8407 <td> - </td>
8408
8409 <td>
8410
8411 <a href="#/definitions/InputStream">InputStream</a>
8412 </td>
8413
8414</tr>
8415
8416<tr>
8417 <th>USER_ID</th>
8418 <td>header</td>
8419 <td>no</td>
8420 <td></td>
8421 <td> - </td>
8422
8423
8424 <td>string </td>
8425
8426
8427</tr>
8428
8429
8430</table>
8431
8432
8433
8434#### Response
8435
8436**Content-Type: ** application/json
8437
8438
8439| Status Code | Reason | Response Model |
8440|-------------|-------------|----------------|
8441| 200 | successful operation | <a href="#/definitions/UploadFileResponseDto">UploadFileResponseDto</a>|
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456## /workflow/v1.0/actions
8457
8458
8459### GET
8460
8461<a id="getFilteredActions">List Filtered Actions </a>
8462
8463Get list of actions based on a filter criteria | If no filter is sent all actions will be returned
8464
8465
8466
8467
8468
8469
8470
8471#### Request
8472
8473
8474**Content-Type: ** application/json
8475
8476##### Parameters
8477
8478<table border="1">
8479 <tr>
8480 <th>Name</th>
8481 <th>Located in</th>
8482 <th>Required</th>
8483 <th>Description</th>
8484 <th>Default</th>
8485 <th>Schema</th>
8486 </tr>
8487
8488
8489
8490<tr>
8491 <th>vendor</th>
8492 <td>query</td>
8493 <td>no</td>
8494 <td></td>
8495 <td> - </td>
8496
8497
8498 <td>string </td>
8499
8500
8501</tr>
8502
8503<tr>
8504 <th>category</th>
8505 <td>query</td>
8506 <td>no</td>
8507 <td></td>
8508 <td> - </td>
8509
8510
8511 <td>string </td>
8512
8513
8514</tr>
8515
8516<tr>
8517 <th>name</th>
8518 <td>query</td>
8519 <td>no</td>
8520 <td></td>
8521 <td> - </td>
8522
8523
8524 <td>string </td>
8525
8526
8527</tr>
8528
8529<tr>
8530 <th>modelId</th>
8531 <td>query</td>
8532 <td>no</td>
8533 <td></td>
8534 <td> - </td>
8535
8536
8537 <td>string </td>
8538
8539
8540</tr>
8541
8542<tr>
8543 <th>componentId</th>
8544 <td>query</td>
8545 <td>no</td>
8546 <td></td>
8547 <td> - </td>
8548
8549
8550 <td>string </td>
8551
8552
8553</tr>
8554
8555
8556</table>
8557
8558
8559
8560#### Response
8561
8562**Content-Type: ** application/json
8563
8564
8565| Status Code | Reason | Response Model |
8566|-------------|-------------|----------------|
8567| default | successful operation | - |
8568
8569
8570
8571
8572
8573
8574### POST
8575
8576
8577<a id="createAction">Create a new Action</a>
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587#### Request
8588
8589
8590**Content-Type: ** application/json
8591
8592##### Parameters
8593
8594<table border="1">
8595 <tr>
8596 <th>Name</th>
8597 <th>Located in</th>
8598 <th>Required</th>
8599 <th>Description</th>
8600 <th>Default</th>
8601 <th>Schema</th>
8602 </tr>
8603
8604
8605
8606<tr>
8607 <th>body</th>
8608 <td>body</td>
8609 <td>no</td>
8610 <td></td>
8611 <td> - </td>
8612
8613 <td>
8614
8615
8616 </td>
8617
8618</tr>
8619
8620
8621</table>
8622
8623
8624
8625#### Response
8626
8627**Content-Type: ** application/json
8628
8629
8630| Status Code | Reason | Response Model |
8631|-------------|-------------|----------------|
8632| default | successful operation | - |
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647## /workflow/v1.0/actions/components
8648
8649
8650### GET
8651
8652<a id="getEcompComponents">List ECOMP Components supported by Action Library</a>
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662#### Request
8663
8664
8665**Content-Type: ** application/json
8666
8667##### Parameters
8668
8669
8670
8671
8672
8673
8674#### Response
8675
8676**Content-Type: ** application/json
8677
8678
8679| Status Code | Reason | Response Model |
8680|-------------|-------------|----------------|
8681| default | successful operation | - |
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699## /workflow/v1.0/actions/{actionInvariantUUID}
8700
8701
8702### GET
8703
8704<a id="getActionsByActionInvariantUuId">List Actions For Given Action Invariant UUID</a>
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714#### Request
8715
8716
8717**Content-Type: ** application/json
8718
8719##### Parameters
8720
8721<table border="1">
8722 <tr>
8723 <th>Name</th>
8724 <th>Located in</th>
8725 <th>Required</th>
8726 <th>Description</th>
8727 <th>Default</th>
8728 <th>Schema</th>
8729 </tr>
8730
8731
8732
8733<tr>
8734 <th>actionInvariantUUID</th>
8735 <td>path</td>
8736 <td>yes</td>
8737 <td></td>
8738 <td> - </td>
8739
8740
8741 <td>string </td>
8742
8743
8744</tr>
8745
8746<tr>
8747 <th>version</th>
8748 <td>query</td>
8749 <td>no</td>
8750 <td></td>
8751 <td> - </td>
8752
8753
8754 <td>string </td>
8755
8756
8757</tr>
8758
8759
8760</table>
8761
8762
8763
8764#### Response
8765
8766**Content-Type: ** application/json
8767
8768
8769| Status Code | Reason | Response Model |
8770|-------------|-------------|----------------|
8771| default | successful operation | - |
8772
8773
8774
8775
8776### PUT
8777
8778<a id="updateAction">Update an existing action</a>
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788#### Request
8789
8790
8791**Content-Type: ** application/json
8792
8793##### Parameters
8794
8795<table border="1">
8796 <tr>
8797 <th>Name</th>
8798 <th>Located in</th>
8799 <th>Required</th>
8800 <th>Description</th>
8801 <th>Default</th>
8802 <th>Schema</th>
8803 </tr>
8804
8805
8806
8807<tr>
8808 <th>actionInvariantUUID</th>
8809 <td>path</td>
8810 <td>yes</td>
8811 <td></td>
8812 <td> - </td>
8813
8814
8815 <td>string </td>
8816
8817
8818</tr>
8819
8820<tr>
8821 <th>body</th>
8822 <td>body</td>
8823 <td>no</td>
8824 <td></td>
8825 <td> - </td>
8826
8827 <td>
8828
8829
8830 </td>
8831
8832</tr>
8833
8834
8835</table>
8836
8837
8838
8839#### Response
8840
8841**Content-Type: ** application/json
8842
8843
8844| Status Code | Reason | Response Model |
8845|-------------|-------------|----------------|
8846| default | successful operation | - |
8847
8848
8849
8850
8851### POST
8852
8853
8854<a id="actOnAction">Actions on a action</a>
8855
8856Performs 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.|
8857
8858
8859
8860
8861
8862
8863
8864#### Request
8865
8866
8867**Content-Type: ** application/json
8868
8869##### Parameters
8870
8871<table border="1">
8872 <tr>
8873 <th>Name</th>
8874 <th>Located in</th>
8875 <th>Required</th>
8876 <th>Description</th>
8877 <th>Default</th>
8878 <th>Schema</th>
8879 </tr>
8880
8881
8882
8883<tr>
8884 <th>actionInvariantUUID</th>
8885 <td>path</td>
8886 <td>yes</td>
8887 <td></td>
8888 <td> - </td>
8889
8890
8891 <td>string </td>
8892
8893
8894</tr>
8895
8896<tr>
8897 <th>body</th>
8898 <td>body</td>
8899 <td>no</td>
8900 <td></td>
8901 <td> - </td>
8902
8903 <td>
8904
8905
8906 </td>
8907
8908</tr>
8909
8910
8911</table>
8912
8913
8914
8915#### Response
8916
8917**Content-Type: ** application/json
8918
8919
8920| Status Code | Reason | Response Model |
8921|-------------|-------------|----------------|
8922| default | successful operation | - |
8923
8924
8925
8926
8927
8928### DELETE
8929
8930<a id="deleteAction">Delete Action</a>
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940#### Request
8941
8942
8943**Content-Type: ** application/json
8944
8945##### Parameters
8946
8947<table border="1">
8948 <tr>
8949 <th>Name</th>
8950 <th>Located in</th>
8951 <th>Required</th>
8952 <th>Description</th>
8953 <th>Default</th>
8954 <th>Schema</th>
8955 </tr>
8956
8957
8958
8959<tr>
8960 <th>actionInvariantUUID</th>
8961 <td>path</td>
8962 <td>yes</td>
8963 <td></td>
8964 <td> - </td>
8965
8966
8967 <td>string </td>
8968
8969
8970</tr>
8971
8972
8973</table>
8974
8975
8976
8977#### Response
8978
8979**Content-Type: ** application/json
8980
8981
8982| Status Code | Reason | Response Model |
8983|-------------|-------------|----------------|
8984| default | successful operation | - |
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996## /workflow/v1.0/actions/{actionInvariantUUID}/artifacts
8997
8998
8999
9000
9001
9002
9003### POST
9004
9005
9006<a id="uploadArtifact">Upload new Artifact</a>
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016#### Request
9017
9018
9019**Content-Type: ** multipart/form-data
9020
9021##### Parameters
9022
9023<table border="1">
9024 <tr>
9025 <th>Name</th>
9026 <th>Located in</th>
9027 <th>Required</th>
9028 <th>Description</th>
9029 <th>Default</th>
9030 <th>Schema</th>
9031 </tr>
9032
9033
9034
9035<tr>
9036 <th>actionInvariantUUID</th>
9037 <td>path</td>
9038 <td>yes</td>
9039 <td></td>
9040 <td> - </td>
9041
9042
9043 <td>string </td>
9044
9045
9046</tr>
9047
9048<tr>
9049 <th>body</th>
9050 <td>body</td>
9051 <td>no</td>
9052 <td></td>
9053 <td> - </td>
9054
9055 <td>
9056
9057
9058 </td>
9059
9060</tr>
9061
9062<tr>
9063 <th>body</th>
9064 <td>body</td>
9065 <td>no</td>
9066 <td></td>
9067 <td> - </td>
9068
9069 <td>
9070
9071
9072 </td>
9073
9074</tr>
9075
9076<tr>
9077 <th>body</th>
9078 <td>body</td>
9079 <td>no</td>
9080 <td></td>
9081 <td> - </td>
9082
9083 <td>
9084
9085
9086 </td>
9087
9088</tr>
9089
9090<tr>
9091 <th>body</th>
9092 <td>body</td>
9093 <td>no</td>
9094 <td></td>
9095 <td> - </td>
9096
9097 <td>
9098
9099
9100 </td>
9101
9102</tr>
9103
9104<tr>
9105 <th>body</th>
9106 <td>body</td>
9107 <td>no</td>
9108 <td></td>
9109 <td> - </td>
9110
9111 <td>
9112
9113
9114 </td>
9115
9116</tr>
9117
9118<tr>
9119 <th>Content-MD5</th>
9120 <td>header</td>
9121 <td>no</td>
9122 <td></td>
9123 <td> - </td>
9124
9125
9126 <td>string </td>
9127
9128
9129</tr>
9130
9131<tr>
9132 <th>body</th>
9133 <td>body</td>
9134 <td>no</td>
9135 <td></td>
9136 <td> - </td>
9137
9138 <td>
9139
9140 <a href="#/definitions/Attachment">Attachment</a>
9141 </td>
9142
9143</tr>
9144
9145
9146</table>
9147
9148
9149
9150#### Response
9151
9152**Content-Type: ** application/json
9153
9154
9155| Status Code | Reason | Response Model |
9156|-------------|-------------|----------------|
9157| default | successful operation | - |
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172## /workflow/v1.0/actions/{actionInvariantUUID}/artifacts/{artifactUUID}
9173
9174
9175
9176
9177### PUT
9178
9179<a id="updateArtifact">Update an existing artifact</a>
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189#### Request
9190
9191
9192**Content-Type: ** multipart/form-data
9193
9194##### Parameters
9195
9196<table border="1">
9197 <tr>
9198 <th>Name</th>
9199 <th>Located in</th>
9200 <th>Required</th>
9201 <th>Description</th>
9202 <th>Default</th>
9203 <th>Schema</th>
9204 </tr>
9205
9206
9207
9208<tr>
9209 <th>actionInvariantUUID</th>
9210 <td>path</td>
9211 <td>yes</td>
9212 <td></td>
9213 <td> - </td>
9214
9215
9216 <td>string </td>
9217
9218
9219</tr>
9220
9221<tr>
9222 <th>artifactUUID</th>
9223 <td>path</td>
9224 <td>yes</td>
9225 <td></td>
9226 <td> - </td>
9227
9228
9229 <td>string </td>
9230
9231
9232</tr>
9233
9234<tr>
9235 <th>body</th>
9236 <td>body</td>
9237 <td>no</td>
9238 <td></td>
9239 <td> - </td>
9240
9241 <td>
9242
9243
9244 </td>
9245
9246</tr>
9247
9248<tr>
9249 <th>body</th>
9250 <td>body</td>
9251 <td>no</td>
9252 <td></td>
9253 <td> - </td>
9254
9255 <td>
9256
9257
9258 </td>
9259
9260</tr>
9261
9262<tr>
9263 <th>body</th>
9264 <td>body</td>
9265 <td>no</td>
9266 <td></td>
9267 <td> - </td>
9268
9269 <td>
9270
9271
9272 </td>
9273
9274</tr>
9275
9276<tr>
9277 <th>body</th>
9278 <td>body</td>
9279 <td>no</td>
9280 <td></td>
9281 <td> - </td>
9282
9283 <td>
9284
9285
9286 </td>
9287
9288</tr>
9289
9290<tr>
9291 <th>body</th>
9292 <td>body</td>
9293 <td>no</td>
9294 <td></td>
9295 <td> - </td>
9296
9297 <td>
9298
9299
9300 </td>
9301
9302</tr>
9303
9304<tr>
9305 <th>Content-MD5</th>
9306 <td>header</td>
9307 <td>no</td>
9308 <td></td>
9309 <td> - </td>
9310
9311
9312 <td>string </td>
9313
9314
9315</tr>
9316
9317<tr>
9318 <th>body</th>
9319 <td>body</td>
9320 <td>no</td>
9321 <td></td>
9322 <td> - </td>
9323
9324 <td>
9325
9326 <a href="#/definitions/Attachment">Attachment</a>
9327 </td>
9328
9329</tr>
9330
9331
9332</table>
9333
9334
9335
9336#### Response
9337
9338**Content-Type: ** application/json
9339
9340
9341| Status Code | Reason | Response Model |
9342|-------------|-------------|----------------|
9343| default | successful operation | - |
9344
9345
9346
9347
9348
9349
9350### DELETE
9351
9352<a id="deleteArtifact">Delete Artifact</a>
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362#### Request
9363
9364
9365**Content-Type: ** application/json
9366
9367##### Parameters
9368
9369<table border="1">
9370 <tr>
9371 <th>Name</th>
9372 <th>Located in</th>
9373 <th>Required</th>
9374 <th>Description</th>
9375 <th>Default</th>
9376 <th>Schema</th>
9377 </tr>
9378
9379
9380
9381<tr>
9382 <th>actionInvariantUUID</th>
9383 <td>path</td>
9384 <td>yes</td>
9385 <td></td>
9386 <td> - </td>
9387
9388
9389 <td>string </td>
9390
9391
9392</tr>
9393
9394<tr>
9395 <th>artifactUUID</th>
9396 <td>path</td>
9397 <td>yes</td>
9398 <td></td>
9399 <td> - </td>
9400
9401
9402 <td>string </td>
9403
9404
9405</tr>
9406
9407
9408</table>
9409
9410
9411
9412#### Response
9413
9414**Content-Type: ** application/json
9415
9416
9417| Status Code | Reason | Response Model |
9418|-------------|-------------|----------------|
9419| default | successful operation | - |
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431## /workflow/v1.0/actions/{actionUUID}/artifacts/{artifactUUID}
9432
9433
9434### GET
9435
9436<a id="downloadArtifact">Downloads artifact for action</a>
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446#### Request
9447
9448
9449**Content-Type: ** application/json
9450
9451##### Parameters
9452
9453<table border="1">
9454 <tr>
9455 <th>Name</th>
9456 <th>Located in</th>
9457 <th>Required</th>
9458 <th>Description</th>
9459 <th>Default</th>
9460 <th>Schema</th>
9461 </tr>
9462
9463
9464
9465<tr>
9466 <th>actionUUID</th>
9467 <td>path</td>
9468 <td>yes</td>
9469 <td></td>
9470 <td> - </td>
9471
9472
9473 <td>string </td>
9474
9475
9476</tr>
9477
9478<tr>
9479 <th>artifactUUID</th>
9480 <td>path</td>
9481 <td>yes</td>
9482 <td></td>
9483 <td> - </td>
9484
9485
9486 <td>string </td>
9487
9488
9489</tr>
9490
9491
9492</table>
9493
9494
9495
9496#### Response
9497
9498**Content-Type: ** application/octet-stream
9499
9500
9501| Status Code | Reason | Response Model |
9502|-------------|-------------|----------------|
9503| default | successful operation | - |
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522# Definitions
9523
9524## <a name="/definitions/Attachment">Attachment</a>
9525
9526<table border="1">
9527 <tr>
9528 <th>name</th>
9529 <th>type</th>
9530 <th>required</th>
9531 <th>description</th>
9532 <th>example</th>
9533 </tr>
9534
9535 <tr>
9536 <td>headers</td>
9537 <td>
9538
9539
9540 object
9541
9542 </td>
9543 <td>optional</td>
9544 <td>-</td>
9545 <td></td>
9546 </tr>
9547
9548 <tr>
9549 <td>object</td>
9550 <td>
9551
9552
9553 object
9554
9555 </td>
9556 <td>optional</td>
9557 <td>-</td>
9558 <td></td>
9559 </tr>
9560
9561 <tr>
9562 <td>contentType</td>
9563 <td>
9564
9565 <a href="#/definitions/MediaType">MediaType</a>
9566
9567
9568 </td>
9569 <td>optional</td>
9570 <td>-</td>
9571 <td></td>
9572 </tr>
9573
9574 <tr>
9575 <td>contentDisposition</td>
9576 <td>
9577
9578 <a href="#/definitions/ContentDisposition">ContentDisposition</a>
9579
9580
9581 </td>
9582 <td>optional</td>
9583 <td>-</td>
9584 <td></td>
9585 </tr>
9586
9587 <tr>
9588 <td>dataHandler</td>
9589 <td>
9590
9591 <a href="#/definitions/DataHandler">DataHandler</a>
9592
9593
9594 </td>
9595 <td>optional</td>
9596 <td>-</td>
9597 <td></td>
9598 </tr>
9599
Michael Lando0de99c22017-02-28 10:54:57 +0200[diff] [blame]9600 <tr>
9601 <td>contentId</td>
9602 <td>
9603
9604
9605 string
9606
9607 </td>
9608 <td>optional</td>
9609 <td>-</td>
9610 <td></td>
9611 </tr>
9612
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]9613</table>
9614
9615## <a name="/definitions/ChoiceOrOtherDtoAggregationFunction">ChoiceOrOtherDtoAggregationFunction</a>
9616
9617<table border="1">
9618 <tr>
9619 <th>name</th>
9620 <th>type</th>
9621 <th>required</th>
9622 <th>description</th>
9623 <th>example</th>
9624 </tr>
9625
9626 <tr>
9627 <td>choice</td>
9628 <td>
9629
9630
9631 string
9632
9633 </td>
9634 <td>required</td>
9635 <td>-</td>
9636 <td></td>
9637 </tr>
9638
9639 <tr>
9640 <td>other</td>
9641 <td>
9642
9643
9644 string
9645
9646 </td>
9647 <td>required</td>
9648 <td>-</td>
9649 <td></td>
9650 </tr>
9651
9652</table>
9653
9654## <a name="/definitions/ChoiceOrOtherDtoEntitlementMetric">ChoiceOrOtherDtoEntitlementMetric</a>
9655
9656<table border="1">
9657 <tr>
9658 <th>name</th>
9659 <th>type</th>
9660 <th>required</th>
9661 <th>description</th>
9662 <th>example</th>
9663 </tr>
9664
9665 <tr>
9666 <td>choice</td>
9667 <td>
9668
9669
9670 string
9671
9672 </td>
9673 <td>required</td>
9674 <td>-</td>
9675 <td></td>
9676 </tr>
9677
9678 <tr>
9679 <td>other</td>
9680 <td>
9681
9682
9683 string
9684
9685 </td>
9686 <td>required</td>
9687 <td>-</td>
9688 <td></td>
9689 </tr>
9690
9691</table>
9692
9693## <a name="/definitions/ChoiceOrOtherDtoEntitlementTime">ChoiceOrOtherDtoEntitlementTime</a>
9694
9695<table border="1">
9696 <tr>
9697 <th>name</th>
9698 <th>type</th>
9699 <th>required</th>
9700 <th>description</th>
9701 <th>example</th>
9702 </tr>
9703
9704 <tr>
9705 <td>choice</td>
9706 <td>
9707
9708
9709 string
9710
9711 </td>
9712 <td>required</td>
9713 <td>-</td>
9714 <td></td>
9715 </tr>
9716
9717 <tr>
9718 <td>other</td>
9719 <td>
9720
9721
9722 string
9723
9724 </td>
9725 <td>required</td>
9726 <td>-</td>
9727 <td></td>
9728 </tr>
9729
9730</table>
9731
9732## <a name="/definitions/ChoiceOrOtherDtoLicenseTerm">ChoiceOrOtherDtoLicenseTerm</a>
9733
9734<table border="1">
9735 <tr>
9736 <th>name</th>
9737 <th>type</th>
9738 <th>required</th>
9739 <th>description</th>
9740 <th>example</th>
9741 </tr>
9742
9743 <tr>
9744 <td>choice</td>
9745 <td>
9746
9747
9748 string
9749
9750 </td>
9751 <td>required</td>
9752 <td>-</td>
9753 <td></td>
9754 </tr>
9755
9756 <tr>
9757 <td>other</td>
9758 <td>
9759
9760
9761 string
9762
9763 </td>
9764 <td>required</td>
9765 <td>-</td>
9766 <td></td>
9767 </tr>
9768
9769</table>
9770
9771## <a name="/definitions/CommandInfo">CommandInfo</a>
9772
9773<table border="1">
9774 <tr>
9775 <th>name</th>
9776 <th>type</th>
9777 <th>required</th>
9778 <th>description</th>
9779 <th>example</th>
9780 </tr>
9781
9782 <tr>
9783 <td>commandClass</td>
9784 <td>
9785
9786
9787 string
9788
9789 </td>
9790 <td>optional</td>
9791 <td>-</td>
9792 <td></td>
9793 </tr>
9794
9795 <tr>
9796 <td>commandName</td>
9797 <td>
9798
9799
9800 string
9801
9802 </td>
9803 <td>optional</td>
9804 <td>-</td>
9805 <td></td>
9806 </tr>
9807
9808</table>
9809
9810## <a name="/definitions/ComponentData">ComponentData</a>
9811
9812<table border="1">
9813 <tr>
9814 <th>name</th>
9815 <th>type</th>
9816 <th>required</th>
9817 <th>description</th>
9818 <th>example</th>
9819 </tr>
9820
9821 <tr>
9822 <td>name</td>
9823 <td>
9824
9825
9826 string
9827
9828 </td>
9829 <td>optional</td>
9830 <td>-</td>
9831 <td></td>
9832 </tr>
9833
9834 <tr>
9835 <td>description</td>
9836 <td>
9837
9838
9839 string
9840
9841 </td>
9842 <td>optional</td>
9843 <td>-</td>
9844 <td></td>
9845 </tr>
9846
9847 <tr>
9848 <td>displayName</td>
9849 <td>
9850
9851
9852 string
9853
9854 </td>
9855 <td>optional</td>
9856 <td>-</td>
9857 <td></td>
9858 </tr>
9859
9860</table>
9861
9862## <a name="/definitions/ComponentDto">ComponentDto</a>
9863
9864<table border="1">
9865 <tr>
9866 <th>name</th>
9867 <th>type</th>
9868 <th>required</th>
9869 <th>description</th>
9870 <th>example</th>
9871 </tr>
9872
9873 <tr>
9874 <td>name</td>
9875 <td>
9876
9877
9878 string
9879
9880 </td>
9881 <td>optional</td>
9882 <td>-</td>
9883 <td></td>
9884 </tr>
9885
9886 <tr>
9887 <td>displayName</td>
9888 <td>
9889
9890
9891 string
9892
9893 </td>
9894 <td>optional</td>
9895 <td>-</td>
9896 <td></td>
9897 </tr>
9898
9899 <tr>
9900 <td>description</td>
9901 <td>
9902
9903
9904 string
9905
9906 </td>
9907 <td>optional</td>
9908 <td>-</td>
9909 <td></td>
9910 </tr>
9911
9912 <tr>
9913 <td>id</td>
9914 <td>
9915
9916
9917 string
9918
9919 </td>
9920 <td>optional</td>
9921 <td>-</td>
9922 <td></td>
9923 </tr>
9924
9925</table>
9926
9927## <a name="/definitions/ComponentRequestDto">ComponentRequestDto</a>
9928
9929<table border="1">
9930 <tr>
9931 <th>name</th>
9932 <th>type</th>
9933 <th>required</th>
9934 <th>description</th>
9935 <th>example</th>
9936 </tr>
9937
9938 <tr>
9939 <td>name</td>
9940 <td>
9941
9942
9943 string
9944
9945 </td>
9946 <td>optional</td>
9947 <td>-</td>
9948 <td></td>
9949 </tr>
9950
9951 <tr>
9952 <td>displayName</td>
9953 <td>
9954
9955
9956 string
9957
9958 </td>
9959 <td>optional</td>
9960 <td>-</td>
9961 <td></td>
9962 </tr>
9963
9964 <tr>
9965 <td>description</td>
9966 <td>
9967
9968
9969 string
9970
9971 </td>
9972 <td>optional</td>
9973 <td>-</td>
9974 <td></td>
9975 </tr>
9976
9977</table>
9978
9979## <a name="/definitions/ConfigurationDataDto">ConfigurationDataDto</a>
9980
9981<table border="1">
9982 <tr>
9983 <th>name</th>
9984 <th>type</th>
9985 <th>required</th>
9986 <th>description</th>
9987 <th>example</th>
9988 </tr>
9989
9990 <tr>
9991 <td>value</td>
9992 <td>
9993
9994
9995 string
9996
9997 </td>
9998 <td>optional</td>
9999 <td>-</td>
10000 <td></td>
10001 </tr>
10002
10003 <tr>
10004 <td>timeStamp</td>
10005 <td>
10006
10007
10008 integer (int64)
10009
10010 </td>
10011 <td>optional</td>
10012 <td>-</td>
10013 <td></td>
10014 </tr>
10015
10016</table>
10017
10018## <a name="/definitions/ContentDisposition">ContentDisposition</a>
10019
10020<table border="1">
10021 <tr>
10022 <th>name</th>
10023 <th>type</th>
10024 <th>required</th>
10025 <th>description</th>
10026 <th>example</th>
10027 </tr>
10028
10029 <tr>
10030 <td>type</td>
10031 <td>
10032
10033
10034 string
10035
10036 </td>
10037 <td>optional</td>
10038 <td>-</td>
10039 <td></td>
10040 </tr>
10041
10042 <tr>
10043 <td>parameters</td>
10044 <td>
10045
10046
10047 object
10048
10049 </td>
10050 <td>optional</td>
10051 <td>-</td>
10052 <td></td>
10053 </tr>
10054
10055 <tr>
10056 <td>filename</td>
10057 <td>
10058
10059
10060 string
10061
10062 </td>
10063 <td>optional</td>
10064 <td>-</td>
10065 <td></td>
10066 </tr>
10067
10068</table>
10069
10070## <a name="/definitions/DataFlavor">DataFlavor</a>
10071
10072<table border="1">
10073 <tr>
10074 <th>name</th>
10075 <th>type</th>
10076 <th>required</th>
10077 <th>description</th>
10078 <th>example</th>
10079 </tr>
10080
10081 <tr>
10082 <td>mimeType</td>
10083 <td>
10084
10085
10086 string
10087
10088 </td>
10089 <td>optional</td>
10090 <td>-</td>
10091 <td></td>
10092 </tr>
10093
10094 <tr>
10095 <td>humanPresentableName</td>
10096 <td>
10097
10098
10099 string
10100
10101 </td>
10102 <td>optional</td>
10103 <td>-</td>
10104 <td></td>
10105 </tr>
10106
10107 <tr>
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]10108 <td>defaultRepresentationClassAsString</td>
10109 <td>
10110
10111
10112 string
10113
10114 </td>
10115 <td>optional</td>
10116 <td>-</td>
10117 <td></td>
10118 </tr>
10119
10120 <tr>
10121 <td>primaryType</td>
10122 <td>
10123
10124
10125 string
10126
10127 </td>
10128 <td>optional</td>
10129 <td>-</td>
10130 <td></td>
10131 </tr>
10132
10133 <tr>
10134 <td>flavorJavaFileListType</td>
10135 <td>
10136
10137
10138 boolean
10139
10140 </td>
10141 <td>optional</td>
10142 <td>-</td>
10143 <td></td>
10144 </tr>
10145
10146 <tr>
10147 <td>flavorRemoteObjectType</td>
10148 <td>
10149
10150
10151 boolean
10152
10153 </td>
10154 <td>optional</td>
10155 <td>-</td>
10156 <td></td>
10157 </tr>
10158
10159 <tr>
10160 <td>flavorSerializedObjectType</td>
10161 <td>
10162
10163
10164 boolean
10165
10166 </td>
10167 <td>optional</td>
10168 <td>-</td>
10169 <td></td>
10170 </tr>
10171
10172 <tr>
10173 <td>flavorTextType</td>
10174 <td>
10175
10176
10177 boolean
10178
10179 </td>
10180 <td>optional</td>
10181 <td>-</td>
10182 <td></td>
10183 </tr>
10184
10185 <tr>
10186 <td>mimeTypeSerializedObject</td>
10187 <td>
10188
10189
10190 boolean
10191
10192 </td>
10193 <td>optional</td>
10194 <td>-</td>
10195 <td></td>
10196 </tr>
10197
10198 <tr>
10199 <td>representationClassByteBuffer</td>
10200 <td>
10201
10202
10203 boolean
10204
10205 </td>
10206 <td>optional</td>
10207 <td>-</td>
10208 <td></td>
10209 </tr>
10210
10211 <tr>
10212 <td>representationClassCharBuffer</td>
10213 <td>
10214
10215
10216 boolean
10217
10218 </td>
10219 <td>optional</td>
10220 <td>-</td>
10221 <td></td>
10222 </tr>
10223
10224 <tr>
10225 <td>representationClassInputStream</td>
10226 <td>
10227
10228
10229 boolean
10230
10231 </td>
10232 <td>optional</td>
10233 <td>-</td>
10234 <td></td>
10235 </tr>
10236
10237 <tr>
10238 <td>representationClassReader</td>
10239 <td>
10240
10241
10242 boolean
10243
10244 </td>
10245 <td>optional</td>
10246 <td>-</td>
10247 <td></td>
10248 </tr>
10249
10250 <tr>
10251 <td>representationClassRemote</td>
10252 <td>
10253
10254
10255 boolean
10256
10257 </td>
10258 <td>optional</td>
10259 <td>-</td>
10260 <td></td>
10261 </tr>
10262
10263 <tr>
10264 <td>representationClassSerializable</td>
10265 <td>
10266
10267
10268 boolean
10269
10270 </td>
10271 <td>optional</td>
10272 <td>-</td>
10273 <td></td>
10274 </tr>
10275
Michael Lando0de99c22017-02-28 10:54:57 +0200[diff] [blame]10276 <tr>
10277 <td>subType</td>
10278 <td>
10279
10280
10281 string
10282
10283 </td>
10284 <td>optional</td>
10285 <td>-</td>
10286 <td></td>
10287 </tr>
10288
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]10289</table>
10290
10291## <a name="/definitions/DataHandler">DataHandler</a>
10292
10293<table border="1">
10294 <tr>
10295 <th>name</th>
10296 <th>type</th>
10297 <th>required</th>
10298 <th>description</th>
10299 <th>example</th>
10300 </tr>
10301
10302 <tr>
10303 <td>dataSource</td>
10304 <td>
10305
10306 <a href="#/definitions/DataSource">DataSource</a>
10307
10308
10309 </td>
10310 <td>optional</td>
10311 <td>-</td>
10312 <td></td>
10313 </tr>
10314
10315 <tr>
10316 <td>name</td>
10317 <td>
10318
10319
10320 string
10321
10322 </td>
10323 <td>optional</td>
10324 <td>-</td>
10325 <td></td>
10326 </tr>
10327
10328 <tr>
10329 <td>inputStream</td>
10330 <td>
10331
10332 <a href="#/definitions/InputStream">InputStream</a>
10333
10334
10335 </td>
10336 <td>optional</td>
10337 <td>-</td>
10338 <td></td>
10339 </tr>
10340
10341 <tr>
10342 <td>content</td>
10343 <td>
10344
10345
10346 object
10347
10348 </td>
10349 <td>optional</td>
10350 <td>-</td>
10351 <td></td>
10352 </tr>
10353
10354 <tr>
10355 <td>contentType</td>
10356 <td>
10357
10358
10359 string
10360
10361 </td>
10362 <td>optional</td>
10363 <td>-</td>
10364 <td></td>
10365 </tr>
10366
10367 <tr>
10368 <td>outputStream</td>
10369 <td>
10370
10371 <a href="#/definitions/OutputStream">OutputStream</a>
10372
10373
10374 </td>
10375 <td>optional</td>
10376 <td>-</td>
10377 <td></td>
10378 </tr>
10379
10380 <tr>
10381 <td>allCommands</td>
10382 <td>
10383
10384
10385 array[<a href="#/definitions/CommandInfo">CommandInfo</a>]
10386
10387
10388
10389 </td>
10390 <td>optional</td>
10391 <td>-</td>
10392 <td></td>
10393 </tr>
10394
10395 <tr>
10396 <td>preferredCommands</td>
10397 <td>
10398
10399
10400 array[<a href="#/definitions/CommandInfo">CommandInfo</a>]
10401
10402
10403
10404 </td>
10405 <td>optional</td>
10406 <td>-</td>
10407 <td></td>
10408 </tr>
10409
10410 <tr>
10411 <td>transferDataFlavors</td>
10412 <td>
10413
10414
10415 array[<a href="#/definitions/DataFlavor">DataFlavor</a>]
10416
10417
10418
10419 </td>
10420 <td>optional</td>
10421 <td>-</td>
10422 <td></td>
10423 </tr>
10424
10425</table>
10426
10427## <a name="/definitions/DataSource">DataSource</a>
10428
10429<table border="1">
10430 <tr>
10431 <th>name</th>
10432 <th>type</th>
10433 <th>required</th>
10434 <th>description</th>
10435 <th>example</th>
10436 </tr>
10437
10438 <tr>
10439 <td>name</td>
10440 <td>
10441
10442
10443 string
10444
10445 </td>
10446 <td>optional</td>
10447 <td>-</td>
10448 <td></td>
10449 </tr>
10450
10451 <tr>
10452 <td>inputStream</td>
10453 <td>
10454
10455 <a href="#/definitions/InputStream">InputStream</a>
10456
10457
10458 </td>
10459 <td>optional</td>
10460 <td>-</td>
10461 <td></td>
10462 </tr>
10463
10464 <tr>
10465 <td>contentType</td>
10466 <td>
10467
10468
10469 string
10470
10471 </td>
10472 <td>optional</td>
10473 <td>-</td>
10474 <td></td>
10475 </tr>
10476
10477 <tr>
10478 <td>outputStream</td>
10479 <td>
10480
10481 <a href="#/definitions/OutputStream">OutputStream</a>
10482
10483
10484 </td>
10485 <td>optional</td>
10486 <td>-</td>
10487 <td></td>
10488 </tr>
10489
10490</table>
10491
10492## <a name="/definitions/EntitlementPoolEntity">EntitlementPoolEntity</a>
10493
10494<table border="1">
10495 <tr>
10496 <th>name</th>
10497 <th>type</th>
10498 <th>required</th>
10499 <th>description</th>
10500 <th>example</th>
10501 </tr>
10502
10503 <tr>
10504 <td>name</td>
10505 <td>
10506
10507
10508 string
10509
10510 </td>
10511 <td>required</td>
10512 <td>-</td>
10513 <td></td>
10514 </tr>
10515
10516 <tr>
10517 <td>description</td>
10518 <td>
10519
10520
10521 string
10522
10523 </td>
10524 <td>required</td>
10525 <td>-</td>
10526 <td></td>
10527 </tr>
10528
10529 <tr>
10530 <td>thresholdValue</td>
10531 <td>
10532
10533
10534 integer (int32)
10535
10536 </td>
10537 <td>required</td>
10538 <td>-</td>
10539 <td></td>
10540 </tr>
10541
10542 <tr>
10543 <td>thresholdUnits</td>
10544 <td>
10545
10546
10547 string
10548
10549 </td>
10550 <td>required</td>
10551 <td>-</td>
10552 <td></td>
10553 </tr>
10554
10555 <tr>
10556 <td>entitlementMetric</td>
10557 <td>
10558
10559 <a href="#/definitions/ChoiceOrOtherDtoEntitlementMetric">ChoiceOrOtherDtoEntitlementMetric</a>
10560
10561
10562 </td>
10563 <td>required</td>
10564 <td>-</td>
10565 <td></td>
10566 </tr>
10567
10568 <tr>
10569 <td>increments</td>
10570 <td>
10571
10572
10573 string
10574
10575 </td>
10576 <td>optional</td>
10577 <td>-</td>
10578 <td></td>
10579 </tr>
10580
10581 <tr>
10582 <td>aggregationFunction</td>
10583 <td>
10584
10585 <a href="#/definitions/ChoiceOrOtherDtoAggregationFunction">ChoiceOrOtherDtoAggregationFunction</a>
10586
10587
10588 </td>
10589 <td>required</td>
10590 <td>-</td>
10591 <td></td>
10592 </tr>
10593
10594 <tr>
10595 <td>operationalScope</td>
10596 <td>
10597
10598 <a href="#/definitions/MultiChoiceOrOtherDtoOperationalScope">MultiChoiceOrOtherDtoOperationalScope</a>
10599
10600
10601 </td>
10602 <td>required</td>
10603 <td>-</td>
10604 <td></td>
10605 </tr>
10606
10607 <tr>
10608 <td>time</td>
10609 <td>
10610
10611 <a href="#/definitions/ChoiceOrOtherDtoEntitlementTime">ChoiceOrOtherDtoEntitlementTime</a>
10612
10613
10614 </td>
10615 <td>required</td>
10616 <td>-</td>
10617 <td></td>
10618 </tr>
10619
10620 <tr>
10621 <td>manufacturerReferenceNumber</td>
10622 <td>
10623
10624
10625 string
10626
10627 </td>
10628 <td>required</td>
10629 <td>-</td>
10630 <td></td>
10631 </tr>
10632
10633 <tr>
10634 <td>id</td>
10635 <td>
10636
10637
10638 string
10639
10640 </td>
10641 <td>optional</td>
10642 <td>-</td>
10643 <td></td>
10644 </tr>
10645
10646 <tr>
10647 <td>referencingFeatureGroups</td>
10648 <td>
10649
10650
10651 array[string]
10652
10653 </td>
10654 <td>optional</td>
10655 <td>-</td>
10656 <td></td>
10657 </tr>
10658
10659</table>
10660
10661## <a name="/definitions/EntitlementPoolRequest">EntitlementPoolRequest</a>
10662
10663<table border="1">
10664 <tr>
10665 <th>name</th>
10666 <th>type</th>
10667 <th>required</th>
10668 <th>description</th>
10669 <th>example</th>
10670 </tr>
10671
10672 <tr>
10673 <td>name</td>
10674 <td>
10675
10676
10677 string
10678
10679 </td>
10680 <td>required</td>
10681 <td>-</td>
10682 <td></td>
10683 </tr>
10684
10685 <tr>
10686 <td>description</td>
10687 <td>
10688
10689
10690 string
10691
10692 </td>
10693 <td>required</td>
10694 <td>-</td>
10695 <td></td>
10696 </tr>
10697
10698 <tr>
10699 <td>thresholdValue</td>
10700 <td>
10701
10702
10703 integer (int32)
10704
10705 </td>
10706 <td>required</td>
10707 <td>-</td>
10708 <td></td>
10709 </tr>
10710
10711 <tr>
10712 <td>thresholdUnits</td>
10713 <td>
10714
10715
10716 string
10717
10718 </td>
10719 <td>required</td>
10720 <td>-</td>
10721 <td></td>
10722 </tr>
10723
10724 <tr>
10725 <td>entitlementMetric</td>
10726 <td>
10727
10728 <a href="#/definitions/ChoiceOrOtherDtoEntitlementMetric">ChoiceOrOtherDtoEntitlementMetric</a>
10729
10730
10731 </td>
10732 <td>required</td>
10733 <td>-</td>
10734 <td></td>
10735 </tr>
10736
10737 <tr>
10738 <td>increments</td>
10739 <td>
10740
10741
10742 string
10743
10744 </td>
10745 <td>optional</td>
10746 <td>-</td>
10747 <td></td>
10748 </tr>
10749
10750 <tr>
10751 <td>aggregationFunction</td>
10752 <td>
10753
10754 <a href="#/definitions/ChoiceOrOtherDtoAggregationFunction">ChoiceOrOtherDtoAggregationFunction</a>
10755
10756
10757 </td>
10758 <td>required</td>
10759 <td>-</td>
10760 <td></td>
10761 </tr>
10762
10763 <tr>
10764 <td>operationalScope</td>
10765 <td>
10766
10767 <a href="#/definitions/MultiChoiceOrOtherDtoOperationalScope">MultiChoiceOrOtherDtoOperationalScope</a>
10768
10769
10770 </td>
10771 <td>required</td>
10772 <td>-</td>
10773 <td></td>
10774 </tr>
10775
10776 <tr>
10777 <td>time</td>
10778 <td>
10779
10780 <a href="#/definitions/ChoiceOrOtherDtoEntitlementTime">ChoiceOrOtherDtoEntitlementTime</a>
10781
10782
10783 </td>
10784 <td>required</td>
10785 <td>-</td>
10786 <td></td>
10787 </tr>
10788
10789 <tr>
10790 <td>manufacturerReferenceNumber</td>
10791 <td>
10792
10793
10794 string
10795
10796 </td>
10797 <td>required</td>
10798 <td>-</td>
10799 <td></td>
10800 </tr>
10801
10802</table>
10803
10804## <a name="/definitions/ErrorMessage">ErrorMessage</a>
10805
10806<table border="1">
10807 <tr>
10808 <th>name</th>
10809 <th>type</th>
10810 <th>required</th>
10811 <th>description</th>
10812 <th>example</th>
10813 </tr>
10814
10815 <tr>
10816 <td>level</td>
10817 <td>
10818
10819
10820 string
10821
10822 </td>
10823 <td>optional</td>
10824 <td>-</td>
10825 <td></td>
10826 </tr>
10827
10828 <tr>
10829 <td>message</td>
10830 <td>
10831
10832
10833 string
10834
10835 </td>
10836 <td>optional</td>
10837 <td>-</td>
10838 <td></td>
10839 </tr>
10840
10841</table>
10842
10843## <a name="/definitions/FeatureGroupEntity">FeatureGroupEntity</a>
10844
10845<table border="1">
10846 <tr>
10847 <th>name</th>
10848 <th>type</th>
10849 <th>required</th>
10850 <th>description</th>
10851 <th>example</th>
10852 </tr>
10853
10854 <tr>
10855 <td>name</td>
10856 <td>
10857
10858
10859 string
10860
10861 </td>
10862 <td>required</td>
10863 <td>-</td>
10864 <td></td>
10865 </tr>
10866
10867 <tr>
10868 <td>description</td>
10869 <td>
10870
10871
10872 string
10873
10874 </td>
10875 <td>required</td>
10876 <td>-</td>
10877 <td></td>
10878 </tr>
10879
10880 <tr>
10881 <td>partNumber</td>
10882 <td>
10883
10884
10885 string
10886
10887 </td>
10888 <td>required</td>
10889 <td>-</td>
10890 <td></td>
10891 </tr>
10892
10893 <tr>
10894 <td>id</td>
10895 <td>
10896
10897
10898 string
10899
10900 </td>
10901 <td>optional</td>
10902 <td>-</td>
10903 <td></td>
10904 </tr>
10905
10906 <tr>
10907 <td>licenseKeyGroupsIds</td>
10908 <td>
10909
10910
10911 array[string]
10912
10913 </td>
10914 <td>optional</td>
10915 <td>-</td>
10916 <td></td>
10917 </tr>
10918
10919 <tr>
10920 <td>entitlementPoolsIds</td>
10921 <td>
10922
10923
10924 array[string]
10925
10926 </td>
10927 <td>optional</td>
10928 <td>-</td>
10929 <td></td>
10930 </tr>
10931
10932 <tr>
10933 <td>referencingLicenseAgreements</td>
10934 <td>
10935
10936
10937 array[string]
10938
10939 </td>
10940 <td>optional</td>
10941 <td>-</td>
10942 <td></td>
10943 </tr>
10944
10945</table>
10946
10947## <a name="/definitions/FeatureGroupModel">FeatureGroupModel</a>
10948
10949<table border="1">
10950 <tr>
10951 <th>name</th>
10952 <th>type</th>
10953 <th>required</th>
10954 <th>description</th>
10955 <th>example</th>
10956 </tr>
10957
10958 <tr>
10959 <td>name</td>
10960 <td>
10961
10962
10963 string
10964
10965 </td>
10966 <td>required</td>
10967 <td>-</td>
10968 <td></td>
10969 </tr>
10970
10971 <tr>
10972 <td>description</td>
10973 <td>
10974
10975
10976 string
10977
10978 </td>
10979 <td>required</td>
10980 <td>-</td>
10981 <td></td>
10982 </tr>
10983
10984 <tr>
10985 <td>partNumber</td>
10986 <td>
10987
10988
10989 string
10990
10991 </td>
10992 <td>required</td>
10993 <td>-</td>
10994 <td></td>
10995 </tr>
10996
10997 <tr>
10998 <td>id</td>
10999 <td>
11000
11001
11002 string
11003
11004 </td>
11005 <td>optional</td>
11006 <td>-</td>
11007 <td></td>
11008 </tr>
11009
11010 <tr>
11011 <td>referencingLicenseAgreements</td>
11012 <td>
11013
11014
11015 array[string]
11016
11017 </td>
11018 <td>optional</td>
11019 <td>-</td>
11020 <td></td>
11021 </tr>
11022
11023 <tr>
11024 <td>licenseKeyGroups</td>
11025 <td>
11026
11027
11028 array[<a href="#/definitions/LicenseKeyGroupEntityDto">LicenseKeyGroupEntityDto</a>]
11029
11030
11031
11032 </td>
11033 <td>optional</td>
11034 <td>-</td>
11035 <td></td>
11036 </tr>
11037
11038 <tr>
11039 <td>entitlementPools</td>
11040 <td>
11041
11042
11043 array[<a href="#/definitions/EntitlementPoolEntity">EntitlementPoolEntity</a>]
11044
11045
11046
11047 </td>
11048 <td>optional</td>
11049 <td>-</td>
11050 <td></td>
11051 </tr>
11052
11053</table>
11054
11055## <a name="/definitions/FeatureGroupRequest">FeatureGroupRequest</a>
11056
11057<table border="1">
11058 <tr>
11059 <th>name</th>
11060 <th>type</th>
11061 <th>required</th>
11062 <th>description</th>
11063 <th>example</th>
11064 </tr>
11065
11066 <tr>
11067 <td>name</td>
11068 <td>
11069
11070
11071 string
11072
11073 </td>
11074 <td>required</td>
11075 <td>-</td>
11076 <td></td>
11077 </tr>
11078
11079 <tr>
11080 <td>description</td>
11081 <td>
11082
11083
11084 string
11085
11086 </td>
11087 <td>required</td>
11088 <td>-</td>
11089 <td></td>
11090 </tr>
11091
11092 <tr>
11093 <td>partNumber</td>
11094 <td>
11095
11096
11097 string
11098
11099 </td>
11100 <td>required</td>
11101 <td>-</td>
11102 <td></td>
11103 </tr>
11104
11105 <tr>
11106 <td>addedLicenseKeyGroupsIds</td>
11107 <td>
11108
11109
11110 array[string]
11111
11112 </td>
11113 <td>optional</td>
11114 <td>-</td>
11115 <td></td>
11116 </tr>
11117
11118 <tr>
11119 <td>addedEntitlementPoolsIds</td>
11120 <td>
11121
11122
11123 array[string]
11124
11125 </td>
11126 <td>optional</td>
11127 <td>-</td>
11128 <td></td>
11129 </tr>
11130
11131</table>
11132
11133## <a name="/definitions/FeatureGroupUpdateRequest">FeatureGroupUpdateRequest</a>
11134
11135<table border="1">
11136 <tr>
11137 <th>name</th>
11138 <th>type</th>
11139 <th>required</th>
11140 <th>description</th>
11141 <th>example</th>
11142 </tr>
11143
11144 <tr>
11145 <td>name</td>
11146 <td>
11147
11148
11149 string
11150
11151 </td>
11152 <td>required</td>
11153 <td>-</td>
11154 <td></td>
11155 </tr>
11156
11157 <tr>
11158 <td>description</td>
11159 <td>
11160
11161
11162 string
11163
11164 </td>
11165 <td>required</td>
11166 <td>-</td>
11167 <td></td>
11168 </tr>
11169
11170 <tr>
11171 <td>partNumber</td>
11172 <td>
11173
11174
11175 string
11176
11177 </td>
11178 <td>required</td>
11179 <td>-</td>
11180 <td></td>
11181 </tr>
11182
11183 <tr>
11184 <td>addedLicenseKeyGroupsIds</td>
11185 <td>
11186
11187
11188 array[string]
11189
11190 </td>
11191 <td>optional</td>
11192 <td>-</td>
11193 <td></td>
11194 </tr>
11195
11196 <tr>
11197 <td>addedEntitlementPoolsIds</td>
11198 <td>
11199
11200
11201 array[string]
11202
11203 </td>
11204 <td>optional</td>
11205 <td>-</td>
11206 <td></td>
11207 </tr>
11208
11209 <tr>
11210 <td>removedLicenseKeyGroupsIds</td>
11211 <td>
11212
11213
11214 array[string]
11215
11216 </td>
11217 <td>optional</td>
11218 <td>-</td>
11219 <td></td>
11220 </tr>
11221
11222 <tr>
11223 <td>removedEntitlementPoolsIds</td>
11224 <td>
11225
11226
11227 array[string]
11228
11229 </td>
11230 <td>optional</td>
11231 <td>-</td>
11232 <td></td>
11233 </tr>
11234
11235</table>
11236
11237## <a name="/definitions/File">File</a>
11238
11239<table border="1">
11240 <tr>
11241 <th>name</th>
11242 <th>type</th>
11243 <th>required</th>
11244 <th>description</th>
11245 <th>example</th>
11246 </tr>
11247
11248 <tr>
11249 <td>path</td>
11250 <td>
11251
11252
11253 string
11254
11255 </td>
11256 <td>optional</td>
11257 <td>-</td>
11258 <td></td>
11259 </tr>
11260
11261 <tr>
11262 <td>name</td>
11263 <td>
11264
11265
11266 string
11267
11268 </td>
11269 <td>optional</td>
11270 <td>-</td>
11271 <td></td>
11272 </tr>
11273
11274 <tr>
11275 <td>canonicalPath</td>
11276 <td>
11277
11278
11279 string
11280
11281 </td>
11282 <td>optional</td>
11283 <td>-</td>
11284 <td></td>
11285 </tr>
11286
11287 <tr>
11288 <td>parent</td>
11289 <td>
11290
11291
11292 string
11293
11294 </td>
11295 <td>optional</td>
11296 <td>-</td>
11297 <td></td>
11298 </tr>
11299
11300 <tr>
11301 <td>absolute</td>
11302 <td>
11303
11304
11305 boolean
11306
11307 </td>
11308 <td>optional</td>
11309 <td>-</td>
11310 <td></td>
11311 </tr>
11312
11313 <tr>
11314 <td>absoluteFile</td>
11315 <td>
11316
11317 <a href="#/definitions/File">File</a>
11318
11319
11320 </td>
11321 <td>optional</td>
11322 <td>-</td>
11323 <td></td>
11324 </tr>
11325
11326 <tr>
11327 <td>absolutePath</td>
11328 <td>
11329
11330
11331 string
11332
11333 </td>
11334 <td>optional</td>
11335 <td>-</td>
11336 <td></td>
11337 </tr>
11338
11339 <tr>
11340 <td>canonicalFile</td>
11341 <td>
11342
11343 <a href="#/definitions/File">File</a>
11344
11345
11346 </td>
11347 <td>optional</td>
11348 <td>-</td>
11349 <td></td>
11350 </tr>
11351
11352 <tr>
11353 <td>freeSpace</td>
11354 <td>
11355
11356
11357 integer (int64)
11358
11359 </td>
11360 <td>optional</td>
11361 <td>-</td>
11362 <td></td>
11363 </tr>
11364
11365 <tr>
11366 <td>parentFile</td>
11367 <td>
11368
11369 <a href="#/definitions/File">File</a>
11370
11371
11372 </td>
11373 <td>optional</td>
11374 <td>-</td>
11375 <td></td>
11376 </tr>
11377
11378 <tr>
11379 <td>totalSpace</td>
11380 <td>
11381
11382
11383 integer (int64)
11384
11385 </td>
11386 <td>optional</td>
11387 <td>-</td>
11388 <td></td>
11389 </tr>
11390
11391 <tr>
11392 <td>usableSpace</td>
11393 <td>
11394
11395
11396 integer (int64)
11397
11398 </td>
11399 <td>optional</td>
11400 <td>-</td>
11401 <td></td>
11402 </tr>
11403
11404 <tr>
11405 <td>directory</td>
11406 <td>
11407
11408
11409 boolean
11410
11411 </td>
11412 <td>optional</td>
11413 <td>-</td>
11414 <td></td>
11415 </tr>
11416
11417 <tr>
11418 <td>file</td>
11419 <td>
11420
11421
11422 boolean
11423
11424 </td>
11425 <td>optional</td>
11426 <td>-</td>
11427 <td></td>
11428 </tr>
11429
11430 <tr>
11431 <td>hidden</td>
11432 <td>
11433
11434
11435 boolean
11436
11437 </td>
11438 <td>optional</td>
11439 <td>-</td>
11440 <td></td>
11441 </tr>
11442
11443</table>
11444
11445## <a name="/definitions/InputStream">InputStream</a>
11446
11447<table border="1">
11448 <tr>
11449 <th>name</th>
11450 <th>type</th>
11451 <th>required</th>
11452 <th>description</th>
11453 <th>example</th>
11454 </tr>
11455
11456</table>
11457
11458## <a name="/definitions/LicenseAgreementEntity">LicenseAgreementEntity</a>
11459
11460<table border="1">
11461 <tr>
11462 <th>name</th>
11463 <th>type</th>
11464 <th>required</th>
11465 <th>description</th>
11466 <th>example</th>
11467 </tr>
11468
11469 <tr>
11470 <td>name</td>
11471 <td>
11472
11473
11474 string
11475
11476 </td>
11477 <td>required</td>
11478 <td>-</td>
11479 <td></td>
11480 </tr>
11481
11482 <tr>
11483 <td>description</td>
11484 <td>
11485
11486
11487 string
11488
11489 </td>
11490 <td>required</td>
11491 <td>-</td>
11492 <td></td>
11493 </tr>
11494
11495 <tr>
11496 <td>licenseTerm</td>
11497 <td>
11498
11499 <a href="#/definitions/ChoiceOrOtherDtoLicenseTerm">ChoiceOrOtherDtoLicenseTerm</a>
11500
11501
11502 </td>
11503 <td>required</td>
11504 <td>-</td>
11505 <td></td>
11506 </tr>
11507
11508 <tr>
11509 <td>requirementsAndConstrains</td>
11510 <td>
11511
11512
11513 string
11514
11515 </td>
11516 <td>optional</td>
11517 <td>-</td>
11518 <td></td>
11519 </tr>
11520
11521 <tr>
11522 <td>id</td>
11523 <td>
11524
11525
11526 string
11527
11528 </td>
11529 <td>optional</td>
11530 <td>-</td>
11531 <td></td>
11532 </tr>
11533
11534 <tr>
11535 <td>featureGroupsIds</td>
11536 <td>
11537
11538
11539 array[string]
11540
11541 </td>
11542 <td>optional</td>
11543 <td>-</td>
11544 <td></td>
11545 </tr>
11546
11547</table>
11548
11549## <a name="/definitions/LicenseAgreementModel">LicenseAgreementModel</a>
11550
11551<table border="1">
11552 <tr>
11553 <th>name</th>
11554 <th>type</th>
11555 <th>required</th>
11556 <th>description</th>
11557 <th>example</th>
11558 </tr>
11559
11560 <tr>
11561 <td>name</td>
11562 <td>
11563
11564
11565 string
11566
11567 </td>
11568 <td>required</td>
11569 <td>-</td>
11570 <td></td>
11571 </tr>
11572
11573 <tr>
11574 <td>description</td>
11575 <td>
11576
11577
11578 string
11579
11580 </td>
11581 <td>required</td>
11582 <td>-</td>
11583 <td></td>
11584 </tr>
11585
11586 <tr>
11587 <td>licenseTerm</td>
11588 <td>
11589
11590 <a href="#/definitions/ChoiceOrOtherDtoLicenseTerm">ChoiceOrOtherDtoLicenseTerm</a>
11591
11592
11593 </td>
11594 <td>required</td>
11595 <td>-</td>
11596 <td></td>
11597 </tr>
11598
11599 <tr>
11600 <td>requirementsAndConstrains</td>
11601 <td>
11602
11603
11604 string
11605
11606 </td>
11607 <td>optional</td>
11608 <td>-</td>
11609 <td></td>
11610 </tr>
11611
11612 <tr>
11613 <td>id</td>
11614 <td>
11615
11616
11617 string
11618
11619 </td>
11620 <td>optional</td>
11621 <td>-</td>
11622 <td></td>
11623 </tr>
11624
11625 <tr>
11626 <td>featureGroups</td>
11627 <td>
11628
11629
11630 array[<a href="#/definitions/FeatureGroupEntity">FeatureGroupEntity</a>]
11631
11632
11633
11634 </td>
11635 <td>optional</td>
11636 <td>-</td>
11637 <td></td>
11638 </tr>
11639
11640</table>
11641
11642## <a name="/definitions/LicenseAgreementRequest">LicenseAgreementRequest</a>
11643
11644<table border="1">
11645 <tr>
11646 <th>name</th>
11647 <th>type</th>
11648 <th>required</th>
11649 <th>description</th>
11650 <th>example</th>
11651 </tr>
11652
11653 <tr>
11654 <td>name</td>
11655 <td>
11656
11657
11658 string
11659
11660 </td>
11661 <td>required</td>
11662 <td>-</td>
11663 <td></td>
11664 </tr>
11665
11666 <tr>
11667 <td>description</td>
11668 <td>
11669
11670
11671 string
11672
11673 </td>
11674 <td>required</td>
11675 <td>-</td>
11676 <td></td>
11677 </tr>
11678
11679 <tr>
11680 <td>licenseTerm</td>
11681 <td>
11682
11683 <a href="#/definitions/ChoiceOrOtherDtoLicenseTerm">ChoiceOrOtherDtoLicenseTerm</a>
11684
11685
11686 </td>
11687 <td>required</td>
11688 <td>-</td>
11689 <td></td>
11690 </tr>
11691
11692 <tr>
11693 <td>requirementsAndConstrains</td>
11694 <td>
11695
11696
11697 string
11698
11699 </td>
11700 <td>optional</td>
11701 <td>-</td>
11702 <td></td>
11703 </tr>
11704
11705 <tr>
11706 <td>addedFeatureGroupsIds</td>
11707 <td>
11708
11709
11710 array[string]
11711
11712 </td>
11713 <td>optional</td>
11714 <td>-</td>
11715 <td></td>
11716 </tr>
11717
11718</table>
11719
11720## <a name="/definitions/LicenseAgreementUpdateRequest">LicenseAgreementUpdateRequest</a>
11721
11722<table border="1">
11723 <tr>
11724 <th>name</th>
11725 <th>type</th>
11726 <th>required</th>
11727 <th>description</th>
11728 <th>example</th>
11729 </tr>
11730
11731 <tr>
11732 <td>name</td>
11733 <td>
11734
11735
11736 string
11737
11738 </td>
11739 <td>required</td>
11740 <td>-</td>
11741 <td></td>
11742 </tr>
11743
11744 <tr>
11745 <td>description</td>
11746 <td>
11747
11748
11749 string
11750
11751 </td>
11752 <td>required</td>
11753 <td>-</td>
11754 <td></td>
11755 </tr>
11756
11757 <tr>
11758 <td>licenseTerm</td>
11759 <td>
11760
11761 <a href="#/definitions/ChoiceOrOtherDtoLicenseTerm">ChoiceOrOtherDtoLicenseTerm</a>
11762
11763
11764 </td>
11765 <td>required</td>
11766 <td>-</td>
11767 <td></td>
11768 </tr>
11769
11770 <tr>
11771 <td>requirementsAndConstrains</td>
11772 <td>
11773
11774
11775 string
11776
11777 </td>
11778 <td>optional</td>
11779 <td>-</td>
11780 <td></td>
11781 </tr>
11782
11783 <tr>
11784 <td>addedFeatureGroupsIds</td>
11785 <td>
11786
11787
11788 array[string]
11789
11790 </td>
11791 <td>optional</td>
11792 <td>-</td>
11793 <td></td>
11794 </tr>
11795
11796 <tr>
11797 <td>removedFeatureGroupsIds</td>
11798 <td>
11799
11800
11801 array[string]
11802
11803 </td>
11804 <td>optional</td>
11805 <td>-</td>
11806 <td></td>
11807 </tr>
11808
11809</table>
11810
11811## <a name="/definitions/LicenseKeyGroupEntityDto">LicenseKeyGroupEntityDto</a>
11812
11813<table border="1">
11814 <tr>
11815 <th>name</th>
11816 <th>type</th>
11817 <th>required</th>
11818 <th>description</th>
11819 <th>example</th>
11820 </tr>
11821
11822 <tr>
11823 <td>name</td>
11824 <td>
11825
11826
11827 string
11828
11829 </td>
11830 <td>required</td>
11831 <td>-</td>
11832 <td></td>
11833 </tr>
11834
11835 <tr>
11836 <td>description</td>
11837 <td>
11838
11839
11840 string
11841
11842 </td>
11843 <td>required</td>
11844 <td>-</td>
11845 <td></td>
11846 </tr>
11847
11848 <tr>
11849 <td>type</td>
11850 <td>
11851
11852
11853 string
11854
11855 </td>
11856 <td>required</td>
11857 <td>-</td>
11858 <td></td>
11859 </tr>
11860
11861 <tr>
11862 <td>operationalScope</td>
11863 <td>
11864
11865 <a href="#/definitions/MultiChoiceOrOtherDtoOperationalScope">MultiChoiceOrOtherDtoOperationalScope</a>
11866
11867
11868 </td>
11869 <td>required</td>
11870 <td>-</td>
11871 <td></td>
11872 </tr>
11873
11874 <tr>
11875 <td>id</td>
11876 <td>
11877
11878
11879 string
11880
11881 </td>
11882 <td>optional</td>
11883 <td>-</td>
11884 <td></td>
11885 </tr>
11886
11887 <tr>
11888 <td>referencingFeatureGroups</td>
11889 <td>
11890
11891
11892 array[string]
11893
11894 </td>
11895 <td>optional</td>
11896 <td>-</td>
11897 <td></td>
11898 </tr>
11899
11900</table>
11901
11902## <a name="/definitions/LicenseKeyGroupRequestDto">LicenseKeyGroupRequestDto</a>
11903
11904<table border="1">
11905 <tr>
11906 <th>name</th>
11907 <th>type</th>
11908 <th>required</th>
11909 <th>description</th>
11910 <th>example</th>
11911 </tr>
11912
11913 <tr>
11914 <td>name</td>
11915 <td>
11916
11917
11918 string
11919
11920 </td>
11921 <td>required</td>
11922 <td>-</td>
11923 <td></td>
11924 </tr>
11925
11926 <tr>
11927 <td>description</td>
11928 <td>
11929
11930
11931 string
11932
11933 </td>
11934 <td>required</td>
11935 <td>-</td>
11936 <td></td>
11937 </tr>
11938
11939 <tr>
11940 <td>type</td>
11941 <td>
11942
11943
11944 string
11945
11946 </td>
11947 <td>required</td>
11948 <td>-</td>
11949 <td></td>
11950 </tr>
11951
11952 <tr>
11953 <td>operationalScope</td>
11954 <td>
11955
11956 <a href="#/definitions/MultiChoiceOrOtherDtoOperationalScope">MultiChoiceOrOtherDtoOperationalScope</a>
11957
11958
11959 </td>
11960 <td>required</td>
11961 <td>-</td>
11962 <td></td>
11963 </tr>
11964
11965</table>
11966
11967## <a name="/definitions/LicensingData">LicensingData</a>
11968
11969<table border="1">
11970 <tr>
11971 <th>name</th>
11972 <th>type</th>
11973 <th>required</th>
11974 <th>description</th>
11975 <th>example</th>
11976 </tr>
11977
11978 <tr>
11979 <td>licenseAgreement</td>
11980 <td>
11981
11982
11983 string
11984
11985 </td>
11986 <td>optional</td>
11987 <td>-</td>
11988 <td></td>
11989 </tr>
11990
11991 <tr>
11992 <td>featureGroups</td>
11993 <td>
11994
11995
11996 array[string]
11997
11998 </td>
11999 <td>optional</td>
12000 <td>-</td>
12001 <td></td>
12002 </tr>
12003
12004</table>
12005
12006## <a name="/definitions/MediaType">MediaType</a>
12007
12008<table border="1">
12009 <tr>
12010 <th>name</th>
12011 <th>type</th>
12012 <th>required</th>
12013 <th>description</th>
12014 <th>example</th>
12015 </tr>
12016
12017 <tr>
12018 <td>type</td>
12019 <td>
12020
12021
12022 string
12023
12024 </td>
12025 <td>optional</td>
12026 <td>-</td>
12027 <td></td>
12028 </tr>
12029
12030 <tr>
12031 <td>subtype</td>
12032 <td>
12033
12034
12035 string
12036
12037 </td>
12038 <td>optional</td>
12039 <td>-</td>
12040 <td></td>
12041 </tr>
12042
12043 <tr>
12044 <td>parameters</td>
12045 <td>
12046
12047
12048 object
12049
12050 </td>
12051 <td>optional</td>
12052 <td>-</td>
12053 <td></td>
12054 </tr>
12055
12056 <tr>
Michael Landoefa037d2017-02-19 12:57:33 +0200[diff] [blame]12057 <td>wildcardType</td>
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]12058 <td>
12059
12060
12061 boolean
12062
12063 </td>
12064 <td>optional</td>
12065 <td>-</td>
12066 <td></td>
12067 </tr>
12068
12069 <tr>
Michael Landoefa037d2017-02-19 12:57:33 +0200[diff] [blame]12070 <td>wildcardSubtype</td>
Michael Landof5f13c42017-02-19 12:35:04 +0200[diff] [blame]12071 <td>
12072
12073
12074 boolean
12075
12076 </td>
12077 <td>optional</td>
12078 <td>-</td>
12079 <td></td>
12080 </tr>
12081
12082</table>
12083
12084## <a name="/definitions/MibUploadStatusDto">MibUploadStatusDto</a>
12085
12086<table border="1">
12087 <tr>
12088 <th>name</th>
12089 <th>type</th>
12090 <th>required</th>
12091 <th>description</th>
12092 <th>example</th>
12093 </tr>
12094
12095 <tr>
12096 <td>snmpTrap</td>
12097 <td>
12098
12099
12100 string
12101
12102 </td>
12103 <td>optional</td>
12104 <td>-</td>
12105 <td></td>
12106 </tr>
12107
12108 <tr>
12109 <td>snmpPoll</td>
12110 <td>
12111
12112
12113 string
12114
12115 </td>
12116 <td>optional</td>
12117 <td>-</td>
12118 <td></td>
12119 </tr>
12120
12121</table>
12122
12123## <a name="/definitions/MultiChoiceOrOtherDtoOperationalScope">MultiChoiceOrOtherDtoOperationalScope</a>
12124
12125<table border="1">
12126 <tr>
12127 <th>name</th>
12128 <th>type</th>
12129 <th>required</th>
12130 <th>description</th>
12131 <th>example</th>
12132 </tr>
12133
12134 <tr>
12135 <td>choices</td>
12136 <td>
12137
12138
12139 array[string]
12140
12141 </td>
12142 <td>required</td>
12143 <td>-</td>
12144 <td></td>
12145 </tr>
12146
12147 <tr>
12148 <td>other</td>
12149 <td>
12150
12151
12152 string
12153
12154 </td>
12155 <td>required</td>
12156 <td>-</td>
12157 <td></td>
12158 </tr>
12159
12160</table>
12161
12162## <a name="/definitions/NetworkDto">NetworkDto</a>
12163
12164<table border="1">
12165 <tr>
12166 <th>name</th>
12167 <th>type</th>
12168 <th>required</th>
12169 <th>description</th>
12170 <th>example</th>
12171 </tr>
12172
12173 <tr>
12174 <td>name</td>
12175 <td>
12176
12177
12178 string
12179
12180 </td>
12181 <td>required</td>
12182 <td>-</td>
12183 <td></td>
12184 </tr>
12185
12186 <tr>
12187 <td>dhcp</td>
12188 <td>
12189
12190
12191 boolean
12192
12193 </td>
12194 <td>required</td>
12195 <td>-</td>
12196 <td></td>
12197 </tr>
12198
12199 <tr>
12200 <td>id</td>
12201 <td>
12202
12203
12204 string
12205
12206 </td>
12207 <td>optional</td>
12208 <td>-</td>
12209 <td></td>
12210 </tr>
12211
12212</table>
12213
12214## <a name="/definitions/NetworkRequestDto">NetworkRequestDto</a>
12215
12216<table border="1">
12217 <tr>
12218 <th>name</th>
12219 <th>type</th>
12220 <th>required</th>
12221 <th>description</th>
12222 <th>example</th>
12223 </tr>
12224
12225 <tr>
12226 <td>name</td>
12227 <td>
12228
12229
12230 string
12231
12232 </td>
12233 <td>required</td>
12234 <td>-</td>
12235 <td></td>
12236 </tr>
12237
12238 <tr>
12239 <td>dhcp</td>
12240 <td>
12241
12242
12243 boolean
12244
12245 </td>
12246 <td>required</td>
12247 <td>-</td>
12248 <td></td>
12249 </tr>
12250
12251</table>
12252
12253## <a name="/definitions/NicDto">NicDto</a>
12254
12255<table border="1">
12256 <tr>
12257 <th>name</th>
12258 <th>type</th>
12259 <th>required</th>
12260 <th>description</th>
12261 <th>example</th>
12262 </tr>
12263
12264 <tr>
12265 <td>name</td>
12266 <td>
12267
12268
12269 string
12270
12271 </td>
12272 <td>optional</td>
12273 <td>-</td>
12274 <td></td>
12275 </tr>
12276
12277 <tr>
12278 <td>description</td>
12279 <td>
12280
12281
12282 string
12283
12284 </td>
12285 <td>optional</td>
12286 <td>-</td>
12287 <td></td>
12288 </tr>
12289
12290 <tr>
12291 <td>networkId</td>
12292 <td>
12293
12294
12295 string
12296
12297 </td>
12298 <td>optional</td>
12299 <td>-</td>
12300 <td></td>
12301 </tr>
12302
12303 <tr>
12304 <td>id</td>
12305 <td>
12306
12307
12308 string
12309
12310 </td>
12311 <td>optional</td>
12312 <td>-</td>
12313 <td></td>
12314 </tr>
12315
12316 <tr>
12317 <td>networkName</td>
12318 <td>
12319
12320
12321 string
12322
12323 </td>
12324 <td>optional</td>
12325 <td>-</td>
12326 <td></td>
12327 </tr>
12328
12329</table>
12330
12331## <a name="/definitions/NicRequestDto">NicRequestDto</a>
12332
12333<table border="1">
12334 <tr>
12335 <th>name</th>
12336 <th>type</th>
12337 <th>required</th>
12338 <th>description</th>
12339 <th>example</th>
12340 </tr>
12341
12342 <tr>
12343 <td>name</td>
12344 <td>
12345
12346
12347 string
12348
12349 </td>
12350 <td>optional</td>
12351 <td>-</td>
12352 <td></td>
12353 </tr>
12354
12355 <tr>
12356 <td>description</td>
12357 <td>
12358
12359
12360 string
12361
12362 </td>
12363 <td>optional</td>
12364 <td>-</td>
12365 <td></td>
12366 </tr>
12367
12368 <tr>
12369 <td>networkId</td>
12370 <td>
12371
12372
12373 string
12374
12375 </td>
12376 <td>optional</td>
12377 <td>-</td>
12378 <td></td>
12379 </tr>
12380
12381</table>
12382
12383## <a name="/definitions/OutputStream">OutputStream</a>
12384
12385<table border="1">
12386 <tr>
12387 <th>name</th>
12388 <th>type</th>
12389 <th>required</th>
12390 <th>description</th>
12391 <th>example</th>
12392 </tr>
12393
12394</table>
12395
12396## <a name="/definitions/PackageInfoDto">PackageInfoDto</a>
12397
12398<table border="1">
12399 <tr>
12400 <th>name</th>
12401 <th>type</th>
12402 <th>required</th>
12403 <th>description</th>
12404 <th>example</th>
12405 </tr>
12406
12407 <tr>
12408 <td>displayName</td>
12409 <td>
12410
12411
12412 string
12413
12414 </td>
12415 <td>optional</td>
12416 <td>-</td>
12417 <td></td>
12418 </tr>
12419
12420 <tr>
12421 <td>description</td>
12422 <td>
12423
12424
12425 string
12426
12427 </td>
12428 <td>optional</td>
12429 <td>-</td>
12430 <td></td>
12431 </tr>
12432
12433 <tr>
12434 <td>vspName</td>
12435 <td>
12436
12437
12438 string
12439
12440 </td>
12441 <td>optional</td>
12442 <td>-</td>
12443 <td></td>
12444 </tr>
12445
12446 <tr>
12447 <td>version</td>
12448 <td>
12449
12450
12451 string
12452
12453 </td>
12454 <td>optional</td>
12455 <td>-</td>
12456 <td></td>
12457 </tr>
12458
12459 <tr>
12460 <td>packageId</td>
12461 <td>
12462
12463
12464 string
12465
12466 </td>
12467 <td>optional</td>
12468 <td>-</td>
12469 <td></td>
12470 </tr>
12471
12472 <tr>
12473 <td>category</td>
12474 <td>
12475
12476
12477 string
12478
12479 </td>
12480 <td>optional</td>
12481 <td>-</td>
12482 <td></td>
12483 </tr>
12484
12485 <tr>
12486 <td>subCategory</td>
12487 <td>
12488
12489
12490 string
12491
12492 </td>
12493 <td>optional</td>
12494 <td>-</td>
12495 <td></td>
12496 </tr>
12497
12498 <tr>
12499 <td>vendorName</td>
12500 <td>
12501
12502
12503 string
12504
12505 </td>
12506 <td>optional</td>
12507 <td>-</td>
12508 <td></td>
12509 </tr>
12510
12511 <tr>
12512 <td>vendorRelease</td>
12513 <td>
12514
12515
12516 string
12517
12518 </td>
12519 <td>optional</td>
12520 <td>-</td>
12521 <td></td>
12522 </tr>
12523
12524 <tr>
12525 <td>packageChecksum</td>
12526 <td>
12527
12528
12529 string
12530
12531 </td>
12532 <td>optional</td>
12533 <td>-</td>
12534 <td></td>
12535 </tr>
12536
12537 <tr>
12538 <td>packageType</td>
12539 <td>
12540
12541
12542 string
12543
12544 </td>
12545 <td>optional</td>
12546 <td>-</td>
12547 <td></td>
12548 </tr>
12549
12550</table>
12551
12552## <a name="/definitions/ProcessEntityDto">ProcessEntityDto</a>
12553
12554<table border="1">
12555 <tr>
12556 <th>name</th>
12557 <th>type</th>
12558 <th>required</th>
12559 <th>description</th>
12560 <th>example</th>
12561 </tr>
12562
12563 <tr>
12564 <td>name</td>
12565 <td>
12566
12567
12568 string
12569
12570 </td>
12571 <td>required</td>
12572 <td>-</td>
12573 <td></td>
12574 </tr>
12575
12576 <tr>
12577 <td>description</td>
12578 <td>
12579
12580
12581 string
12582
12583 </td>
12584 <td>optional</td>
12585 <td>-</td>
12586 <td></td>
12587 </tr>
12588
12589 <tr>
12590 <td>id</td>
12591 <td>
12592
12593
12594 string
12595
12596 </td>
12597 <td>optional</td>
12598 <td>-</td>
12599 <td></td>
12600 </tr>
12601
12602 <tr>
12603 <td>artifactName</td>
12604 <td>
12605
12606
12607 string
12608
12609 </td>
12610 <td>optional</td>
12611 <td>-</td>
12612 <td></td>
12613 </tr>
12614
12615</table>
12616
12617## <a name="/definitions/ProcessRequestDto">ProcessRequestDto</a>
12618
12619<table border="1">
12620 <tr>
12621 <th>name</th>
12622 <th>type</th>
12623 <th>required</th>
12624 <th>description</th>
12625 <th>example</th>
12626 </tr>
12627
12628 <tr>
12629 <td>name</td>
12630 <td>
12631
12632
12633 string
12634
12635 </td>
12636 <td>required</td>
12637 <td>-</td>
12638 <td></td>
12639 </tr>
12640
12641 <tr>
12642 <td>description</td>
12643 <td>
12644
12645
12646 string
12647
12648 </td>
12649 <td>optional</td>
12650 <td>-</td>
12651 <td></td>
12652 </tr>
12653
12654</table>
12655
12656## <a name="/definitions/QuestionnaireResponseDto">QuestionnaireResponseDto</a>
12657
12658<table border="1">
12659 <tr>
12660 <th>name</th>
12661 <th>type</th>
12662 <th>required</th>
12663 <th>description</th>
12664 <th>example</th>
12665 </tr>
12666
12667 <tr>
12668 <td>schema</td>
12669 <td>
12670
12671
12672 string
12673
12674 </td>
12675 <td>optional</td>
12676 <td>-</td>
12677 <td></td>
12678 </tr>
12679
12680 <tr>
12681 <td>data</td>
12682 <td>
12683
12684
12685 string
12686
12687 </td>
12688 <td>optional</td>
12689 <td>-</td>
12690 <td></td>
12691 </tr>
12692
12693</table>
12694
12695## <a name="/definitions/UploadFileResponseDto">UploadFileResponseDto</a>
12696
12697<table border="1">
12698 <tr>
12699 <th>name</th>
12700 <th>type</th>
12701 <th>required</th>
12702 <th>description</th>
12703 <th>example</th>
12704 </tr>
12705
12706 <tr>
12707 <td>fileNames</td>
12708 <td>
12709
12710
12711 array[string]
12712
12713 </td>
12714 <td>optional</td>
12715 <td>-</td>
12716 <td></td>
12717 </tr>
12718
12719 <tr>
12720 <td>errors</td>
12721 <td>
12722
12723
12724 object
12725
12726 </td>
12727 <td>optional</td>
12728 <td>-</td>
12729 <td></td>
12730 </tr>
12731
12732 <tr>
12733 <td>status</td>
12734 <td>
12735
12736
12737 string
12738
12739 </td>
12740 <td>optional</td>
12741 <td>-</td>
12742 <td></td>
12743 </tr>
12744
12745</table>
12746
12747## <a name="/definitions/VendorLicenseModelActionRequestDto">VendorLicenseModelActionRequestDto</a>
12748
12749<table border="1">
12750 <tr>
12751 <th>name</th>
12752 <th>type</th>
12753 <th>required</th>
12754 <th>description</th>
12755 <th>example</th>
12756 </tr>
12757
12758 <tr>
12759 <td>action</td>
12760 <td>
12761
12762
12763 string
12764
12765 </td>
12766 <td>optional</td>
12767 <td>-</td>
12768 <td></td>
12769 </tr>
12770
12771</table>
12772
12773## <a name="/definitions/VendorLicenseModelEntity">VendorLicenseModelEntity</a>
12774
12775<table border="1">
12776 <tr>
12777 <th>name</th>
12778 <th>type</th>
12779 <th>required</th>
12780 <th>description</th>
12781 <th>example</th>
12782 </tr>
12783
12784 <tr>
12785 <td>vendorName</td>
12786 <td>
12787
12788
12789 string
12790
12791 </td>
12792 <td>required</td>
12793 <td>-</td>
12794 <td></td>
12795 </tr>
12796
12797 <tr>
12798 <td>description</td>
12799 <td>
12800
12801
12802 string
12803
12804 </td>
12805 <td>required</td>
12806 <td>-</td>
12807 <td></td>
12808 </tr>
12809
12810 <tr>
12811 <td>iconRef</td>
12812 <td>
12813
12814
12815 string
12816
12817 </td>
12818 <td>required</td>
12819 <td>-</td>
12820 <td></td>
12821 </tr>
12822
12823 <tr>
12824 <td>id</td>
12825 <td>
12826
12827
12828 string
12829
12830 </td>
12831 <td>optional</td>
12832 <td>-</td>
12833 <td></td>
12834 </tr>
12835
12836 <tr>
12837 <td>version</td>
12838 <td>
12839
12840
12841 string
12842
12843 </td>
12844 <td>optional</td>
12845 <td>-</td>
12846 <td></td>
12847 </tr>
12848
12849 <tr>
12850 <td>status</td>
12851 <td>
12852
12853
12854 string
12855
12856 </td>
12857 <td>optional</td>
12858 <td>-</td>
12859 <td></td>
12860 </tr>
12861
12862 <tr>
12863 <td>lockingUser</td>
12864 <td>
12865
12866
12867 string
12868
12869 </td>
12870 <td>optional</td>
12871 <td>-</td>
12872 <td></td>
12873 </tr>
12874
12875 <tr>
12876 <td>viewableVersions</td>
12877 <td>
12878
12879
12880 array[string]
12881
12882 </td>
12883 <td>optional</td>
12884 <td>-</td>
12885 <td></td>
12886 </tr>
12887
12888 <tr>
12889 <td>finalVersions</td>
12890 <td>
12891
12892
12893 array[string]
12894
12895 </td>
12896 <td>optional</td>
12897 <td>-</td>
12898 <td></td>
12899 </tr>
12900
12901</table>
12902
12903## <a name="/definitions/VendorLicenseModelRequest">VendorLicenseModelRequest</a>
12904
12905<table border="1">
12906 <tr>
12907 <th>name</th>
12908 <th>type</th>
12909 <th>required</th>
12910 <th>description</th>
12911 <th>example</th>
12912 </tr>
12913
12914 <tr>
12915 <td>vendorName</td>
12916 <td>
12917
12918
12919 string
12920
12921 </td>
12922 <td>required</td>
12923 <td>-</td>
12924 <td></td>
12925 </tr>
12926
12927 <tr>
12928 <td>description</td>
12929 <td>
12930
12931
12932 string
12933
12934 </td>
12935 <td>required</td>
12936 <td>-</td>
12937 <td></td>
12938 </tr>
12939
12940 <tr>
12941 <td>iconRef</td>
12942 <td>
12943
12944
12945 string
12946
12947 </td>
12948 <td>required</td>
12949 <td>-</td>
12950 <td></td>
12951 </tr>
12952
12953</table>
12954
12955## <a name="/definitions/VersionSoftwareProductActionRequestDto">VersionSoftwareProductActionRequestDto</a>
12956
12957<table border="1">
12958 <tr>
12959 <th>name</th>
12960 <th>type</th>
12961 <th>required</th>
12962 <th>description</th>
12963 <th>example</th>
12964 </tr>
12965
12966 <tr>
12967 <td>action</td>
12968 <td>
12969
12970
12971 string
12972
12973 </td>
12974 <td>optional</td>
12975 <td>-</td>
12976 <td></td>
12977 </tr>
12978
12979</table>
12980
12981## <a name="/definitions/VspCreationDto">VspCreationDto</a>
12982
12983<table border="1">
12984 <tr>
12985 <th>name</th>
12986 <th>type</th>
12987 <th>required</th>
12988 <th>description</th>
12989 <th>example</th>
12990 </tr>
12991
12992 <tr>
12993 <td>vspId</td>
12994 <td>
12995
12996
12997 string
12998
12999 </td>
13000 <td>optional</td>
13001 <td>-</td>
13002 <td></td>
13003 </tr>
13004
13005</table>
13006
13007## <a name="/definitions/VspDescriptionDto">VspDescriptionDto</a>
13008
13009<table border="1">
13010 <tr>
13011 <th>name</th>
13012 <th>type</th>
13013 <th>required</th>
13014 <th>description</th>
13015 <th>example</th>
13016 </tr>
13017
13018 <tr>
13019 <td>name</td>
13020 <td>
13021
13022
13023 string
13024
13025 </td>
13026 <td>required</td>
13027 <td>-</td>
13028 <td></td>
13029 </tr>
13030
13031 <tr>
13032 <td>description</td>
13033 <td>
13034
13035
13036 string
13037
13038 </td>
13039 <td>required</td>
13040 <td>-</td>
13041 <td></td>
13042 </tr>
13043
13044 <tr>
13045 <td>icon</td>
13046 <td>
13047
13048
13049 string
13050
13051 </td>
13052 <td>optional</td>
13053 <td>-</td>
13054 <td></td>
13055 </tr>
13056
13057 <tr>
13058 <td>category</td>
13059 <td>
13060
13061
13062 string
13063
13064 </td>
13065 <td>required</td>
13066 <td>-</td>
13067 <td></td>
13068 </tr>
13069
13070 <tr>
13071 <td>subCategory</td>
13072 <td>
13073
13074
13075 string
13076
13077 </td>
13078 <td>required</td>
13079 <td>-</td>
13080 <td></td>
13081 </tr>
13082
13083 <tr>
13084 <td>vendorName</td>
13085 <td>
13086
13087
13088 string
13089
13090 </td>
13091 <td>required</td>
13092 <td>-</td>
13093 <td></td>
13094 </tr>
13095
13096 <tr>
13097 <td>vendorId</td>
13098 <td>
13099
13100
13101 string
13102
13103 </td>
13104 <td>required</td>
13105 <td>-</td>
13106 <td></td>
13107 </tr>
13108
13109 <tr>
13110 <td>licensingVersion</td>
13111 <td>
13112
13113
13114 string
13115
13116 </td>
13117 <td>optional</td>
13118 <td>-</td>
13119 <td></td>
13120 </tr>
13121
13122 <tr>
13123 <td>licensingData</td>
13124 <td>
13125
13126 <a href="#/definitions/LicensingData">LicensingData</a>
13127
13128
13129 </td>
13130 <td>optional</td>
13131 <td>-</td>
13132 <td></td>
13133 </tr>
13134
13135</table>
13136
13137</xmp>
13138
13139<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
13140</html>