docs/api/apis/serviceInstances-api.rst

   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.
   4
   5 serviceInstances API
   6 ====================
   7
   8
   9 This API allows to generate some requests to manage:
  10
  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)
  16
  17 links:
  18
  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`
  25 - :ref:`create_vnf`
  26 - :ref:`delete_vnf`
  27 - :ref:`get_orchestration_request_by_id`
  28 - :ref:`get_orchestration_request_all`
  29
  30
  31 .. _create_service_instance:
  32
  33 Create service instance
  34 +++++++++++++++++++++++
  35
  36 +--------------------+--------------------------------------------------------+
  37 |Interface Definition|Description                                             |
  38 +====================+========================================================+
  39 |URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances |
  40 +--------------------+--------------------------------------------------------+
  41 |Operation Type      |POST                                                    |
  42 +--------------------+--------------------------------------------------------+
  43 |Content-Type        |application/json                                        |
  44 +--------------------+--------------------------------------------------------+
  45
  46 Request Headers:
  47
  48 +-------------------+---------+-----------------------------------------------------------------------------------------+
  49 |Header Name        |Required |Description                                                                              |
  50 +===================+=========+=========================================================================================+
  51 |Authorization      |Y        |Base64 encoded username:password                                                         |
  52 +-------------------+---------+-----------------------------------------------------------------------------------------+
  53
  54 Request Body:
  55
  56 +----------------+---------+-----------+--------------------------+-------------------------------------------+
  57 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
  58 +================+=========+===========+==========================+===========================================+
  59 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
  60 +----------------+---------+-----------+--------------------------+-------------------------------------------+
  61
  62 RequestDetails Object
  63
  64 +-------------------+--------------------------+-------------------------------------------------+
  65 |Attribute          |Content                   |Description                                      |
  66 +===================+==========================+=================================================+
  67 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
  68 +-------------------+--------------------------+-------------------------------------------------+
  69 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
  70 +-------------------+--------------------------+-------------------------------------------------+
  71 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
  72 +-------------------+--------------------------+-------------------------------------------------+
  73 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
  74 +-------------------+--------------------------+-------------------------------------------------+
  75 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
  76 +-------------------+--------------------------+-------------------------------------------------+
  77 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
  78 +-------------------+--------------------------+-------------------------------------------------+
  79 |project            |project Object            |Content of project object.                       |
  80 +-------------------+--------------------------+-------------------------------------------------+
  81 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
  82 +-------------------+--------------------------+-------------------------------------------------+
  83 |platform           |platform Object           |Content of platform object.                      |
  84 +-------------------+--------------------------+-------------------------------------------------+
  85 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
  86 +-------------------+--------------------------+-------------------------------------------------+
  87
  88 ModelInfo Object
  89
  90 +-------------------------+------------------+-------------------------------------------------+
  91 |Attribute                |Content           |Description                                      |
  92 +=========================+==================+=================================================+
  93 |ModelType                |String            |Type of model                                    |
  94 +-------------------------+------------------+-------------------------------------------------+
  95 |ModelInvariantId         |String            |The Model Invariant Id.                          |
  96 +-------------------------+------------------+-------------------------------------------------+
  97 |ModelNameVersionId       |String            |The modelname Version Id                         |
  98 +-------------------------+------------------+-------------------------------------------------+
  99 |ModelName                |String            |Name of the Model                                |
 100 +-------------------------+------------------+-------------------------------------------------+
 101 |ModelVersion             |String            |Version of the model                             |
 102 +-------------------------+------------------+-------------------------------------------------+
 103 |ModelCustomization Name  |String            |The Model Customization name                     |
 104 +-------------------------+------------------+-------------------------------------------------+
 105 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
 106 +-------------------------+------------------+-------------------------------------------------+
 107 |modelVersionId           |String            |The Model version id                             |
 108 +-------------------------+------------------+-------------------------------------------------+
 109 |modelUuid                |String            |The Model UUid                                   |
 110 +-------------------------+------------------+-------------------------------------------------+
 111 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
 112 +-------------------------+------------------+-------------------------------------------------+
 113 |modelInstanceName        |String            |The Model Instance  name                         |
 114 +-------------------------+------------------+-------------------------------------------------+
 115
 116
 117 SubscriberInfo Object
 118
 119 +-------------------------+------------------+-------------------------------------------------+
 120 |Attribute                |Content           |Description                                      |
 121 +=========================+==================+=================================================+
 122 |GlobalSubscriberId       |String            |Global customer Id (in A&AI)                     |
 123 +-------------------------+------------------+-------------------------------------------------+
 124 |SubscriberName           |String            |Name of the Subscriber                           |
 125 +-------------------------+------------------+-------------------------------------------------+
 126
 127 RequestInfo Object
 128
 129 +-------------------------+------------------+-------------------------------------------------+
 130 |Attribute                |Content           |Description                                      |
 131 +=========================+==================+=================================================+
 132 |Source                   |String            |source of the request                            |
 133 +-------------------------+------------------+-------------------------------------------------+
 134 |billingAccountNumber     |String            |billingAccountNumber of the request              |
 135 +-------------------------+------------------+-------------------------------------------------+
 136 |callbackUrl              |String            |callbackUrl of the request                       |
 137 +-------------------------+------------------+-------------------------------------------------+
 138 |correlator               |String            |correlator of the request                        |
 139 +-------------------------+------------------+-------------------------------------------------+
 140 |orderNumber              |String            |orderNumber of the request                       |
 141 +-------------------------+------------------+-------------------------------------------------+
 142 |productFamilyId          |String            |productFamilyId of the request                   |
 143 +-------------------------+------------------+-------------------------------------------------+
 144 |orderVersion             |String            |orderVersion of the request                      |
 145 +-------------------------+------------------+-------------------------------------------------+
 146 |instanceName             |String            |instanceName of the request                      |
 147 +-------------------------+------------------+-------------------------------------------------+
 148 |suppressRollback         |String            |suppressRollback of the request                  |
 149 +-------------------------+------------------+-------------------------------------------------+
 150 |requestorId              |String            |requestorId of the request                       |
 151 +-------------------------+------------------+-------------------------------------------------+
 152
 153 RequestParameters Object
 154
 155 +-------------------------+------------------+-------------------------------------------------+
 156 |Attribute                |Content           |Description                                      |
 157 +=========================+==================+=================================================+
 158 |SubscriptionServiceType  |String            |The service type of the Subscription             |
 159 +-------------------------+------------------+-------------------------------------------------+
 160 |UserParams               |Array             |The product family Id.                           |
 161 +-------------------------+------------------+-------------------------------------------------+
 162 |aLaCarte                 |Boolean           | aLaCarte                                        |
 163 +-------------------------+------------------+-------------------------------------------------+
 164 |autoBuildVfModules       |Boolean           |autoBuildVfModules                               |
 165 +-------------------------+------------------+-------------------------------------------------+
 166 |cascadeDelete            |Boolean           |cascadeDelete                                    |
 167 +-------------------------+------------------+-------------------------------------------------+
 168 |usePreload               |Boolean           |usePreload                                       |
 169 +-------------------------+------------------+-------------------------------------------------+
 170 |rebuildVolumeGroups      |Boolean           |rebuildVolumeGroups                              |
 171 +-------------------------+------------------+-------------------------------------------------+
 172 |payload                  |String            |payload                                          |
 173 +-------------------------+------------------+-------------------------------------------------+
 174 |controllerType           |String            |controllerType                                   |
 175 +-------------------------+------------------+-------------------------------------------------+
 176
 177 UserParams Object
 178
 179 +-------------------------+------------------+-------------------------------------------------+
 180 |Attribute                |Content           |Description                                      |
 181 +=========================+==================+=================================================+
 182 |name                     |String            |Tag name of attribute                            |
 183 +-------------------------+------------------+-------------------------------------------------+
 184 |value                    |String            |Value of the tag                                 |
 185 +-------------------------+------------------+-------------------------------------------------+
 186
 187 CloudConfiguration Object
 188
 189 +-------------------------+------------------+-------------------------------------------------+
 190 |Attribute                |Content           |Description                                      |
 191 +=========================+==================+=================================================+
 192 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 193 +-------------------------+------------------+-------------------------------------------------+
 194 |tenantId                 |String            |Name of the Subscriber                           |
 195 +-------------------------+------------------+-------------------------------------------------+
 196 |aicNodeClli              |String            |aicNodeClli property                             |
 197 +-------------------------+------------------+-------------------------------------------------+
 198
 199 Project Object
 200
 201 +-------------------------+------------------+-------------------------------------------------+
 202 |Attribute                |Content           |Description                                      |
 203 +=========================+==================+=================================================+
 204 |projectName              |String            |Name of the project                              |
 205 +-------------------------+------------------+-------------------------------------------------+
 206
 207 OwningEntity Object
 208
 209 +-------------------------+------------------+-------------------------------------------------+
 210 |Attribute                |Content           |Description                                      |
 211 +=========================+==================+=================================================+
 212 |owningEntityId           |String            |owningEntityId of the owingEntity                |
 213 +-------------------------+------------------+-------------------------------------------------+
 214 |owningEntityName         |String            |owningEntityName of the owingEntity              |
 215 +-------------------------+------------------+-------------------------------------------------+
 216
 217 Platform Object
 218
 219 +-------------------------+------------------+-------------------------------------------------+
 220 |Attribute                |Content           |Description                                      |
 221 +=========================+==================+=================================================+
 222 |platformName             |String            |Platform Name                                    |
 223 +-------------------------+------------------+-------------------------------------------------+
 224
 225 LineOfBusiness Object
 226
 227 +-------------------------+------------------+-------------------------------------------------+
 228 |Attribute                |Content           |Description                                      |
 229 +=========================+==================+=================================================+
 230 |lineOfBusinessName       |String            |Line Of Business Name                            |
 231 +-------------------------+------------------+-------------------------------------------------+
 232
 233
 234 .. _delete_service_instance:
 235
 236 Delete service instance
 237 +++++++++++++++++++++++
 238
 239 +--------------------+--------------------------------------------------------------------------------+
 240 |Interface Definition|Description                                                                     |
 241 +====================+================================================================================+
 242 |URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}     |
 243 +--------------------+--------------------------------------------------------------------------------+
 244 |Operation Type      |DELETE                                                                          |
 245 +--------------------+--------------------------------------------------------------------------------+
 246 |Content-Type        |application/json                                                                |
 247 +--------------------+--------------------------------------------------------------------------------+
 248
 249 Request Headers:
 250
 251 +-------------------+---------+-----------------------------------------------------------------------------------------+
 252 |Header Name        |Required |Description                                                                              |
 253 +===================+=========+=========================================================================================+
 254 |Authorization      |Y        |Base64 encoded username:password                                                         |
 255 +-------------------+---------+-----------------------------------------------------------------------------------------+
 256
 257 Request Body:
 258
 259 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 260 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 261 +================+=========+===========+==========================+===========================================+
 262 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 263 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 264
 265 RequestDetails Object
 266
 267 +-------------------+-------------------------+-------------------------------------------------+
 268 |Attribute          |Content                  |Description                                      |
 269 +===================+=========================+=================================================+
 270 |modelInfo          |modelInfo Object         |Content of modelInfo object.                     |
 271 +-------------------+-------------------------+-------------------------------------------------+
 272 |requestInfo        |requestInfo Object       |Content of requestInfo object.                   |
 273 +-------------------+-------------------------+-------------------------------------------------+
 274
 275 ModelInfo Object
 276
 277 +-------------------------+------------------+-------------------------------------------------+
 278 |Attribute                |Content           |Description                                      |
 279 +=========================+==================+=================================================+
 280 |ModelType                |String            |Type of model                                    |
 281 +-------------------------+------------------+-------------------------------------------------+
 282 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 283 +-------------------------+------------------+-------------------------------------------------+
 284 |ModelName                |String            |Name of the Model                                |
 285 +-------------------------+------------------+-------------------------------------------------+
 286 |ModelVersion             |String            |Version of the model                             |
 287 +-------------------------+------------------+-------------------------------------------------+
 288
 289 RequestInfo Object
 290
 291 +-------------------------+------------------+-------------------------------------------------+
 292 |Attribute                |Content           |Description                                      |
 293 +=========================+==================+=================================================+
 294 |Source                   |String            |source of the request                            |
 295 +-------------------------+------------------+-------------------------------------------------+
 296
 297
 298 .. _create_volume_group:
 299
 300 Create Volume Group
 301 +++++++++++++++++++
 302
 303 +--------------------+------------------------------------------------------------------------------------------------------------------+
 304 |Interface Definition|Description                                                                                                       |
 305 +====================+==================================================================================================================+
 306 |URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups     |
 307 +--------------------+------------------------------------------------------------------------------------------------------------------+
 308 |Operation Type      |POST                                                                                                              |
 309 +--------------------+------------------------------------------------------------------------------------------------------------------+
 310 |Content-Type        |application/json                                                                                                  |
 311 +--------------------+------------------------------------------------------------------------------------------------------------------+
 312
 313 Request Headers:
 314
 315 +-------------------+---------+-----------------------------------------------------------------------------------------+
 316 |Header Name        |Required |Description                                                                              |
 317 +===================+=========+=========================================================================================+
 318 |Authorization      |Y        |Base64 encoded username:password                                                         |
 319 +-------------------+---------+-----------------------------------------------------------------------------------------+
 320
 321 Request Body:
 322
 323 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 324 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 325 +================+=========+===========+==========================+===========================================+
 326 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 327 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 328
 329 RequestDetails Object
 330
 331 +-------------------+--------------------------+-------------------------------------------------+
 332 |Attribute          |Content                   |Description                                      |
 333 +===================+==========================+=================================================+
 334 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
 335 +-------------------+--------------------------+-------------------------------------------------+
 336 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
 337 +-------------------+--------------------------+-------------------------------------------------+
 338 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
 339 +-------------------+--------------------------+-------------------------------------------------+
 340 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
 341 +-------------------+--------------------------+-------------------------------------------------+
 342 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
 343 +-------------------+--------------------------+-------------------------------------------------+
 344 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
 345 +-------------------+--------------------------+-------------------------------------------------+
 346 |project            |project Object            |Content of project object.                       |
 347 +-------------------+--------------------------+-------------------------------------------------+
 348 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
 349 +-------------------+--------------------------+-------------------------------------------------+
 350 |platform           |platform Object           |Content of platform object.                      |
 351 +-------------------+--------------------------+-------------------------------------------------+
 352 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
 353 +-------------------+--------------------------+-------------------------------------------------+
 354
 355 ModelInfo Object
 356
 357 +-------------------------+------------------+-------------------------------------------------+
 358 |Attribute                |Content           |Description                                      |
 359 +=========================+==================+=================================================+
 360 |ModelType                |String            |Type of model                                    |
 361 +-------------------------+------------------+-------------------------------------------------+
 362 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 363 +-------------------------+------------------+-------------------------------------------------+
 364 |ModelNameVersionId       |String            |The modelname Version Id                         |
 365 +-------------------------+------------------+-------------------------------------------------+
 366 |ModelName                |String            |Name of the Model                                |
 367 +-------------------------+------------------+-------------------------------------------------+
 368 |ModelVersion             |String            |Version of the model                             |
 369 +-------------------------+------------------+-------------------------------------------------+
 370 |ModelCustomization Name  |String            |The Model Customization name                     |
 371 +-------------------------+------------------+-------------------------------------------------+
 372 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
 373 +-------------------------+------------------+-------------------------------------------------+
 374 |modelVersionId           |String            |The Model version id                             |
 375 +-------------------------+------------------+-------------------------------------------------+
 376 |modelUuid                |String            |The Model UUid                                   |
 377 +-------------------------+------------------+-------------------------------------------------+
 378 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
 379 +-------------------------+------------------+-------------------------------------------------+
 380 |modelInstanceName        |String            |The Model Instance  name                         |
 381 +-------------------------+------------------+-------------------------------------------------+
 382
 383 CloudConfiguration Object
 384
 385 +-------------------------+------------------+-------------------------------------------------+
 386 |Attribute                |Content           |Description                                      |
 387 +=========================+==================+=================================================+
 388 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 389 +-------------------------+------------------+-------------------------------------------------+
 390 |tenantId                 |String            |Name of the Subscriber                           |
 391 +-------------------------+------------------+-------------------------------------------------+
 392 |aicNodeClli              |String            |aicNodeClli property                             |
 393 +-------------------------+------------------+-------------------------------------------------+
 394
 395 RequestInfo Object
 396
 397 +-------------------------+------------------+-------------------------------------------------+
 398 |Attribute                |Content           |Description                                      |
 399 +=========================+==================+=================================================+
 400 |Source                   |String            |source of the request                            |
 401 +-------------------------+------------------+-------------------------------------------------+
 402 |billingAccountNumber     |String            |billingAccountNumber of the request              |
 403 +-------------------------+------------------+-------------------------------------------------+
 404 |callbackUrl              |String            |callbackUrl of the request                       |
 405 +-------------------------+------------------+-------------------------------------------------+
 406 |correlator               |String            |correlator of the request                        |
 407 +-------------------------+------------------+-------------------------------------------------+
 408 |orderNumber              |String            |orderNumber of the request                       |
 409 +-------------------------+------------------+-------------------------------------------------+
 410 |productFamilyId          |String            |productFamilyId of the request                   |
 411 +-------------------------+------------------+-------------------------------------------------+
 412 |orderVersion             |String            |orderVersion of the request                      |
 413 +-------------------------+------------------+-------------------------------------------------+
 414 |instanceName             |String            |instanceName of the request                      |
 415 +-------------------------+------------------+-------------------------------------------------+
 416 |suppressRollback         |String            |suppressRollback of the request                  |
 417 +-------------------------+------------------+-------------------------------------------------+
 418 |requestorId              |String            |requestorId of the request                       |
 419 +-------------------------+------------------+-------------------------------------------------+
 420
 421 relatedInstance List
 422
 423 +-------------------------+------------------+-------------------------------------------------+
 424 |Attribute                |Content           |Description                                      |
 425 +=========================+==================+=================================================+
 426 |relatedInstance          |Object            |relatedInstance Object                           |
 427 +-------------------------+------------------+-------------------------------------------------+
 428
 429 relatedInstance List
 430
 431 +-------------------------+------------------+-------------------------------------------------+
 432 |Attribute                |Content           |Description                                      |
 433 +=========================+==================+=================================================+
 434 |instanceId               |String            |instanceId                                       |
 435 +-------------------------+------------------+-------------------------------------------------+
 436 |modelInfo                |Object            |Content of modelInfo object.                     |
 437 +-------------------------+------------------+-------------------------------------------------+
 438
 439 .. _delete_volume_group:
 440
 441 Delete Volume Group
 442 +++++++++++++++++++
 443
 444 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 445 |Interface Definition|Description                                                                                                                                 |
 446 +====================+============================================================================================================================================+
 447 |URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id}     |
 448 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 449 |Operation Type      |DELETE                                                                                                                                      |
 450 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 451 |Content-Type        |application/json                                                                                                                            |
 452 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 453
 454 Request Headers:
 455
 456 +-------------------+---------+-----------------------------------------------------------------------------------------+
 457 |Header Name        |Required |Description                                                                              |
 458 +===================+=========+=========================================================================================+
 459 |Authorization      |Y        |Base64 encoded username:password                                                         |
 460 +-------------------+---------+-----------------------------------------------------------------------------------------+
 461
 462 Request Body:
 463
 464 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 465 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 466 +================+=========+===========+==========================+===========================================+
 467 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 468 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 469
 470 RequestDetails Object
 471
 472 +---------------------+-------------------------+-------------------------------------------------+
 473 |Attribute            |Content                  |Description                                      |
 474 +=====================+=========================+=================================================+
 475 |modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
 476 +---------------------+-------------------------+-------------------------------------------------+
 477 |cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
 478 +---------------------+-------------------------+-------------------------------------------------+
 479 |requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
 480 +---------------------+-------------------------+-------------------------------------------------+
 481
 482 ModelInfo Object
 483
 484 +-------------------------+------------------+-------------------------------------------------+
 485 |Attribute                |Content           |Description                                      |
 486 +=========================+==================+=================================================+
 487 |ModelType                |String            |Type of model                                    |
 488 +-------------------------+------------------+-------------------------------------------------+
 489 |ModelName                |String            |Name of the Model                                |
 490 +-------------------------+------------------+-------------------------------------------------+
 491
 492 CloudConfiguration Object
 493
 494 +-------------------------+------------------+-------------------------------------------------+
 495 |Attribute                |Content           |Description                                      |
 496 +=========================+==================+=================================================+
 497 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 498 +-------------------------+------------------+-------------------------------------------------+
 499 |tenantId                 |String            |Name of the Subscriber                           |
 500 +-------------------------+------------------+-------------------------------------------------+
 501
 502 RequestInfo Object
 503
 504 +-------------------------+------------------+-------------------------------------------------+
 505 |Attribute                |Content           |Description                                      |
 506 +=========================+==================+=================================================+
 507 |Source                   |String            |source of the request                            |
 508 +-------------------------+------------------+-------------------------------------------------+
 509
 510 .. _create_vf_module:
 511
 512 Create VF Module
 513 ++++++++++++++++
 514
 515 +--------------------+---------------------------------------------------------------------------------------------------------------+
 516 |Interface Definition|Description                                                                                                    |
 517 +====================+===============================================================================================================+
 518 |URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules     |
 519 +--------------------+---------------------------------------------------------------------------------------------------------------+
 520 |Operation Type      |POST                                                                                                           |
 521 +--------------------+---------------------------------------------------------------------------------------------------------------+
 522 |Content-Type        |application/json                                                                                               |
 523 +--------------------+---------------------------------------------------------------------------------------------------------------+
 524
 525 Request Headers:
 526
 527 +-------------------+---------+-----------------------------------------------------------------------------------------+
 528 |Header Name        |Required |Description                                                                              |
 529 +===================+=========+=========================================================================================+
 530 |Authorization      |Y        |Base64 encoded username:password                                                         |
 531 +-------------------+---------+-----------------------------------------------------------------------------------------+
 532
 533 Request Body:
 534
 535 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 536 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 537 +================+=========+===========+==========================+===========================================+
 538 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 539 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 540
 541 RequestDetails Object
 542
 543 +---------------------+-------------------------+-------------------------------------------------+
 544 |Attribute            |Content                  |Description                                      |
 545 +=====================+=========================+=================================================+
 546 |modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
 547 +---------------------+-------------------------+-------------------------------------------------+
 548 |cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
 549 +---------------------+-------------------------+-------------------------------------------------+
 550 |requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
 551 +---------------------+-------------------------+-------------------------------------------------+
 552 |relatedInstanceList  |List                     |Content of relatedInstanceList.                  |
 553 +---------------------+-------------------------+-------------------------------------------------+
 554
 555 ModelInfo Object
 556
 557 +-------------------------+------------------+-------------------------------------------------+
 558 |Attribute                |Content           |Description                                      |
 559 +=========================+==================+=================================================+
 560 |ModelType                |String            |Type of model                                    |
 561 +-------------------------+------------------+-------------------------------------------------+
 562 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 563 +-------------------------+------------------+-------------------------------------------------+
 564 |ModelNameVersionId       |String            |The modelname Version Id                         |
 565 +-------------------------+------------------+-------------------------------------------------+
 566 |ModelName                |String            |Name of the Model                                |
 567 +-------------------------+------------------+-------------------------------------------------+
 568 |ModelVersion             |String            |Version of the model                             |
 569 +-------------------------+------------------+-------------------------------------------------+
 570 |ModelCustomization Name  |String            |The Model Customization name                     |
 571 +-------------------------+------------------+-------------------------------------------------+
 572
 573 CloudConfiguration Object
 574
 575 +-------------------------+------------------+-------------------------------------------------+
 576 |Attribute                |Content           |Description                                      |
 577 +=========================+==================+=================================================+
 578 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 579 +-------------------------+------------------+-------------------------------------------------+
 580 |tenantId                 |String            |Name of the Subscriber                           |
 581 +-------------------------+------------------+-------------------------------------------------+
 582
 583 RequestInfo Object
 584
 585 +-------------------------+------------------+-------------------------------------------------+
 586 |Attribute                |Content           |Description                                      |
 587 +=========================+==================+=================================================+
 588 |InstanceName             |String            |The instance Name                                |
 589 +-------------------------+------------------+-------------------------------------------------+
 590 |Source                   |String            |source of the request                            |
 591 +-------------------------+------------------+-------------------------------------------------+
 592 |SuppressRollback         |Boolean           |SuppressRollback                                 |
 593 +-------------------------+------------------+-------------------------------------------------+
 594
 595 relatedInstance List
 596
 597 +-------------------------+------------------+-------------------------------------------------+
 598 |Attribute                |Content           |Description                                      |
 599 +=========================+==================+=================================================+
 600 |relatedInstance          |Object            |relatedInstance Object                           |
 601 +-------------------------+------------------+-------------------------------------------------+
 602
 603 relatedInstance List
 604
 605 +-------------------------+------------------+-------------------------------------------------+
 606 |Attribute                |Content           |Description                                      |
 607 +=========================+==================+=================================================+
 608 |instanceId               |String            |instanceId                                       |
 609 +-------------------------+------------------+-------------------------------------------------+
 610 |modelInfo                |Object            |Content of modelInfo object.                     |
 611 +-------------------------+------------------+-------------------------------------------------+
 612 |instanceName             |String            |Name of the instance                             |
 613 +-------------------------+------------------+-------------------------------------------------+
 614
 615 .. _delete_vf_module:
 616
 617 Delete VF Module
 618 ++++++++++++++++
 619
 620 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
 621 |Interface Definition|Description                                                                                                                          |
 622 +====================+=====================================================================================================================================+
 623 |URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id}     |
 624 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
 625 |Operation Type      |DELETE                                                                                                                               |
 626 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
 627 |Content-Type        |application/json                                                                                                                     |
 628 +--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
 629
 630 Request Headers:
 631
 632 +-------------------+---------+-----------------------------------------------------------------------------------------+
 633 |Header Name        |Required |Description                                                                              |
 634 +===================+=========+=========================================================================================+
 635 |Authorization      |Y        |Base64 encoded username:password                                                         |
 636 +-------------------+---------+-----------------------------------------------------------------------------------------+
 637
 638 Request Body:
 639
 640 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 641 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 642 +================+=========+===========+==========================+===========================================+
 643 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 644 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 645
 646 RequestDetails Object
 647
 648 +---------------------+-------------------------+-------------------------------------------------+
 649 |Attribute            |Content                  |Description                                      |
 650 +=====================+=========================+=================================================+
 651 |modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
 652 +---------------------+-------------------------+-------------------------------------------------+
 653 |cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
 654 +---------------------+-------------------------+-------------------------------------------------+
 655 |requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
 656 +---------------------+-------------------------+-------------------------------------------------+
 657
 658 ModelInfo Object
 659
 660 +-------------------------+------------------+-------------------------------------------------+
 661 |Attribute                |Content           |Description                                      |
 662 +=========================+==================+=================================================+
 663 |ModelType                |String            |Type of model                                    |
 664 +-------------------------+------------------+-------------------------------------------------+
 665 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 666 +-------------------------+------------------+-------------------------------------------------+
 667 |ModelNameVersionId       |String            |The modelname Version Id                         |
 668 +-------------------------+------------------+-------------------------------------------------+
 669 |ModelName                |String            |Name of the Model                                |
 670 +-------------------------+------------------+-------------------------------------------------+
 671 |ModelVersion             |String            |Version of the model                             |
 672 +-------------------------+------------------+-------------------------------------------------+
 673 |ModelCustomization Name  |String            |The Model Customization name                     |
 674 +-------------------------+------------------+-------------------------------------------------+
 675
 676 CloudConfiguration Object
 677
 678 +-------------------------+------------------+-------------------------------------------------+
 679 |Attribute                |Content           |Description                                      |
 680 +=========================+==================+=================================================+
 681 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 682 +-------------------------+------------------+-------------------------------------------------+
 683 |tenantId                 |String            |Name of the Subscriber                           |
 684 +-------------------------+------------------+-------------------------------------------------+
 685
 686 RequestInfo Object
 687
 688 +-------------------------+------------------+-------------------------------------------------+
 689 |Attribute                |Content           |Description                                      |
 690 +=========================+==================+=================================================+
 691 |Source                   |String            |source of the request                            |
 692 +-------------------------+------------------+-------------------------------------------------+
 693
 694
 695 .. _create_vnf:
 696
 697 Create VNF
 698 ++++++++++
 699
 700 +--------------------+-------------------------------------------------------------------------------------+
 701 |Interface Definition|Description                                                                          |
 702 +====================+=====================================================================================+
 703 |URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs     |
 704 +--------------------+-------------------------------------------------------------------------------------+
 705 |Operation Type      |POST                                                                                 |
 706 +--------------------+-------------------------------------------------------------------------------------+
 707 |Content-Type        |application/json                                                                     |
 708 +--------------------+-------------------------------------------------------------------------------------+
 709
 710 Request Headers:
 711
 712 +-------------------+---------+-----------------------------------------------------------------------------------------+
 713 |Header Name        |Required |Description                                                                              |
 714 +===================+=========+=========================================================================================+
 715 |Authorization      |Y        |Base64 encoded username:password                                                         |
 716 +-------------------+---------+-----------------------------------------------------------------------------------------+
 717
 718 Request Body:
 719
 720 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 721 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 722 +================+=========+===========+==========================+===========================================+
 723 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 724 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 725
 726 RequestDetails Object
 727
 728 +-------------------+--------------------------+-------------------------------------------------+
 729 |Attribute          |Content                   |Description                                      |
 730 +===================+==========================+=================================================+
 731 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
 732 +-------------------+--------------------------+-------------------------------------------------+
 733 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
 734 +-------------------+--------------------------+-------------------------------------------------+
 735 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
 736 +-------------------+--------------------------+-------------------------------------------------+
 737 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
 738 +-------------------+--------------------------+-------------------------------------------------+
 739 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
 740 +-------------------+--------------------------+-------------------------------------------------+
 741 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
 742 +-------------------+--------------------------+-------------------------------------------------+
 743 |project            |project Object            |Content of project object.                       |
 744 +-------------------+--------------------------+-------------------------------------------------+
 745 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
 746 +-------------------+--------------------------+-------------------------------------------------+
 747 |platform           |platform Object           |Content of platform object.                      |
 748 +-------------------+--------------------------+-------------------------------------------------+
 749 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
 750 +-------------------+--------------------------+-------------------------------------------------+
 751
 752 ModelInfo Object
 753
 754 +-------------------------+------------------+-------------------------------------------------+
 755 |Attribute                |Content           |Description                                      |
 756 +=========================+==================+=================================================+
 757 |ModelType                |String            |Type of model                                    |
 758 +-------------------------+------------------+-------------------------------------------------+
 759 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 760 +-------------------------+------------------+-------------------------------------------------+
 761 |ModelNameVersionId       |String            |The modelname Version Id                         |
 762 +-------------------------+------------------+-------------------------------------------------+
 763 |ModelName                |String            |Name of the Model                                |
 764 +-------------------------+------------------+-------------------------------------------------+
 765 |ModelVersion             |String            |Version of the model                             |
 766 +-------------------------+------------------+-------------------------------------------------+
 767 |ModelCustomization Name  |String            |The Model Customization name                     |
 768 +-------------------------+------------------+-------------------------------------------------+
 769 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
 770 +-------------------------+------------------+-------------------------------------------------+
 771 |modelVersionId           |String            |The Model version id                             |
 772 +-------------------------+------------------+-------------------------------------------------+
 773 |modelUuid                |String            |The Model UUid                                   |
 774 +-------------------------+------------------+-------------------------------------------------+
 775 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
 776 +-------------------------+------------------+-------------------------------------------------+
 777 |modelInstanceName        |String            |The Model Instance  name                         |
 778 +-------------------------+------------------+-------------------------------------------------+
 779
 780 CloudConfiguration Object
 781
 782 +-------------------------+------------------+-------------------------------------------------+
 783 |Attribute                |Content           |Description                                      |
 784 +=========================+==================+=================================================+
 785 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 786 +-------------------------+------------------+-------------------------------------------------+
 787 |tenantId                 |String            |Name of the Subscriber                           |
 788 +-------------------------+------------------+-------------------------------------------------+
 789
 790 RequestInfo Object
 791
 792 +-------------------------+------------------+-------------------------------------------------+
 793 |Attribute                |Content           |Description                                      |
 794 +=========================+==================+=================================================+
 795 |Source                   |String            |source of the request                            |
 796 +-------------------------+------------------+-------------------------------------------------+
 797 |billingAccountNumber     |String            |billingAccountNumber of the request              |
 798 +-------------------------+------------------+-------------------------------------------------+
 799 |callbackUrl              |String            |callbackUrl of the request                       |
 800 +-------------------------+------------------+-------------------------------------------------+
 801 |correlator               |String            |correlator of the request                        |
 802 +-------------------------+------------------+-------------------------------------------------+
 803 |orderNumber              |String            |orderNumber of the request                       |
 804 +-------------------------+------------------+-------------------------------------------------+
 805 |productFamilyId          |String            |productFamilyId of the request                   |
 806 +-------------------------+------------------+-------------------------------------------------+
 807 |orderVersion             |String            |orderVersion of the request                      |
 808 +-------------------------+------------------+-------------------------------------------------+
 809 |instanceName             |String            |instanceName of the request                      |
 810 +-------------------------+------------------+-------------------------------------------------+
 811 |suppressRollback         |String            |suppressRollback of the request                  |
 812 +-------------------------+------------------+-------------------------------------------------+
 813 |requestorId              |String            |requestorId of the request                       |
 814 +-------------------------+------------------+-------------------------------------------------+
 815
 816 relatedInstance List
 817
 818 +-------------------------+------------------+-------------------------------------------------+
 819 |Attribute                |Content           |Description                                      |
 820 +=========================+==================+=================================================+
 821 |relatedInstance          |Object            |relatedInstance Object                           |
 822 +-------------------------+------------------+-------------------------------------------------+
 823
 824 relatedInstance List
 825
 826 +-------------------------+------------------+-------------------------------------------------+
 827 |Attribute                |Content           |Description                                      |
 828 +=========================+==================+=================================================+
 829 |instanceId               |String            |instanceId                                       |
 830 +-------------------------+------------------+-------------------------------------------------+
 831 |modelInfo                |Object            |Content of modelInfo object.                     |
 832 +-------------------------+------------------+-------------------------------------------------+
 833
 834 RequestParameters Object
 835
 836 +-------------------------+------------------+-------------------------------------------------+
 837 |Attribute                |Content           |Description                                      |
 838 +=========================+==================+=================================================+
 839 |UserParams               |Array             |The product family Id.                           |
 840 +-------------------------+------------------+-------------------------------------------------+
 841
 842 UserParams Object
 843
 844 +-------------------------+------------------+-------------------------------------------------+
 845 |Attribute                |Content           |Description                                      |
 846 +=========================+==================+=================================================+
 847 |name                     |String            |Tag name of attribute                            |
 848 +-------------------------+------------------+-------------------------------------------------+
 849 |value                    |String            |Value of the tag                                 |
 850 +-------------------------+------------------+-------------------------------------------------+
 851
 852 .. _delete_vnf:
 853
 854 Delete VNF
 855 ++++++++++
 856
 857 +--------------------+-----------------------------------------------------------------------------------------------------+
 858 |Interface Definition|Description                                                                                          |
 859 +====================+=====================================================================================================+
 860 |URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}     |
 861 +--------------------+-----------------------------------------------------------------------------------------------------+
 862 |Operation Type      |DELETE                                                                                               |
 863 +--------------------+-----------------------------------------------------------------------------------------------------+
 864 |Content-Type        |application/json                                                                                     |
 865 +--------------------+-----------------------------------------------------------------------------------------------------+
 866
 867 Request Headers:
 868
 869 +-------------------+---------+-----------------------------------------------------------------------------------------+
 870 |Header Name        |Required |Description                                                                              |
 871 +===================+=========+=========================================================================================+
 872 |Authorization      |Y        |Base64 encoded username:password                                                         |
 873 +-------------------+---------+-----------------------------------------------------------------------------------------+
 874
 875 Request Body:
 876
 877 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 878 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 879 +================+=========+===========+==========================+===========================================+
 880 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 881 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 882
 883 RequestDetails Object
 884
 885 +---------------------+-------------------------+-------------------------------------------------+
 886 |Attribute            |Content                  |Description                                      |
 887 +=====================+=========================+=================================================+
 888 |modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
 889 +---------------------+-------------------------+-------------------------------------------------+
 890 |cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
 891 +---------------------+-------------------------+-------------------------------------------------+
 892 |requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
 893 +---------------------+-------------------------+-------------------------------------------------+
 894 |requestParameters    |requestParameters Object |Content of requestParameters object.             |
 895 +---------------------+-------------------------+-------------------------------------------------+
 896
 897 ModelInfo Object
 898
 899 +-------------------------+------------------+-------------------------------------------------+
 900 |Attribute                |Content           |Description                                      |
 901 +=========================+==================+=================================================+
 902 |ModelType                |String            |Type of model                                    |
 903 +-------------------------+------------------+-------------------------------------------------+
 904 |ModelName                |String            |Name of the Model                                |
 905 +-------------------------+------------------+-------------------------------------------------+
 906
 907 CloudConfiguration Object
 908
 909 +-------------------------+------------------+-------------------------------------------------+
 910 |Attribute                |Content           |Description                                      |
 911 +=========================+==================+=================================================+
 912 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 913 +-------------------------+------------------+-------------------------------------------------+
 914 |tenantId                 |String            |Name of the Subscriber                           |
 915 +-------------------------+------------------+-------------------------------------------------+
 916
 917 RequestInfo Object
 918
 919 +-------------------------+------------------+-------------------------------------------------+
 920 |Attribute                |Content           |Description                                      |
 921 +=========================+==================+=================================================+
 922 |Source                   |String            |source of the request                            |
 923 +-------------------------+------------------+-------------------------------------------------+
 924
 925 RequestParameters Object
 926
 927 +-------------------------+------------------+-------------------------------------------------+
 928 |Attribute                |Content           |Description                                      |
 929 +=========================+==================+=================================================+
 930 |UserParams               |Array             |The product family Id.                           |
 931 +-------------------------+------------------+-------------------------------------------------+
 932
 933 UserParams Object
 934
 935 +-------------------------+------------------+-------------------------------------------------+
 936 |Attribute                |Content           |Description                                      |
 937 +=========================+==================+=================================================+
 938 |name                     |String            |Tag name of attribute                            |
 939 +-------------------------+------------------+-------------------------------------------------+
 940 |value                    |String            |Value of the tag                                 |
 941 +-------------------------+------------------+-------------------------------------------------+
 942
 943 .. _get_orchestration_request_by_id:
 944
 945 GET Orchestration Request
 946 +++++++++++++++++++++++++
 947
 948 +--------------------+-------------------------------------------------------------------------------------+
 949 |Interface Definition|Description                                                                          |
 950 +====================+=====================================================================================+
 951 |URI                 |/onap/so/infra/orchestrationRequests/v7/{request-id}                                 |
 952 +--------------------+-------------------------------------------------------------------------------------+
 953 |Operation Type      |GET                                                                                  |
 954 +--------------------+-------------------------------------------------------------------------------------+
 955 |Content-Type        |application/json                                                                     |
 956 +--------------------+-------------------------------------------------------------------------------------+
 957
 958 Request Headers:
 959
 960 +-------------------+---------+-----------------------------------------------------------------------------------------+
 961 |Header Name        |Required |Description                                                                              |
 962 +===================+=========+=========================================================================================+
 963 |Authorization      |Y        |Base64 encoded username:password                                                         |
 964 +-------------------+---------+-----------------------------------------------------------------------------------------+
 965
 966 Response Body:
 967
 968 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 969 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 970 +================+=========+===========+==========================+===========================================+
 971 |request         |M        |1          |request Object            |Content of request object.                 |
 972 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 973
 974 Request Object
 975
 976 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 977 |Attribute          |Qualifier|Cardinality|Content                   |Description                                |
 978 +===================+=========+===========+==========================+===========================================+
 979 |requestId          |M        |1          |String                    |Request Id                                 |
 980 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 981 |startTime          |M        |1          |request Object            |Start time.                                |
 982 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 983 |requestScope       |M        |1          |request Object            |Scope of the request.                      |
 984 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 985 |requestType        |M        |1          |request Object            |Type of the request.                       |
 986 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 987 |requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
 988 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 989 |requestStatus      |M        |1          |requestStatus Object      |Type of the request.                       |
 990 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 991
 992 RequestDetails Object
 993
 994 +-------------------+--------------------------+-------------------------------------------------+
 995 |Attribute          |Content                   |Description                                      |
 996 +===================+==========================+=================================================+
 997 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
 998 +-------------------+--------------------------+-------------------------------------------------+
 999 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
1000 +-------------------+--------------------------+-------------------------------------------------+
1001 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
1002 +-------------------+--------------------------+-------------------------------------------------+
1003 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
1004 +-------------------+--------------------------+-------------------------------------------------+
1005 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
1006 +-------------------+--------------------------+-------------------------------------------------+
1007 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
1008 +-------------------+--------------------------+-------------------------------------------------+
1009 |project            |project Object            |Content of project object.                       |
1010 +-------------------+--------------------------+-------------------------------------------------+
1011 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
1012 +-------------------+--------------------------+-------------------------------------------------+
1013 |platform           |platform Object           |Content of platform object.                      |
1014 +-------------------+--------------------------+-------------------------------------------------+
1015 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
1016 +-------------------+--------------------------+-------------------------------------------------+
1017
1018 ModelInfo Object
1019
1020 +-------------------------+------------------+-------------------------------------------------+
1021 |Attribute                |Content           |Description                                      |
1022 +=========================+==================+=================================================+
1023 |ModelType                |String            |Type of model                                    |
1024 +-------------------------+------------------+-------------------------------------------------+
1025 |ModelInvariantId         |String            |The Model Invariant Id.                          |
1026 +-------------------------+------------------+-------------------------------------------------+
1027 |ModelNameVersionId       |String            |The modelname Version Id                         |
1028 +-------------------------+------------------+-------------------------------------------------+
1029 |ModelName                |String            |Name of the Model                                |
1030 +-------------------------+------------------+-------------------------------------------------+
1031 |ModelVersion             |String            |Version of the model                             |
1032 +-------------------------+------------------+-------------------------------------------------+
1033 |ModelCustomization Name  |String            |The Model Customization name                     |
1034 +-------------------------+------------------+-------------------------------------------------+
1035 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
1036 +-------------------------+------------------+-------------------------------------------------+
1037 |modelVersionId           |String            |The Model version id                             |
1038 +-------------------------+------------------+-------------------------------------------------+
1039 |modelUuid                |String            |The Model UUid                                   |
1040 +-------------------------+------------------+-------------------------------------------------+
1041 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
1042 +-------------------------+------------------+-------------------------------------------------+
1043 |modelInstanceName        |String            |The Model Instance  name                         |
1044 +-------------------------+------------------+-------------------------------------------------+
1045
1046 SubscriberInfo Object
1047
1048 +-------------------------+------------------+-------------------------------------------------+
1049 |Attribute                |Content           |Description                                      |
1050 +=========================+==================+=================================================+
1051 |GlobalSubscriberId       |String            |Global customer Id (in A&AI)                     |
1052 +-------------------------+------------------+-------------------------------------------------+
1053 |SubscriberName           |String            |Name of the Subscriber                           |
1054 +-------------------------+------------------+-------------------------------------------------+
1055
1056 RequestInfo Object
1057
1058 +-------------------------+------------------+-------------------------------------------------+
1059 |Attribute                |Content           |Description                                      |
1060 +=========================+==================+=================================================+
1061 |Source                   |String            |source of the request                            |
1062 +-------------------------+------------------+-------------------------------------------------+
1063 |billingAccountNumber     |String            |billingAccountNumber of the request              |
1064 +-------------------------+------------------+-------------------------------------------------+
1065 |callbackUrl              |String            |callbackUrl of the request                       |
1066 +-------------------------+------------------+-------------------------------------------------+
1067 |correlator               |String            |correlator of the request                        |
1068 +-------------------------+------------------+-------------------------------------------------+
1069 |orderNumber              |String            |orderNumber of the request                       |
1070 +-------------------------+------------------+-------------------------------------------------+
1071 |productFamilyId          |String            |productFamilyId of the request                   |
1072 +-------------------------+------------------+-------------------------------------------------+
1073 |orderVersion             |String            |orderVersion of the request                      |
1074 +-------------------------+------------------+-------------------------------------------------+
1075 |instanceName             |String            |instanceName of the request                      |
1076 +-------------------------+------------------+-------------------------------------------------+
1077 |suppressRollback         |String            |suppressRollback of the request                  |
1078 +-------------------------+------------------+-------------------------------------------------+
1079 |requestorId              |String            |requestorId of the request                       |
1080 +-------------------------+------------------+-------------------------------------------------+
1081
1082 RequestParameters Object
1083
1084 +-------------------------+------------------+-------------------------------------------------+
1085 |Attribute                |Content           |Description                                      |
1086 +=========================+==================+=================================================+
1087 |SubscriptionServiceType  |String            |The service type of the Subscription             |
1088 +-------------------------+------------------+-------------------------------------------------+
1089
1090 RequestStatus Object
1091
1092 +-------------------------+------------------+-------------------------------------------------+
1093 |Attribute                |Content           |Description                                      |
1094 +=========================+==================+=================================================+
1095 |finishTime               |String            |Time                                             |
1096 +-------------------------+------------------+-------------------------------------------------+
1097 |requestState             |String            |state of the request                             |
1098 +-------------------------+------------------+-------------------------------------------------+
1099 |statusMessage            |String            |statusMessage                                    |
1100 +-------------------------+------------------+-------------------------------------------------+
1101 |percentProgress          |String            |percentage of progress                           |
1102 +-------------------------+------------------+-------------------------------------------------+
1103
1104
1105 .. _get_orchestration_request_all:
1106
1107 GET Orchestration Requests
1108 ++++++++++++++++++++++++++
1109
1110 +--------------------+--------------------------------------------------------------+
1111 |Interface Definition|Description                                                   |
1112 +====================+==============================================================+
1113 |URI                 |/onap/so/infra/orchestrationRequests/v7                       |
1114 +--------------------+--------------------------------------------------------------+
1115 |Operation Type      |GET                                                           |
1116 +--------------------+--------------------------------------------------------------+
1117 |Content-Type        |application/json                                              |
1118 +--------------------+--------------------------------------------------------------+
1119
1120 Request Headers:
1121
1122 +-------------------+---------+-----------------------------------------------------------------------------------------+
1123 |Header Name        |Required |Description                                                                              |
1124 +===================+=========+=========================================================================================+
1125 |Authorization      |Y        |Base64 encoded username:password                                                         |
1126 +-------------------+---------+-----------------------------------------------------------------------------------------+
1127
1128 Query Parameters:
1129
1130 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1131 |Attribute          |Required |Cardinality|Content|Description                                                                                          |
1132 +===================+=========+===========+=======+=====================================================================================================+
1133 |filter             |Y        |1          |String | Orchestration filter (scheme KeyTypes:Option:Value)                                                 |
1134 |                   |         |           |       |                                                                                                     |
1135 |                   |         |           |       | KeyTypes:                                                                                           |
1136 |                   |         |           |       |   serviceInstanceId, serviceInstanceName, vnfInstanceId, pnfName, vnfInstanceName,                  |
1137 |                   |         |           |       |   vfModuleInstanceId, vfModuleInstanceName, volumeGroupInstanceId, volumeGroupInstanceName,         |
1138 |                   |         |           |       |   networkInstanceId, networkInstanceName, configurationInstanceId, configurationInstanceName,       |
1139 |                   |         |           |       |   lcpCloudRegionId, tenantId, modelType, requestorId, requestExecutionDate, startTime, requestScope |
1140 |                   |         |           |       |                                                                                                     |
1141 |                   |         |           |       | Option:                                                                                             |
1142 |                   |         |           |       |   EQUALS (or any not null string), DOES_NOT_EQUAL [e.g. modelType:EQUALS:VNF, modelType:qwe:VNF]    |
1143 |                   |         |           |       |   for KeyTypes equals startTime or requestExecutionDate: DOES_NOT_EQUAL, BETWEEN_DATES              |
1144 |                   |         |           |       |   [e.g. startTime:BETWEEN_DATES:30-5-2000:30-5-2030]                                                |
1145 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1146 |includeCloudRequest|N        |1          |Boolean| Enable or disable cloud data request                                                                |
1147 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1148 |format             |N        |1          |String | Orchestration request format [DETAIL, STATUSDETAIL, SIMPLE, SIMPLENOTASKINFO]                       |
1149 +-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1150
1151 Response Body:
1152
1153 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1154 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
1155 +================+=========+===========+==========================+===========================================+
1156 |requestList     |M        |1          |Array                     |Content of request List.                   |
1157 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1158
1159 RequestList :
1160
1161 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1162 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
1163 +================+=========+===========+==========================+===========================================+
1164 |request         |M        |1          |request Object            |Content of request object.                 |
1165 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1166
1167 Request Object
1168
1169 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1170 |Attribute          |Qualifier|Cardinality|Content                   |Description                                |
1171 +===================+=========+===========+==========================+===========================================+
1172 |requestId          |M        |1          |String                    |Request Id.                                |
1173 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1174 |startTime          |M        |1          |request Object            |Start time.                                |
1175 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1176 |requestScope       |M        |1          |request Object            |Scope of the request.                      |
1177 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1178 |requestType        |M        |1          |request Object            |Type of the request.                       |
1179 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1180 |requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
1181 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1182 |requestStatus      |M        |1          |requestStatus Object      |Type of the request.                       |
1183 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1184
1185 RequestDetails Object
1186
1187 +-------------------+--------------------------+-------------------------------------------------+
1188 |Attribute          |Content                   |Description                                      |
1189 +===================+==========================+=================================================+
1190 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
1191 +-------------------+--------------------------+-------------------------------------------------+
1192 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
1193 +-------------------+--------------------------+-------------------------------------------------+
1194 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
1195 +-------------------+--------------------------+-------------------------------------------------+
1196 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
1197 +-------------------+--------------------------+-------------------------------------------------+
1198 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
1199 +-------------------+--------------------------+-------------------------------------------------+
1200 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
1201 +-------------------+--------------------------+-------------------------------------------------+
1202 |project            |project Object            |Content of project object.                       |
1203 +-------------------+--------------------------+-------------------------------------------------+
1204 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
1205 +-------------------+--------------------------+-------------------------------------------------+
1206 |platform           |platform Object           |Content of platform object.                      |
1207 +-------------------+--------------------------+-------------------------------------------------+
1208 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
1209 +-------------------+--------------------------+-------------------------------------------------+
1210
1211 ModelInfo Object
1212
1213 +-------------------------+------------------+-------------------------------------------------+
1214 |Attribute                |Content           |Description                                      |
1215 +=========================+==================+=================================================+
1216 |ModelType                |String            |Type of model                                    |
1217 +-------------------------+------------------+-------------------------------------------------+
1218 |ModelInvariantId         |String            |The Model Invariant Id.                          |
1219 +-------------------------+------------------+-------------------------------------------------+
1220 |ModelNameVersionId       |String            |The modelname Version Id                         |
1221 +-------------------------+------------------+-------------------------------------------------+
1222 |ModelName                |String            |Name of the Model                                |
1223 +-------------------------+------------------+-------------------------------------------------+
1224 |ModelVersion             |String            |Version of the model                             |
1225 +-------------------------+------------------+-------------------------------------------------+
1226 |ModelCustomization Name  |String            |The Model Customization name                     |
1227 +-------------------------+------------------+-------------------------------------------------+
1228 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
1229 +-------------------------+------------------+-------------------------------------------------+
1230 |modelVersionId           |String            |The Model version id                             |
1231 +-------------------------+------------------+-------------------------------------------------+
1232 |modelUuid                |String            |The Model UUid                                   |
1233 +-------------------------+------------------+-------------------------------------------------+
1234 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
1235 +-------------------------+------------------+-------------------------------------------------+
1236 |modelInstanceName        |String            |The Model Instance  name                         |
1237 +-------------------------+------------------+-------------------------------------------------+
1238
1239 SubscriberInfo Object
1240
1241 +-------------------------+------------------+-------------------------------------------------+
1242 |Attribute                |Content           |Description                                      |
1243 +=========================+==================+=================================================+
1244 |GlobalSubscriberId       |String            |Global customer Id (in A&AI)                     |
1245 +-------------------------+------------------+-------------------------------------------------+
1246 |SubscriberName           |String            |Name of the Subscriber                           |
1247 +-------------------------+------------------+-------------------------------------------------+
1248
1249 RequestInfo Object
1250
1251 +-------------------------+------------------+-------------------------------------------------+
1252 |Attribute                |Content           |Description                                      |
1253 +=========================+==================+=================================================+
1254 |Source                   |String            |source of the request                            |
1255 +-------------------------+------------------+-------------------------------------------------+
1256 |billingAccountNumber     |String            |billingAccountNumber of the request              |
1257 +-------------------------+------------------+-------------------------------------------------+
1258 |callbackUrl              |String            |callbackUrl of the request                       |
1259 +-------------------------+------------------+-------------------------------------------------+
1260 |correlator               |String            |correlator of the request                        |
1261 +-------------------------+------------------+-------------------------------------------------+
1262 |orderNumber              |String            |orderNumber of the request                       |
1263 +-------------------------+------------------+-------------------------------------------------+
1264 |productFamilyId          |String            |productFamilyId of the request                   |
1265 +-------------------------+------------------+-------------------------------------------------+
1266 |orderVersion             |String            |orderVersion of the request                      |
1267 +-------------------------+------------------+-------------------------------------------------+
1268 |instanceName             |String            |instanceName of the request                      |
1269 +-------------------------+------------------+-------------------------------------------------+
1270 |suppressRollback         |String            |suppressRollback of the request                  |
1271 +-------------------------+------------------+-------------------------------------------------+
1272 |requestorId              |String            |requestorId of the request                       |
1273 +-------------------------+------------------+-------------------------------------------------+
1274
1275 RequestParameters Object
1276
1277 +-------------------------+------------------+-------------------------------------------------+
1278 |Attribute                |Content           |Description                                      |
1279 +=========================+==================+=================================================+
1280 |SubscriptionServiceType  |String            |The service type of the Subscription             |
1281 +-------------------------+------------------+-------------------------------------------------+
1282
1283 RequestStatus Object
1284
1285 +-------------------------+------------------+-------------------------------------------------+
1286 |Attribute                |Content           |Description                                      |
1287 +=========================+==================+=================================================+
1288 |finishTime               |String            |Time                                             |
1289 +-------------------------+------------------+-------------------------------------------------+
1290 |requestState             |String            |state of the request                             |
1291 +-------------------------+------------------+-------------------------------------------------+
1292 |statusMessage            |String            |statusMessage                                    |
1293 +-------------------------+------------------+-------------------------------------------------+
1294 |percentProgress          |String            |percentage of progress                           |
1295 +-------------------------+------------------+-------------------------------------------------+