1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2018 Huawei Technologies Co., Ltd.
9 This API allows to generate some requests to manage:
11 - serviceInstances (create, delete)
12 - volumeGroups attached to a vnf instance (create, delete)
13 - vfModules attached to a vnf instance (create, delete)
14 - vnfs attached to a service instance (create, delete)
15 - orchestrationRequests (get)
20 - :ref:`create_service_instance`
21 - :ref:`delete_service_instance`
22 - :ref:`create_volume_group`
23 - :ref:`delete_volume_group`
24 - :ref:`create_vf_module`
25 - :ref:`delete_vf_module`
30 - :ref:`get_orchestration_request_by_id`
31 - :ref:`get_orchestration_request_all`
34 .. _create_service_instance:
36 Create service instance
37 +++++++++++++++++++++++
39 +--------------------+--------------------------------------------------------+
40 |Interface Definition|Description |
41 +====================+========================================================+
42 |URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances |
43 +--------------------+--------------------------------------------------------+
44 |Operation Type |POST |
45 +--------------------+--------------------------------------------------------+
46 |Content-Type |application/json |
47 +--------------------+--------------------------------------------------------+
51 +-------------------+---------+-----------------------------------------------------------------------------------------+
52 |Header Name |Required |Description |
53 +===================+=========+=========================================================================================+
54 |Authorization |Y |Base64 encoded username:password |
55 +-------------------+---------+-----------------------------------------------------------------------------------------+
59 +----------------+---------+-----------+--------------------------+-------------------------------------------+
60 |Attribute |Qualifier|Cardinality|Content |Description |
61 +================+=========+===========+==========================+===========================================+
62 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
63 +----------------+---------+-----------+--------------------------+-------------------------------------------+
67 +-------------------+--------------------------+-------------------------------------------------+
68 |Attribute |Content |Description |
69 +===================+==========================+=================================================+
70 |modelInfo |modelInfo Object |Content of modelInfo object. |
71 +-------------------+--------------------------+-------------------------------------------------+
72 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
73 +-------------------+--------------------------+-------------------------------------------------+
74 |requestInfo |requestInfo Object |Content of requestInfo object. |
75 +-------------------+--------------------------+-------------------------------------------------+
76 |requestParameters |requestParameters Object |Content of requestParameters object. |
77 +-------------------+--------------------------+-------------------------------------------------+
78 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
79 +-------------------+--------------------------+-------------------------------------------------+
80 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
81 +-------------------+--------------------------+-------------------------------------------------+
82 |project |project Object |Content of project object. |
83 +-------------------+--------------------------+-------------------------------------------------+
84 |owningEntity |owningEntity Object |Content of owningEntity object. |
85 +-------------------+--------------------------+-------------------------------------------------+
86 |platform |platform Object |Content of platform object. |
87 +-------------------+--------------------------+-------------------------------------------------+
88 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
89 +-------------------+--------------------------+-------------------------------------------------+
93 +-------------------------+------------------+-------------------------------------------------+
94 |Attribute |Content |Description |
95 +=========================+==================+=================================================+
96 |ModelType |String |Type of model |
97 +-------------------------+------------------+-------------------------------------------------+
98 |ModelInvariantId |String |The Model Invariant Id. |
99 +-------------------------+------------------+-------------------------------------------------+
100 |ModelNameVersionId |String |The modelname Version Id |
101 +-------------------------+------------------+-------------------------------------------------+
102 |ModelName |String |Name of the Model |
103 +-------------------------+------------------+-------------------------------------------------+
104 |ModelVersion |String |Version of the model |
105 +-------------------------+------------------+-------------------------------------------------+
106 |ModelCustomization Name |String |The Model Customization name |
107 +-------------------------+------------------+-------------------------------------------------+
108 |modelCustomizationUuid |String |The Model Customization UUid |
109 +-------------------------+------------------+-------------------------------------------------+
110 |modelVersionId |String |The Model version id |
111 +-------------------------+------------------+-------------------------------------------------+
112 |modelUuid |String |The Model UUid |
113 +-------------------------+------------------+-------------------------------------------------+
114 |modelInvariantUuid |String |The Model Invariant UUid |
115 +-------------------------+------------------+-------------------------------------------------+
116 |modelInstanceName |String |The Model Instance name |
117 +-------------------------+------------------+-------------------------------------------------+
120 SubscriberInfo Object
122 +-------------------------+------------------+-------------------------------------------------+
123 |Attribute |Content |Description |
124 +=========================+==================+=================================================+
125 |GlobalSubscriberId |String |Global customer Id (in A&AI) |
126 +-------------------------+------------------+-------------------------------------------------+
127 |SubscriberName |String |Name of the Subscriber |
128 +-------------------------+------------------+-------------------------------------------------+
132 +-------------------------+------------------+-------------------------------------------------+
133 |Attribute |Content |Description |
134 +=========================+==================+=================================================+
135 |Source |String |source of the request |
136 +-------------------------+------------------+-------------------------------------------------+
137 |billingAccountNumber |String |billingAccountNumber of the request |
138 +-------------------------+------------------+-------------------------------------------------+
139 |callbackUrl |String |callbackUrl of the request |
140 +-------------------------+------------------+-------------------------------------------------+
141 |correlator |String |correlator of the request |
142 +-------------------------+------------------+-------------------------------------------------+
143 |orderNumber |String |orderNumber of the request |
144 +-------------------------+------------------+-------------------------------------------------+
145 |productFamilyId |String |productFamilyId of the request |
146 +-------------------------+------------------+-------------------------------------------------+
147 |orderVersion |String |orderVersion of the request |
148 +-------------------------+------------------+-------------------------------------------------+
149 |instanceName |String |instanceName of the request |
150 +-------------------------+------------------+-------------------------------------------------+
151 |suppressRollback |String |suppressRollback of the request |
152 +-------------------------+------------------+-------------------------------------------------+
153 |requestorId |String |requestorId of the request |
154 +-------------------------+------------------+-------------------------------------------------+
156 RequestParameters Object
158 +-------------------------+------------------+-------------------------------------------------+
159 |Attribute |Content |Description |
160 +=========================+==================+=================================================+
161 |SubscriptionServiceType |String |The service type of the Subscription |
162 +-------------------------+------------------+-------------------------------------------------+
163 |UserParams |Array |The product family Id. |
164 +-------------------------+------------------+-------------------------------------------------+
165 |aLaCarte |Boolean | aLaCarte |
166 +-------------------------+------------------+-------------------------------------------------+
167 |autoBuildVfModules |Boolean |autoBuildVfModules |
168 +-------------------------+------------------+-------------------------------------------------+
169 |cascadeDelete |Boolean |cascadeDelete |
170 +-------------------------+------------------+-------------------------------------------------+
171 |usePreload |Boolean |usePreload |
172 +-------------------------+------------------+-------------------------------------------------+
173 |rebuildVolumeGroups |Boolean |rebuildVolumeGroups |
174 +-------------------------+------------------+-------------------------------------------------+
175 |payload |String |payload |
176 +-------------------------+------------------+-------------------------------------------------+
177 |controllerType |String |controllerType |
178 +-------------------------+------------------+-------------------------------------------------+
182 +-------------------------+------------------+-------------------------------------------------+
183 |Attribute |Content |Description |
184 +=========================+==================+=================================================+
185 |name |String |Tag name of attribute |
186 +-------------------------+------------------+-------------------------------------------------+
187 |value |String |Value of the tag |
188 +-------------------------+------------------+-------------------------------------------------+
190 CloudConfiguration Object
192 +-------------------------+------------------+-------------------------------------------------+
193 |Attribute |Content |Description |
194 +=========================+==================+=================================================+
195 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
196 +-------------------------+------------------+-------------------------------------------------+
197 |tenantId |String |Name of the Subscriber |
198 +-------------------------+------------------+-------------------------------------------------+
199 |aicNodeClli |String |aicNodeClli property |
200 +-------------------------+------------------+-------------------------------------------------+
204 +-------------------------+------------------+-------------------------------------------------+
205 |Attribute |Content |Description |
206 +=========================+==================+=================================================+
207 |projectName |String |Name of the project |
208 +-------------------------+------------------+-------------------------------------------------+
212 +-------------------------+------------------+-------------------------------------------------+
213 |Attribute |Content |Description |
214 +=========================+==================+=================================================+
215 |owningEntityId |String |owningEntityId of the owingEntity |
216 +-------------------------+------------------+-------------------------------------------------+
217 |owningEntityName |String |owningEntityName of the owingEntity |
218 +-------------------------+------------------+-------------------------------------------------+
222 +-------------------------+------------------+-------------------------------------------------+
223 |Attribute |Content |Description |
224 +=========================+==================+=================================================+
225 |platformName |String |Platform Name |
226 +-------------------------+------------------+-------------------------------------------------+
228 LineOfBusiness Object
230 +-------------------------+------------------+-------------------------------------------------+
231 |Attribute |Content |Description |
232 +=========================+==================+=================================================+
233 |lineOfBusinessName |String |Line Of Business Name |
234 +-------------------------+------------------+-------------------------------------------------+
237 .. _delete_service_instance:
239 Delete service instance
240 +++++++++++++++++++++++
242 +--------------------+--------------------------------------------------------------------------------+
243 |Interface Definition|Description |
244 +====================+================================================================================+
245 |URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId} |
246 +--------------------+--------------------------------------------------------------------------------+
247 |Operation Type |DELETE |
248 +--------------------+--------------------------------------------------------------------------------+
249 |Content-Type |application/json |
250 +--------------------+--------------------------------------------------------------------------------+
254 +-------------------+---------+-----------------------------------------------------------------------------------------+
255 |Header Name |Required |Description |
256 +===================+=========+=========================================================================================+
257 |Authorization |Y |Base64 encoded username:password |
258 +-------------------+---------+-----------------------------------------------------------------------------------------+
262 +----------------+---------+-----------+--------------------------+-------------------------------------------+
263 |Attribute |Qualifier|Cardinality|Content |Description |
264 +================+=========+===========+==========================+===========================================+
265 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
266 +----------------+---------+-----------+--------------------------+-------------------------------------------+
268 RequestDetails Object
270 +-------------------+-------------------------+-------------------------------------------------+
271 |Attribute |Content |Description |
272 +===================+=========================+=================================================+
273 |modelInfo |modelInfo Object |Content of modelInfo object. |
274 +-------------------+-------------------------+-------------------------------------------------+
275 |requestInfo |requestInfo Object |Content of requestInfo object. |
276 +-------------------+-------------------------+-------------------------------------------------+
280 +-------------------------+------------------+-------------------------------------------------+
281 |Attribute |Content |Description |
282 +=========================+==================+=================================================+
283 |ModelType |String |Type of model |
284 +-------------------------+------------------+-------------------------------------------------+
285 |ModelInvariantId |String |The Model Invariant Id. |
286 +-------------------------+------------------+-------------------------------------------------+
287 |ModelName |String |Name of the Model |
288 +-------------------------+------------------+-------------------------------------------------+
289 |ModelVersion |String |Version of the model |
290 +-------------------------+------------------+-------------------------------------------------+
294 +-------------------------+------------------+-------------------------------------------------+
295 |Attribute |Content |Description |
296 +=========================+==================+=================================================+
297 |Source |String |source of the request |
298 +-------------------------+------------------+-------------------------------------------------+
301 .. _create_volume_group:
306 +--------------------+------------------------------------------------------------------------------------------------------------------+
307 |Interface Definition|Description |
308 +====================+==================================================================================================================+
309 |URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups |
310 +--------------------+------------------------------------------------------------------------------------------------------------------+
311 |Operation Type |POST |
312 +--------------------+------------------------------------------------------------------------------------------------------------------+
313 |Content-Type |application/json |
314 +--------------------+------------------------------------------------------------------------------------------------------------------+
318 +-------------------+---------+-----------------------------------------------------------------------------------------+
319 |Header Name |Required |Description |
320 +===================+=========+=========================================================================================+
321 |Authorization |Y |Base64 encoded username:password |
322 +-------------------+---------+-----------------------------------------------------------------------------------------+
326 +----------------+---------+-----------+--------------------------+-------------------------------------------+
327 |Attribute |Qualifier|Cardinality|Content |Description |
328 +================+=========+===========+==========================+===========================================+
329 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
330 +----------------+---------+-----------+--------------------------+-------------------------------------------+
332 RequestDetails Object
334 +-------------------+--------------------------+-------------------------------------------------+
335 |Attribute |Content |Description |
336 +===================+==========================+=================================================+
337 |modelInfo |modelInfo Object |Content of modelInfo object. |
338 +-------------------+--------------------------+-------------------------------------------------+
339 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
340 +-------------------+--------------------------+-------------------------------------------------+
341 |requestInfo |requestInfo Object |Content of requestInfo object. |
342 +-------------------+--------------------------+-------------------------------------------------+
343 |requestParameters |requestParameters Object |Content of requestParameters object. |
344 +-------------------+--------------------------+-------------------------------------------------+
345 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
346 +-------------------+--------------------------+-------------------------------------------------+
347 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
348 +-------------------+--------------------------+-------------------------------------------------+
349 |project |project Object |Content of project object. |
350 +-------------------+--------------------------+-------------------------------------------------+
351 |owningEntity |owningEntity Object |Content of owningEntity object. |
352 +-------------------+--------------------------+-------------------------------------------------+
353 |platform |platform Object |Content of platform object. |
354 +-------------------+--------------------------+-------------------------------------------------+
355 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
356 +-------------------+--------------------------+-------------------------------------------------+
360 +-------------------------+------------------+-------------------------------------------------+
361 |Attribute |Content |Description |
362 +=========================+==================+=================================================+
363 |ModelType |String |Type of model |
364 +-------------------------+------------------+-------------------------------------------------+
365 |ModelInvariantId |String |The Model Invariant Id. |
366 +-------------------------+------------------+-------------------------------------------------+
367 |ModelNameVersionId |String |The modelname Version Id |
368 +-------------------------+------------------+-------------------------------------------------+
369 |ModelName |String |Name of the Model |
370 +-------------------------+------------------+-------------------------------------------------+
371 |ModelVersion |String |Version of the model |
372 +-------------------------+------------------+-------------------------------------------------+
373 |ModelCustomization Name |String |The Model Customization name |
374 +-------------------------+------------------+-------------------------------------------------+
375 |modelCustomizationUuid |String |The Model Customization UUid |
376 +-------------------------+------------------+-------------------------------------------------+
377 |modelVersionId |String |The Model version id |
378 +-------------------------+------------------+-------------------------------------------------+
379 |modelUuid |String |The Model UUid |
380 +-------------------------+------------------+-------------------------------------------------+
381 |modelInvariantUuid |String |The Model Invariant UUid |
382 +-------------------------+------------------+-------------------------------------------------+
383 |modelInstanceName |String |The Model Instance name |
384 +-------------------------+------------------+-------------------------------------------------+
386 CloudConfiguration Object
388 +-------------------------+------------------+-------------------------------------------------+
389 |Attribute |Content |Description |
390 +=========================+==================+=================================================+
391 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
392 +-------------------------+------------------+-------------------------------------------------+
393 |tenantId |String |Name of the Subscriber |
394 +-------------------------+------------------+-------------------------------------------------+
395 |aicNodeClli |String |aicNodeClli property |
396 +-------------------------+------------------+-------------------------------------------------+
400 +-------------------------+------------------+-------------------------------------------------+
401 |Attribute |Content |Description |
402 +=========================+==================+=================================================+
403 |Source |String |source of the request |
404 +-------------------------+------------------+-------------------------------------------------+
405 |billingAccountNumber |String |billingAccountNumber of the request |
406 +-------------------------+------------------+-------------------------------------------------+
407 |callbackUrl |String |callbackUrl of the request |
408 +-------------------------+------------------+-------------------------------------------------+
409 |correlator |String |correlator of the request |
410 +-------------------------+------------------+-------------------------------------------------+
411 |orderNumber |String |orderNumber of the request |
412 +-------------------------+------------------+-------------------------------------------------+
413 |productFamilyId |String |productFamilyId of the request |
414 +-------------------------+------------------+-------------------------------------------------+
415 |orderVersion |String |orderVersion of the request |
416 +-------------------------+------------------+-------------------------------------------------+
417 |instanceName |String |instanceName of the request |
418 +-------------------------+------------------+-------------------------------------------------+
419 |suppressRollback |String |suppressRollback of the request |
420 +-------------------------+------------------+-------------------------------------------------+
421 |requestorId |String |requestorId of the request |
422 +-------------------------+------------------+-------------------------------------------------+
426 +-------------------------+------------------+-------------------------------------------------+
427 |Attribute |Content |Description |
428 +=========================+==================+=================================================+
429 |relatedInstance |Object |relatedInstance Object |
430 +-------------------------+------------------+-------------------------------------------------+
434 +-------------------------+------------------+-------------------------------------------------+
435 |Attribute |Content |Description |
436 +=========================+==================+=================================================+
437 |instanceId |String |instanceId |
438 +-------------------------+------------------+-------------------------------------------------+
439 |modelInfo |Object |Content of modelInfo object. |
440 +-------------------------+------------------+-------------------------------------------------+
442 .. _delete_volume_group:
447 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
448 |Interface Definition|Description |
449 +====================+============================================================================================================================================+
450 |URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id} |
451 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
452 |Operation Type |DELETE |
453 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
454 |Content-Type |application/json |
455 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
459 +-------------------+---------+-----------------------------------------------------------------------------------------+
460 |Header Name |Required |Description |
461 +===================+=========+=========================================================================================+
462 |Authorization |Y |Base64 encoded username:password |
463 +-------------------+---------+-----------------------------------------------------------------------------------------+
467 +----------------+---------+-----------+--------------------------+-------------------------------------------+
468 |Attribute |Qualifier|Cardinality|Content |Description |
469 +================+=========+===========+==========================+===========================================+
470 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
471 +----------------+---------+-----------+--------------------------+-------------------------------------------+
473 RequestDetails Object
475 +---------------------+-------------------------+-------------------------------------------------+
476 |Attribute |Content |Description |
477 +=====================+=========================+=================================================+
478 |modelInfo |modelInfo Object |Content of modelInfo object. |
479 +---------------------+-------------------------+-------------------------------------------------+
480 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
481 +---------------------+-------------------------+-------------------------------------------------+
482 |requestInfo |requestInfo Object |Content of requestInfo object. |
483 +---------------------+-------------------------+-------------------------------------------------+
487 +-------------------------+------------------+-------------------------------------------------+
488 |Attribute |Content |Description |
489 +=========================+==================+=================================================+
490 |ModelType |String |Type of model |
491 +-------------------------+------------------+-------------------------------------------------+
492 |ModelName |String |Name of the Model |
493 +-------------------------+------------------+-------------------------------------------------+
495 CloudConfiguration Object
497 +-------------------------+------------------+-------------------------------------------------+
498 |Attribute |Content |Description |
499 +=========================+==================+=================================================+
500 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
501 +-------------------------+------------------+-------------------------------------------------+
502 |tenantId |String |Name of the Subscriber |
503 +-------------------------+------------------+-------------------------------------------------+
507 +-------------------------+------------------+-------------------------------------------------+
508 |Attribute |Content |Description |
509 +=========================+==================+=================================================+
510 |Source |String |source of the request |
511 +-------------------------+------------------+-------------------------------------------------+
513 .. _create_vf_module:
518 +--------------------+---------------------------------------------------------------------------------------------------------------+
519 |Interface Definition|Description |
520 +====================+===============================================================================================================+
521 |URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules |
522 +--------------------+---------------------------------------------------------------------------------------------------------------+
523 |Operation Type |POST |
524 +--------------------+---------------------------------------------------------------------------------------------------------------+
525 |Content-Type |application/json |
526 +--------------------+---------------------------------------------------------------------------------------------------------------+
530 +-------------------+---------+-----------------------------------------------------------------------------------------+
531 |Header Name |Required |Description |
532 +===================+=========+=========================================================================================+
533 |Authorization |Y |Base64 encoded username:password |
534 +-------------------+---------+-----------------------------------------------------------------------------------------+
538 +----------------+---------+-----------+--------------------------+-------------------------------------------+
539 |Attribute |Qualifier|Cardinality|Content |Description |
540 +================+=========+===========+==========================+===========================================+
541 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
542 +----------------+---------+-----------+--------------------------+-------------------------------------------+
544 RequestDetails Object
546 +---------------------+-------------------------+-------------------------------------------------+
547 |Attribute |Content |Description |
548 +=====================+=========================+=================================================+
549 |modelInfo |modelInfo Object |Content of modelInfo object. |
550 +---------------------+-------------------------+-------------------------------------------------+
551 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
552 +---------------------+-------------------------+-------------------------------------------------+
553 |requestInfo |requestInfo Object |Content of requestInfo object. |
554 +---------------------+-------------------------+-------------------------------------------------+
555 |relatedInstanceList |List |Content of relatedInstanceList. |
556 +---------------------+-------------------------+-------------------------------------------------+
560 +-------------------------+------------------+-------------------------------------------------+
561 |Attribute |Content |Description |
562 +=========================+==================+=================================================+
563 |ModelType |String |Type of model |
564 +-------------------------+------------------+-------------------------------------------------+
565 |ModelInvariantId |String |The Model Invariant Id. |
566 +-------------------------+------------------+-------------------------------------------------+
567 |ModelNameVersionId |String |The modelname Version Id |
568 +-------------------------+------------------+-------------------------------------------------+
569 |ModelName |String |Name of the Model |
570 +-------------------------+------------------+-------------------------------------------------+
571 |ModelVersion |String |Version of the model |
572 +-------------------------+------------------+-------------------------------------------------+
573 |ModelCustomization Name |String |The Model Customization name |
574 +-------------------------+------------------+-------------------------------------------------+
576 CloudConfiguration Object
578 +-------------------------+------------------+-------------------------------------------------+
579 |Attribute |Content |Description |
580 +=========================+==================+=================================================+
581 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
582 +-------------------------+------------------+-------------------------------------------------+
583 |tenantId |String |Name of the Subscriber |
584 +-------------------------+------------------+-------------------------------------------------+
588 +-------------------------+------------------+-------------------------------------------------+
589 |Attribute |Content |Description |
590 +=========================+==================+=================================================+
591 |InstanceName |String |The instance Name |
592 +-------------------------+------------------+-------------------------------------------------+
593 |Source |String |source of the request |
594 +-------------------------+------------------+-------------------------------------------------+
595 |SuppressRollback |Boolean |SuppressRollback |
596 +-------------------------+------------------+-------------------------------------------------+
600 +-------------------------+------------------+-------------------------------------------------+
601 |Attribute |Content |Description |
602 +=========================+==================+=================================================+
603 |relatedInstance |Object |relatedInstance Object |
604 +-------------------------+------------------+-------------------------------------------------+
608 +-------------------------+------------------+-------------------------------------------------+
609 |Attribute |Content |Description |
610 +=========================+==================+=================================================+
611 |instanceId |String |instanceId |
612 +-------------------------+------------------+-------------------------------------------------+
613 |modelInfo |Object |Content of modelInfo object. |
614 +-------------------------+------------------+-------------------------------------------------+
615 |instanceName |String |Name of the instance |
616 +-------------------------+------------------+-------------------------------------------------+
618 .. _delete_vf_module:
623 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
624 |Interface Definition|Description |
625 +====================+=====================================================================================================================================+
626 |URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id} |
627 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
628 |Operation Type |DELETE |
629 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
630 |Content-Type |application/json |
631 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
635 +-------------------+---------+-----------------------------------------------------------------------------------------+
636 |Header Name |Required |Description |
637 +===================+=========+=========================================================================================+
638 |Authorization |Y |Base64 encoded username:password |
639 +-------------------+---------+-----------------------------------------------------------------------------------------+
643 +----------------+---------+-----------+--------------------------+-------------------------------------------+
644 |Attribute |Qualifier|Cardinality|Content |Description |
645 +================+=========+===========+==========================+===========================================+
646 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
647 +----------------+---------+-----------+--------------------------+-------------------------------------------+
649 RequestDetails Object
651 +---------------------+-------------------------+-------------------------------------------------+
652 |Attribute |Content |Description |
653 +=====================+=========================+=================================================+
654 |modelInfo |modelInfo Object |Content of modelInfo object. |
655 +---------------------+-------------------------+-------------------------------------------------+
656 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
657 +---------------------+-------------------------+-------------------------------------------------+
658 |requestInfo |requestInfo Object |Content of requestInfo object. |
659 +---------------------+-------------------------+-------------------------------------------------+
663 +-------------------------+------------------+-------------------------------------------------+
664 |Attribute |Content |Description |
665 +=========================+==================+=================================================+
666 |ModelType |String |Type of model |
667 +-------------------------+------------------+-------------------------------------------------+
668 |ModelInvariantId |String |The Model Invariant Id. |
669 +-------------------------+------------------+-------------------------------------------------+
670 |ModelNameVersionId |String |The modelname Version Id |
671 +-------------------------+------------------+-------------------------------------------------+
672 |ModelName |String |Name of the Model |
673 +-------------------------+------------------+-------------------------------------------------+
674 |ModelVersion |String |Version of the model |
675 +-------------------------+------------------+-------------------------------------------------+
676 |ModelCustomization Name |String |The Model Customization name |
677 +-------------------------+------------------+-------------------------------------------------+
679 CloudConfiguration Object
681 +-------------------------+------------------+-------------------------------------------------+
682 |Attribute |Content |Description |
683 +=========================+==================+=================================================+
684 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
685 +-------------------------+------------------+-------------------------------------------------+
686 |tenantId |String |Name of the Subscriber |
687 +-------------------------+------------------+-------------------------------------------------+
691 +-------------------------+------------------+-------------------------------------------------+
692 |Attribute |Content |Description |
693 +=========================+==================+=================================================+
694 |Source |String |source of the request |
695 +-------------------------+------------------+-------------------------------------------------+
703 +--------------------+-------------------------------------------------------------------------------------+
704 |Interface Definition|Description |
705 +====================+=====================================================================================+
706 |URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs |
707 +--------------------+-------------------------------------------------------------------------------------+
708 |Operation Type |POST |
709 +--------------------+-------------------------------------------------------------------------------------+
710 |Content-Type |application/json |
711 +--------------------+-------------------------------------------------------------------------------------+
715 +-------------------+---------+-----------------------------------------------------------------------------------------+
716 |Header Name |Required |Description |
717 +===================+=========+=========================================================================================+
718 |Authorization |Y |Base64 encoded username:password |
719 +-------------------+---------+-----------------------------------------------------------------------------------------+
723 +----------------+---------+-----------+--------------------------+-------------------------------------------+
724 |Attribute |Qualifier|Cardinality|Content |Description |
725 +================+=========+===========+==========================+===========================================+
726 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
727 +----------------+---------+-----------+--------------------------+-------------------------------------------+
729 RequestDetails Object
731 +-------------------+--------------------------+-------------------------------------------------+
732 |Attribute |Content |Description |
733 +===================+==========================+=================================================+
734 |modelInfo |modelInfo Object |Content of modelInfo object. |
735 +-------------------+--------------------------+-------------------------------------------------+
736 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
737 +-------------------+--------------------------+-------------------------------------------------+
738 |requestInfo |requestInfo Object |Content of requestInfo object. |
739 +-------------------+--------------------------+-------------------------------------------------+
740 |requestParameters |requestParameters Object |Content of requestParameters object. |
741 +-------------------+--------------------------+-------------------------------------------------+
742 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
743 +-------------------+--------------------------+-------------------------------------------------+
744 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
745 +-------------------+--------------------------+-------------------------------------------------+
746 |project |project Object |Content of project object. |
747 +-------------------+--------------------------+-------------------------------------------------+
748 |owningEntity |owningEntity Object |Content of owningEntity object. |
749 +-------------------+--------------------------+-------------------------------------------------+
750 |platform |platform Object |Content of platform object. |
751 +-------------------+--------------------------+-------------------------------------------------+
752 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
753 +-------------------+--------------------------+-------------------------------------------------+
757 +-------------------------+------------------+-------------------------------------------------+
758 |Attribute |Content |Description |
759 +=========================+==================+=================================================+
760 |ModelType |String |Type of model |
761 +-------------------------+------------------+-------------------------------------------------+
762 |ModelInvariantId |String |The Model Invariant Id. |
763 +-------------------------+------------------+-------------------------------------------------+
764 |ModelNameVersionId |String |The modelname Version Id |
765 +-------------------------+------------------+-------------------------------------------------+
766 |ModelName |String |Name of the Model |
767 +-------------------------+------------------+-------------------------------------------------+
768 |ModelVersion |String |Version of the model |
769 +-------------------------+------------------+-------------------------------------------------+
770 |ModelCustomization Name |String |The Model Customization name |
771 +-------------------------+------------------+-------------------------------------------------+
772 |modelCustomizationUuid |String |The Model Customization UUid |
773 +-------------------------+------------------+-------------------------------------------------+
774 |modelVersionId |String |The Model version id |
775 +-------------------------+------------------+-------------------------------------------------+
776 |modelUuid |String |The Model UUid |
777 +-------------------------+------------------+-------------------------------------------------+
778 |modelInvariantUuid |String |The Model Invariant UUid |
779 +-------------------------+------------------+-------------------------------------------------+
780 |modelInstanceName |String |The Model Instance name |
781 +-------------------------+------------------+-------------------------------------------------+
783 CloudConfiguration Object
785 +-------------------------+------------------+-------------------------------------------------+
786 |Attribute |Content |Description |
787 +=========================+==================+=================================================+
788 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
789 +-------------------------+------------------+-------------------------------------------------+
790 |tenantId |String |Name of the Subscriber |
791 +-------------------------+------------------+-------------------------------------------------+
795 +-------------------------+------------------+-------------------------------------------------+
796 |Attribute |Content |Description |
797 +=========================+==================+=================================================+
798 |Source |String |source of the request |
799 +-------------------------+------------------+-------------------------------------------------+
800 |billingAccountNumber |String |billingAccountNumber of the request |
801 +-------------------------+------------------+-------------------------------------------------+
802 |callbackUrl |String |callbackUrl of the request |
803 +-------------------------+------------------+-------------------------------------------------+
804 |correlator |String |correlator of the request |
805 +-------------------------+------------------+-------------------------------------------------+
806 |orderNumber |String |orderNumber of the request |
807 +-------------------------+------------------+-------------------------------------------------+
808 |productFamilyId |String |productFamilyId of the request |
809 +-------------------------+------------------+-------------------------------------------------+
810 |orderVersion |String |orderVersion of the request |
811 +-------------------------+------------------+-------------------------------------------------+
812 |instanceName |String |instanceName of the request |
813 +-------------------------+------------------+-------------------------------------------------+
814 |suppressRollback |String |suppressRollback of the request |
815 +-------------------------+------------------+-------------------------------------------------+
816 |requestorId |String |requestorId of the request |
817 +-------------------------+------------------+-------------------------------------------------+
821 +-------------------------+------------------+-------------------------------------------------+
822 |Attribute |Content |Description |
823 +=========================+==================+=================================================+
824 |relatedInstance |Object |relatedInstance Object |
825 +-------------------------+------------------+-------------------------------------------------+
829 +-------------------------+------------------+-------------------------------------------------+
830 |Attribute |Content |Description |
831 +=========================+==================+=================================================+
832 |instanceId |String |instanceId |
833 +-------------------------+------------------+-------------------------------------------------+
834 |modelInfo |Object |Content of modelInfo object. |
835 +-------------------------+------------------+-------------------------------------------------+
837 RequestParameters Object
839 +-------------------------+------------------+-------------------------------------------------+
840 |Attribute |Content |Description |
841 +=========================+==================+=================================================+
842 |UserParams |Array |The product family Id. |
843 +-------------------------+------------------+-------------------------------------------------+
847 +-------------------------+------------------+-------------------------------------------------+
848 |Attribute |Content |Description |
849 +=========================+==================+=================================================+
850 |name |String |Tag name of attribute |
851 +-------------------------+------------------+-------------------------------------------------+
852 |value |String |Value of the tag |
853 +-------------------------+------------------+-------------------------------------------------+
860 +--------------------+-----------------------------------------------------------------------------------------------------+
861 |Interface Definition|Description |
862 +====================+=====================================================================================================+
863 |URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId} |
864 +--------------------+-----------------------------------------------------------------------------------------------------+
865 |Operation Type |DELETE |
866 +--------------------+-----------------------------------------------------------------------------------------------------+
867 |Content-Type |application/json |
868 +--------------------+-----------------------------------------------------------------------------------------------------+
872 +-------------------+---------+-----------------------------------------------------------------------------------------+
873 |Header Name |Required |Description |
874 +===================+=========+=========================================================================================+
875 |Authorization |Y |Base64 encoded username:password |
876 +-------------------+---------+-----------------------------------------------------------------------------------------+
880 +----------------+---------+-----------+--------------------------+-------------------------------------------+
881 |Attribute |Qualifier|Cardinality|Content |Description |
882 +================+=========+===========+==========================+===========================================+
883 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
884 +----------------+---------+-----------+--------------------------+-------------------------------------------+
886 RequestDetails Object
888 +---------------------+-------------------------+-------------------------------------------------+
889 |Attribute |Content |Description |
890 +=====================+=========================+=================================================+
891 |modelInfo |modelInfo Object |Content of modelInfo object. |
892 +---------------------+-------------------------+-------------------------------------------------+
893 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
894 +---------------------+-------------------------+-------------------------------------------------+
895 |requestInfo |requestInfo Object |Content of requestInfo object. |
896 +---------------------+-------------------------+-------------------------------------------------+
897 |requestParameters |requestParameters Object |Content of requestParameters object. |
898 +---------------------+-------------------------+-------------------------------------------------+
902 +-------------------------+------------------+-------------------------------------------------+
903 |Attribute |Content |Description |
904 +=========================+==================+=================================================+
905 |ModelType |String |Type of model |
906 +-------------------------+------------------+-------------------------------------------------+
907 |ModelName |String |Name of the Model |
908 +-------------------------+------------------+-------------------------------------------------+
910 CloudConfiguration Object
912 +-------------------------+------------------+-------------------------------------------------+
913 |Attribute |Content |Description |
914 +=========================+==================+=================================================+
915 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
916 +-------------------------+------------------+-------------------------------------------------+
917 |tenantId |String |Name of the Subscriber |
918 +-------------------------+------------------+-------------------------------------------------+
922 +-------------------------+------------------+-------------------------------------------------+
923 |Attribute |Content |Description |
924 +=========================+==================+=================================================+
925 |Source |String |source of the request |
926 +-------------------------+------------------+-------------------------------------------------+
928 RequestParameters Object
930 +-------------------------+------------------+-------------------------------------------------+
931 |Attribute |Content |Description |
932 +=========================+==================+=================================================+
933 |UserParams |Array |The product family Id. |
934 +-------------------------+------------------+-------------------------------------------------+
938 +-------------------------+------------------+-------------------------------------------------+
939 |Attribute |Content |Description |
940 +=========================+==================+=================================================+
941 |name |String |Tag name of attribute |
942 +-------------------------+------------------+-------------------------------------------------+
943 |value |String |Value of the tag |
944 +-------------------------+------------------+-------------------------------------------------+
951 +--------------------+-------------------------------------------------------------------------------------+
952 |Interface Definition|Description |
953 +====================+=====================================================================================+
954 |URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/cnfs |
955 +--------------------+-------------------------------------------------------------------------------------+
956 |Operation Type |POST |
957 +--------------------+-------------------------------------------------------------------------------------+
958 |Content-Type |application/json |
959 +--------------------+-------------------------------------------------------------------------------------+
963 +-------------------+---------+-----------------------------------------------------------------------------------------+
964 |Header Name |Required |Description |
965 +===================+=========+=========================================================================================+
966 |Authorization |Y |Base64 encoded username:password |
967 +-------------------+---------+-----------------------------------------------------------------------------------------+
971 +----------------+---------+-----------+--------------------------+-------------------------------------------+
972 |Attribute |Qualifier|Cardinality|Content |Description |
973 +================+=========+===========+==========================+===========================================+
974 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
975 +----------------+---------+-----------+--------------------------+-------------------------------------------+
977 RequestDetails Object
979 +-------------------+--------------------------+-------------------------------------------------+
980 |Attribute |Content |Description |
981 +===================+==========================+=================================================+
982 |modelInfo |modelInfo Object |Content of modelInfo object. |
983 +-------------------+--------------------------+-------------------------------------------------+
984 |requestInfo |requestInfo Object |Content of requestInfo object. |
985 +-------------------+--------------------------+-------------------------------------------------+
986 |requestParameters |requestParameters Object |Content of requestParameters object. |
987 +-------------------+--------------------------+-------------------------------------------------+
988 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
989 +-------------------+--------------------------+-------------------------------------------------+
990 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
991 +-------------------+--------------------------+-------------------------------------------------+
992 |platform |platform Object |Content of platform object. |
993 +-------------------+--------------------------+-------------------------------------------------+
994 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
995 +-------------------+--------------------------+-------------------------------------------------+
999 +-------------------------+------------------+-------------------------------------------------+
1000 |Attribute |Content |Description |
1001 +=========================+==================+=================================================+
1002 |modelType |String |Type of model |
1003 +-------------------------+------------------+-------------------------------------------------+
1004 |modelInvariantId |String |The Model Invariant Id. |
1005 +-------------------------+------------------+-------------------------------------------------+
1006 |modelName |String |Name of the Model |
1007 +-------------------------+------------------+-------------------------------------------------+
1008 |modelVersion |String |Version of the model |
1009 +-------------------------+------------------+-------------------------------------------------+
1010 |modelCustomizationName |String |The Model Customization name |
1011 +-------------------------+------------------+-------------------------------------------------+
1012 |modelVersionId |String |The Model version id |
1013 +-------------------------+------------------+-------------------------------------------------+
1015 CloudConfiguration Object
1017 +-------------------------+------------------+-------------------------------------------------+
1018 |Attribute |Content |Description |
1019 +=========================+==================+=================================================+
1020 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
1021 +-------------------------+------------------+-------------------------------------------------+
1022 |tenantId |String |Name of the Subscriber |
1023 +-------------------------+------------------+-------------------------------------------------+
1024 |cloudOwner |String |Name of the cloud owner |
1025 +-------------------------+------------------+-------------------------------------------------+
1029 +-------------------------+------------------+-------------------------------------------------+
1030 |Attribute |Content |Description |
1031 +=========================+==================+=================================================+
1032 |source |String |source of the request |
1033 +-------------------------+------------------+-------------------------------------------------+
1034 |productFamilyId |String |productFamilyId of the request |
1035 +-------------------------+------------------+-------------------------------------------------+
1036 |instanceName |String |instanceName of the request |
1037 +-------------------------+------------------+-------------------------------------------------+
1038 |suppressRollback |String |suppressRollback of the request |
1039 +-------------------------+------------------+-------------------------------------------------+
1040 |requestorId |String |requestorId of the request |
1041 +-------------------------+------------------+-------------------------------------------------+
1043 relatedInstance List
1045 +-------------------------+------------------+-------------------------------------------------+
1046 |Attribute |Content |Description |
1047 +=========================+==================+=================================================+
1048 |relatedInstance |Object |relatedInstance Object |
1049 +-------------------------+------------------+-------------------------------------------------+
1051 relatedInstance List
1053 +-------------------------+------------------+-------------------------------------------------+
1054 |Attribute |Content |Description |
1055 +=========================+==================+=================================================+
1056 |instanceId |String |instanceId |
1057 +-------------------------+------------------+-------------------------------------------------+
1058 |modelInfo |Object |Content of modelInfo object. |
1059 +-------------------------+------------------+-------------------------------------------------+
1061 RequestParameters Object
1063 +-------------------------+------------------+-------------------------------------------------+
1064 |Attribute |Content |Description |
1065 +=========================+==================+=================================================+
1066 |userParams |Array |The product family Id. |
1067 +-------------------------+------------------+-------------------------------------------------+
1071 +-------------------------+------------------+-------------------------------------------------+
1072 |Attribute |Content |Description |
1073 +=========================+==================+=================================================+
1074 |name |String |Tag name of attribute |
1075 +-------------------------+------------------+-------------------------------------------------+
1076 |value |String |Value of the tag |
1077 +-------------------------+------------------+-------------------------------------------------+
1084 +--------------------+-----------------------------------------------------------------------------------------------------+
1085 |Interface Definition|Description |
1086 +====================+=====================================================================================================+
1087 |URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/cnfs/{cnfInstanceId} |
1088 +--------------------+-----------------------------------------------------------------------------------------------------+
1089 |Operation Type |DELETE |
1090 +--------------------+-----------------------------------------------------------------------------------------------------+
1091 |Content-Type |application/json |
1092 +--------------------+-----------------------------------------------------------------------------------------------------+
1096 +-------------------+---------+-----------------------------------------------------------------------------------------+
1097 |Header Name |Required |Description |
1098 +===================+=========+=========================================================================================+
1099 |Authorization |Y |Base64 encoded username:password |
1100 +-------------------+---------+-----------------------------------------------------------------------------------------+
1104 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1105 |Attribute |Qualifier|Cardinality|Content |Description |
1106 +================+=========+===========+==========================+===========================================+
1107 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
1108 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1110 RequestDetails Object
1112 +---------------------+-------------------------+-------------------------------------------------+
1113 |Attribute |Content |Description |
1114 +=====================+=========================+=================================================+
1115 |modelInfo |modelInfo Object |Content of modelInfo object. |
1116 +---------------------+-------------------------+-------------------------------------------------+
1117 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
1118 +---------------------+-------------------------+-------------------------------------------------+
1119 |requestInfo |requestInfo Object |Content of requestInfo object. |
1120 +---------------------+-------------------------+-------------------------------------------------+
1121 |requestParameters |requestParameters Object |Content of requestParameters object. |
1122 +---------------------+-------------------------+-------------------------------------------------+
1126 +-------------------------+------------------+-------------------------------------------------+
1127 |Attribute |Content |Description |
1128 +=========================+==================+=================================================+
1129 |modelType |String |Type of model |
1130 +-------------------------+------------------+-------------------------------------------------+
1131 |modelName |String |Name of the Model |
1132 +-------------------------+------------------+-------------------------------------------------+
1133 |modelVersionId |String |The Model version id |
1134 +-------------------------+------------------+-------------------------------------------------+
1135 |modelInvariantId |String |The Model Invariant Id. |
1136 +-------------------------+------------------+-------------------------------------------------+
1137 |modelVersion |String |Version of the model |
1138 +-------------------------+------------------+-------------------------------------------------+
1139 |modelCustomizationName |String |The Model Customization name |
1140 +-------------------------+------------------+-------------------------------------------------+
1141 |modelCustomizationId |String |The Model Customization Id. |
1142 +-------------------------+------------------+-------------------------------------------------+
1144 CloudConfiguration Object
1146 +-------------------------+------------------+-------------------------------------------------+
1147 |Attribute |Content |Description |
1148 +=========================+==================+=================================================+
1149 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
1150 +-------------------------+------------------+-------------------------------------------------+
1151 |tenantId |String |Name of the Subscriber |
1152 +-------------------------+------------------+-------------------------------------------------+
1153 |cloudOwner |String |Name of the cloud owner |
1154 +-------------------------+------------------+-------------------------------------------------+
1158 +-------------------------+------------------+-------------------------------------------------+
1159 |Attribute |Content |Description |
1160 +=========================+==================+=================================================+
1161 |source |String |source of the request |
1162 +-------------------------+------------------+-------------------------------------------------+
1163 |requestId |String |request Id |
1164 +-------------------------+------------------+-------------------------------------------------+
1166 RequestParameters Object
1168 +-------------------------+------------------+-------------------------------------------------+
1169 |Attribute |Content |Description |
1170 +=========================+==================+=================================================+
1171 |UserParams |Array |The product family Id. |
1172 +-------------------------+------------------+-------------------------------------------------+
1176 +-------------------------+------------------+-------------------------------------------------+
1177 |Attribute |Content |Description |
1178 +=========================+==================+=================================================+
1179 |name |String |Tag name of attribute |
1180 +-------------------------+------------------+-------------------------------------------------+
1181 |value |String |Value of the tag |
1182 +-------------------------+------------------+-------------------------------------------------+
1184 .. _get_orchestration_request_by_id:
1186 GET Orchestration Request
1187 +++++++++++++++++++++++++
1189 +--------------------+-------------------------------------------------------------------------------------+
1190 |Interface Definition|Description |
1191 +====================+=====================================================================================+
1192 |URI |/onap/so/infra/orchestrationRequests/v7/{request-id} |
1193 +--------------------+-------------------------------------------------------------------------------------+
1194 |Operation Type |GET |
1195 +--------------------+-------------------------------------------------------------------------------------+
1196 |Content-Type |application/json |
1197 +--------------------+-------------------------------------------------------------------------------------+
1201 +-------------------+---------+-----------------------------------------------------------------------------------------+
1202 |Header Name |Required |Description |
1203 +===================+=========+=========================================================================================+
1204 |Authorization |Y |Base64 encoded username:password |
1205 +-------------------+---------+-----------------------------------------------------------------------------------------+
1209 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1210 |Attribute |Qualifier|Cardinality|Content |Description |
1211 +================+=========+===========+==========================+===========================================+
1212 |request |M |1 |request Object |Content of request object. |
1213 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1217 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1218 |Attribute |Qualifier|Cardinality|Content |Description |
1219 +===================+=========+===========+==========================+===========================================+
1220 |requestId |M |1 |String |Request Id |
1221 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1222 |startTime |M |1 |request Object |Start time. |
1223 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1224 |requestScope |M |1 |request Object |Scope of the request. |
1225 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1226 |requestType |M |1 |request Object |Type of the request. |
1227 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1228 |requestDetails |M |1 |requestDetails Object |Type of the request. |
1229 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1230 |requestStatus |M |1 |requestStatus Object |Type of the request. |
1231 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1233 RequestDetails Object
1235 +-------------------+--------------------------+-------------------------------------------------+
1236 |Attribute |Content |Description |
1237 +===================+==========================+=================================================+
1238 |modelInfo |modelInfo Object |Content of modelInfo object. |
1239 +-------------------+--------------------------+-------------------------------------------------+
1240 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
1241 +-------------------+--------------------------+-------------------------------------------------+
1242 |requestInfo |requestInfo Object |Content of requestInfo object. |
1243 +-------------------+--------------------------+-------------------------------------------------+
1244 |requestParameters |requestParameters Object |Content of requestParameters object. |
1245 +-------------------+--------------------------+-------------------------------------------------+
1246 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
1247 +-------------------+--------------------------+-------------------------------------------------+
1248 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
1249 +-------------------+--------------------------+-------------------------------------------------+
1250 |project |project Object |Content of project object. |
1251 +-------------------+--------------------------+-------------------------------------------------+
1252 |owningEntity |owningEntity Object |Content of owningEntity object. |
1253 +-------------------+--------------------------+-------------------------------------------------+
1254 |platform |platform Object |Content of platform object. |
1255 +-------------------+--------------------------+-------------------------------------------------+
1256 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
1257 +-------------------+--------------------------+-------------------------------------------------+
1261 +-------------------------+------------------+-------------------------------------------------+
1262 |Attribute |Content |Description |
1263 +=========================+==================+=================================================+
1264 |ModelType |String |Type of model |
1265 +-------------------------+------------------+-------------------------------------------------+
1266 |ModelInvariantId |String |The Model Invariant Id. |
1267 +-------------------------+------------------+-------------------------------------------------+
1268 |ModelNameVersionId |String |The modelname Version Id |
1269 +-------------------------+------------------+-------------------------------------------------+
1270 |ModelName |String |Name of the Model |
1271 +-------------------------+------------------+-------------------------------------------------+
1272 |ModelVersion |String |Version of the model |
1273 +-------------------------+------------------+-------------------------------------------------+
1274 |ModelCustomization Name |String |The Model Customization name |
1275 +-------------------------+------------------+-------------------------------------------------+
1276 |modelCustomizationUuid |String |The Model Customization UUid |
1277 +-------------------------+------------------+-------------------------------------------------+
1278 |modelVersionId |String |The Model version id |
1279 +-------------------------+------------------+-------------------------------------------------+
1280 |modelUuid |String |The Model UUid |
1281 +-------------------------+------------------+-------------------------------------------------+
1282 |modelInvariantUuid |String |The Model Invariant UUid |
1283 +-------------------------+------------------+-------------------------------------------------+
1284 |modelInstanceName |String |The Model Instance name |
1285 +-------------------------+------------------+-------------------------------------------------+
1287 SubscriberInfo Object
1289 +-------------------------+------------------+-------------------------------------------------+
1290 |Attribute |Content |Description |
1291 +=========================+==================+=================================================+
1292 |GlobalSubscriberId |String |Global customer Id (in A&AI) |
1293 +-------------------------+------------------+-------------------------------------------------+
1294 |SubscriberName |String |Name of the Subscriber |
1295 +-------------------------+------------------+-------------------------------------------------+
1299 +-------------------------+------------------+-------------------------------------------------+
1300 |Attribute |Content |Description |
1301 +=========================+==================+=================================================+
1302 |Source |String |source of the request |
1303 +-------------------------+------------------+-------------------------------------------------+
1304 |billingAccountNumber |String |billingAccountNumber of the request |
1305 +-------------------------+------------------+-------------------------------------------------+
1306 |callbackUrl |String |callbackUrl of the request |
1307 +-------------------------+------------------+-------------------------------------------------+
1308 |correlator |String |correlator of the request |
1309 +-------------------------+------------------+-------------------------------------------------+
1310 |orderNumber |String |orderNumber of the request |
1311 +-------------------------+------------------+-------------------------------------------------+
1312 |productFamilyId |String |productFamilyId of the request |
1313 +-------------------------+------------------+-------------------------------------------------+
1314 |orderVersion |String |orderVersion of the request |
1315 +-------------------------+------------------+-------------------------------------------------+
1316 |instanceName |String |instanceName of the request |
1317 +-------------------------+------------------+-------------------------------------------------+
1318 |suppressRollback |String |suppressRollback of the request |
1319 +-------------------------+------------------+-------------------------------------------------+
1320 |requestorId |String |requestorId of the request |
1321 +-------------------------+------------------+-------------------------------------------------+
1323 RequestParameters Object
1325 +-------------------------+------------------+-------------------------------------------------+
1326 |Attribute |Content |Description |
1327 +=========================+==================+=================================================+
1328 |SubscriptionServiceType |String |The service type of the Subscription |
1329 +-------------------------+------------------+-------------------------------------------------+
1331 RequestStatus Object
1333 +-------------------------+------------------+-------------------------------------------------+
1334 |Attribute |Content |Description |
1335 +=========================+==================+=================================================+
1336 |finishTime |String |Time |
1337 +-------------------------+------------------+-------------------------------------------------+
1338 |requestState |String |state of the request |
1339 +-------------------------+------------------+-------------------------------------------------+
1340 |statusMessage |String |statusMessage |
1341 +-------------------------+------------------+-------------------------------------------------+
1342 |percentProgress |String |percentage of progress |
1343 +-------------------------+------------------+-------------------------------------------------+
1346 .. _get_orchestration_request_all:
1348 GET Orchestration Requests
1349 ++++++++++++++++++++++++++
1351 +--------------------+--------------------------------------------------------------+
1352 |Interface Definition|Description |
1353 +====================+==============================================================+
1354 |URI |/onap/so/infra/orchestrationRequests/v7 |
1355 +--------------------+--------------------------------------------------------------+
1356 |Operation Type |GET |
1357 +--------------------+--------------------------------------------------------------+
1358 |Content-Type |application/json |
1359 +--------------------+--------------------------------------------------------------+
1363 +-------------------+---------+-----------------------------------------------------------------------------------------+
1364 |Header Name |Required |Description |
1365 +===================+=========+=========================================================================================+
1366 |Authorization |Y |Base64 encoded username:password |
1367 +-------------------+---------+-----------------------------------------------------------------------------------------+
1371 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1372 |Attribute |Required |Cardinality|Content|Description |
1373 +===================+=========+===========+=======+=====================================================================================================+
1374 |filter |Y |1 |String | Orchestration filter (scheme KeyTypes:Option:Value) |
1376 | | | | | KeyTypes: |
1377 | | | | | serviceInstanceId, serviceInstanceName, vnfInstanceId, pnfName, vnfInstanceName, |
1378 | | | | | vfModuleInstanceId, vfModuleInstanceName, volumeGroupInstanceId, volumeGroupInstanceName, |
1379 | | | | | networkInstanceId, networkInstanceName, configurationInstanceId, configurationInstanceName, |
1380 | | | | | lcpCloudRegionId, tenantId, modelType, requestorId, requestExecutionDate, startTime, requestScope |
1383 | | | | | EQUALS (or any not null string), DOES_NOT_EQUAL [e.g. modelType:EQUALS:VNF, modelType:qwe:VNF] |
1384 | | | | | for KeyTypes equals startTime or requestExecutionDate: DOES_NOT_EQUAL, BETWEEN_DATES |
1385 | | | | | [e.g. startTime:BETWEEN_DATES:30-5-2000:30-5-2030] |
1386 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1387 |includeCloudRequest|N |1 |Boolean| Enable or disable cloud data request |
1388 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1389 |format |N |1 |String | Orchestration request format [DETAIL, STATUSDETAIL, SIMPLE, SIMPLENOTASKINFO] |
1390 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1394 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1395 |Attribute |Qualifier|Cardinality|Content |Description |
1396 +================+=========+===========+==========================+===========================================+
1397 |requestList |M |1 |Array |Content of request List. |
1398 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1402 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1403 |Attribute |Qualifier|Cardinality|Content |Description |
1404 +================+=========+===========+==========================+===========================================+
1405 |request |M |1 |request Object |Content of request object. |
1406 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1410 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1411 |Attribute |Qualifier|Cardinality|Content |Description |
1412 +===================+=========+===========+==========================+===========================================+
1413 |requestId |M |1 |String |Request Id. |
1414 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1415 |startTime |M |1 |request Object |Start time. |
1416 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1417 |requestScope |M |1 |request Object |Scope of the request. |
1418 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1419 |requestType |M |1 |request Object |Type of the request. |
1420 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1421 |requestDetails |M |1 |requestDetails Object |Type of the request. |
1422 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1423 |requestStatus |M |1 |requestStatus Object |Type of the request. |
1424 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1426 RequestDetails Object
1428 +-------------------+--------------------------+-------------------------------------------------+
1429 |Attribute |Content |Description |
1430 +===================+==========================+=================================================+
1431 |modelInfo |modelInfo Object |Content of modelInfo object. |
1432 +-------------------+--------------------------+-------------------------------------------------+
1433 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
1434 +-------------------+--------------------------+-------------------------------------------------+
1435 |requestInfo |requestInfo Object |Content of requestInfo object. |
1436 +-------------------+--------------------------+-------------------------------------------------+
1437 |requestParameters |requestParameters Object |Content of requestParameters object. |
1438 +-------------------+--------------------------+-------------------------------------------------+
1439 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
1440 +-------------------+--------------------------+-------------------------------------------------+
1441 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
1442 +-------------------+--------------------------+-------------------------------------------------+
1443 |project |project Object |Content of project object. |
1444 +-------------------+--------------------------+-------------------------------------------------+
1445 |owningEntity |owningEntity Object |Content of owningEntity object. |
1446 +-------------------+--------------------------+-------------------------------------------------+
1447 |platform |platform Object |Content of platform object. |
1448 +-------------------+--------------------------+-------------------------------------------------+
1449 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
1450 +-------------------+--------------------------+-------------------------------------------------+
1454 +-------------------------+------------------+-------------------------------------------------+
1455 |Attribute |Content |Description |
1456 +=========================+==================+=================================================+
1457 |ModelType |String |Type of model |
1458 +-------------------------+------------------+-------------------------------------------------+
1459 |ModelInvariantId |String |The Model Invariant Id. |
1460 +-------------------------+------------------+-------------------------------------------------+
1461 |ModelNameVersionId |String |The modelname Version Id |
1462 +-------------------------+------------------+-------------------------------------------------+
1463 |ModelName |String |Name of the Model |
1464 +-------------------------+------------------+-------------------------------------------------+
1465 |ModelVersion |String |Version of the model |
1466 +-------------------------+------------------+-------------------------------------------------+
1467 |ModelCustomization Name |String |The Model Customization name |
1468 +-------------------------+------------------+-------------------------------------------------+
1469 |modelCustomizationUuid |String |The Model Customization UUid |
1470 +-------------------------+------------------+-------------------------------------------------+
1471 |modelVersionId |String |The Model version id |
1472 +-------------------------+------------------+-------------------------------------------------+
1473 |modelUuid |String |The Model UUid |
1474 +-------------------------+------------------+-------------------------------------------------+
1475 |modelInvariantUuid |String |The Model Invariant UUid |
1476 +-------------------------+------------------+-------------------------------------------------+
1477 |modelInstanceName |String |The Model Instance name |
1478 +-------------------------+------------------+-------------------------------------------------+
1480 SubscriberInfo Object
1482 +-------------------------+------------------+-------------------------------------------------+
1483 |Attribute |Content |Description |
1484 +=========================+==================+=================================================+
1485 |GlobalSubscriberId |String |Global customer Id (in A&AI) |
1486 +-------------------------+------------------+-------------------------------------------------+
1487 |SubscriberName |String |Name of the Subscriber |
1488 +-------------------------+------------------+-------------------------------------------------+
1492 +-------------------------+------------------+-------------------------------------------------+
1493 |Attribute |Content |Description |
1494 +=========================+==================+=================================================+
1495 |Source |String |source of the request |
1496 +-------------------------+------------------+-------------------------------------------------+
1497 |billingAccountNumber |String |billingAccountNumber of the request |
1498 +-------------------------+------------------+-------------------------------------------------+
1499 |callbackUrl |String |callbackUrl of the request |
1500 +-------------------------+------------------+-------------------------------------------------+
1501 |correlator |String |correlator of the request |
1502 +-------------------------+------------------+-------------------------------------------------+
1503 |orderNumber |String |orderNumber of the request |
1504 +-------------------------+------------------+-------------------------------------------------+
1505 |productFamilyId |String |productFamilyId of the request |
1506 +-------------------------+------------------+-------------------------------------------------+
1507 |orderVersion |String |orderVersion of the request |
1508 +-------------------------+------------------+-------------------------------------------------+
1509 |instanceName |String |instanceName of the request |
1510 +-------------------------+------------------+-------------------------------------------------+
1511 |suppressRollback |String |suppressRollback of the request |
1512 +-------------------------+------------------+-------------------------------------------------+
1513 |requestorId |String |requestorId of the request |
1514 +-------------------------+------------------+-------------------------------------------------+
1516 RequestParameters Object
1518 +-------------------------+------------------+-------------------------------------------------+
1519 |Attribute |Content |Description |
1520 +=========================+==================+=================================================+
1521 |SubscriptionServiceType |String |The service type of the Subscription |
1522 +-------------------------+------------------+-------------------------------------------------+
1524 RequestStatus Object
1526 +-------------------------+------------------+-------------------------------------------------+
1527 |Attribute |Content |Description |
1528 +=========================+==================+=================================================+
1529 |finishTime |String |Time |
1530 +-------------------------+------------------+-------------------------------------------------+
1531 |requestState |String |state of the request |
1532 +-------------------------+------------------+-------------------------------------------------+
1533 |statusMessage |String |statusMessage |
1534 +-------------------------+------------------+-------------------------------------------------+
1535 |percentProgress |String |percentage of progress |
1536 +-------------------------+------------------+-------------------------------------------------+
1543 +--------------------+---------------------------------------------------------------------------------------------------------------+
1544 |Interface Definition|Description |
1545 +====================+===============================================================================================================+
1546 |URI |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/healthcheck |
1547 +--------------------+---------------------------------------------------------------------------------------------------------------+
1548 |Operation Type |POST |
1549 +--------------------+---------------------------------------------------------------------------------------------------------------+
1550 |Content-Type |application/json |
1551 +--------------------+---------------------------------------------------------------------------------------------------------------+
1555 +-------------------+---------+-----------------------------------------------------------------------------------------+
1556 |Header Name |Required |Description |
1557 +===================+=========+=========================================================================================+
1558 |Authorization |Y |Base64 encoded username:password |
1559 +-------------------+---------+-----------------------------------------------------------------------------------------+
1563 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1564 |Attribute |Qualifier|Cardinality|Content |Description |
1565 +================+=========+===========+==========================+===========================================+
1566 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
1567 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1569 RequestDetails Object
1571 +---------------------+-------------------------+-------------------------------------------------+
1572 |Attribute |Content |Description |
1573 +=====================+=========================+=================================================+
1574 |modelInfo |modelInfo Object |Content of modelInfo object. |
1575 +---------------------+-------------------------+-------------------------------------------------+
1576 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
1577 +---------------------+-------------------------+-------------------------------------------------+
1578 |requestInfo |requestInfo Object |Content of requestInfo object. |
1579 +---------------------+-------------------------+-------------------------------------------------+
1580 |relatedInstanceList |List |Content of relatedInstanceList. |
1581 +---------------------+-------------------------+-------------------------------------------------+
1585 +-------------------------+------------------+-------------------------------------------------+
1586 |Attribute |Content |Description |
1587 +=========================+==================+=================================================+
1588 |ModelType |String |Type of model |
1589 +-------------------------+------------------+-------------------------------------------------+
1590 |ModelInvariantId |String |The Model Invariant Id. |
1591 +-------------------------+------------------+-------------------------------------------------+
1592 |ModelNameVersionId |String |The modelname Version Id |
1593 +-------------------------+------------------+-------------------------------------------------+
1594 |ModelName |String |Name of the Model |
1595 +-------------------------+------------------+-------------------------------------------------+
1596 |ModelVersion |String |Version of the model |
1597 +-------------------------+------------------+-------------------------------------------------+
1598 |ModelCustomization Name |String |The Model Customization name |
1599 +-------------------------+------------------+-------------------------------------------------+
1601 CloudConfiguration Object
1603 +-------------------------+------------------+-------------------------------------------------+
1604 |Attribute |Content |Description |
1605 +=========================+==================+=================================================+
1606 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
1607 +-------------------------+------------------+-------------------------------------------------+
1608 |tenantId |String |Name of the Subscriber |
1609 +-------------------------+------------------+-------------------------------------------------+
1613 +-------------------------+------------------+-------------------------------------------------+
1614 |Attribute |Content |Description |
1615 +=========================+==================+=================================================+
1616 |InstanceName |String |The instance Name |
1617 +-------------------------+------------------+-------------------------------------------------+
1618 |Source |String |source of the request |
1619 +-------------------------+------------------+-------------------------------------------------+
1620 |SuppressRollback |Boolean |SuppressRollback |
1621 +-------------------------+------------------+-------------------------------------------------+
1623 relatedInstance List
1625 +-------------------------+------------------+-------------------------------------------------+
1626 |Attribute |Content |Description |
1627 +=========================+==================+=================================================+
1628 |relatedInstance |Object |relatedInstance Object |
1629 +-------------------------+------------------+-------------------------------------------------+
1631 relatedInstance List
1633 +-------------------------+------------------+-------------------------------------------------+
1634 |Attribute |Content |Description |
1635 +=========================+==================+=================================================+
1636 |instanceId |String |instanceId |
1637 +-------------------------+------------------+-------------------------------------------------+
1638 |modelInfo |Object |Content of modelInfo object. |
1639 +-------------------------+------------------+-------------------------------------------------+
1640 |instanceName |String |Name of the instance |
1641 +-------------------------+------------------+-------------------------------------------------+