Gitiles
Code Review Sign In
gerrit.nordix.org / onap / so / 0ba1528b972c9311df0ed01b6ec47a22481a4f9d / . / docs / api / swagger / swagger.yaml
blob: 181a8df756078a75953d1e6d759af27c2b9db78c [file] [log] [blame]
seshukm68b0a262018-09-28 16:28:41 +0800[diff] [blame]1swagger: '2.0'
2info:
3 version: 3.1.2
Priyadharshini3cf70702020-08-10 10:01:05 +0530[diff] [blame]4 title: SO Guilin APIs
seshukm68b0a262018-09-28 16:28:41 +0800[diff] [blame]5tags:
6 - name: e2eServiceInstances
Priyadharshinic86ab4a2020-08-14 17:11:49 +0530[diff] [blame]7 - name: Onap3gppServiceInstances
seshukm68b0a262018-09-28 16:28:41 +0800[diff] [blame]8 - name: globalhealthcheck
9 - name: nodehealthcheck
10 - name: onapsoinfraorchestrationRequests
Priyadharshinic86ab4a2020-08-14 17:11:49 +0530[diff] [blame]11 - name: onapsoinfraorchestrationTasks
seshukm68b0a262018-09-28 16:28:41 +0800[diff] [blame]12 - name: onapsoinfraserviceInstantiation
13 - name: onapsoinfratasks
14 - name: onapsoinfracloudResources
15 - name: onapsoinfracloudResourcesRequests
16 - name: onapsoinframodelDistributions
rameshiyer27e28d9422020-08-17 15:51:46 +0100[diff] [blame]17 - name: onapsoinfraworkflowSpecifications
18 - name: onapsoinfrainstanceManagement
seshukm68b0a262018-09-28 16:28:41 +0800[diff] [blame]19schemes:
seshukm9bd738c2019-01-18 14:11:47 +0530[diff] [blame]20 - http
seshukm68b0a262018-09-28 16:28:41 +0800[diff] [blame]21paths:
22 '/onap/so/infra/e2eServiceInstances/{version}':
23 post:
24 tags:
25 - e2eServiceInstances
26 summary: Create an E2E Service Instance on a version provided
27 description: ''
28 operationId: createE2EServiceInstance
29 consumes:
30 - application/json
31 produces:
32 - application/json
33 parameters:
34 - in: body
35 name: body
36 required: false
37 schema:
38 type: string
39 - name: version
40 in: path
41 required: true
42 type: string
43 pattern: '[vV][3-5]'
44 responses:
45 default:
46 description: successful operation
47 '/onap/so/infra/e2eServiceInstances/{version}/{serviceId}':
48 put:
49 tags:
50 - e2eServiceInstances
51 summary: Update an E2E Service Instance on a version provided and serviceId
52 description: ''
53 operationId: updateE2EServiceInstance
54 consumes:
55 - application/json
56 produces:
57 - application/json
58 parameters:
59 - in: body
60 name: body
61 required: false
62 schema:
63 type: string
64 - name: version
65 in: path
66 required: true
67 type: string
68 pattern: '[vV][3-5]'
69 - name: serviceId
70 in: path
71 required: true
72 type: string
73 responses:
74 default:
75 description: successful operation
76 delete:
77 tags:
78 - e2eServiceInstances
79 summary: Delete E2E Service Instance on a specified version and serviceId
80 description: ''
81 operationId: deleteE2EServiceInstance
82 consumes:
83 - application/json
84 produces:
85 - application/json
86 parameters:
87 - in: body
88 name: body
89 required: false
90 schema:
91 type: string
92 - name: version
93 in: path
94 required: true
95 type: string
96 pattern: '[vV][3-5]'
97 - name: serviceId
98 in: path
99 required: true
100 type: string
101 responses:
102 default:
103 description: successful operation
Priyadharshinic86ab4a2020-08-14 17:11:49 +0530[diff] [blame]104 '/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/{operationType}':
105 post:
106 tags:
107 - e2eServiceInstances
108 summary: >-
109 Activate/Deactivate 5G slice Service on a specified version and
110 serviceId
111 description: ''
112 operationId: activateE2EServiceInstances
113 consumes:
114 - application/json
115 produces:
116 - application/json
117 parameters:
118 - in: body
119 name: body
120 required: false
121 schema:
122 type: string
123 - name: version
124 in: path
125 required: true
126 type: string
127 pattern: '[vV][3-5]'
128 - name: serviceId
129 in: path
130 required: true
131 type: string
132 - name: operationType
133 in: path
134 required: true
135 type: string
136 pattern: activate/deactivate
137 responses:
138 default:
139 description: successful operation
seshukm68b0a262018-09-28 16:28:41 +0800[diff] [blame]140 '/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}':
141 get:
142 tags:
143 - e2eServiceInstances
144 summary: Find e2eServiceInstances Requests for a given serviceId and operationId
145 description: ''
146 operationId: getE2EServiceInstances
147 produces:
148 - application/json
149 parameters:
150 - name: serviceId
151 in: path
152 required: true
153 type: string
154 - name: version
155 in: path
156 required: true
157 type: string
158 pattern: '[vV][3-5]'
159 - name: operationId
160 in: path
161 required: true
162 type: string
163 responses:
164 default:
165 description: successful operation
166 '/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/scale':
167 post:
168 tags:
169 - e2eServiceInstances
170 summary: Scale E2E Service Instance on a specified version
171 description: ''
172 operationId: scaleE2EServiceInstance
173 consumes:
174 - application/json
175 produces:
176 - application/json
177 parameters:
178 - in: body
179 name: body
180 required: false
181 schema:
182 type: string
183 - name: version
184 in: path
185 required: true
186 type: string
187 pattern: '[vV][3-5]'
188 - name: serviceId
189 in: path
190 required: true
191 type: string
192 responses:
193 default:
194 description: successful operation
195 '/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/modeldifferences':
196 post:
197 tags:
198 - e2eServiceInstances
199 summary: >-
200 Find added and deleted resources of target model for the
rameshiyer27e28d9422020-08-17 15:51:46 +0100[diff] [blame]201 e2eserviceInstance on a given serviceId
seshukm68b0a262018-09-28 16:28:41 +0800[diff] [blame]202 description: ''
203 operationId: compareModelwithTargetVersion
204 consumes:
205 - application/json
206 produces:
207 - application/json
208 parameters:
209 - in: body
210 name: body
211 required: false
212 schema:
213 type: string
214 - name: serviceId
215 in: path
216 required: true
217 type: string
218 - name: version
219 in: path
220 required: true
221 type: string
222 pattern: '[vV][3-5]'
223 responses:
224 default:
225 description: successful operation
Priyadharshini3cf70702020-08-10 10:01:05 +0530[diff] [blame]226 '/onap/so/infra/3gppservices/{version}/allocate':
227 post:
228 tags:
Priyadharshinic86ab4a2020-08-14 17:11:49 +0530[diff] [blame]229 - Onap3gppServiceInstances
Priyadharshini3cf70702020-08-10 10:01:05 +0530[diff] [blame]230 summary: Create a 3GPP Service Instance on a version provided
231 description: ''
232 operationId: allocate3gppService
233 consumes:
234 - application/json
235 produces:
236 - application/json
237 parameters:
238 - in: body
239 name: body
240 required: true
241 schema:
242 $ref: '#/definitions/Allocate3gppService'
243 - name: version
244 in: path
245 required: true
246 type: string
247 pattern: '[vV][1]'
248 responses:
249 default:
250 description: successful operation
251 schema:
252 $ref: '#/definitions/3gppServiceResponse'
253 '/onap/so/infra/3gppservices/{version}/deAllocate':
254 delete:
255 tags:
Priyadharshinic86ab4a2020-08-14 17:11:49 +0530[diff] [blame]256 - Onap3gppServiceInstances
Priyadharshini3cf70702020-08-10 10:01:05 +0530[diff] [blame]257 summary: Terminate/Deallocate a 3GPP Service Instance on a version provided
258 description: ''
259 operationId: deallocate3gppService
260 consumes:
261 - application/json
262 produces:
263 - application/json
264 parameters:
265 - in: body
266 name: body
267 required: true
268 schema:
269 $ref: '#/definitions/DeAllocate3gppService'
270 - name: version
271 in: path
272 required: true
273 type: string
274 pattern: '[vV][1]'
275 responses:
276 default:
277 description: successful operation
278 schema:
279 $ref: '#/definitions/3gppServiceResponse'
280 '/onap/so/infra/3gppservices/{version}/modify':
281 put:
282 tags:
Priyadharshinic86ab4a2020-08-14 17:11:49 +0530[diff] [blame]283 - Onap3gppServiceInstances
Priyadharshini3cf70702020-08-10 10:01:05 +0530[diff] [blame]284 summary: Modify a 3GPP Service Instance on a version provided
285 description: ''
286 operationId: modify3gppService
287 consumes:
288 - application/json
289 produces:
290 - application/json
291 parameters:
292 - in: body
293 name: body
294 required: true
295 schema:
296 $ref: '#/definitions/Modify3gppService'
297 - name: version
298 in: path
299 required: true
300 type: string
301 pattern: '[vV][1]'
302 responses:
303 default:
304 description: successful operation
305 schema:
306 $ref: '#/definitions/3gppServiceResponse'
307 '/onap/so/infra/3gppservices/{version}/activate':
308 post:
309 tags:
Priyadharshinic86ab4a2020-08-14 17:11:49 +0530[diff] [blame]310 - Onap3gppServiceInstances
Priyadharshini3cf70702020-08-10 10:01:05 +0530[diff] [blame]311 summary: Activate a 3GPP Service Instance on a version provided
312 description: ''
313 operationId: activate3gppService
314 consumes:
315 - application/json
316 produces:
317 - application/json
318 parameters:
319 - in: body
320 name: body
321 required: true
322 schema:
323 $ref: '#/definitions/3gppServiceActivation'
324 - name: version
325 in: path
326 required: true
327 type: string
328 pattern: '[vV][1]'
329 responses:
330 default:
331 description: successful operation
332 schema:
333 $ref: '#/definitions/3gppServiceResponse'
334 '/onap/so/infra/3gppservices/{version}/deActivate':
335 post:
336 tags:
Priyadharshinic86ab4a2020-08-14 17:11:49 +0530[diff] [blame]337 - Onap3gppServiceInstances
Priyadharshini3cf70702020-08-10 10:01:05 +0530[diff] [blame]338 summary: Deactivate a 3GPP Service Instance on a version provided
339 description: ''
340 operationId: deactivate3gppService
341 consumes:
342 - application/json
343 produces:
344 - application/json
345 parameters:
346 - in: body
347 name: body
348 required: true
349 schema:
350 $ref: '#/definitions/3gppServiceActivation'
351 - name: version
352 in: path
353 required: true
354 type: string
355 pattern: '[vV][1]'
356 responses:
357 default:
358 description: successful operation
359 schema:
360 $ref: '#/definitions/3gppServiceResponse'
361 '/onap/so/infra/3gppservices/{version}/subnetCapabilityQuery':
362 get:
363 tags:
Priyadharshinic86ab4a2020-08-14 17:11:49 +0530[diff] [blame]364 - Onap3gppServiceInstances
Priyadharshini3cf70702020-08-10 10:01:05 +0530[diff] [blame]365 summary: Provides subnet capability based on subnet types
366 description: ''
367 operationId: querySubnetCapability
368 consumes:
369 - application/json
370 produces:
371 - application/json
372 parameters:
373 - in: body
374 name: body
375 required: true
376 schema:
377 $ref: '#/definitions/QuerySubnetCapability'
378 - name: version
379 in: path
380 required: true
381 type: string
382 pattern: '[vV][1]'
383 responses:
384 default:
385 description: successful operation with capabilities for the queried subnetTypes
386 schema:
387 type: object
seshukm68b0a262018-09-28 16:28:41 +0800[diff] [blame]388 /globalhealthcheck:
389 get:
390 tags:
391 - globalhealthcheck
392 summary: Performing global health check
393 description: ''
394 operationId: globalHealthcheck
395 produces:
396 - text/html
397 parameters:
398 - name: enableBpmn
399 in: query
400 required: false
401 type: boolean
402 default: true
403 responses:
404 default:
405 description: successful operation
406 /nodehealthcheck:
407 get:
408 tags:
409 - nodehealthcheck
410 summary: Performing node health check
411 description: ''
412 operationId: nodeHealthcheck
413 produces:
414 - text/html
415 parameters: []
416 responses:
417 default:
418 description: successful operation
419 '/onap/so/infra/orchestrationRequests/{version}':
420 get:
421 tags:
422 - onapsoinfraorchestrationRequests
423 summary: Find Orchestrated Requests for a URI Information
424 description: ''
425 operationId: getOrchestrationRequest
426 produces:
427 - application/json
428 parameters:
429 - name: version
430 in: path
431 required: true
432 type: string
433 pattern: '[vV][4-7]'
434 responses:
435 default:
436 description: successful operation
437 '/onap/so/infra/orchestrationRequests/{version}/{requestId}':
438 get:
439 tags:
440 - onapsoinfraorchestrationRequests
441 summary: Find Orchestrated Requests for a given requestId
442 description: ''
443 operationId: getOrchestrationRequestForReqId
444 produces:
445 - application/json
446 parameters:
447 - name: requestId
448 in: path
449 required: true
450 type: string
451 - name: version
452 in: path
453 required: true
454 type: string
455 pattern: '[vV][4-7]'
456 responses:
457 default:
458 description: successful operation
459 '/onap/so/infra/orchestrationRequests/{version}/{requestId}/unlock':
460 post:
461 tags:
462 - onapsoinfraorchestrationRequests
463 summary: Unlock Orchestrated Requests for a given requestId
464 description: ''
465 operationId: unlockOrchestrationRequest
466 consumes:
467 - application/json
468 produces:
469 - application/json
470 parameters:
471 - in: body
472 name: body
473 required: false
474 schema:
475 type: string
476 - name: requestId
477 in: path
478 required: true
479 type: string
480 - name: version
481 in: path
482 required: true
483 type: string
484 pattern: '[vV][4-7]'
485 responses:
486 default:
487 description: successful operation
Priyadharshinic86ab4a2020-08-14 17:11:49 +0530[diff] [blame]488 '/onap/so/infra/orchestrationTasks/{version}':
489 get:
490 tags:
491 - onapsoinfraorchestrationTasks
492 summary: Get all orchestrationTasks
493 description: ''
494 operationId: getAllOrchestrationTasks
495 produces:
496 - application/json
497 parameters:
498 - name: version
499 in: path
500 required: true
501 type: string
502 pattern: '[vV][4-7]'
503 responses:
504 default:
505 description: successful operation
506 post:
507 tags:
508 - onapsoinfraorchestrationTasks
509 summary: Create an orchestrationTask
510 description: ''
511 operationId: createOrchestrationTask
512 produces:
513 - application/json
514 parameters:
515 - in: body
516 name: body
517 required: false
518 schema:
519 type: string
520 - name: version
521 in: path
522 required: true
523 type: string
524 pattern: '[vV][4-7]'
525 responses:
526 default:
527 description: successful operation
528 '/onap/so/infra/orchestrationTasks/{version}/{taskId}':
529 get:
530 tags:
531 - onapsoinfraorchestrationTasks
532 summary: Get orchestrationTask for a given taskId
533 description: ''
534 operationId: getOrchestrationTask
535 produces:
536 - application/json
537 parameters:
538 - name: taskId
539 in: path
540 required: true
541 type: string
542 - name: version
543 in: path
544 required: true
545 type: string
546 pattern: '[vV][4-7]'
547 responses:
548 default:
549 description: successful operation
550 put:
551 tags:
552 - onapsoinfraorchestrationTasks
553 summary: update orchestrationTask for a given taskId
554 description: ''
555 operationId: updateOrchestrationTask
556 produces:
557 - application/json
558 parameters:
559 - name: taskId
560 in: path
561 required: true
562 type: string
563 - name: version
564 in: path
565 required: true
566 type: string
567 pattern: '[vV][4-7]'
568 - in: body
569 name: body
570 required: false
571 schema:
572 type: string
573 responses:
574 default:
575 description: successful operation
576 delete:
577 tags:
578 - onapsoinfraorchestrationTasks
579 summary: delete orchestrationTask for a given taskId
580 description: ''
581 operationId: deleteOrchestrationTask
582 produces:
583 - application/json
584 parameters:
585 - name: taskId
586 in: path
587 required: true
588 type: string
589 - name: version
590 in: path
591 required: true
592 type: string
593 pattern: '[vV][4-7]'
594 responses:
595 default:
596 description: successful operation
597 '/onap/so/infra/orchestrationTasks/{version}/{taskId}/commit':
598 post:
599 tags:
600 - onapsoinfraorchestrationTasks
601 summary: commit orchestrationTask for a given taskId
602 description: ''
603 operationId: commitOrchestrationTask
604 produces:
605 - application/json
606 parameters:
607 - in: body
608 name: body
609 required: false
610 schema:
611 type: string
612 - name: taskId
613 in: path
614 required: true
615 type: string
616 - name: version
617 in: path
618 required: true
619 type: string
620 pattern: '[vV][4-7]'
621 responses:
622 default:
623 description: successful operation
624 '/onap/so/infra/orchestrationTasks/{version}/{taskId}/abort':
625 post:
626 tags:
627 - onapsoinfraorchestrationTasks
628 summary: abort orchestrationTask for a given taskId
629 description: ''
630 operationId: abortOrchestrationTask
631 produces:
632 - application/json
633 parameters:
634 - in: body
635 name: body
636 required: false
637 schema:
638 type: string
639 - name: taskId
640 in: path
641 required: true
642 type: string
643 - name: version
644 in: path
645 required: true
646 type: string
647 pattern: '[vV][4-7]'
648 responses:
649 default:
650 description: successful operation
seshukm68b0a262018-09-28 16:28:41 +0800[diff] [blame]651 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/deactivateAndCloudDelete':
652 post:
653 tags:
654 - onapsoinfraserviceInstantiation
655 summary: Deactivate and Cloud Delete VfModule instance
656 description: ''
657 operationId: deactivateAndCloudDeleteVfModuleInstance
658 consumes:
659 - application/json
660 produces:
661 - application/json
662 parameters:
663 - in: body
664 name: body
665 required: false
666 schema:
667 type: string
668 - name: version
669 in: path
670 required: true
671 type: string
672 pattern: '[vV][7]'
673 - name: serviceInstanceId
674 in: path
675 required: true
676 type: string
677 - name: vnfInstanceId
678 in: path
679 required: true
680 type: string
681 - name: vfmoduleInstanceId
682 in: path
683 required: true
684 type: string
685 responses:
686 default:
687 description: successful operation
688 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/enablePort':
689 post:
690 tags:
691 - onapsoinfraserviceInstantiation
692 summary: Enable Port Mirroring
693 description: ''
694 operationId: enablePort
695 consumes:
696 - application/json
697 produces:
698 - application/json
699 parameters:
700 - in: body
701 name: body
702 required: false
703 schema:
704 type: string
705 - name: version
706 in: path
707 required: true
708 type: string
709 pattern: '[vV][5-7]'
710 - name: serviceInstanceId
711 in: path
712 required: true
713 type: string
714 - name: configurationInstanceId
715 in: path
716 required: true
717 type: string
718 responses:
719 default:
720 description: successful operation
721 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/disablePort':
722 post:
723 tags:
724 - onapsoinfraserviceInstantiation
725 summary: Disable Port Mirroring
726 description: ''
727 operationId: disablePort
728 consumes:
729 - application/json
730 produces:
731 - application/json
732 parameters:
733 - in: body
734 name: body
735 required: false
736 schema:
737 type: string
738 - name: version
739 in: path
740 required: true
741 type: string
742 pattern: '[vV][5-7]'
743 - name: serviceInstanceId
744 in: path
745 required: true
746 type: string
747 - name: configurationInstanceId
748 in: path
749 required: true
750 type: string
751 responses:
752 default:
753 description: successful operation
754 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/activate':
755 post:
756 tags:
757 - onapsoinfraserviceInstantiation
758 summary: Activate Port Mirroring
759 description: ''
760 operationId: activatePort
761 consumes:
762 - application/json
763 produces:
764 - application/json
765 parameters:
766 - in: body
767 name: body
768 required: false
769 schema:
770 type: string
771 - name: version
772 in: path
773 required: true
774 type: string
775 pattern: '[vV][5-7]'
776 - name: serviceInstanceId
777 in: path
778 required: true
779 type: string
780 - name: configurationInstanceId
781 in: path
782 required: true
783 type: string
784 responses:
785 default:
786 description: successful operation
787 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/deactivate':
788 post:
789 tags:
790 - onapsoinfraserviceInstantiation
791 summary: Deactivate Port Mirroring
792 description: ''
793 operationId: deactivatePort
794 consumes:
795 - application/json
796 produces:
797 - application/json
798 parameters:
799 - in: body
800 name: body
801 required: false
802 schema:
803 type: string
804 - name: version
805 in: path
806 required: true
807 type: string
808 pattern: '[vV][5-7]'
809 - name: serviceInstanceId
810 in: path
811 required: true
812 type: string
813 - name: configurationInstanceId
814 in: path
815 required: true
816 type: string
817 responses:
818 default:
819 description: successful operation
820 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/addRelationships':
821 post:
822 tags:
823 - onapsoinfraserviceInstantiation
824 summary: Add Relationships to a Service Instance
825 description: ''
826 operationId: addRelationships
827 consumes:
828 - application/json
829 produces:
830 - application/json
831 parameters:
832 - in: body
833 name: body
834 required: false
835 schema:
836 type: string
837 - name: version
838 in: path
839 required: true
840 type: string
841 pattern: '[vV][6-7]'
842 - name: serviceInstanceId
843 in: path
844 required: true
845 type: string
846 responses:
847 default:
848 description: successful operation
849 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/scaleOut':
850 post:
851 tags:
852 - onapsoinfraserviceInstantiation
853 summary: VF Auto Scale Out
854 description: ''
855 operationId: scaleOutVfModule
856 consumes:
857 - application/json
858 produces:
859 - application/json
860 parameters:
861 - in: body
862 name: body
863 required: false
864 schema:
865 type: string
866 - name: version
867 in: path
868 required: true
869 type: string
870 pattern: '[vV][7]'
871 - name: serviceInstanceId
872 in: path
873 required: true
874 type: string
875 - name: vnfInstanceId
876 in: path
877 required: true
878 type: string
879 responses:
880 default:
881 description: successful operation
882 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/inPlaceSoftwareUpdate':
883 post:
884 tags:
885 - onapsoinfraserviceInstantiation
886 summary: Perform VNF software update
887 description: ''
888 operationId: inPlaceSoftwareUpdate
889 consumes:
890 - application/json
891 produces:
892 - application/json
893 parameters:
894 - in: body
895 name: body
896 required: false
897 schema:
898 type: string
899 - name: version
900 in: path
901 required: true
902 type: string
903 pattern: '[vV][6-7]'
904 - name: serviceInstanceId
905 in: path
906 required: true
907 type: string
908 - name: vnfInstanceId
909 in: path
910 required: true
911 type: string
912 responses:
913 default:
914 description: successful operation
915 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/applyUpdatedConfig':
916 post:
917 tags:
918 - onapsoinfraserviceInstantiation
919 summary: Apply updated configuration
920 description: ''
921 operationId: applyUpdatedConfig
922 consumes:
923 - application/json
924 produces:
925 - application/json
926 parameters:
927 - in: body
928 name: body
929 required: false
930 schema:
931 type: string
932 - name: version
933 in: path
934 required: true
935 type: string
936 pattern: '[vV][6-7]'
937 - name: serviceInstanceId
938 in: path
939 required: true
940 type: string
941 - name: vnfInstanceId
942 in: path
943 required: true
944 type: string
945 responses:
946 default:
947 description: successful operation
948 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances':
949 post:
950 tags:
951 - onapsoinfraserviceInstantiation
952 summary: Create a Service Instance on a version provided
953 description: ''
954 operationId: createServiceInstance
955 consumes:
956 - application/json
957 produces:
958 - application/json
959 parameters:
960 - in: body
961 name: body
962 required: false
963 schema:
964 type: string
965 - name: version
966 in: path
967 required: true
968 type: string
969 pattern: '[vV][5-7]'
970 responses:
971 default:
972 description: successful operation
973 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/activate':
974 post:
975 tags:
976 - onapsoinfraserviceInstantiation
977 summary: Activate provided Service Instance
978 description: ''
979 operationId: activateServiceInstance
980 consumes:
981 - application/json
982 produces:
983 - application/json
984 parameters:
985 - in: body
986 name: body
987 required: false
988 schema:
989 type: string
990 - name: version
991 in: path
992 required: true
993 type: string
994 pattern: '[vV][5-7]'
995 - name: serviceInstanceId
996 in: path
997 required: true
998 type: string
999 responses:
1000 default:
1001 description: successful operation
1002 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/deactivate':
1003 post:
1004 tags:
1005 - onapsoinfraserviceInstantiation
1006 summary: Deactivate provided Service Instance
1007 description: ''
1008 operationId: deactivateServiceInstance
1009 consumes:
1010 - application/json
1011 produces:
1012 - application/json
1013 parameters:
1014 - in: body
1015 name: body
1016 required: false
1017 schema:
1018 type: string
1019 - name: version
1020 in: path
1021 required: true
1022 type: string
1023 pattern: '[vV][5-7]'
1024 - name: serviceInstanceId
1025 in: path
1026 required: true
1027 type: string
1028 responses:
1029 default:
1030 description: successful operation
1031 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}':
1032 delete:
1033 tags:
1034 - onapsoinfraserviceInstantiation
1035 summary: Delete provided Service Instance
1036 description: ''
1037 operationId: deleteServiceInstance
1038 consumes:
1039 - application/json
1040 produces:
1041 - application/json
1042 parameters:
1043 - in: body
1044 name: body
1045 required: false
1046 schema:
1047 type: string
1048 - name: version
1049 in: path
1050 required: true
1051 type: string
1052 pattern: '[vV][5-7]'
1053 - name: serviceInstanceId
1054 in: path
1055 required: true
1056 type: string
1057 responses:
1058 default:
1059 description: successful operation
1060 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/assign':
1061 post:
1062 tags:
1063 - onapsoinfraserviceInstantiation
1064 summary: Assign Service Instance
1065 description: ''
1066 operationId: assignServiceInstance
1067 consumes:
1068 - application/json
1069 produces:
1070 - application/json
1071 parameters:
1072 - in: body
1073 name: body
1074 required: false
1075 schema:
1076 type: string
1077 - name: version
1078 in: path
1079 required: true
1080 type: string
1081 pattern: '[vV][7]'
1082 responses:
1083 default:
1084 description: successful operation
1085 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/unassign':
1086 post:
1087 tags:
1088 - onapsoinfraserviceInstantiation
1089 summary: Unassign Service Instance
1090 description: ''
1091 operationId: unassignServiceInstance
1092 consumes:
1093 - application/json
1094 produces:
1095 - application/json
1096 parameters:
1097 - in: body
1098 name: body
1099 required: false
1100 schema:
1101 type: string
1102 - name: version
1103 in: path
1104 required: true
1105 type: string
1106 pattern: '[vV][7]'
1107 - name: serviceInstanceId
1108 in: path
1109 required: true
1110 type: string
1111 responses:
1112 default:
1113 description: successful operation
1114 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations':
1115 post:
1116 tags:
1117 - onapsoinfraserviceInstantiation
1118 summary: Create Port Mirroring Configuration
1119 description: ''
1120 operationId: createPortConfiguration
1121 consumes:
1122 - application/json
1123 produces:
1124 - application/json
1125 parameters:
1126 - in: body
1127 name: body
1128 required: false
1129 schema:
1130 type: string
1131 - name: version
1132 in: path
1133 required: true
1134 type: string
1135 pattern: '[vV][5-7]'
1136 - name: serviceInstanceId
1137 in: path
1138 required: true
1139 type: string
1140 responses:
1141 default:
1142 description: successful operation
1143 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}':
1144 delete:
1145 tags:
1146 - onapsoinfraserviceInstantiation
1147 summary: Delete provided Port
1148 description: ''
1149 operationId: deletePortConfiguration
1150 consumes:
1151 - application/json
1152 produces:
1153 - application/json
1154 parameters:
1155 - in: body
1156 name: body
1157 required: false
1158 schema:
1159 type: string
1160 - name: version
1161 in: path
1162 required: true
1163 type: string
1164 pattern: '[vV][5-7]'
1165 - name: serviceInstanceId
1166 in: path
1167 required: true
1168 type: string
1169 - name: configurationInstanceId
1170 in: path
1171 required: true
1172 type: string
1173 responses:
1174 default:
1175 description: successful operation
1176 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/removeRelationships':
1177 post:
1178 tags:
1179 - onapsoinfraserviceInstantiation
1180 summary: Remove Relationships from Service Instance
1181 description: ''
1182 operationId: removeRelationships
1183 consumes:
1184 - application/json
1185 produces:
1186 - application/json
1187 parameters:
1188 - in: body
1189 name: body
1190 required: false
1191 schema:
1192 type: string
1193 - name: version
1194 in: path
1195 required: true
1196 type: string
1197 pattern: '[vV][6-7]'
1198 - name: serviceInstanceId
1199 in: path
1200 required: true
1201 type: string
1202 responses:
1203 default:
1204 description: successful operation
1205 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs':
1206 post:
1207 tags:
1208 - onapsoinfraserviceInstantiation
1209 summary: Create VNF on a specified version and serviceInstance
1210 description: ''
1211 operationId: createVnfInstance
1212 consumes:
1213 - application/json
1214 produces:
1215 - application/json
1216 parameters:
1217 - in: body
1218 name: body
1219 required: false
1220 schema:
1221 type: string
1222 - name: version
1223 in: path
1224 required: true
1225 type: string
1226 pattern: '[vV][5-7]'
1227 - name: serviceInstanceId
1228 in: path
1229 required: true
1230 type: string
1231 responses:
1232 default:
1233 description: successful operation
1234 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/replace':
1235 post:
1236 tags:
1237 - onapsoinfraserviceInstantiation
1238 summary: Replace provided VNF instance
1239 description: ''
1240 operationId: replaceVnfInstance
1241 consumes:
1242 - application/json
1243 produces:
1244 - application/json
1245 parameters:
1246 - in: body
1247 name: body
1248 required: false
1249 schema:
1250 type: string
1251 - name: version
1252 in: path
1253 required: true
1254 type: string
1255 pattern: '[vV][5-7]'
1256 - name: serviceInstanceId
1257 in: path
1258 required: true
1259 type: string
1260 - name: vnfInstanceId
1261 in: path
1262 required: true
1263 type: string
1264 responses:
1265 default:
1266 description: successful operation
1267 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}':
1268 put:
1269 tags:
1270 - onapsoinfraserviceInstantiation
1271 summary: 'Update VNF on a specified version, serviceInstance and vnfInstance'
1272 description: ''
1273 operationId: updateVnfInstance
1274 consumes:
1275 - application/json
1276 produces:
1277 - application/json
1278 parameters:
1279 - in: body
1280 name: body
1281 required: false
1282 schema:
1283 type: string
1284 - name: version
1285 in: path
1286 required: true
1287 type: string
1288 pattern: '[vV][5-7]'
1289 - name: serviceInstanceId
1290 in: path
1291 required: true
1292 type: string
1293 - name: vnfInstanceId
1294 in: path
1295 required: true
1296 type: string
1297 responses:
1298 default:
1299 description: successful operation
1300 delete:
1301 tags:
1302 - onapsoinfraserviceInstantiation
1303 summary: Delete provided VNF instance
1304 description: ''
1305 operationId: deleteVnfInstance
1306 consumes:
1307 - application/json
1308 produces:
1309 - application/json
1310 parameters:
1311 - in: body
1312 name: body
1313 required: false
1314 schema:
1315 type: string
1316 - name: version
1317 in: path
1318 required: true
1319 type: string
1320 pattern: '[vV][5-7]'
1321 - name: serviceInstanceId
1322 in: path
1323 required: true
1324 type: string
1325 - name: vnfInstanceId
1326 in: path
1327 required: true
1328 type: string
1329 responses:
1330 default:
1331 description: successful operation
1332 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules':
1333 post:
1334 tags:
1335 - onapsoinfraserviceInstantiation
1336 summary: 'Create VfModule on a specified version, serviceInstance and vnfInstance'
1337 description: ''
1338 operationId: createVfModuleInstance
1339 consumes:
1340 - application/json
1341 produces:
1342 - application/json
1343 parameters:
1344 - in: body
1345 name: body
1346 required: false
1347 schema:
1348 type: string
1349 - name: version
1350 in: path
1351 required: true
1352 type: string
1353 pattern: '[vV][5-7]'
1354 - name: serviceInstanceId
1355 in: path
1356 required: true
1357 type: string
1358 - name: vnfInstanceId
1359 in: path
1360 required: true
1361 type: string
1362 responses:
1363 default:
1364 description: successful operation
1365 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/replace':
1366 post:
1367 tags:
1368 - onapsoinfraserviceInstantiation
1369 summary: 'Create VfModule on a specified version, serviceInstance and vnfInstance'
1370 description: ''
1371 operationId: replaceVfModuleInstance
1372 consumes:
1373 - application/json
1374 produces:
1375 - application/json
1376 parameters:
1377 - in: body
1378 name: body
1379 required: false
1380 schema:
1381 type: string
1382 - name: version
1383 in: path
1384 required: true
1385 type: string
1386 pattern: '[vV][5-7]'
1387 - name: serviceInstanceId
1388 in: path
1389 required: true
1390 type: string
1391 - name: vnfInstanceId
1392 in: path
1393 required: true
1394 type: string
1395 - name: vfmoduleInstanceId
1396 in: path
1397 required: true
1398 type: string
1399 responses:
1400 default:
1401 description: successful operation
1402 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}':
1403 put:
1404 tags:
1405 - onapsoinfraserviceInstantiation
1406 summary: >-
1407 Update VfModule on a specified version, serviceInstance, vnfInstance and
1408 vfModule
1409 description: ''
1410 operationId: updateVfModuleInstance
1411 consumes:
1412 - application/json
1413 produces:
1414 - application/json
1415 parameters:
1416 - in: body
1417 name: body
1418 required: false
1419 schema:
1420 type: string
1421 - name: version
1422 in: path
1423 required: true
1424 type: string
1425 pattern: '[vV][5-7]'
1426 - name: serviceInstanceId
1427 in: path
1428 required: true
1429 type: string
1430 - name: vnfInstanceId
1431 in: path
1432 required: true
1433 type: string
1434 - name: vfmoduleInstanceId
1435 in: path
1436 required: true
1437 type: string
1438 responses:
1439 default:
1440 description: successful operation
1441 delete:
1442 tags:
1443 - onapsoinfraserviceInstantiation
1444 summary: Delete provided VfModule instance
1445 description: ''
1446 operationId: deleteVfModuleInstance
1447 consumes:
1448 - application/json
1449 produces:
1450 - application/json
1451 parameters:
1452 - in: body
1453 name: body
1454 required: false
1455 schema:
1456 type: string
1457 - name: version
1458 in: path
1459 required: true
1460 type: string
1461 pattern: '[vV][5-7]'
1462 - name: serviceInstanceId
1463 in: path
1464 required: true
1465 type: string
1466 - name: vnfInstanceId
1467 in: path
1468 required: true
1469 type: string
1470 - name: vfmoduleInstanceId
1471 in: path
1472 required: true
1473 type: string
1474 responses:
1475 default:
1476 description: successful operation
1477 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups':
1478 post:
1479 tags:
1480 - onapsoinfraserviceInstantiation
1481 summary: 'Create VolumeGroup on a specified version, serviceInstance, vnfInstance'
1482 description: ''
1483 operationId: createVolumeGroupInstance
1484 consumes:
1485 - application/json
1486 produces:
1487 - application/json
1488 parameters:
1489 - in: body
1490 name: body
1491 required: false
1492 schema:
1493 type: string
1494 - name: version
1495 in: path
1496 required: true
1497 type: string
1498 pattern: '[vV][5-7]'
1499 - name: serviceInstanceId
1500 in: path
1501 required: true
1502 type: string
1503 - name: vnfInstanceId
1504 in: path
1505 required: true
1506 type: string
1507 responses:
1508 default:
1509 description: successful operation
1510 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}':
1511 put:
1512 tags:
1513 - onapsoinfraserviceInstantiation
1514 summary: >-
1515 Update VolumeGroup on a specified version, serviceInstance, vnfInstance
1516 and volumeGroup
1517 description: ''
1518 operationId: updateVolumeGroupInstance
1519 consumes:
1520 - application/json
1521 produces:
1522 - application/json
1523 parameters:
1524 - in: body
1525 name: body
1526 required: false
1527 schema:
1528 type: string
1529 - name: version
1530 in: path
1531 required: true
1532 type: string
1533 pattern: '[vV][5-7]'
1534 - name: serviceInstanceId
1535 in: path
1536 required: true
1537 type: string
1538 - name: vnfInstanceId
1539 in: path
1540 required: true
1541 type: string
1542 - name: volumeGroupInstanceId
1543 in: path
1544 required: true
1545 type: string
1546 responses:
1547 default:
1548 description: successful operation
1549 delete:
1550 tags:
1551 - onapsoinfraserviceInstantiation
1552 summary: Delete provided VolumeGroup instance
1553 description: ''
1554 operationId: deleteVolumeGroupInstance
1555 consumes:
1556 - application/json
1557 produces:
1558 - application/json
1559 parameters:
1560 - in: body
1561 name: body
1562 required: false
1563 schema:
1564 type: string
1565 - name: version
1566 in: path
1567 required: true
1568 type: string
1569 pattern: '[vV][5-7]'
1570 - name: serviceInstanceId
1571 in: path
1572 required: true
1573 type: string
1574 - name: vnfInstanceId
1575 in: path
1576 required: true
1577 type: string
1578 - name: volumeGroupInstanceId
1579 in: path
1580 required: true
1581 type: string
1582 responses:
1583 default:
1584 description: successful operation
1585 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks':
1586 post:
1587 tags:
1588 - onapsoinfraserviceInstantiation
1589 summary: 'Create NetworkInstance on a specified version and serviceInstance '
1590 description: ''
1591 operationId: createNetworkInstance
1592 consumes:
1593 - application/json
1594 produces:
1595 - application/json
1596 parameters:
1597 - in: body
1598 name: body
1599 required: false
1600 schema:
1601 type: string
1602 - name: version
1603 in: path
1604 required: true
1605 type: string
1606 pattern: '[vV][5-7]'
1607 - name: serviceInstanceId
1608 in: path
1609 required: true
1610 type: string
1611 responses:
1612 default:
1613 description: successful operation
1614 '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}':
1615 put:
1616 tags:
1617 - onapsoinfraserviceInstantiation
1618 summary: >-
1619 Update VolumeGroup on a specified version, serviceInstance,
1620 networkInstance
1621 description: ''
1622 operationId: updateNetworkInstance
1623 consumes:
1624 - application/json
1625 produces:
1626 - application/json
1627 parameters:
1628 - in: body
1629 name: body
1630 required: false
1631 schema:
1632 type: string
1633 - name: version
1634 in: path
1635 required: true
1636 type: string
1637 pattern: '[vV][5-7]'
1638 - name: serviceInstanceId
1639 in: path
1640 required: true
1641 type: string
1642 - name: networkInstanceId
1643 in: path
1644 required: true
1645 type: string
1646 responses:
1647 default:
1648 description: successful operation
1649 delete:
1650 tags:
1651 - onapsoinfraserviceInstantiation
1652 summary: Delete provided Network instance
1653 description: ''
1654 operationId: deleteNetworkInstance
1655 consumes:
1656 - application/json
1657 produces:
1658 - application/json
1659 parameters:
1660 - in: body
1661 name: body
1662 required: false
1663 schema:
1664 type: string
1665 - name: version
1666 in: path
1667 required: true
1668 type: string
1669 pattern: '[vV][5-7]'
1670 - name: serviceInstanceId
1671 in: path
1672 required: true
1673 type: string
1674 - name: networkInstanceId
1675 in: path
1676 required: true
1677 type: string
1678 responses:
1679 default:
1680 description: successful operation
1681 '/onap/so/infra/tasks/{version}':
1682 get:
1683 tags:
1684 - onapsoinfratasks
1685 summary: Finds Manual Tasks
1686 description: ''
1687 operationId: queryFilters
1688 parameters:
1689 - name: taskId
1690 in: query
1691 required: false
1692 type: string
1693 - name: originalRequestId
1694 in: query
1695 required: false
1696 type: string
1697 - name: subscriptionServiceType
1698 in: query
1699 required: false
1700 type: string
1701 - name: nfRole
1702 in: query
1703 required: false
1704 type: string
1705 - name: buildingBlockName
1706 in: query
1707 required: false
1708 type: string
1709 - name: originalRequestDate
1710 in: query
1711 required: false
1712 type: string
1713 - name: originalRequestorId
1714 in: query
1715 required: false
1716 type: string
1717 - name: version
1718 in: path
1719 required: true
1720 type: string
1721 pattern: '[vV]1'
1722 responses:
1723 default:
1724 description: successful operation
1725 '/onap/so/infra/cloudResources/{version}/operationalEnvironments':
1726 post:
1727 tags:
1728 - onapsoinfracloudResources
1729 summary: Create an Operational Environment
1730 description: ''
1731 operationId: createOperationEnvironment
1732 consumes:
1733 - application/json
1734 produces:
1735 - application/json
1736 parameters:
1737 - in: body
1738 name: body
1739 required: false
1740 schema:
1741 type: string
1742 - name: version
1743 in: path
1744 required: true
1745 type: string
1746 pattern: '[vV][1]'
1747 responses:
1748 default:
1749 description: successful operation
1750 '/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/activate':
1751 post:
1752 tags:
1753 - onapsoinfracloudResources
1754 summary: Activate an Operational Environment
1755 description: ''
1756 operationId: activateOperationEnvironment
1757 consumes:
1758 - application/json
1759 produces:
1760 - application/json
1761 parameters:
1762 - in: body
1763 name: body
1764 required: false
1765 schema:
1766 type: string
1767 - name: version
1768 in: path
1769 required: true
1770 type: string
1771 pattern: '[vV][1]'
1772 - name: operationalEnvironmentId
1773 in: path
1774 required: true
1775 type: string
1776 responses:
1777 default:
1778 description: successful operation
1779 '/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/deactivate':
1780 post:
1781 tags:
1782 - onapsoinfracloudResources
1783 summary: Deactivate an Operational Environment
1784 description: ''
1785 operationId: deactivateOperationEnvironment
1786 consumes:
1787 - application/json
1788 produces:
1789 - application/json
1790 parameters:
1791 - in: body
1792 name: body
1793 required: false
1794 schema:
1795 type: string
1796 - name: version
1797 in: path
1798 required: true
1799 type: string
1800 pattern: '[vV][1]'
1801 - name: operationalEnvironmentId
1802 in: path
1803 required: true
1804 type: string
1805 responses:
1806 default:
1807 description: successful operation
1808 '/onap/so/infra/cloudResourcesRequests/{version}/{requestId}/unlock':
1809 post:
1810 tags:
1811 - onapsoinfracloudResourcesRequests
1812 summary: Unlock CloudOrchestration requests for a specified requestId
1813 description: ''
1814 operationId: unlockOrchestrationRequestForReqId
1815 consumes:
1816 - application/json
1817 produces:
1818 - application/json
1819 parameters:
1820 - in: body
1821 name: body
1822 required: false
1823 schema:
1824 type: string
1825 - name: requestId
1826 in: path
1827 required: true
1828 type: string
1829 - name: version
1830 in: path
1831 required: true
1832 type: string
1833 pattern: '[vV][1]'
1834 responses:
1835 default:
1836 description: successful operation
1837 '/onap/so/infra/cloudResourcesRequests/{version}':
1838 get:
1839 tags:
1840 - onapsoinfracloudResourcesRequests
1841 summary: Get status of an Operational Environment based on filter criteria
1842 description: ''
1843 operationId: getOperationEnvironmentStatusFilter
1844 consumes:
1845 - application/json
1846 produces:
1847 - application/json
1848 parameters:
1849 - name: version
1850 in: path
1851 required: true
1852 type: string
1853 pattern: '[vV][1]'
1854 responses:
1855 default:
1856 description: successful operation
1857 '/onap/so/infra/modelDistributions/{version}/distributions/{distributionId}':
1858 post:
1859 tags:
1860 - onapsoinframodelDistributions
1861 summary: Update model distribution status
1862 description: ''
1863 operationId: updateModelDistributionStatus
1864 consumes:
1865 - application/json
1866 produces:
1867 - application/json
1868 parameters:
1869 - in: body
1870 name: body
1871 required: false
1872 schema:
1873 type: string
1874 - name: version
1875 in: path
1876 required: true
1877 type: string
1878 pattern: '[vV][1]'
1879 - name: distributionId
1880 in: path
1881 required: true
1882 type: string
1883 responses:
1884 default:
1885 description: successful operation
rameshiyer27e28d9422020-08-17 15:51:46 +0100[diff] [blame]1886 '/onap/so/infra/workflowSpecifications/{version}/workflows':
1887 get:
1888 tags:
1889 - onapsoinfraworkflowSpecifications
1890 summary: Retrieve Workflow details based on the filter criteria
1891 description: ''
1892 operationId: queryWorkflowSpecifications
1893 consumes:
1894 - application/json
1895 produces:
1896 - application/json
1897 parameters:
1898 - name: resourceTarget
1899 in: query
1900 required: false
1901 type: string
1902 - name: version
1903 in: path
1904 required: true
1905 type: string
1906 pattern: '[vV][1]'
1907 responses:
1908 default:
1909 description: List of workflow specifications on successful operation
1910 schema:
1911 $ref: '#/definitions/RetrievingWorkflowResponse'
1912 '/onap/so/infra/instanceManagement/{version}/serviceInstances/{serviceInstanceId}/workflows/{workflow_UUID}':
1913 post:
1914 tags:
1915 - onapsoinfrainstanceManagement
1916 summary: Executing service level custom workflow
1917 description: ''
1918 operationId: executeServiceLevelCustomWorkflow
1919 consumes:
1920 - application/json
1921 produces:
1922 - application/json
1923 parameters:
1924 - in: body
1925 name: body
1926 required: false
1927 schema:
1928 $ref: '#/definitions/ServiceLevelWorkflowExecution'
1929 - name: version
1930 in: path
1931 required: true
1932 type: string
1933 pattern: '[vV][1]'
1934 - name: serviceInstanceId
1935 in: path
1936 required: true
1937 type: string
1938 - name: workflow_UUID
1939 in: path
1940 required: true
1941 type: string
1942 responses:
1943 default:
1944 description: successful operation
Priyadharshini3cf70702020-08-10 10:01:05 +0530[diff] [blame]1945definitions:
1946 Allocate3gppService:
1947 description: This describes the request body for 3gpp service allocation
1948 type: object
1949 properties:
1950 name:
1951 description: Name of the service to allocate
1952 type: string
1953 modelInvariantUuid:
1954 description: >-
1955 Model Invariant UUID corresponding to the service. For E.g : NSST
1956 Model invariant uuid in case of NSSI creation
1957 type: string
1958 modelUuid:
1959 description: >-
1960 Model UUID corresponding to the service. For E.g : NSST Model uuid in
1961 case of NSSI creation
1962 type: string
1963 globalSubscriberId:
1964 type: string
1965 subscriptionServiceType:
1966 description: 'Service type for the subscription. For E.G :5G'
1967 type: string
1968 networkType:
1969 description: 'Network type. For E.G :AN/CN/TN'
1970 type: string
1971 additionalProperties:
1972 description: Map of additional properties required for service allocation
1973 type: object
1974 DeAllocate3gppService:
1975 description: This describes the request body for 3gpp service Termination/Deallocation
1976 type: object
1977 properties:
1978 serviceInstanceID:
1979 description: ID of the service to terminate
1980 type: string
1981 globalSubscriberId:
1982 type: string
1983 subscriptionServiceType:
1984 description: 'Service type for the subscription. For E.G :5G'
1985 type: string
1986 networkType:
1987 description: 'Network type. For E.G :AN/CN/TN'
1988 type: string
1989 additionalProperties:
1990 description: Map of additional properties required for service deallocation
1991 type: object
1992 Modify3gppService:
1993 description: This describes the request body for 3gpp service modification
1994 type: object
1995 properties:
1996 name:
1997 description: Name of the service to modify
1998 type: string
1999 serviceInstanceID:
2000 description: ID of the service to modify
2001 type: string
2002 globalSubscriberId:
2003 type: string
2004 subscriptionServiceType:
2005 description: 'Service type for the subscription. For E.G :5G'
2006 type: string
2007 networkType:
2008 description: 'Network type. For E.G :AN/CN/TN'
2009 type: string
2010 additionalProperties:
2011 description: Map of additional properties required for service modification
2012 type: object
2013 3gppServiceActivation:
2014 description: This describes the request body for 3gpp service activation/deactivation
2015 type: object
2016 properties:
2017 serviceInstanceID:
2018 description: ID of the service to be activated/deactivated
2019 type: string
2020 globalSubscriberId:
2021 type: string
2022 subscriptionServiceType:
2023 description: 'Service type for the subscription. For E.G :5G'
2024 type: string
2025 networkType:
2026 description: 'Network type. For E.G :AN/CN/TN'
2027 type: string
2028 additionalProperties:
2029 description: >-
2030 Map of additional properties required for service
2031 activation/deactivation
2032 type: object
2033 QuerySubnetCapability:
2034 description: This describes the subnet capabilities that can be queried
2035 type: object
2036 properties:
2037 subnetTypes:
2038 type: array
2039 items:
2040 $ref: '#/definitions/SubnetTypes'
2041 SubnetTypes:
2042 description: This describes allowed subnet types
2043 type: string
2044 enum:
2045 - AN
Priyadharshinic86ab4a2020-08-14 17:11:49 +0530[diff] [blame]2046 - AN_NF
Priyadharshini3cf70702020-08-10 10:01:05 +0530[diff] [blame]2047 - CN
Priyadharshinic86ab4a2020-08-14 17:11:49 +0530[diff] [blame]2048 - TN_FH
2049 - TN_MH
2050 - TN_BH
Priyadharshini3cf70702020-08-10 10:01:05 +0530[diff] [blame]2051 3gppServiceResponse:
2052 description: This describes the response for 3gpp services
2053 type: object
2054 properties:
2055 jobId:
2056 description: Job ID to be used to identify the status of the job
2057 type: string
2058 status:
2059 description: status of the job
2060 type: string
2061 statusDescription:
2062 description: Description on status in case of erroneous response
Priyadharshinic86ab4a2020-08-14 17:11:49 +0530[diff] [blame]2063 type: object
rameshiyer27e28d9422020-08-17 15:51:46 +0100[diff] [blame]2064 RetrievingWorkflowResponse:
2065 description: Response body of fetching workflows using resource target
2066 type: object
2067 properties:
2068 workflowSpecificationList:
2069 description: List of Workflow specification data
2070 type: array
2071 items:
2072 $ref: '#/definitions/WorkflowSpecification'
2073 WorkflowSpecification:
2074 description: This describes workflow specification object
2075 type: object
2076 properties:
2077 artifactInfo:
2078 description: 'Attributes related to artifact information '
2079 type: object
2080 properties:
2081 artifactType:
2082 description: Type of the artifact to be queried
2083 type: string
2084 artifactUuid:
2085 description: UUID of the artifact
2086 type: string
2087 artifactName:
2088 description: Name of the artifact
2089 type: string
2090 artifactVersion:
2091 description: Artifact's Version
2092 type: string
2093 artifactDescription:
2094 description: ''
2095 type: string
2096 workflowName:
2097 description: Name of the workflow fetched for the resource type
2098 type: string
2099 operationName:
2100 description: Mapped operation name of the corresponding workflow
2101 type: string
2102 workflowSource:
2103 description: ''
2104 type: string
2105 workflowResourceTarget:
2106 description: Type of Resource mapped against the workflow
2107 type: string
2108 ServiceLevelWorkflowExecution:
2109 description: This describes the request body of service level custom workflow execution
2110 type: object
2111 properties:
2112 requestInfo:
2113 description: Request object contains source information
2114 type: object
2115 properties:
2116 source:
2117 description: Name of the sender
2118 type: string
2119 suppressRollback:
2120 description: Enable/disable rollback suppression
2121 type: boolean
2122 requestorId:
2123 description: Id of the sender
2124 type: string
2125 modelInfo:
2126 description: Parameters related to the service model
2127 type: object
2128 properties:
2129 modelType:
2130 description: Type of the model to be executed
2131 type: string
2132 modelInvariantUuid:
2133 description: Model invariant id corresponding to the service
2134 type: string
2135 modelUuid:
2136 description: Model uuid corresponding to the service
2137 type: string
2138 modelVersionId:
2139 description: Model version of the service instance
2140 type: string
2141 modelName:
2142 description: Name of the service
2143 type: string
2144 modelVersion:
2145 description: Version of the service instance
2146 type: string
2147 requestParameters:
2148 description: User parameter object
2149 type: object
2150 properties:
2151 subscriptionServiceType:
2152 description: Type of service subscription
2153 type: string
2154 subscriberInfo:
2155 description: Subscriber id information
2156 type: object
2157 properties:
2158 globalSubscriberId:
2159 description: Id of the subscriber sending the request
2160 type: string
2161 project:
2162 description: Information about the target project name
2163 type: object
2164 properties:
2165 projectName:
2166 description: Name of the target project
2167 type: string
2168 owningEntity:
2169 description: Object describes the entity details
2170 type: object
2171 properties:
2172 owningEntityId:
2173 description: Id of the owning Entity
2174 type: string
2175 owningEntityName:
2176 description: Name of the owning Entity
2177 type: string