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)
19 - :ref:`create_service_instance`
20 - :ref:`delete_service_instance`
21 - :ref:`create_volume_group`
22 - :ref:`delete_volume_group`
23 - :ref:`create_vf_module`
24 - :ref:`delete_vf_module`
27 - :ref:`get_orchestration_request_by_id`
28 - :ref:`get_orchestration_request_all`
31 .. _create_service_instance:
33 Create service instance
34 +++++++++++++++++++++++
36 +--------------------+--------------------------------------------------------+
37 |Interface Definition|Description |
38 +====================+========================================================+
39 |URI |/onap/so/infra/serviceInstances/v6 |
40 +--------------------+--------------------------------------------------------+
41 |Operation Type |POST |
42 +--------------------+--------------------------------------------------------+
43 |Content-Type |application/json |
44 +--------------------+--------------------------------------------------------+
48 +----------------+---------+-----------+--------------------------+-------------------------------------------+
49 |Attribute |Qualifier|Cardinality|Content |Description |
50 +================+=========+===========+==========================+===========================================+
51 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
52 +----------------+---------+-----------+--------------------------+-------------------------------------------+
56 +-------------------+--------------------------+-------------------------------------------------+
57 |Attribute |Content |Description |
58 +===================+==========================+=================================================+
59 |modelInfo |modelInfo Object |Content of modelInfo object. |
60 +-------------------+--------------------------+-------------------------------------------------+
61 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
62 +-------------------+--------------------------+-------------------------------------------------+
63 |requestInfo |requestInfo Object |Content of requestInfo object. |
64 +-------------------+--------------------------+-------------------------------------------------+
65 |requestParameters |requestParameters Object |Content of requestParameters object. |
66 +-------------------+--------------------------+-------------------------------------------------+
67 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
68 +-------------------+--------------------------+-------------------------------------------------+
69 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
70 +-------------------+--------------------------+-------------------------------------------------+
71 |project |project Object |Content of project object. |
72 +-------------------+--------------------------+-------------------------------------------------+
73 |owningEntity |owningEntity Object |Content of owningEntity object. |
74 +-------------------+--------------------------+-------------------------------------------------+
75 |platform |platform Object |Content of platform object. |
76 +-------------------+--------------------------+-------------------------------------------------+
77 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
78 +-------------------+--------------------------+-------------------------------------------------+
82 +-------------------------+------------------+-------------------------------------------------+
83 |Attribute |Content |Description |
84 +=========================+==================+=================================================+
85 |ModelType |String |Type of model |
86 +-------------------------+------------------+-------------------------------------------------+
87 |ModelInvariantId |String |The Model Invariant Id. |
88 +-------------------------+------------------+-------------------------------------------------+
89 |ModelNameVersionId |String |The modelname Version Id |
90 +-------------------------+------------------+-------------------------------------------------+
91 |ModelName |String |Name of the Model |
92 +-------------------------+------------------+-------------------------------------------------+
93 |ModelVersion |String |Version of the model |
94 +-------------------------+------------------+-------------------------------------------------+
95 |ModelCustomization Name |String |The Model Customization name |
96 +-------------------------+------------------+-------------------------------------------------+
97 |modelCustomizationUuid |String |The Model Customization UUid |
98 +-------------------------+------------------+-------------------------------------------------+
99 |modelVersionId |String |The Model version id |
100 +-------------------------+------------------+-------------------------------------------------+
101 |modelUuid |String |The Model UUid |
102 +-------------------------+------------------+-------------------------------------------------+
103 |modelInvariantUuid |String |The Model Invariant UUid |
104 +-------------------------+------------------+-------------------------------------------------+
105 |modelInstanceName |String |The Model Instance name |
106 +-------------------------+------------------+-------------------------------------------------+
109 SubscriberInfo Object
111 +-------------------------+------------------+-------------------------------------------------+
112 |Attribute |Content |Description |
113 +=========================+==================+=================================================+
114 |GlobalSubscriberId |String |Global customer Id (in A&AI) |
115 +-------------------------+------------------+-------------------------------------------------+
116 |SubscriberName |String |Name of the Subscriber |
117 +-------------------------+------------------+-------------------------------------------------+
121 +-------------------------+------------------+-------------------------------------------------+
122 |Attribute |Content |Description |
123 +=========================+==================+=================================================+
124 |Source |String |source of the request |
125 +-------------------------+------------------+-------------------------------------------------+
126 |billingAccountNumber |String |billingAccountNumber of the request |
127 +-------------------------+------------------+-------------------------------------------------+
128 |callbackUrl |String |callbackUrl of the request |
129 +-------------------------+------------------+-------------------------------------------------+
130 |correlator |String |correlator of the request |
131 +-------------------------+------------------+-------------------------------------------------+
132 |orderNumber |String |orderNumber of the request |
133 +-------------------------+------------------+-------------------------------------------------+
134 |productFamilyId |String |productFamilyId of the request |
135 +-------------------------+------------------+-------------------------------------------------+
136 |orderVersion |String |orderVersion of the request |
137 +-------------------------+------------------+-------------------------------------------------+
138 |instanceName |String |instanceName of the request |
139 +-------------------------+------------------+-------------------------------------------------+
140 |suppressRollback |String |suppressRollback of the request |
141 +-------------------------+------------------+-------------------------------------------------+
142 |requestorId |String |requestorId of the request |
143 +-------------------------+------------------+-------------------------------------------------+
145 RequestParameters Object
147 +-------------------------+------------------+-------------------------------------------------+
148 |Attribute |Content |Description |
149 +=========================+==================+=================================================+
150 |SubscriptionServiceType |String |The service type of the Subscription |
151 +-------------------------+------------------+-------------------------------------------------+
152 |UserParams |Array |The product family Id. |
153 +-------------------------+------------------+-------------------------------------------------+
154 |aLaCarte |Boolean | aLaCarte |
155 +-------------------------+------------------+-------------------------------------------------+
156 |autoBuildVfModules |Boolean |autoBuildVfModules |
157 +-------------------------+------------------+-------------------------------------------------+
158 |cascadeDelete |Boolean |cascadeDelete |
159 +-------------------------+------------------+-------------------------------------------------+
160 |usePreload |Boolean |usePreload |
161 +-------------------------+------------------+-------------------------------------------------+
162 |rebuildVolumeGroups |Boolean |rebuildVolumeGroups |
163 +-------------------------+------------------+-------------------------------------------------+
164 |payload |String |payload |
165 +-------------------------+------------------+-------------------------------------------------+
166 |controllerType |String |controllerType |
167 +-------------------------+------------------+-------------------------------------------------+
171 +-------------------------+------------------+-------------------------------------------------+
172 |Attribute |Content |Description |
173 +=========================+==================+=================================================+
174 |name |String |Tag name of attribute |
175 +-------------------------+------------------+-------------------------------------------------+
176 |value |String |Value of the tag |
177 +-------------------------+------------------+-------------------------------------------------+
179 CloudConfiguration Object
181 +-------------------------+------------------+-------------------------------------------------+
182 |Attribute |Content |Description |
183 +=========================+==================+=================================================+
184 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
185 +-------------------------+------------------+-------------------------------------------------+
186 |tenantId |String |Name of the Subscriber |
187 +-------------------------+------------------+-------------------------------------------------+
188 |aicNodeClli |String |aicNodeClli property |
189 +-------------------------+------------------+-------------------------------------------------+
193 +-------------------------+------------------+-------------------------------------------------+
194 |Attribute |Content |Description |
195 +=========================+==================+=================================================+
196 |projectName |String |Name of the project |
197 +-------------------------+------------------+-------------------------------------------------+
201 +-------------------------+------------------+-------------------------------------------------+
202 |Attribute |Content |Description |
203 +=========================+==================+=================================================+
204 |owningEntityId |String |owningEntityId of the owingEntity |
205 +-------------------------+------------------+-------------------------------------------------+
206 |owningEntityName |String |owningEntityName of the owingEntity |
207 +-------------------------+------------------+-------------------------------------------------+
211 +-------------------------+------------------+-------------------------------------------------+
212 |Attribute |Content |Description |
213 +=========================+==================+=================================================+
214 |platformName |String |Platform Name |
215 +-------------------------+------------------+-------------------------------------------------+
217 LineOfBusiness Object
219 +-------------------------+------------------+-------------------------------------------------+
220 |Attribute |Content |Description |
221 +=========================+==================+=================================================+
222 |lineOfBusinessName |String |Line Of Business Name |
223 +-------------------------+------------------+-------------------------------------------------+
226 .. _delete_service_instance:
228 Delete service instance
229 +++++++++++++++++++++++
231 +--------------------+--------------------------------------------------------------------------------+
232 |Interface Definition|Description |
233 +====================+================================================================================+
234 |URI |/onap/so/infra/serviceInstances/v6/{serviceInstanceId} |
235 +--------------------+--------------------------------------------------------------------------------+
236 |Operation Type |DELETE |
237 +--------------------+--------------------------------------------------------------------------------+
238 |Content-Type |application/json |
239 +--------------------+--------------------------------------------------------------------------------+
243 +----------------+---------+-----------+--------------------------+-------------------------------------------+
244 |Attribute |Qualifier|Cardinality|Content |Description |
245 +================+=========+===========+==========================+===========================================+
246 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
247 +----------------+---------+-----------+--------------------------+-------------------------------------------+
249 RequestDetails Object
251 +-------------------+-------------------------+-------------------------------------------------+
252 |Attribute |Content |Description |
253 +===================+=========================+=================================================+
254 |modelInfo |modelInfo Object |Content of modelInfo object. |
255 +-------------------+-------------------------+-------------------------------------------------+
256 |requestInfo |requestInfo Object |Content of requestInfo object. |
257 +-------------------+-------------------------+-------------------------------------------------+
261 +-------------------------+------------------+-------------------------------------------------+
262 |Attribute |Content |Description |
263 +=========================+==================+=================================================+
264 |ModelType |String |Type of model |
265 +-------------------------+------------------+-------------------------------------------------+
266 |ModelInvariantId |String |The Model Invariant Id. |
267 +-------------------------+------------------+-------------------------------------------------+
268 |ModelName |String |Name of the Model |
269 +-------------------------+------------------+-------------------------------------------------+
270 |ModelVersion |String |Version of the model |
271 +-------------------------+------------------+-------------------------------------------------+
275 +-------------------------+------------------+-------------------------------------------------+
276 |Attribute |Content |Description |
277 +=========================+==================+=================================================+
278 |Source |String |source of the request |
279 +-------------------------+------------------+-------------------------------------------------+
282 .. _create_volume_group:
287 +--------------------+------------------------------------------------------------------------------------------------------------------+
288 |Interface Definition|Description |
289 +====================+==================================================================================================================+
290 |URI |/onap/so/infra/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups |
291 +--------------------+------------------------------------------------------------------------------------------------------------------+
292 |Operation Type |POST |
293 +--------------------+------------------------------------------------------------------------------------------------------------------+
294 |Content-Type |application/json |
295 +--------------------+------------------------------------------------------------------------------------------------------------------+
299 +----------------+---------+-----------+--------------------------+-------------------------------------------+
300 |Attribute |Qualifier|Cardinality|Content |Description |
301 +================+=========+===========+==========================+===========================================+
302 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
303 +----------------+---------+-----------+--------------------------+-------------------------------------------+
305 RequestDetails Object
307 +-------------------+--------------------------+-------------------------------------------------+
308 |Attribute |Content |Description |
309 +===================+==========================+=================================================+
310 |modelInfo |modelInfo Object |Content of modelInfo object. |
311 +-------------------+--------------------------+-------------------------------------------------+
312 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
313 +-------------------+--------------------------+-------------------------------------------------+
314 |requestInfo |requestInfo Object |Content of requestInfo object. |
315 +-------------------+--------------------------+-------------------------------------------------+
316 |requestParameters |requestParameters Object |Content of requestParameters object. |
317 +-------------------+--------------------------+-------------------------------------------------+
318 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
319 +-------------------+--------------------------+-------------------------------------------------+
320 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
321 +-------------------+--------------------------+-------------------------------------------------+
322 |project |project Object |Content of project object. |
323 +-------------------+--------------------------+-------------------------------------------------+
324 |owningEntity |owningEntity Object |Content of owningEntity object. |
325 +-------------------+--------------------------+-------------------------------------------------+
326 |platform |platform Object |Content of platform object. |
327 +-------------------+--------------------------+-------------------------------------------------+
328 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
329 +-------------------+--------------------------+-------------------------------------------------+
333 +-------------------------+------------------+-------------------------------------------------+
334 |Attribute |Content |Description |
335 +=========================+==================+=================================================+
336 |ModelType |String |Type of model |
337 +-------------------------+------------------+-------------------------------------------------+
338 |ModelInvariantId |String |The Model Invariant Id. |
339 +-------------------------+------------------+-------------------------------------------------+
340 |ModelNameVersionId |String |The modelname Version Id |
341 +-------------------------+------------------+-------------------------------------------------+
342 |ModelName |String |Name of the Model |
343 +-------------------------+------------------+-------------------------------------------------+
344 |ModelVersion |String |Version of the model |
345 +-------------------------+------------------+-------------------------------------------------+
346 |ModelCustomization Name |String |The Model Customization name |
347 +-------------------------+------------------+-------------------------------------------------+
348 |modelCustomizationUuid |String |The Model Customization UUid |
349 +-------------------------+------------------+-------------------------------------------------+
350 |modelVersionId |String |The Model version id |
351 +-------------------------+------------------+-------------------------------------------------+
352 |modelUuid |String |The Model UUid |
353 +-------------------------+------------------+-------------------------------------------------+
354 |modelInvariantUuid |String |The Model Invariant UUid |
355 +-------------------------+------------------+-------------------------------------------------+
356 |modelInstanceName |String |The Model Instance name |
357 +-------------------------+------------------+-------------------------------------------------+
359 CloudConfiguration Object
361 +-------------------------+------------------+-------------------------------------------------+
362 |Attribute |Content |Description |
363 +=========================+==================+=================================================+
364 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
365 +-------------------------+------------------+-------------------------------------------------+
366 |tenantId |String |Name of the Subscriber |
367 +-------------------------+------------------+-------------------------------------------------+
368 |aicNodeClli |String |aicNodeClli property |
369 +-------------------------+------------------+-------------------------------------------------+
373 +-------------------------+------------------+-------------------------------------------------+
374 |Attribute |Content |Description |
375 +=========================+==================+=================================================+
376 |Source |String |source of the request |
377 +-------------------------+------------------+-------------------------------------------------+
378 |billingAccountNumber |String |billingAccountNumber of the request |
379 +-------------------------+------------------+-------------------------------------------------+
380 |callbackUrl |String |callbackUrl of the request |
381 +-------------------------+------------------+-------------------------------------------------+
382 |correlator |String |correlator of the request |
383 +-------------------------+------------------+-------------------------------------------------+
384 |orderNumber |String |orderNumber of the request |
385 +-------------------------+------------------+-------------------------------------------------+
386 |productFamilyId |String |productFamilyId of the request |
387 +-------------------------+------------------+-------------------------------------------------+
388 |orderVersion |String |orderVersion of the request |
389 +-------------------------+------------------+-------------------------------------------------+
390 |instanceName |String |instanceName of the request |
391 +-------------------------+------------------+-------------------------------------------------+
392 |suppressRollback |String |suppressRollback of the request |
393 +-------------------------+------------------+-------------------------------------------------+
394 |requestorId |String |requestorId of the request |
395 +-------------------------+------------------+-------------------------------------------------+
399 +-------------------------+------------------+-------------------------------------------------+
400 |Attribute |Content |Description |
401 +=========================+==================+=================================================+
402 |relatedInstance |Object |relatedInstance Object |
403 +-------------------------+------------------+-------------------------------------------------+
407 +-------------------------+------------------+-------------------------------------------------+
408 |Attribute |Content |Description |
409 +=========================+==================+=================================================+
410 |instanceId |String |instanceId |
411 +-------------------------+------------------+-------------------------------------------------+
412 |modelInfo |Object |Content of modelInfo object. |
413 +-------------------------+------------------+-------------------------------------------------+
415 .. _delete_volume_group:
420 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
421 |Interface Definition|Description |
422 +====================+============================================================================================================================================+
423 |URI |/onap/so/infra/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id} |
424 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
425 |Operation Type |DELETE |
426 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
427 |Content-Type |application/json |
428 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
432 +----------------+---------+-----------+--------------------------+-------------------------------------------+
433 |Attribute |Qualifier|Cardinality|Content |Description |
434 +================+=========+===========+==========================+===========================================+
435 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
436 +----------------+---------+-----------+--------------------------+-------------------------------------------+
438 RequestDetails Object
440 +---------------------+-------------------------+-------------------------------------------------+
441 |Attribute |Content |Description |
442 +=====================+=========================+=================================================+
443 |modelInfo |modelInfo Object |Content of modelInfo object. |
444 +---------------------+-------------------------+-------------------------------------------------+
445 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
446 +---------------------+-------------------------+-------------------------------------------------+
447 |requestInfo |requestInfo Object |Content of requestInfo object. |
448 +---------------------+-------------------------+-------------------------------------------------+
452 +-------------------------+------------------+-------------------------------------------------+
453 |Attribute |Content |Description |
454 +=========================+==================+=================================================+
455 |ModelType |String |Type of model |
456 +-------------------------+------------------+-------------------------------------------------+
457 |ModelName |String |Name of the Model |
458 +-------------------------+------------------+-------------------------------------------------+
460 CloudConfiguration Object
462 +-------------------------+------------------+-------------------------------------------------+
463 |Attribute |Content |Description |
464 +=========================+==================+=================================================+
465 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
466 +-------------------------+------------------+-------------------------------------------------+
467 |tenantId |String |Name of the Subscriber |
468 +-------------------------+------------------+-------------------------------------------------+
472 +-------------------------+------------------+-------------------------------------------------+
473 |Attribute |Content |Description |
474 +=========================+==================+=================================================+
475 |Source |String |source of the request |
476 +-------------------------+------------------+-------------------------------------------------+
478 .. _create_vf_module:
483 +--------------------+---------------------------------------------------------------------------------------------------------------+
484 |Interface Definition|Description |
485 +====================+===============================================================================================================+
486 |URI |/onap/so/infra/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules |
487 +--------------------+---------------------------------------------------------------------------------------------------------------+
488 |Operation Type |POST |
489 +--------------------+---------------------------------------------------------------------------------------------------------------+
490 |Content-Type |application/json |
491 +--------------------+---------------------------------------------------------------------------------------------------------------+
495 +----------------+---------+-----------+--------------------------+-------------------------------------------+
496 |Attribute |Qualifier|Cardinality|Content |Description |
497 +================+=========+===========+==========================+===========================================+
498 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
499 +----------------+---------+-----------+--------------------------+-------------------------------------------+
501 RequestDetails Object
503 +---------------------+-------------------------+-------------------------------------------------+
504 |Attribute |Content |Description |
505 +=====================+=========================+=================================================+
506 |modelInfo |modelInfo Object |Content of modelInfo object. |
507 +---------------------+-------------------------+-------------------------------------------------+
508 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
509 +---------------------+-------------------------+-------------------------------------------------+
510 |requestInfo |requestInfo Object |Content of requestInfo object. |
511 +---------------------+-------------------------+-------------------------------------------------+
512 |relatedInstanceList |List |Content of relatedInstanceList. |
513 +---------------------+-------------------------+-------------------------------------------------+
517 +-------------------------+------------------+-------------------------------------------------+
518 |Attribute |Content |Description |
519 +=========================+==================+=================================================+
520 |ModelType |String |Type of model |
521 +-------------------------+------------------+-------------------------------------------------+
522 |ModelInvariantId |String |The Model Invariant Id. |
523 +-------------------------+------------------+-------------------------------------------------+
524 |ModelNameVersionId |String |The modelname Version Id |
525 +-------------------------+------------------+-------------------------------------------------+
526 |ModelName |String |Name of the Model |
527 +-------------------------+------------------+-------------------------------------------------+
528 |ModelVersion |String |Version of the model |
529 +-------------------------+------------------+-------------------------------------------------+
530 |ModelCustomization Name |String |The Model Customization name |
531 +-------------------------+------------------+-------------------------------------------------+
533 CloudConfiguration Object
535 +-------------------------+------------------+-------------------------------------------------+
536 |Attribute |Content |Description |
537 +=========================+==================+=================================================+
538 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
539 +-------------------------+------------------+-------------------------------------------------+
540 |tenantId |String |Name of the Subscriber |
541 +-------------------------+------------------+-------------------------------------------------+
545 +-------------------------+------------------+-------------------------------------------------+
546 |Attribute |Content |Description |
547 +=========================+==================+=================================================+
548 |InstanceName |String |The instance Name |
549 +-------------------------+------------------+-------------------------------------------------+
550 |Source |String |source of the request |
551 +-------------------------+------------------+-------------------------------------------------+
552 |SuppressRollback |Boolean |SuppressRollback |
553 +-------------------------+------------------+-------------------------------------------------+
557 +-------------------------+------------------+-------------------------------------------------+
558 |Attribute |Content |Description |
559 +=========================+==================+=================================================+
560 |relatedInstance |Object |relatedInstance Object |
561 +-------------------------+------------------+-------------------------------------------------+
565 +-------------------------+------------------+-------------------------------------------------+
566 |Attribute |Content |Description |
567 +=========================+==================+=================================================+
568 |instanceId |String |instanceId |
569 +-------------------------+------------------+-------------------------------------------------+
570 |modelInfo |Object |Content of modelInfo object. |
571 +-------------------------+------------------+-------------------------------------------------+
572 |instanceName |String |Name of the instance |
573 +-------------------------+------------------+-------------------------------------------------+
575 .. _delete_vf_module:
580 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
581 |Interface Definition|Description |
582 +====================+=====================================================================================================================================+
583 |URI |/onap/so/infra/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id} |
584 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
585 |Operation Type |DELETE |
586 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
587 |Content-Type |application/json |
588 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
592 +----------------+---------+-----------+--------------------------+-------------------------------------------+
593 |Attribute |Qualifier|Cardinality|Content |Description |
594 +================+=========+===========+==========================+===========================================+
595 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
596 +----------------+---------+-----------+--------------------------+-------------------------------------------+
598 RequestDetails Object
600 +---------------------+-------------------------+-------------------------------------------------+
601 |Attribute |Content |Description |
602 +=====================+=========================+=================================================+
603 |modelInfo |modelInfo Object |Content of modelInfo object. |
604 +---------------------+-------------------------+-------------------------------------------------+
605 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
606 +---------------------+-------------------------+-------------------------------------------------+
607 |requestInfo |requestInfo Object |Content of requestInfo object. |
608 +---------------------+-------------------------+-------------------------------------------------+
612 +-------------------------+------------------+-------------------------------------------------+
613 |Attribute |Content |Description |
614 +=========================+==================+=================================================+
615 |ModelType |String |Type of model |
616 +-------------------------+------------------+-------------------------------------------------+
617 |ModelInvariantId |String |The Model Invariant Id. |
618 +-------------------------+------------------+-------------------------------------------------+
619 |ModelNameVersionId |String |The modelname Version Id |
620 +-------------------------+------------------+-------------------------------------------------+
621 |ModelName |String |Name of the Model |
622 +-------------------------+------------------+-------------------------------------------------+
623 |ModelVersion |String |Version of the model |
624 +-------------------------+------------------+-------------------------------------------------+
625 |ModelCustomization Name |String |The Model Customization name |
626 +-------------------------+------------------+-------------------------------------------------+
628 CloudConfiguration Object
630 +-------------------------+------------------+-------------------------------------------------+
631 |Attribute |Content |Description |
632 +=========================+==================+=================================================+
633 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
634 +-------------------------+------------------+-------------------------------------------------+
635 |tenantId |String |Name of the Subscriber |
636 +-------------------------+------------------+-------------------------------------------------+
640 +-------------------------+------------------+-------------------------------------------------+
641 |Attribute |Content |Description |
642 +=========================+==================+=================================================+
643 |Source |String |source of the request |
644 +-------------------------+------------------+-------------------------------------------------+
652 +--------------------+-------------------------------------------------------------------------------------+
653 |Interface Definition|Description |
654 +====================+=====================================================================================+
655 |URI |/onap/so/infra/serviceInstances/v6/{serviceInstanceId}/vnfs |
656 +--------------------+-------------------------------------------------------------------------------------+
657 |Operation Type |POST |
658 +--------------------+-------------------------------------------------------------------------------------+
659 |Content-Type |application/json |
660 +--------------------+-------------------------------------------------------------------------------------+
664 +----------------+---------+-----------+--------------------------+-------------------------------------------+
665 |Attribute |Qualifier|Cardinality|Content |Description |
666 +================+=========+===========+==========================+===========================================+
667 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
668 +----------------+---------+-----------+--------------------------+-------------------------------------------+
670 RequestDetails Object
672 +-------------------+--------------------------+-------------------------------------------------+
673 |Attribute |Content |Description |
674 +===================+==========================+=================================================+
675 |modelInfo |modelInfo Object |Content of modelInfo object. |
676 +-------------------+--------------------------+-------------------------------------------------+
677 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
678 +-------------------+--------------------------+-------------------------------------------------+
679 |requestInfo |requestInfo Object |Content of requestInfo object. |
680 +-------------------+--------------------------+-------------------------------------------------+
681 |requestParameters |requestParameters Object |Content of requestParameters object. |
682 +-------------------+--------------------------+-------------------------------------------------+
683 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
684 +-------------------+--------------------------+-------------------------------------------------+
685 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
686 +-------------------+--------------------------+-------------------------------------------------+
687 |project |project Object |Content of project object. |
688 +-------------------+--------------------------+-------------------------------------------------+
689 |owningEntity |owningEntity Object |Content of owningEntity object. |
690 +-------------------+--------------------------+-------------------------------------------------+
691 |platform |platform Object |Content of platform object. |
692 +-------------------+--------------------------+-------------------------------------------------+
693 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
694 +-------------------+--------------------------+-------------------------------------------------+
698 +-------------------------+------------------+-------------------------------------------------+
699 |Attribute |Content |Description |
700 +=========================+==================+=================================================+
701 |ModelType |String |Type of model |
702 +-------------------------+------------------+-------------------------------------------------+
703 |ModelInvariantId |String |The Model Invariant Id. |
704 +-------------------------+------------------+-------------------------------------------------+
705 |ModelNameVersionId |String |The modelname Version Id |
706 +-------------------------+------------------+-------------------------------------------------+
707 |ModelName |String |Name of the Model |
708 +-------------------------+------------------+-------------------------------------------------+
709 |ModelVersion |String |Version of the model |
710 +-------------------------+------------------+-------------------------------------------------+
711 |ModelCustomization Name |String |The Model Customization name |
712 +-------------------------+------------------+-------------------------------------------------+
713 |modelCustomizationUuid |String |The Model Customization UUid |
714 +-------------------------+------------------+-------------------------------------------------+
715 |modelVersionId |String |The Model version id |
716 +-------------------------+------------------+-------------------------------------------------+
717 |modelUuid |String |The Model UUid |
718 +-------------------------+------------------+-------------------------------------------------+
719 |modelInvariantUuid |String |The Model Invariant UUid |
720 +-------------------------+------------------+-------------------------------------------------+
721 |modelInstanceName |String |The Model Instance name |
722 +-------------------------+------------------+-------------------------------------------------+
724 CloudConfiguration Object
726 +-------------------------+------------------+-------------------------------------------------+
727 |Attribute |Content |Description |
728 +=========================+==================+=================================================+
729 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
730 +-------------------------+------------------+-------------------------------------------------+
731 |tenantId |String |Name of the Subscriber |
732 +-------------------------+------------------+-------------------------------------------------+
736 +-------------------------+------------------+-------------------------------------------------+
737 |Attribute |Content |Description |
738 +=========================+==================+=================================================+
739 |Source |String |source of the request |
740 +-------------------------+------------------+-------------------------------------------------+
741 |billingAccountNumber |String |billingAccountNumber of the request |
742 +-------------------------+------------------+-------------------------------------------------+
743 |callbackUrl |String |callbackUrl of the request |
744 +-------------------------+------------------+-------------------------------------------------+
745 |correlator |String |correlator of the request |
746 +-------------------------+------------------+-------------------------------------------------+
747 |orderNumber |String |orderNumber of the request |
748 +-------------------------+------------------+-------------------------------------------------+
749 |productFamilyId |String |productFamilyId of the request |
750 +-------------------------+------------------+-------------------------------------------------+
751 |orderVersion |String |orderVersion of the request |
752 +-------------------------+------------------+-------------------------------------------------+
753 |instanceName |String |instanceName of the request |
754 +-------------------------+------------------+-------------------------------------------------+
755 |suppressRollback |String |suppressRollback of the request |
756 +-------------------------+------------------+-------------------------------------------------+
757 |requestorId |String |requestorId of the request |
758 +-------------------------+------------------+-------------------------------------------------+
762 +-------------------------+------------------+-------------------------------------------------+
763 |Attribute |Content |Description |
764 +=========================+==================+=================================================+
765 |relatedInstance |Object |relatedInstance Object |
766 +-------------------------+------------------+-------------------------------------------------+
770 +-------------------------+------------------+-------------------------------------------------+
771 |Attribute |Content |Description |
772 +=========================+==================+=================================================+
773 |instanceId |String |instanceId |
774 +-------------------------+------------------+-------------------------------------------------+
775 |modelInfo |Object |Content of modelInfo object. |
776 +-------------------------+------------------+-------------------------------------------------+
778 RequestParameters Object
780 +-------------------------+------------------+-------------------------------------------------+
781 |Attribute |Content |Description |
782 +=========================+==================+=================================================+
783 |UserParams |Array |The product family Id. |
784 +-------------------------+------------------+-------------------------------------------------+
788 +-------------------------+------------------+-------------------------------------------------+
789 |Attribute |Content |Description |
790 +=========================+==================+=================================================+
791 |name |String |Tag name of attribute |
792 +-------------------------+------------------+-------------------------------------------------+
793 |value |String |Value of the tag |
794 +-------------------------+------------------+-------------------------------------------------+
801 +--------------------+-----------------------------------------------------------------------------------------------------+
802 |Interface Definition|Description |
803 +====================+=====================================================================================================+
804 |URI |/onap/so/infra/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId} |
805 +--------------------+-----------------------------------------------------------------------------------------------------+
806 |Operation Type |DELETE |
807 +--------------------+-----------------------------------------------------------------------------------------------------+
808 |Content-Type |application/json |
809 +--------------------+-----------------------------------------------------------------------------------------------------+
813 +----------------+---------+-----------+--------------------------+-------------------------------------------+
814 |Attribute |Qualifier|Cardinality|Content |Description |
815 +================+=========+===========+==========================+===========================================+
816 |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
817 +----------------+---------+-----------+--------------------------+-------------------------------------------+
819 RequestDetails Object
821 +---------------------+-------------------------+-------------------------------------------------+
822 |Attribute |Content |Description |
823 +=====================+=========================+=================================================+
824 |modelInfo |modelInfo Object |Content of modelInfo object. |
825 +---------------------+-------------------------+-------------------------------------------------+
826 |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. |
827 +---------------------+-------------------------+-------------------------------------------------+
828 |requestInfo |requestInfo Object |Content of requestInfo object. |
829 +---------------------+-------------------------+-------------------------------------------------+
830 |requestParameters |requestParameters Object |Content of requestParameters object. |
831 +---------------------+-------------------------+-------------------------------------------------+
835 +-------------------------+------------------+-------------------------------------------------+
836 |Attribute |Content |Description |
837 +=========================+==================+=================================================+
838 |ModelType |String |Type of model |
839 +-------------------------+------------------+-------------------------------------------------+
840 |ModelName |String |Name of the Model |
841 +-------------------------+------------------+-------------------------------------------------+
843 CloudConfiguration Object
845 +-------------------------+------------------+-------------------------------------------------+
846 |Attribute |Content |Description |
847 +=========================+==================+=================================================+
848 |lcpCloudRegionId |String |CloudRegion Id (in A&AI) |
849 +-------------------------+------------------+-------------------------------------------------+
850 |tenantId |String |Name of the Subscriber |
851 +-------------------------+------------------+-------------------------------------------------+
855 +-------------------------+------------------+-------------------------------------------------+
856 |Attribute |Content |Description |
857 +=========================+==================+=================================================+
858 |Source |String |source of the request |
859 +-------------------------+------------------+-------------------------------------------------+
861 RequestParameters Object
863 +-------------------------+------------------+-------------------------------------------------+
864 |Attribute |Content |Description |
865 +=========================+==================+=================================================+
866 |UserParams |Array |The product family Id. |
867 +-------------------------+------------------+-------------------------------------------------+
871 +-------------------------+------------------+-------------------------------------------------+
872 |Attribute |Content |Description |
873 +=========================+==================+=================================================+
874 |name |String |Tag name of attribute |
875 +-------------------------+------------------+-------------------------------------------------+
876 |value |String |Value of the tag |
877 +-------------------------+------------------+-------------------------------------------------+
879 .. _get_orchestration_request_by_id:
881 GET Orchestration Request
882 +++++++++++++++++++++++++
884 +--------------------+-------------------------------------------------------------------------------------+
885 |Interface Definition|Description |
886 +====================+=====================================================================================+
887 |URI |/onap/so/infra/orchestrationRequests/v6/{request-id} |
888 +--------------------+-------------------------------------------------------------------------------------+
889 |Operation Type |GET |
890 +--------------------+-------------------------------------------------------------------------------------+
891 |Content-Type |application/json |
892 +--------------------+-------------------------------------------------------------------------------------+
896 +----------------+---------+-----------+--------------------------+-------------------------------------------+
897 |Attribute |Qualifier|Cardinality|Content |Description |
898 +================+=========+===========+==========================+===========================================+
899 |request |M |1 |request Object |Content of request object. |
900 +----------------+---------+-----------+--------------------------+-------------------------------------------+
904 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
905 |Attribute |Qualifier|Cardinality|Content |Description |
906 +===================+=========+===========+==========================+===========================================+
907 |requestId |M |1 |String |Request Id |
908 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
909 |startTime |M |1 |request Object |Start time. |
910 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
911 |requestScope |M |1 |request Object |Scope of the request. |
912 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
913 |requestType |M |1 |request Object |Type of the request. |
914 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
915 |requestDetails |M |1 |requestDetails Object |Type of the request. |
916 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
917 |requestStatus |M |1 |requestStatus Object |Type of the request. |
918 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
920 RequestDetails Object
922 +-------------------+--------------------------+-------------------------------------------------+
923 |Attribute |Content |Description |
924 +===================+==========================+=================================================+
925 |modelInfo |modelInfo Object |Content of modelInfo object. |
926 +-------------------+--------------------------+-------------------------------------------------+
927 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
928 +-------------------+--------------------------+-------------------------------------------------+
929 |requestInfo |requestInfo Object |Content of requestInfo object. |
930 +-------------------+--------------------------+-------------------------------------------------+
931 |requestParameters |requestParameters Object |Content of requestParameters object. |
932 +-------------------+--------------------------+-------------------------------------------------+
933 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
934 +-------------------+--------------------------+-------------------------------------------------+
935 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
936 +-------------------+--------------------------+-------------------------------------------------+
937 |project |project Object |Content of project object. |
938 +-------------------+--------------------------+-------------------------------------------------+
939 |owningEntity |owningEntity Object |Content of owningEntity object. |
940 +-------------------+--------------------------+-------------------------------------------------+
941 |platform |platform Object |Content of platform object. |
942 +-------------------+--------------------------+-------------------------------------------------+
943 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
944 +-------------------+--------------------------+-------------------------------------------------+
948 +-------------------------+------------------+-------------------------------------------------+
949 |Attribute |Content |Description |
950 +=========================+==================+=================================================+
951 |ModelType |String |Type of model |
952 +-------------------------+------------------+-------------------------------------------------+
953 |ModelInvariantId |String |The Model Invariant Id. |
954 +-------------------------+------------------+-------------------------------------------------+
955 |ModelNameVersionId |String |The modelname Version Id |
956 +-------------------------+------------------+-------------------------------------------------+
957 |ModelName |String |Name of the Model |
958 +-------------------------+------------------+-------------------------------------------------+
959 |ModelVersion |String |Version of the model |
960 +-------------------------+------------------+-------------------------------------------------+
961 |ModelCustomization Name |String |The Model Customization name |
962 +-------------------------+------------------+-------------------------------------------------+
963 |modelCustomizationUuid |String |The Model Customization UUid |
964 +-------------------------+------------------+-------------------------------------------------+
965 |modelVersionId |String |The Model version id |
966 +-------------------------+------------------+-------------------------------------------------+
967 |modelUuid |String |The Model UUid |
968 +-------------------------+------------------+-------------------------------------------------+
969 |modelInvariantUuid |String |The Model Invariant UUid |
970 +-------------------------+------------------+-------------------------------------------------+
971 |modelInstanceName |String |The Model Instance name |
972 +-------------------------+------------------+-------------------------------------------------+
974 SubscriberInfo Object
976 +-------------------------+------------------+-------------------------------------------------+
977 |Attribute |Content |Description |
978 +=========================+==================+=================================================+
979 |GlobalSubscriberId |String |Global customer Id (in A&AI) |
980 +-------------------------+------------------+-------------------------------------------------+
981 |SubscriberName |String |Name of the Subscriber |
982 +-------------------------+------------------+-------------------------------------------------+
986 +-------------------------+------------------+-------------------------------------------------+
987 |Attribute |Content |Description |
988 +=========================+==================+=================================================+
989 |Source |String |source of the request |
990 +-------------------------+------------------+-------------------------------------------------+
991 |billingAccountNumber |String |billingAccountNumber of the request |
992 +-------------------------+------------------+-------------------------------------------------+
993 |callbackUrl |String |callbackUrl of the request |
994 +-------------------------+------------------+-------------------------------------------------+
995 |correlator |String |correlator of the request |
996 +-------------------------+------------------+-------------------------------------------------+
997 |orderNumber |String |orderNumber of the request |
998 +-------------------------+------------------+-------------------------------------------------+
999 |productFamilyId |String |productFamilyId of the request |
1000 +-------------------------+------------------+-------------------------------------------------+
1001 |orderVersion |String |orderVersion of the request |
1002 +-------------------------+------------------+-------------------------------------------------+
1003 |instanceName |String |instanceName of the request |
1004 +-------------------------+------------------+-------------------------------------------------+
1005 |suppressRollback |String |suppressRollback of the request |
1006 +-------------------------+------------------+-------------------------------------------------+
1007 |requestorId |String |requestorId of the request |
1008 +-------------------------+------------------+-------------------------------------------------+
1010 RequestParameters Object
1012 +-------------------------+------------------+-------------------------------------------------+
1013 |Attribute |Content |Description |
1014 +=========================+==================+=================================================+
1015 |SubscriptionServiceType |String |The service type of the Subscription |
1016 +-------------------------+------------------+-------------------------------------------------+
1018 RequestStatus Object
1020 +-------------------------+------------------+-------------------------------------------------+
1021 |Attribute |Content |Description |
1022 +=========================+==================+=================================================+
1023 |finishTime |String |Time |
1024 +-------------------------+------------------+-------------------------------------------------+
1025 |requestState |String |state of the request |
1026 +-------------------------+------------------+-------------------------------------------------+
1027 |statusMessage |String |statusMessage |
1028 +-------------------------+------------------+-------------------------------------------------+
1029 |percentProgress |String |percentage of progress |
1030 +-------------------------+------------------+-------------------------------------------------+
1033 .. _get_orchestration_request_all:
1035 GET Orchestration Requests
1036 ++++++++++++++++++++++++++
1038 +--------------------+--------------------------------------------------------------+
1039 |Interface Definition|Description |
1040 +====================+==============================================================+
1041 |URI |/onap/so/infra/orchestrationRequests/v6 |
1042 +--------------------+--------------------------------------------------------------+
1043 |Operation Type |GET |
1044 +--------------------+--------------------------------------------------------------+
1045 |Content-Type |application/json |
1046 +--------------------+--------------------------------------------------------------+
1050 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1051 |Attribute |Qualifier|Cardinality|Content |Description |
1052 +================+=========+===========+==========================+===========================================+
1053 |requestList |M |1 |Array |Content of request List. |
1054 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1058 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1059 |Attribute |Qualifier|Cardinality|Content |Description |
1060 +================+=========+===========+==========================+===========================================+
1061 |request |M |1 |request Object |Content of request object. |
1062 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1066 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1067 |Attribute |Qualifier|Cardinality|Content |Description |
1068 +===================+=========+===========+==========================+===========================================+
1069 |requestId |M |1 |String |Request Id. |
1070 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1071 |startTime |M |1 |request Object |Start time. |
1072 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1073 |requestScope |M |1 |request Object |Scope of the request. |
1074 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1075 |requestType |M |1 |request Object |Type of the request. |
1076 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1077 |requestDetails |M |1 |requestDetails Object |Type of the request. |
1078 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1079 |requestStatus |M |1 |requestStatus Object |Type of the request. |
1080 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1082 RequestDetails Object
1084 +-------------------+--------------------------+-------------------------------------------------+
1085 |Attribute |Content |Description |
1086 +===================+==========================+=================================================+
1087 |modelInfo |modelInfo Object |Content of modelInfo object. |
1088 +-------------------+--------------------------+-------------------------------------------------+
1089 |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. |
1090 +-------------------+--------------------------+-------------------------------------------------+
1091 |requestInfo |requestInfo Object |Content of requestInfo object. |
1092 +-------------------+--------------------------+-------------------------------------------------+
1093 |requestParameters |requestParameters Object |Content of requestParameters object. |
1094 +-------------------+--------------------------+-------------------------------------------------+
1095 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. |
1096 +-------------------+--------------------------+-------------------------------------------------+
1097 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. |
1098 +-------------------+--------------------------+-------------------------------------------------+
1099 |project |project Object |Content of project object. |
1100 +-------------------+--------------------------+-------------------------------------------------+
1101 |owningEntity |owningEntity Object |Content of owningEntity object. |
1102 +-------------------+--------------------------+-------------------------------------------------+
1103 |platform |platform Object |Content of platform object. |
1104 +-------------------+--------------------------+-------------------------------------------------+
1105 |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
1106 +-------------------+--------------------------+-------------------------------------------------+
1110 +-------------------------+------------------+-------------------------------------------------+
1111 |Attribute |Content |Description |
1112 +=========================+==================+=================================================+
1113 |ModelType |String |Type of model |
1114 +-------------------------+------------------+-------------------------------------------------+
1115 |ModelInvariantId |String |The Model Invariant Id. |
1116 +-------------------------+------------------+-------------------------------------------------+
1117 |ModelNameVersionId |String |The modelname Version Id |
1118 +-------------------------+------------------+-------------------------------------------------+
1119 |ModelName |String |Name of the Model |
1120 +-------------------------+------------------+-------------------------------------------------+
1121 |ModelVersion |String |Version of the model |
1122 +-------------------------+------------------+-------------------------------------------------+
1123 |ModelCustomization Name |String |The Model Customization name |
1124 +-------------------------+------------------+-------------------------------------------------+
1125 |modelCustomizationUuid |String |The Model Customization UUid |
1126 +-------------------------+------------------+-------------------------------------------------+
1127 |modelVersionId |String |The Model version id |
1128 +-------------------------+------------------+-------------------------------------------------+
1129 |modelUuid |String |The Model UUid |
1130 +-------------------------+------------------+-------------------------------------------------+
1131 |modelInvariantUuid |String |The Model Invariant UUid |
1132 +-------------------------+------------------+-------------------------------------------------+
1133 |modelInstanceName |String |The Model Instance name |
1134 +-------------------------+------------------+-------------------------------------------------+
1136 SubscriberInfo Object
1138 +-------------------------+------------------+-------------------------------------------------+
1139 |Attribute |Content |Description |
1140 +=========================+==================+=================================================+
1141 |GlobalSubscriberId |String |Global customer Id (in A&AI) |
1142 +-------------------------+------------------+-------------------------------------------------+
1143 |SubscriberName |String |Name of the Subscriber |
1144 +-------------------------+------------------+-------------------------------------------------+
1148 +-------------------------+------------------+-------------------------------------------------+
1149 |Attribute |Content |Description |
1150 +=========================+==================+=================================================+
1151 |Source |String |source of the request |
1152 +-------------------------+------------------+-------------------------------------------------+
1153 |billingAccountNumber |String |billingAccountNumber of the request |
1154 +-------------------------+------------------+-------------------------------------------------+
1155 |callbackUrl |String |callbackUrl of the request |
1156 +-------------------------+------------------+-------------------------------------------------+
1157 |correlator |String |correlator of the request |
1158 +-------------------------+------------------+-------------------------------------------------+
1159 |orderNumber |String |orderNumber of the request |
1160 +-------------------------+------------------+-------------------------------------------------+
1161 |productFamilyId |String |productFamilyId of the request |
1162 +-------------------------+------------------+-------------------------------------------------+
1163 |orderVersion |String |orderVersion of the request |
1164 +-------------------------+------------------+-------------------------------------------------+
1165 |instanceName |String |instanceName of the request |
1166 +-------------------------+------------------+-------------------------------------------------+
1167 |suppressRollback |String |suppressRollback of the request |
1168 +-------------------------+------------------+-------------------------------------------------+
1169 |requestorId |String |requestorId of the request |
1170 +-------------------------+------------------+-------------------------------------------------+
1172 RequestParameters Object
1174 +-------------------------+------------------+-------------------------------------------------+
1175 |Attribute |Content |Description |
1176 +=========================+==================+=================================================+
1177 |SubscriptionServiceType |String |The service type of the Subscription |
1178 +-------------------------+------------------+-------------------------------------------------+
1180 RequestStatus Object
1182 +-------------------------+------------------+-------------------------------------------------+
1183 |Attribute |Content |Description |
1184 +=========================+==================+=================================================+
1185 |finishTime |String |Time |
1186 +-------------------------+------------------+-------------------------------------------------+
1187 |requestState |String |state of the request |
1188 +-------------------------+------------------+-------------------------------------------------+
1189 |statusMessage |String |statusMessage |
1190 +-------------------------+------------------+-------------------------------------------------+
1191 |percentProgress |String |percentage of progress |
1192 +-------------------------+------------------+-------------------------------------------------+