docs/SO_R1_Interface.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 2017 Huawei Technologies Co., Ltd.
   4
   5 SO Amsterdam Interfaces
   6 ================
   7
   8 .. image:: images/SO_R1_1.png
   9
  10 SO APIs
  11 ============
  12
  13 North Bound APIs
  14 ----------------
  15 Create service instance
  16 ++++++++++++++++++++++++
  17
  18 +--------------------+-------------------------------------+
  19 |Interface Definition|Description                          |
  20 +====================+=====================================+
  21 |URI                 |{serverRoot}/serviceInstances/v4     |
  22 +--------------------+-------------------------------------+
  23 |Operation Type      |POST                                 |
  24 +--------------------+-------------------------------------+
  25 |Content-Type        |application/json                     |
  26 +--------------------+-------------------------------------+
  27
  28 Request Body:
  29
  30 +----------------+---------+-----------+--------------------------+-------------------------------------------+
  31 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
  32 +================+=========+===========+==========================+===========================================+
  33 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
  34 +----------------+---------+-----------+--------------------------+-------------------------------------------+
  35
  36 RequestDetails Object
  37
  38 +-------------------+--------------------------+-------------------------------------------------+
  39 |Attribute          |Content                   |Description                                      |
  40 +===================+==========================+=================================================+
  41 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
  42 +-------------------+--------------------------+-------------------------------------------------+
  43 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
  44 +-------------------+--------------------------+-------------------------------------------------+
  45 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
  46 +-------------------+--------------------------+-------------------------------------------------+
  47 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
  48 +-------------------+--------------------------+-------------------------------------------------+
  49 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
  50 +-------------------+--------------------------+-------------------------------------------------+
  51 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
  52 +-------------------+--------------------------+-------------------------------------------------+
  53 |project            |project Object            |Content of project object.                       |
  54 +-------------------+--------------------------+-------------------------------------------------+
  55 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
  56 +-------------------+--------------------------+-------------------------------------------------+
  57 |platform           |platform Object           |Content of platform object.                      |
  58 +-------------------+--------------------------+-------------------------------------------------+
  59 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
  60 +-------------------+--------------------------+-------------------------------------------------+
  61
  62 ModelInfo Object
  63
  64 +-------------------------+------------------+-------------------------------------------------+
  65 |Attribute                |Content           |Description                                      |
  66 +=========================+==================+=================================================+
  67 |ModelType                |String            |Type of model                                    |
  68 +-------------------------+------------------+-------------------------------------------------+
  69 |ModelInvariantId         |String            |The Model Invariant Id.                          |
  70 +-------------------------+------------------+-------------------------------------------------+
  71 |ModelNameVersionId       |String            |The modelname Version Id                         |
  72 +-------------------------+------------------+-------------------------------------------------+
  73 |ModelName                |String            |Name of the Model                                |
  74 +-------------------------+------------------+-------------------------------------------------+
  75 |ModelVersion             |String            |Version of the model                             |
  76 +-------------------------+------------------+-------------------------------------------------+
  77 |ModelCustomization Name  |String            |The Model Customization name                     |
  78 +-------------------------+------------------+-------------------------------------------------+
  79 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
  80 +-------------------------+------------------+-------------------------------------------------+
  81 |modelVersionId           |String            |The Model version id                             |
  82 +-------------------------+------------------+-------------------------------------------------+
  83 |modelUuid                |String            |The Model UUid                                   |
  84 +-------------------------+------------------+-------------------------------------------------+
  85 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
  86 +-------------------------+------------------+-------------------------------------------------+
  87 |modelInstanceName        |String            |The Model Instance  name                         |
  88 +-------------------------+------------------+-------------------------------------------------+
  89
  90
  91 SubscriberInfo Object
  92
  93 +-------------------------+------------------+-------------------------------------------------+
  94 |Attribute                |Content           |Description                                      |
  95 +=========================+==================+=================================================+
  96 |GlobalSubscriberId       |String            |Global customer Id (in A&AI)                     |
  97 +-------------------------+------------------+-------------------------------------------------+
  98 |SubscriberName           |String            |Name of the Subscriber                           |
  99 +-------------------------+------------------+-------------------------------------------------+
 100
 101 RequestInfo Object
 102
 103 +-------------------------+------------------+-------------------------------------------------+
 104 |Attribute                |Content           |Description                                      |
 105 +=========================+==================+=================================================+
 106 |Source                   |String            |source of the request                            |
 107 +-------------------------+------------------+-------------------------------------------------+
 108 |billingAccountNumber     |String            |billingAccountNumber of the request              |
 109 +-------------------------+------------------+-------------------------------------------------+
 110 |callbackUrl              |String            |callbackUrl of the request                       |
 111 +-------------------------+------------------+-------------------------------------------------+
 112 |correlator               |String            |correlator of the request                        |
 113 +-------------------------+------------------+-------------------------------------------------+
 114 |orderNumber              |String            |orderNumber of the request                       |
 115 +-------------------------+------------------+-------------------------------------------------+
 116 |productFamilyId          |String            |productFamilyId of the request                   |
 117 +-------------------------+------------------+-------------------------------------------------+
 118 |orderVersion             |String            |orderVersion of the request                      |
 119 +-------------------------+------------------+-------------------------------------------------+
 120 |instanceName             |String            |instanceName of the request                      |
 121 +-------------------------+------------------+-------------------------------------------------+
 122 |suppressRollback         |String            |suppressRollback of the request                  |
 123 +-------------------------+------------------+-------------------------------------------------+
 124 |requestorId              |String            |requestorId of the request                       |
 125 +-------------------------+------------------+-------------------------------------------------+
 126
 127 RequestParameters Object
 128
 129 +-------------------------+------------------+-------------------------------------------------+
 130 |Attribute                |Content           |Description                                      |
 131 +=========================+==================+=================================================+
 132 |SubscriptionServiceType  |String            |The service type of the Subscription             |
 133 +-------------------------+------------------+-------------------------------------------------+
 134 |UserParams               |Array             |The product family Id.                           |
 135 +-------------------------+------------------+-------------------------------------------------+
 136 |aLaCarte                 |Boolean           | aLaCarte                                        |
 137 +-------------------------+------------------+-------------------------------------------------+
 138 |autoBuildVfModules       |Boolean           |autoBuildVfModules                               |
 139 +-------------------------+------------------+-------------------------------------------------+
 140 |cascadeDelete            |Boolean           |cascadeDelete                                    |
 141 +-------------------------+------------------+-------------------------------------------------+
 142 |usePreload               |Boolean           |usePreload                                       |
 143 +-------------------------+------------------+-------------------------------------------------+
 144 |rebuildVolumeGroups      |Boolean           |rebuildVolumeGroups                              |
 145 +-------------------------+------------------+-------------------------------------------------+
 146 |payload                  |String            |payload                                          |
 147 +-------------------------+------------------+-------------------------------------------------+
 148 |controllerType           |String            |controllerType                                   |
 149 +-------------------------+------------------+-------------------------------------------------+
 150
 151 UserParams Object
 152
 153 +-------------------------+------------------+-------------------------------------------------+
 154 |Attribute                |Content           |Description                                      |
 155 +=========================+==================+=================================================+
 156 |name                     |String            |Tag name of attribute                            |
 157 +-------------------------+------------------+-------------------------------------------------+
 158 |value                    |String            |Value of the tag                                 |
 159 +-------------------------+------------------+-------------------------------------------------+
 160
 161 CloudConfiguration Object
 162
 163 +-------------------------+------------------+-------------------------------------------------+
 164 |Attribute                |Content           |Description                                      |
 165 +=========================+==================+=================================================+
 166 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 167 +-------------------------+------------------+-------------------------------------------------+
 168 |tenantId                 |String            |Name of the Subscriber                           |
 169 +-------------------------+------------------+-------------------------------------------------+
 170 |aicNodeClli              |String            |aicNodeClli property                             |
 171 +-------------------------+------------------+-------------------------------------------------+
 172
 173 Project Object
 174
 175 +-------------------------+------------------+-------------------------------------------------+
 176 |Attribute                |Content           |Description                                      |
 177 +=========================+==================+=================================================+
 178 |projectName              |String            |Name of the project                              |
 179 +-------------------------+------------------+-------------------------------------------------+
 180
 181 OwningEntity Object
 182
 183 +-------------------------+------------------+-------------------------------------------------+
 184 |Attribute                |Content           |Description                                      |
 185 +=========================+==================+=================================================+
 186 |owningEntityId           |String            |owningEntityId of the owingEntity                |
 187 +-------------------------+------------------+-------------------------------------------------+
 188 |owningEntityName         |String            |owningEntityName of the owingEntity              |
 189 +-------------------------+------------------+-------------------------------------------------+
 190
 191 Platform Object
 192
 193 +-------------------------+------------------+-------------------------------------------------+
 194 |Attribute                |Content           |Description                                      |
 195 +=========================+==================+=================================================+
 196 |platformName             |String            |Platform Name                                    |
 197 +-------------------------+------------------+-------------------------------------------------+
 198
 199 LineOfBusiness Object
 200
 201 +-------------------------+------------------+-------------------------------------------------+
 202 |Attribute                |Content           |Description                                      |
 203 +=========================+==================+=================================================+
 204 |lineOfBusinessName       |String            |Line Of Business Name                            |
 205 +-------------------------+------------------+-------------------------------------------------+
 206
 207 Delete service instance
 208 ++++++++++++++++++++++++
 209
 210 +--------------------+---------------------------------------------------------+
 211 |Interface Definition|Description                                              |
 212 +====================+=========================================================+
 213 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}     |
 214 +--------------------+---------------------------------------------------------+
 215 |Operation Type      |DELETE                                                   |
 216 +--------------------+---------------------------------------------------------+
 217 |Content-Type        |application/json                                         |
 218 +--------------------+---------------------------------------------------------+
 219
 220 Request Body:
 221
 222 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 223 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 224 +================+=========+===========+==========================+===========================================+
 225 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 226 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 227
 228 RequestDetails Object
 229
 230 +-------------------+-------------------------+-------------------------------------------------+
 231 |Attribute          |Content                  |Description                                      |
 232 +===================+=========================+=================================================+
 233 |modelInfo          |modelInfo Object         |Content of modelInfo object.                     |
 234 +-------------------+-------------------------+-------------------------------------------------+
 235 |requestInfo        |requestInfo Object       |Content of requestInfo object.                   |
 236 +-------------------+-------------------------+-------------------------------------------------+
 237
 238 ModelInfo Object
 239
 240 +-------------------------+------------------+-------------------------------------------------+
 241 |Attribute                |Content           |Description                                      |
 242 +=========================+==================+=================================================+
 243 |ModelType                |String            |Type of model                                    |
 244 +-------------------------+------------------+-------------------------------------------------+
 245 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 246 +-------------------------+------------------+-------------------------------------------------+
 247 |ModelName                |String            |Name of the Model                                |
 248 +-------------------------+------------------+-------------------------------------------------+
 249 |ModelVersion             |String            |Version of the model                             |
 250 +-------------------------+------------------+-------------------------------------------------+
 251
 252 RequestInfo Object
 253
 254 +-------------------------+------------------+-------------------------------------------------+
 255 |Attribute                |Content           |Description                                      |
 256 +=========================+==================+=================================================+
 257 |Source                   |String            |source of the request                            |
 258 +-------------------------+------------------+-------------------------------------------------+
 259
 260 Create Volume Group
 261 ++++++++++++++++++++++++
 262
 263 +--------------------+-------------------------------------------------------------------------------------------+
 264 |Interface Definition|Description                                                                                |
 265 +====================+===========================================================================================+
 266 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups     |
 267 +--------------------+-------------------------------------------------------------------------------------------+
 268 |Operation Type      |POST                                                                                       |
 269 +--------------------+-------------------------------------------------------------------------------------------+
 270 |Content-Type        |application/json                                                                           |
 271 +--------------------+-------------------------------------------------------------------------------------------+
 272
 273 Request Body:
 274
 275 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 276 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 277 +================+=========+===========+==========================+===========================================+
 278 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 279 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 280
 281 RequestDetails Object
 282
 283 +-------------------+--------------------------+-------------------------------------------------+
 284 |Attribute          |Content                   |Description                                      |
 285 +===================+==========================+=================================================+
 286 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
 287 +-------------------+--------------------------+-------------------------------------------------+
 288 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
 289 +-------------------+--------------------------+-------------------------------------------------+
 290 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
 291 +-------------------+--------------------------+-------------------------------------------------+
 292 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
 293 +-------------------+--------------------------+-------------------------------------------------+
 294 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
 295 +-------------------+--------------------------+-------------------------------------------------+
 296 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
 297 +-------------------+--------------------------+-------------------------------------------------+
 298 |project            |project Object            |Content of project object.                       |
 299 +-------------------+--------------------------+-------------------------------------------------+
 300 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
 301 +-------------------+--------------------------+-------------------------------------------------+
 302 |platform           |platform Object           |Content of platform object.                      |
 303 +-------------------+--------------------------+-------------------------------------------------+
 304 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
 305 +-------------------+--------------------------+-------------------------------------------------+
 306
 307 ModelInfo Object
 308
 309 +-------------------------+------------------+-------------------------------------------------+
 310 |Attribute                |Content           |Description                                      |
 311 +=========================+==================+=================================================+
 312 |ModelType                |String            |Type of model                                    |
 313 +-------------------------+------------------+-------------------------------------------------+
 314 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 315 +-------------------------+------------------+-------------------------------------------------+
 316 |ModelNameVersionId       |String            |The modelname Version Id                         |
 317 +-------------------------+------------------+-------------------------------------------------+
 318 |ModelName                |String            |Name of the Model                                |
 319 +-------------------------+------------------+-------------------------------------------------+
 320 |ModelVersion             |String            |Version of the model                             |
 321 +-------------------------+------------------+-------------------------------------------------+
 322 |ModelCustomization Name  |String            |The Model Customization name                     |
 323 +-------------------------+------------------+-------------------------------------------------+
 324 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
 325 +-------------------------+------------------+-------------------------------------------------+
 326 |modelVersionId           |String            |The Model version id                             |
 327 +-------------------------+------------------+-------------------------------------------------+
 328 |modelUuid                |String            |The Model UUid                                   |
 329 +-------------------------+------------------+-------------------------------------------------+
 330 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
 331 +-------------------------+------------------+-------------------------------------------------+
 332 |modelInstanceName        |String            |The Model Instance  name                         |
 333 +-------------------------+------------------+-------------------------------------------------+
 334
 335 CloudConfiguration Object
 336
 337 +-------------------------+------------------+-------------------------------------------------+
 338 |Attribute                |Content           |Description                                      |
 339 +=========================+==================+=================================================+
 340 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 341 +-------------------------+------------------+-------------------------------------------------+
 342 |tenantId                 |String            |Name of the Subscriber                           |
 343 +-------------------------+------------------+-------------------------------------------------+
 344 |aicNodeClli              |String            |aicNodeClli property                             |
 345 +-------------------------+------------------+-------------------------------------------------+
 346
 347 RequestInfo Object
 348
 349 +-------------------------+------------------+-------------------------------------------------+
 350 |Attribute                |Content           |Description                                      |
 351 +=========================+==================+=================================================+
 352 |Source                   |String            |source of the request                            |
 353 +-------------------------+------------------+-------------------------------------------------+
 354 |billingAccountNumber     |String            |billingAccountNumber of the request              |
 355 +-------------------------+------------------+-------------------------------------------------+
 356 |callbackUrl              |String            |callbackUrl of the request                       |
 357 +-------------------------+------------------+-------------------------------------------------+
 358 |correlator               |String            |correlator of the request                        |
 359 +-------------------------+------------------+-------------------------------------------------+
 360 |orderNumber              |String            |orderNumber of the request                       |
 361 +-------------------------+------------------+-------------------------------------------------+
 362 |productFamilyId          |String            |productFamilyId of the request                   |
 363 +-------------------------+------------------+-------------------------------------------------+
 364 |orderVersion             |String            |orderVersion of the request                      |
 365 +-------------------------+------------------+-------------------------------------------------+
 366 |instanceName             |String            |instanceName of the request                      |
 367 +-------------------------+------------------+-------------------------------------------------+
 368 |suppressRollback         |String            |suppressRollback of the request                  |
 369 +-------------------------+------------------+-------------------------------------------------+
 370 |requestorId              |String            |requestorId of the request                       |
 371 +-------------------------+------------------+-------------------------------------------------+
 372
 373 relatedInstance List
 374
 375 +-------------------------+------------------+-------------------------------------------------+
 376 |Attribute                |Content           |Description                                      |
 377 +=========================+==================+=================================================+
 378 |relatedInstance          |Object            |relatedInstance Object                           |
 379 +-------------------------+------------------+-------------------------------------------------+
 380
 381 relatedInstance List
 382
 383 +-------------------------+------------------+-------------------------------------------------+
 384 |Attribute                |Content           |Description                                      |
 385 +=========================+==================+=================================================+
 386 |instanceId               |String            |instanceId                                       |
 387 +-------------------------+------------------+-------------------------------------------------+
 388 |modelInfo                |Object            |Content of modelInfo object.                     |
 389 +-------------------------+------------------+-------------------------------------------------+
 390
 391 Delete Volume Group
 392 ++++++++++++++++++++++++
 393
 394 +--------------------+---------------------------------------------------------------------------------------------------------------------+
 395 |Interface Definition|Description                                                                                                          |
 396 +====================+=====================================================================================================================+
 397 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id}     |
 398 +--------------------+---------------------------------------------------------------------------------------------------------------------+
 399 |Operation Type      |DELETE                                                                                                               |
 400 +--------------------+---------------------------------------------------------------------------------------------------------------------+
 401 |Content-Type        |application/json                                                                                                     |
 402 +--------------------+---------------------------------------------------------------------------------------------------------------------+
 403
 404 Request Body:
 405
 406 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 407 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 408 +================+=========+===========+==========================+===========================================+
 409 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 410 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 411
 412 RequestDetails Object
 413
 414 +---------------------+-------------------------+-------------------------------------------------+
 415 |Attribute            |Content                  |Description                                      |
 416 +=====================+=========================+=================================================+
 417 |modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
 418 +---------------------+-------------------------+-------------------------------------------------+
 419 |cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
 420 +---------------------+-------------------------+-------------------------------------------------+
 421 |requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
 422 +---------------------+-------------------------+-------------------------------------------------+
 423
 424 ModelInfo Object
 425
 426 +-------------------------+------------------+-------------------------------------------------+
 427 |Attribute                |Content           |Description                                      |
 428 +=========================+==================+=================================================+
 429 |ModelType                |String            |Type of model                                    |
 430 +-------------------------+------------------+-------------------------------------------------+
 431 |ModelName                |String            |Name of the Model                                |
 432 +-------------------------+------------------+-------------------------------------------------+
 433
 434 CloudConfiguration Object
 435
 436 +-------------------------+------------------+-------------------------------------------------+
 437 |Attribute                |Content           |Description                                      |
 438 +=========================+==================+=================================================+
 439 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 440 +-------------------------+------------------+-------------------------------------------------+
 441 |tenantId                 |String            |Name of the Subscriber                           |
 442 +-------------------------+------------------+-------------------------------------------------+
 443
 444 RequestInfo Object
 445
 446 +-------------------------+------------------+-------------------------------------------------+
 447 |Attribute                |Content           |Description                                      |
 448 +=========================+==================+=================================================+
 449 |Source                   |String            |source of the request                            |
 450 +-------------------------+------------------+-------------------------------------------------+
 451
 452 Create VF Module
 453 +++++++++++++++++
 454
 455 +--------------------+----------------------------------------------------------------------------------------+
 456 |Interface Definition|Description                                                                             |
 457 +====================+========================================================================================+
 458 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules     |
 459 +--------------------+----------------------------------------------------------------------------------------+
 460 |Operation Type      |POST                                                                                    |
 461 +--------------------+----------------------------------------------------------------------------------------+
 462 |Content-Type        |application/json                                                                        |
 463 +--------------------+----------------------------------------------------------------------------------------+
 464
 465 Request Body:
 466
 467 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 468 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 469 +================+=========+===========+==========================+===========================================+
 470 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 471 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 472
 473 RequestDetails Object
 474
 475 +---------------------+-------------------------+-------------------------------------------------+
 476 |Attribute            |Content                  |Description                                      |
 477 +=====================+=========================+=================================================+
 478 |modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
 479 +---------------------+-------------------------+-------------------------------------------------+
 480 |cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
 481 +---------------------+-------------------------+-------------------------------------------------+
 482 |requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
 483 +---------------------+-------------------------+-------------------------------------------------+
 484 |relatedInstanceList  |List                     |Content of relatedInstanceList.                  |
 485 +---------------------+-------------------------+-------------------------------------------------+
 486
 487 ModelInfo Object
 488
 489 +-------------------------+------------------+-------------------------------------------------+
 490 |Attribute                |Content           |Description                                      |
 491 +=========================+==================+=================================================+
 492 |ModelType                |String            |Type of model                                    |
 493 +-------------------------+------------------+-------------------------------------------------+
 494 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 495 +-------------------------+------------------+-------------------------------------------------+
 496 |ModelNameVersionId       |String            |The modelname Version Id                         |
 497 +-------------------------+------------------+-------------------------------------------------+
 498 |ModelName                |String            |Name of the Model                                |
 499 +-------------------------+------------------+-------------------------------------------------+
 500 |ModelVersion             |String            |Version of the model                             |
 501 +-------------------------+------------------+-------------------------------------------------+
 502 |ModelCustomization Name  |String            |The Model Customization name                     |
 503 +-------------------------+------------------+-------------------------------------------------+
 504
 505 CloudConfiguration Object
 506
 507 +-------------------------+------------------+-------------------------------------------------+
 508 |Attribute                |Content           |Description                                      |
 509 +=========================+==================+=================================================+
 510 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 511 +-------------------------+------------------+-------------------------------------------------+
 512 |tenantId                 |String            |Name of the Subscriber                           |
 513 +-------------------------+------------------+-------------------------------------------------+
 514
 515 RequestInfo Object
 516
 517 +-------------------------+------------------+-------------------------------------------------+
 518 |Attribute                |Content           |Description                                      |
 519 +=========================+==================+=================================================+
 520 |InstanceName             |String            |The instance Name                                |
 521 +-------------------------+------------------+-------------------------------------------------+
 522 |Source                   |String            |source of the request                            |
 523 +-------------------------+------------------+-------------------------------------------------+
 524 |SuppressRollback         |Boolean           |SuppressRollback                                 |
 525 +-------------------------+------------------+-------------------------------------------------+
 526
 527 relatedInstance List
 528
 529 +-------------------------+------------------+-------------------------------------------------+
 530 |Attribute                |Content           |Description                                      |
 531 +=========================+==================+=================================================+
 532 |relatedInstance          |Object            |relatedInstance Object                           |
 533 +-------------------------+------------------+-------------------------------------------------+
 534
 535 relatedInstance List
 536
 537 +-------------------------+------------------+-------------------------------------------------+
 538 |Attribute                |Content           |Description                                      |
 539 +=========================+==================+=================================================+
 540 |instanceId               |String            |instanceId                                       |
 541 +-------------------------+------------------+-------------------------------------------------+
 542 |modelInfo                |Object            |Content of modelInfo object.                     |
 543 +-------------------------+------------------+-------------------------------------------------+
 544 |instanceName             |String            |Name of the instance                             |
 545 +-------------------------+------------------+-------------------------------------------------+
 546
 547 Delete VF Module
 548 ++++++++++++++++++++++++
 549
 550 +--------------------+--------------------------------------------------------------------------------------------------------------+
 551 |Interface Definition|Description                                                                                                   |
 552 +====================+==============================================================================================================+
 553 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id}     |
 554 +--------------------+--------------------------------------------------------------------------------------------------------------+
 555 |Operation Type      |DELETE                                                                                                        |
 556 +--------------------+--------------------------------------------------------------------------------------------------------------+
 557 |Content-Type        |application/json                                                                                              |
 558 +--------------------+--------------------------------------------------------------------------------------------------------------+
 559
 560 Request Body:
 561
 562 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 563 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 564 +================+=========+===========+==========================+===========================================+
 565 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 566 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 567
 568 RequestDetails Object
 569
 570 +---------------------+-------------------------+-------------------------------------------------+
 571 |Attribute            |Content                  |Description                                      |
 572 +=====================+=========================+=================================================+
 573 |modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
 574 +---------------------+-------------------------+-------------------------------------------------+
 575 |cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
 576 +---------------------+-------------------------+-------------------------------------------------+
 577 |requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
 578 +---------------------+-------------------------+-------------------------------------------------+
 579
 580 ModelInfo Object
 581
 582 +-------------------------+------------------+-------------------------------------------------+
 583 |Attribute                |Content           |Description                                      |
 584 +=========================+==================+=================================================+
 585 |ModelType                |String            |Type of model                                    |
 586 +-------------------------+------------------+-------------------------------------------------+
 587 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 588 +-------------------------+------------------+-------------------------------------------------+
 589 |ModelNameVersionId       |String            |The modelname Version Id                         |
 590 +-------------------------+------------------+-------------------------------------------------+
 591 |ModelName                |String            |Name of the Model                                |
 592 +-------------------------+------------------+-------------------------------------------------+
 593 |ModelVersion             |String            |Version of the model                             |
 594 +-------------------------+------------------+-------------------------------------------------+
 595 |ModelCustomization Name  |String            |The Model Customization name                     |
 596 +-------------------------+------------------+-------------------------------------------------+
 597
 598 CloudConfiguration Object
 599
 600 +-------------------------+------------------+-------------------------------------------------+
 601 |Attribute                |Content           |Description                                      |
 602 +=========================+==================+=================================================+
 603 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 604 +-------------------------+------------------+-------------------------------------------------+
 605 |tenantId                 |String            |Name of the Subscriber                           |
 606 +-------------------------+------------------+-------------------------------------------------+
 607
 608 RequestInfo Object
 609
 610 +-------------------------+------------------+-------------------------------------------------+
 611 |Attribute                |Content           |Description                                      |
 612 +=========================+==================+=================================================+
 613 |Source                   |String            |source of the request                            |
 614 +-------------------------+------------------+-------------------------------------------------+
 615
 616 Create VNF
 617 +++++++++++++++
 618
 619 +--------------------+--------------------------------------------------------------+
 620 |Interface Definition|Description                                                   |
 621 +====================+==============================================================+
 622 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs     |
 623 +--------------------+--------------------------------------------------------------+
 624 |Operation Type      |POST                                                          |
 625 +--------------------+--------------------------------------------------------------+
 626 |Content-Type        |application/json                                              |
 627 +--------------------+--------------------------------------------------------------+
 628
 629 Request Body:
 630
 631 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 632 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 633 +================+=========+===========+==========================+===========================================+
 634 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 635 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 636
 637 RequestDetails Object
 638
 639 +-------------------+--------------------------+-------------------------------------------------+
 640 |Attribute          |Content                   |Description                                      |
 641 +===================+==========================+=================================================+
 642 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
 643 +-------------------+--------------------------+-------------------------------------------------+
 644 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
 645 +-------------------+--------------------------+-------------------------------------------------+
 646 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
 647 +-------------------+--------------------------+-------------------------------------------------+
 648 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
 649 +-------------------+--------------------------+-------------------------------------------------+
 650 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
 651 +-------------------+--------------------------+-------------------------------------------------+
 652 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
 653 +-------------------+--------------------------+-------------------------------------------------+
 654 |project            |project Object            |Content of project object.                       |
 655 +-------------------+--------------------------+-------------------------------------------------+
 656 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
 657 +-------------------+--------------------------+-------------------------------------------------+
 658 |platform           |platform Object           |Content of platform object.                      |
 659 +-------------------+--------------------------+-------------------------------------------------+
 660 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
 661 +-------------------+--------------------------+-------------------------------------------------+
 662
 663 ModelInfo Object
 664
 665 +-------------------------+------------------+-------------------------------------------------+
 666 |Attribute                |Content           |Description                                      |
 667 +=========================+==================+=================================================+
 668 |ModelType                |String            |Type of model                                    |
 669 +-------------------------+------------------+-------------------------------------------------+
 670 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 671 +-------------------------+------------------+-------------------------------------------------+
 672 |ModelNameVersionId       |String            |The modelname Version Id                         |
 673 +-------------------------+------------------+-------------------------------------------------+
 674 |ModelName                |String            |Name of the Model                                |
 675 +-------------------------+------------------+-------------------------------------------------+
 676 |ModelVersion             |String            |Version of the model                             |
 677 +-------------------------+------------------+-------------------------------------------------+
 678 |ModelCustomization Name  |String            |The Model Customization name                     |
 679 +-------------------------+------------------+-------------------------------------------------+
 680 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
 681 +-------------------------+------------------+-------------------------------------------------+
 682 |modelVersionId           |String            |The Model version id                             |
 683 +-------------------------+------------------+-------------------------------------------------+
 684 |modelUuid                |String            |The Model UUid                                   |
 685 +-------------------------+------------------+-------------------------------------------------+
 686 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
 687 +-------------------------+------------------+-------------------------------------------------+
 688 |modelInstanceName        |String            |The Model Instance  name                         |
 689 +-------------------------+------------------+-------------------------------------------------+
 690
 691 CloudConfiguration Object
 692
 693 +-------------------------+------------------+-------------------------------------------------+
 694 |Attribute                |Content           |Description                                      |
 695 +=========================+==================+=================================================+
 696 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 697 +-------------------------+------------------+-------------------------------------------------+
 698 |tenantId                 |String            |Name of the Subscriber                           |
 699 +-------------------------+------------------+-------------------------------------------------+
 700
 701 RequestInfo Object
 702
 703 +-------------------------+------------------+-------------------------------------------------+
 704 |Attribute                |Content           |Description                                      |
 705 +=========================+==================+=================================================+
 706 |Source                   |String            |source of the request                            |
 707 +-------------------------+------------------+-------------------------------------------------+
 708 |billingAccountNumber     |String            |billingAccountNumber of the request              |
 709 +-------------------------+------------------+-------------------------------------------------+
 710 |callbackUrl              |String            |callbackUrl of the request                       |
 711 +-------------------------+------------------+-------------------------------------------------+
 712 |correlator               |String            |correlator of the request                        |
 713 +-------------------------+------------------+-------------------------------------------------+
 714 |orderNumber              |String            |orderNumber of the request                       |
 715 +-------------------------+------------------+-------------------------------------------------+
 716 |productFamilyId          |String            |productFamilyId of the request                   |
 717 +-------------------------+------------------+-------------------------------------------------+
 718 |orderVersion             |String            |orderVersion of the request                      |
 719 +-------------------------+------------------+-------------------------------------------------+
 720 |instanceName             |String            |instanceName of the request                      |
 721 +-------------------------+------------------+-------------------------------------------------+
 722 |suppressRollback         |String            |suppressRollback of the request                  |
 723 +-------------------------+------------------+-------------------------------------------------+
 724 |requestorId              |String            |requestorId of the request                       |
 725 +-------------------------+------------------+-------------------------------------------------+
 726
 727 relatedInstance List
 728
 729 +-------------------------+------------------+-------------------------------------------------+
 730 |Attribute                |Content           |Description                                      |
 731 +=========================+==================+=================================================+
 732 |relatedInstance          |Object            |relatedInstance Object                           |
 733 +-------------------------+------------------+-------------------------------------------------+
 734
 735 relatedInstance List
 736
 737 +-------------------------+------------------+-------------------------------------------------+
 738 |Attribute                |Content           |Description                                      |
 739 +=========================+==================+=================================================+
 740 |instanceId               |String            |instanceId                                       |
 741 +-------------------------+------------------+-------------------------------------------------+
 742 |modelInfo                |Object            |Content of modelInfo object.                     |
 743 +-------------------------+------------------+-------------------------------------------------+
 744
 745 RequestParameters Object
 746
 747 +-------------------------+------------------+-------------------------------------------------+
 748 |Attribute                |Content           |Description                                      |
 749 +=========================+==================+=================================================+
 750 |UserParams               |Array             |The product family Id.                           |
 751 +-------------------------+------------------+-------------------------------------------------+
 752
 753 UserParams Object
 754
 755 +-------------------------+------------------+-------------------------------------------------+
 756 |Attribute                |Content           |Description                                      |
 757 +=========================+==================+=================================================+
 758 |name                     |String            |Tag name of attribute                            |
 759 +-------------------------+------------------+-------------------------------------------------+
 760 |value                    |String            |Value of the tag                                 |
 761 +-------------------------+------------------+-------------------------------------------------+
 762
 763 Delete VNF
 764 +++++++++++++++
 765
 766 +--------------------+------------------------------------------------------------------------------+
 767 |Interface Definition|Description                                                                   |
 768 +====================+==============================================================================+
 769 |URI                 |{serverRoot}/serviceInstances/v4/{serviceInstanceId}/vnfs/{vnfInstanceId}     |
 770 +--------------------+------------------------------------------------------------------------------+
 771 |Operation Type      |DELETE                                                                        |
 772 +--------------------+------------------------------------------------------------------------------+
 773 |Content-Type        |application/json                                                              |
 774 +--------------------+------------------------------------------------------------------------------+
 775
 776 Request Body:
 777
 778 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 779 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 780 +================+=========+===========+==========================+===========================================+
 781 |requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
 782 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 783
 784 RequestDetails Object
 785
 786 +---------------------+-------------------------+-------------------------------------------------+
 787 |Attribute            |Content                  |Description                                      |
 788 +=====================+=========================+=================================================+
 789 |modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
 790 +---------------------+-------------------------+-------------------------------------------------+
 791 |cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
 792 +---------------------+-------------------------+-------------------------------------------------+
 793 |requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
 794 +---------------------+-------------------------+-------------------------------------------------+
 795 |requestParameters    |requestParameters Object |Content of requestParameters object.             |
 796 +---------------------+-------------------------+-------------------------------------------------+
 797
 798 ModelInfo Object
 799
 800 +-------------------------+------------------+-------------------------------------------------+
 801 |Attribute                |Content           |Description                                      |
 802 +=========================+==================+=================================================+
 803 |ModelType                |String            |Type of model                                    |
 804 +-------------------------+------------------+-------------------------------------------------+
 805 |ModelName                |String            |Name of the Model                                |
 806 +-------------------------+------------------+-------------------------------------------------+
 807
 808 CloudConfiguration Object
 809
 810 +-------------------------+------------------+-------------------------------------------------+
 811 |Attribute                |Content           |Description                                      |
 812 +=========================+==================+=================================================+
 813 |lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
 814 +-------------------------+------------------+-------------------------------------------------+
 815 |tenantId                 |String            |Name of the Subscriber                           |
 816 +-------------------------+------------------+-------------------------------------------------+
 817
 818 RequestInfo Object
 819
 820 +-------------------------+------------------+-------------------------------------------------+
 821 |Attribute                |Content           |Description                                      |
 822 +=========================+==================+=================================================+
 823 |Source                   |String            |source of the request                            |
 824 +-------------------------+------------------+-------------------------------------------------+
 825
 826 RequestParameters Object
 827
 828 +-------------------------+------------------+-------------------------------------------------+
 829 |Attribute                |Content           |Description                                      |
 830 +=========================+==================+=================================================+
 831 |UserParams               |Array             |The product family Id.                           |
 832 +-------------------------+------------------+-------------------------------------------------+
 833
 834 UserParams Object
 835
 836 +-------------------------+------------------+-------------------------------------------------+
 837 |Attribute                |Content           |Description                                      |
 838 +=========================+==================+=================================================+
 839 |name                     |String            |Tag name of attribute                            |
 840 +-------------------------+------------------+-------------------------------------------------+
 841 |value                    |String            |Value of the tag                                 |
 842 +-------------------------+------------------+-------------------------------------------------+
 843
 844 GET Orchestration Request
 845 ++++++++++++++++++++++++++
 846
 847 +--------------------+--------------------------------------------------------------+
 848 |Interface Definition|Description                                                   |
 849 +====================+==============================================================+
 850 |URI                 |{serverRoot}/orchestrationRequests/v4/{request-id}            |
 851 +--------------------+--------------------------------------------------------------+
 852 |Operation Type      |GET                                                           |
 853 +--------------------+--------------------------------------------------------------+
 854 |Content-Type        |application/json                                              |
 855 +--------------------+--------------------------------------------------------------+
 856
 857 Response Body:
 858
 859 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 860 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
 861 +================+=========+===========+==========================+===========================================+
 862 |request         |M        |1          |request Object            |Content of request object.                 |
 863 +----------------+---------+-----------+--------------------------+-------------------------------------------+
 864
 865 Request Object
 866
 867 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 868 |Attribute          |Qualifier|Cardinality|Content                   |Description                                |
 869 +===================+=========+===========+==========================+===========================================+
 870 |requestId          |M        |1          |String                    |Request Id                                 |
 871 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 872 |startTime          |M        |1          |request Object            |Start time.                                |
 873 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 874 |requestScope       |M        |1          |request Object            |Scope of the request.                      |
 875 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 876 |requestType        |M        |1          |request Object            |Type of the request.                       |
 877 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 878 |requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
 879 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 880 |requestStatus      |M        |1          |requestStatus Object      |Type of the request.                       |
 881 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 882
 883 RequestDetails Object
 884
 885 +-------------------+--------------------------+-------------------------------------------------+
 886 |Attribute          |Content                   |Description                                      |
 887 +===================+==========================+=================================================+
 888 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
 889 +-------------------+--------------------------+-------------------------------------------------+
 890 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
 891 +-------------------+--------------------------+-------------------------------------------------+
 892 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
 893 +-------------------+--------------------------+-------------------------------------------------+
 894 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
 895 +-------------------+--------------------------+-------------------------------------------------+
 896 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
 897 +-------------------+--------------------------+-------------------------------------------------+
 898 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
 899 +-------------------+--------------------------+-------------------------------------------------+
 900 |project            |project Object            |Content of project object.                       |
 901 +-------------------+--------------------------+-------------------------------------------------+
 902 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
 903 +-------------------+--------------------------+-------------------------------------------------+
 904 |platform           |platform Object           |Content of platform object.                      |
 905 +-------------------+--------------------------+-------------------------------------------------+
 906 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
 907 +-------------------+--------------------------+-------------------------------------------------+
 908
 909 ModelInfo Object
 910
 911 +-------------------------+------------------+-------------------------------------------------+
 912 |Attribute                |Content           |Description                                      |
 913 +=========================+==================+=================================================+
 914 |ModelType                |String            |Type of model                                    |
 915 +-------------------------+------------------+-------------------------------------------------+
 916 |ModelInvariantId         |String            |The Model Invariant Id.                          |
 917 +-------------------------+------------------+-------------------------------------------------+
 918 |ModelNameVersionId       |String            |The modelname Version Id                         |
 919 +-------------------------+------------------+-------------------------------------------------+
 920 |ModelName                |String            |Name of the Model                                |
 921 +-------------------------+------------------+-------------------------------------------------+
 922 |ModelVersion             |String            |Version of the model                             |
 923 +-------------------------+------------------+-------------------------------------------------+
 924 |ModelCustomization Name  |String            |The Model Customization name                     |
 925 +-------------------------+------------------+-------------------------------------------------+
 926 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
 927 +-------------------------+------------------+-------------------------------------------------+
 928 |modelVersionId           |String            |The Model version id                             |
 929 +-------------------------+------------------+-------------------------------------------------+
 930 |modelUuid                |String            |The Model UUid                                   |
 931 +-------------------------+------------------+-------------------------------------------------+
 932 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
 933 +-------------------------+------------------+-------------------------------------------------+
 934 |modelInstanceName        |String            |The Model Instance  name                         |
 935 +-------------------------+------------------+-------------------------------------------------+
 936
 937 SubscriberInfo Object
 938
 939 +-------------------------+------------------+-------------------------------------------------+
 940 |Attribute                |Content           |Description                                      |
 941 +=========================+==================+=================================================+
 942 |GlobalSubscriberId       |String            |Global customer Id (in A&AI)                     |
 943 +-------------------------+------------------+-------------------------------------------------+
 944 |SubscriberName           |String            |Name of the Subscriber                           |
 945 +-------------------------+------------------+-------------------------------------------------+
 946
 947 RequestInfo Object
 948
 949 +-------------------------+------------------+-------------------------------------------------+
 950 |Attribute                |Content           |Description                                      |
 951 +=========================+==================+=================================================+
 952 |Source                   |String            |source of the request                            |
 953 +-------------------------+------------------+-------------------------------------------------+
 954 |billingAccountNumber     |String            |billingAccountNumber of the request              |
 955 +-------------------------+------------------+-------------------------------------------------+
 956 |callbackUrl              |String            |callbackUrl of the request                       |
 957 +-------------------------+------------------+-------------------------------------------------+
 958 |correlator               |String            |correlator of the request                        |
 959 +-------------------------+------------------+-------------------------------------------------+
 960 |orderNumber              |String            |orderNumber of the request                       |
 961 +-------------------------+------------------+-------------------------------------------------+
 962 |productFamilyId          |String            |productFamilyId of the request                   |
 963 +-------------------------+------------------+-------------------------------------------------+
 964 |orderVersion             |String            |orderVersion of the request                      |
 965 +-------------------------+------------------+-------------------------------------------------+
 966 |instanceName             |String            |instanceName of the request                      |
 967 +-------------------------+------------------+-------------------------------------------------+
 968 |suppressRollback         |String            |suppressRollback of the request                  |
 969 +-------------------------+------------------+-------------------------------------------------+
 970 |requestorId              |String            |requestorId of the request                       |
 971 +-------------------------+------------------+-------------------------------------------------+
 972
 973 RequestParameters Object
 974
 975 +-------------------------+------------------+-------------------------------------------------+
 976 |Attribute                |Content           |Description                                      |
 977 +=========================+==================+=================================================+
 978 |SubscriptionServiceType  |String            |The service type of the Subscription             |
 979 +-------------------------+------------------+-------------------------------------------------+
 980
 981 RequestStatus Object
 982
 983 +-------------------------+------------------+-------------------------------------------------+
 984 |Attribute                |Content           |Description                                      |
 985 +=========================+==================+=================================================+
 986 |finishTime               |String            |Time                                             |
 987 +-------------------------+------------------+-------------------------------------------------+
 988 |requestState             |String            |state of the request                             |
 989 +-------------------------+------------------+-------------------------------------------------+
 990 |statusMessage            |String            |statusMessage                                    |
 991 +-------------------------+------------------+-------------------------------------------------+
 992 |percentProgress          |String            |percentage of progress                           |
 993 +-------------------------+------------------+-------------------------------------------------+
 994
 995 GET Orchestration Requests
 996 ++++++++++++++++++++++++++
 997
 998 +--------------------+--------------------------------------------------------------+
 999 |Interface Definition|Description                                                   |
1000 +====================+==============================================================+
1001 |URI                 |{serverRoot}/orchestrationRequests/v4                         |
1002 +--------------------+--------------------------------------------------------------+
1003 |Operation Type      |GET                                                           |
1004 +--------------------+--------------------------------------------------------------+
1005 |Content-Type        |application/json                                              |
1006 +--------------------+--------------------------------------------------------------+
1007
1008 Response Body:
1009
1010 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1011 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
1012 +================+=========+===========+==========================+===========================================+
1013 |requestList     |M        |1          |Array                     |Content of request List.                   |
1014 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1015
1016 RequestList :
1017
1018 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1019 |Attribute       |Qualifier|Cardinality|Content                   |Description                                |
1020 +================+=========+===========+==========================+===========================================+
1021 |request         |M        |1          |request Object            |Content of request object.                 |
1022 +----------------+---------+-----------+--------------------------+-------------------------------------------+
1023
1024 Request Object
1025
1026 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1027 |Attribute          |Qualifier|Cardinality|Content                   |Description                                |
1028 +===================+=========+===========+==========================+===========================================+
1029 |requestId          |M        |1          |String                    |Request Id.                                 |
1030 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1031 |startTime          |M        |1          |request Object            |Start time.                                |
1032 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1033 |requestScope       |M        |1          |request Object            |Scope of the request.                      |
1034 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1035 |requestType        |M        |1          |request Object            |Type of the request.                       |
1036 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1037 |requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
1038 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1039 |requestStatus      |M        |1          |requestStatus Object      |Type of the request.                       |
1040 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
1041
1042 RequestDetails Object
1043
1044 +-------------------+--------------------------+-------------------------------------------------+
1045 |Attribute          |Content                   |Description                                      |
1046 +===================+==========================+=================================================+
1047 |modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
1048 +-------------------+--------------------------+-------------------------------------------------+
1049 |subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
1050 +-------------------+--------------------------+-------------------------------------------------+
1051 |requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
1052 +-------------------+--------------------------+-------------------------------------------------+
1053 |requestParameters  |requestParameters Object  |Content of requestParameters object.             |
1054 +-------------------+--------------------------+-------------------------------------------------+
1055 |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
1056 +-------------------+--------------------------+-------------------------------------------------+
1057 |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
1058 +-------------------+--------------------------+-------------------------------------------------+
1059 |project            |project Object            |Content of project object.                       |
1060 +-------------------+--------------------------+-------------------------------------------------+
1061 |owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
1062 +-------------------+--------------------------+-------------------------------------------------+
1063 |platform           |platform Object           |Content of platform object.                      |
1064 +-------------------+--------------------------+-------------------------------------------------+
1065 |lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
1066 +-------------------+--------------------------+-------------------------------------------------+
1067
1068 ModelInfo Object
1069
1070 +-------------------------+------------------+-------------------------------------------------+
1071 |Attribute                |Content           |Description                                      |
1072 +=========================+==================+=================================================+
1073 |ModelType                |String            |Type of model                                    |
1074 +-------------------------+------------------+-------------------------------------------------+
1075 |ModelInvariantId         |String            |The Model Invariant Id.                          |
1076 +-------------------------+------------------+-------------------------------------------------+
1077 |ModelNameVersionId       |String            |The modelname Version Id                         |
1078 +-------------------------+------------------+-------------------------------------------------+
1079 |ModelName                |String            |Name of the Model                                |
1080 +-------------------------+------------------+-------------------------------------------------+
1081 |ModelVersion             |String            |Version of the model                             |
1082 +-------------------------+------------------+-------------------------------------------------+
1083 |ModelCustomization Name  |String            |The Model Customization name                     |
1084 +-------------------------+------------------+-------------------------------------------------+
1085 |modelCustomizationUuid   |String            |The Model Customization UUid                     |
1086 +-------------------------+------------------+-------------------------------------------------+
1087 |modelVersionId           |String            |The Model version id                             |
1088 +-------------------------+------------------+-------------------------------------------------+
1089 |modelUuid                |String            |The Model UUid                                   |
1090 +-------------------------+------------------+-------------------------------------------------+
1091 |modelInvariantUuid       |String            |The Model Invariant  UUid                        |
1092 +-------------------------+------------------+-------------------------------------------------+
1093 |modelInstanceName        |String            |The Model Instance  name                         |
1094 +-------------------------+------------------+-------------------------------------------------+
1095
1096 SubscriberInfo Object
1097
1098 +-------------------------+------------------+-------------------------------------------------+
1099 |Attribute                |Content           |Description                                      |
1100 +=========================+==================+=================================================+
1101 |GlobalSubscriberId       |String            |Global customer Id (in A&AI)                     |
1102 +-------------------------+------------------+-------------------------------------------------+
1103 |SubscriberName           |String            |Name of the Subscriber                           |
1104 +-------------------------+------------------+-------------------------------------------------+
1105
1106 RequestInfo Object
1107
1108 +-------------------------+------------------+-------------------------------------------------+
1109 |Attribute                |Content           |Description                                      |
1110 +=========================+==================+=================================================+
1111 |Source                   |String            |source of the request                            |
1112 +-------------------------+------------------+-------------------------------------------------+
1113 |billingAccountNumber     |String            |billingAccountNumber of the request              |
1114 +-------------------------+------------------+-------------------------------------------------+
1115 |callbackUrl              |String            |callbackUrl of the request                       |
1116 +-------------------------+------------------+-------------------------------------------------+
1117 |correlator               |String            |correlator of the request                        |
1118 +-------------------------+------------------+-------------------------------------------------+
1119 |orderNumber              |String            |orderNumber of the request                       |
1120 +-------------------------+------------------+-------------------------------------------------+
1121 |productFamilyId          |String            |productFamilyId of the request                   |
1122 +-------------------------+------------------+-------------------------------------------------+
1123 |orderVersion             |String            |orderVersion of the request                      |
1124 +-------------------------+------------------+-------------------------------------------------+
1125 |instanceName             |String            |instanceName of the request                      |
1126 +-------------------------+------------------+-------------------------------------------------+
1127 |suppressRollback         |String            |suppressRollback of the request                  |
1128 +-------------------------+------------------+-------------------------------------------------+
1129 |requestorId              |String            |requestorId of the request                       |
1130 +-------------------------+------------------+-------------------------------------------------+
1131
1132 RequestParameters Object
1133
1134 +-------------------------+------------------+-------------------------------------------------+
1135 |Attribute                |Content           |Description                                      |
1136 +=========================+==================+=================================================+
1137 |SubscriptionServiceType  |String            |The service type of the Subscription             |
1138 +-------------------------+------------------+-------------------------------------------------+
1139
1140 RequestStatus Object
1141
1142 +-------------------------+------------------+-------------------------------------------------+
1143 |Attribute                |Content           |Description                                      |
1144 +=========================+==================+=================================================+
1145 |finishTime               |String            |Time                                             |
1146 +-------------------------+------------------+-------------------------------------------------+
1147 |requestState             |String            |state of the request                             |
1148 +-------------------------+------------------+-------------------------------------------------+
1149 |statusMessage            |String            |statusMessage                                    |
1150 +-------------------------+------------------+-------------------------------------------------+
1151 |percentProgress          |String            |percentage of progress                           |
1152 +-------------------------+------------------+-------------------------------------------------+
1153
1154 SDC API
1155 --------
1156
1157 Get List of Existing Catalog Assets
1158 +++++++++++++++++++++++++++++++++++
1159
1160 +--------------------+--------------------------+
1161 |Interface Definition|Description               |
1162 +====================+==========================+
1163 |URI                 |sdc/v1/catalog/{assetType}|
1164 +--------------------+--------------------------+
1165 |Operation Type      |GET                       |
1166 +--------------------+--------------------------+
1167
1168 Request Parameters:
1169
1170 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
1171 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
1172 +===================+=========+===========+=======+=============================================================+
1173 |assetType          |M        |1          |String |The requested asset type.valid values are resources/services.|
1174 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
1175 |service-type       |M        |1          |String |Service Type                                                 |
1176 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
1177 |service-instance-id|M        |1          |String |Service Instance ID                                          |
1178 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
1179
1180 Request Headers:
1181
1182 +-------------------+---------+-----------------------------------------------------------------------------------------+
1183 |Header Name        |Qualifier|Description                                                                              |
1184 +===================+=========+=========================================================================================+
1185 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1186 +-------------------+---------+-----------------------------------------------------------------------------------------+
1187 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1188 +-------------------+---------+-----------------------------------------------------------------------------------------+
1189 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1190 +-------------------+---------+-----------------------------------------------------------------------------------------+
1191 |Authorization      |Y        |Base64 encoded username:password                                                         |
1192 +-------------------+---------+-----------------------------------------------------------------------------------------+
1193
1194 Response:
1195
1196 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1197 |Attribute         |Qualifier|Cardinality|Content|Description                                                                           |
1198 +==================+=========+===========+=======+======================================================================================+
1199 |uuid              |M        |1          |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
1200 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1201 |invariantUUID     |M        |1          |String |UUID generated by SDC per each asset.                                                 |
1202 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1203 |name              |M        |1          |String |The name of the asset                                                                 |
1204 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1205 |version           |M        |1          |String |The asset version in SDC catalog.                                                     |
1206 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1207 |toscaModelURL     |M        |1          |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR.    |
1208 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1209 |category          |M        |1          |String |Category of the asset.                                                                |
1210 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1211 |subcategory       |M        |1          |String |Sub-category of the asset                                                             |
1212 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1213 |resourceType      |M        |1          |String |The type of resource.resource types are VF, VL, CP, VFC, VFCMT, PNF.                  |
1214 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1215 |lifecycleState    |M        |1          |String |The lifecycle state of the asset                                                      |
1216 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1217 |lastUpdaterUserId |M        |1          |String |UserID of the SDC designer who was the last to update the asset for this major version|
1218 +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
1219
1220 Get Specific Asset Detailed Metadata
1221 ++++++++++++++++++++++++++++++++++++
1222
1223 +--------------------+-------------------------------------------+
1224 |Interface Definition|Description                                |
1225 +====================+===========================================+
1226 |URI                 |/sdc/v1/catalog/{assetType}/{uuid}/metadata|
1227 +--------------------+-------------------------------------------+
1228 |Operation Type      |GET                                        |
1229 +--------------------+-------------------------------------------+
1230
1231 Request Parameters:
1232
1233 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1234 |Attribute          |Qualifier|Cardinality|Content|Description                                                                          |
1235 +===================+=========+===========+=======+=====================================================================================+
1236 |assetType          |M        |1          |String |The requested asset type.valid values are resources/services.                        |
1237 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1238 |uuid               |M        |1          |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset.|
1239 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1240
1241 Request Headers:
1242
1243 +-------------------+---------+-----------------------------------------------------------------------------------------+
1244 |Header Name        |Qualifier|Description                                                                              |
1245 +===================+=========+=========================================================================================+
1246 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1247 +-------------------+---------+-----------------------------------------------------------------------------------------+
1248 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1249 +-------------------+---------+-----------------------------------------------------------------------------------------+
1250 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1251 +-------------------+---------+-----------------------------------------------------------------------------------------+
1252 |Authorization      |Y        |Base64 encoded username:password                                                         |
1253 +-------------------+---------+-----------------------------------------------------------------------------------------+
1254
1255 Response:
1256
1257 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1258 |Attribute           |Qualifier|Content|Description                                                                           |
1259 +====================+=========+=======+======================================================================================+
1260 |uuid                |M        |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
1261 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1262 |invariantUUID       |M        |String |UUID generated by SDC per each asset.                                                 |
1263 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1264 |name                |M        |String |The name of the asset                                                                 |
1265 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1266 |version             |M        |String |The asset version in SDC catalog.                                                     |
1267 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1268 |toscaModelURL       |M        |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR.    |
1269 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1270 |description         |M        |String |Short description of the resource                                                     |
1271 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1272 |lastUpdaterUserId   |M        |String |UserID of the SDC designer who was the last to update the asset for this major version|
1273 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1274 |lastUpdaterFullName |M        |String |UserID of the SDC designer who was the last to update the asset for this major version|
1275 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1276 |category            |M        |String |Category of the asset                                                                 |
1277 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1278 |subCategory         |M        |String |Sub-category of the asset.                                                            |
1279 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1280 |toscaResourceName   |M        |String |The full name of the asset                                                            |
1281 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1282 |resourceType        |M        |String |The type of resource.                                                                 |
1283 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1284 |lifecycleState      |M        |String |The lifecycle state of the asset                                                      |
1285 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1286 |resources           |N        |Object |Category of the asset                                                                 |
1287 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1288 |artifacts           |M        |Object |Category of the asset                                                                 |
1289 +--------------------+---------+-------+--------------------------------------------------------------------------------------+
1290
1291 Resource Object:
1292
1293 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1294 |Attribute            |Qualifier|Content|Description                                                                                                        |                                                                         |
1295 +=====================+=========+=======+===================================================================================================================+
1296 |resourceInstanceName |M        |String |Logical Resource Instance Name.Unique Identifier of  the instance of the  specific resource in the service context.|
1297 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1298 |resourceName         |M        |String |Resource Name                                                                                                      |
1299 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1300 |resourceInvariantUUID|M        |String |The invariant UUID of the resource                                                                                 |
1301 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1302 |resourceVersion      |M        |String |Resource Version                                                                                                   |
1303 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1304 |resoucreType         |M        |String |Resource Type                                                                                                      |
1305 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1306 |resourceUUID         |M        |String |Global UUID of the resource that specific artifact belongs to                                                      |
1307 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1308 |artifacts            |M        |Object |Array of  resource instance deployment artifacts.                                                                  |
1309 +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
1310
1311 Artifact Metadata Object:
1312
1313 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1314 |Attribute            |Qualifier|Content |Description                                                                                                        |
1315 +=====================+=========+========+===================================================================================================================+
1316 |artifactName         |M        |String  |Artifact File name                                                                                                 |
1317 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1318 |artifactLabel        |M        |String  |Identifier of the artifact within the VF / Service.                                                                |
1319 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1320 |artifactType         |M        |String  |Artifact Type                                                                                                      |
1321 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1322 |artifactGroupType    |M        |String  |Whether the artifact is informational or deployment.                                                               |
1323 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1324 |artifactURL          |M        |String  |Relative artifact’s URL.                                                                                           |
1325 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1326 |artifactDescription  |M        |String  |Artifact Description                                                                                               |
1327 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1328 |artifactTimeout      |N        |Integer |Artifact Description                                                                                               |
1329 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1330 |artifactChecksum     |M        |String  |Base-64 encoded MD5 checksum of the artifact’s payload.                                                            |
1331 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1332 |artifactUUID         |M        |String  |Global UUID generated by SDC each time  when artifact payload is  updated.                                         |
1333 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1334 |artifactVersion      |M        |String  |Service Version                                                                                                    |
1335 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1336 |generatedFromUUID    |N        |String  |This attribute will be  sent only  in the case of  an artifact  generated on basis of  other artifact              |
1337 +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
1338
1339 Download (CSAR of) Specific Asset
1340 +++++++++++++++++++++++++++++++++
1341
1342 +--------------------+-----------------------------------------------------------+
1343 |Interface Definition|Description                                                |
1344 +====================+===========================================================+
1345 |URI                 |/sdc/v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}|
1346 +--------------------+-----------------------------------------------------------+
1347 |Operation Type      |GET                                                        |
1348 +--------------------+-----------------------------------------------------------+
1349
1350 Request Parameters:
1351
1352 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1353 |Attribute          |Qualifier|Cardinality|Content|Description                                                                          |
1354 +===================+=========+===========+=======+=====================================================================================+
1355 |assetType          |M        |1          |String |The requested asset type.valid values are resources/services.                        |
1356 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1357 |Uuid               |M        |1          |String |The uuid of the asset as published in the metadata                                   |
1358 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1359 |artifactUUID       |M        |1          |String |The artifactUUID of the asset as published in the metadata                           |
1360 +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1361
1362 Response:
1363
1364 +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1365 |Header name         |Qualifier|Description                                                                                                               |
1366 +====================+=========+==========================================================================================================================+
1367 |Content-Type        |M        |Specifies the  downloaded payload format as “ arbitrary data in binary format” .Valid value is : application/octet-stream |
1368 +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1369 |Content-Length      |M        |Streamed artifact payload size                                                                                            |
1370 +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1371 |Content-Disposition |M        |Specifies  the name of  file to  store the  downloaded artifact’s  payload  ( RFC 2183) .                                 |
1372 +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
1373
1374 Upload Artifact
1375 +++++++++++++++
1376
1377 +--------------------+-----------------------------------------------------------------------------------------------+
1378 |Interface Definition|Description                                                                                    |
1379 +====================+===============================================================================================+
1380 |URI                 |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts|
1381 +--------------------+-----------------------------------------------------------------------------------------------+
1382 |Operation Type      |POST                                                                                           |
1383 +--------------------+-----------------------------------------------------------------------------------------------+
1384
1385 Request Parameters:
1386
1387 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1388 |Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
1389 +==============================+=========+===========+=======+=====================================================================================+
1390 |assetType                     |M        |1          |String |The requested asset type.valid values are resources/services.                        |
1391 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1392 |Uuid                          |M        |1          |String |The uuid of the asset as published in the metadata                                   |
1393 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1394 |resourceInstanceNormalizedName|M        |1          |String |Normalized name of resource                                                          |
1395 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1396
1397 Request Body
1398 ++++++++++++
1399
1400 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1401 |Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
1402 +==============================+=========+===========+=======+=====================================================================================+
1403 |payloadData                   |M        |1          |String |The data of the artifact after Base64 encoding                                       |
1404 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1405 |artifactLabel                 |M        |1          |String |Identifier of the artifact within the VF / Service.                                  |
1406 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1407 |artifactName                  |M        |1          |String |The name of the artifact                                                             |
1408 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1409 |artifactType                  |M        |1          |String |The type of the artifact                                                             |
1410 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1411 |artifactGroupType             |M        |1          |String |Whether the artifact is informational or deployment.                                 |
1412 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1413 |description                   |M        |1          |String |Description of the artifact                                                          |
1414 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1415
1416 Request Headers:
1417
1418 +-------------------+---------+-----------------------------------------------------------------------------------------+
1419 |Header Name        |Qualifier|Description                                                                              |
1420 +===================+=========+=========================================================================================+
1421 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1422 +-------------------+---------+-----------------------------------------------------------------------------------------+
1423 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1424 +-------------------+---------+-----------------------------------------------------------------------------------------+
1425 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1426 +-------------------+---------+-----------------------------------------------------------------------------------------+
1427 |Authorization      |Y        |Base64 encoded username:password                                                         |
1428 +-------------------+---------+-----------------------------------------------------------------------------------------+
1429 |USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
1430 +-------------------+---------+-----------------------------------------------------------------------------------------+
1431 |Content-Type       |Y        |Valid value is : application/json                                                        |
1432 +-------------------+---------+-----------------------------------------------------------------------------------------+
1433 |Content-MD5        |Y        |The value for this header must be the MD5 checksum over the whole json body              |
1434 +-------------------+---------+-----------------------------------------------------------------------------------------+
1435
1436 Response:
1437
1438 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1439 |Attribute           |Qualifier|Content|Description                                                                                        |
1440 +====================+=========+=======+===================================================================================================+
1441 |artifactName        |M        |String |Artifact File name                                                                                 |
1442 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1443 |artifactType        |M        |String |Artifact Type                                                                                      |
1444 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1445 |artifactURL         |M        |String |Relative artifact’s URL.                                                                           |
1446 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1447 |artifactDescription |M        |String |Artifact Description.                                                                              |
1448 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1449 |artifactTimeout     |N        |String |Will be populated only if its value is not 0.                                                      |
1450 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1451 |artifactChecksum    |Y        |String |Base-64 encoded MD5 checksum of the artifact’s payload.                                            |
1452 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1453 |artifactUUID        |Y        |String |Global UUID generated by SDC each time  when artifact payload is  updated.                         |
1454 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1455 |artifactVersion     |Y        |String |Service Version .                                                                                  |
1456 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1457 |generatedFromUUID   |N        |String |This attribute will be sent only  in the case of an artifact generated on basis of other artifact  |
1458 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1459
1460 Update Artifact
1461 +++++++++++++++
1462
1463 +--------------------+--------------------------------------------------------------------------------------------------------------+
1464 |Interface Definition|Description                                                                                                   |
1465 +====================+==============================================================================================================+
1466 |URI                 |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
1467 +--------------------+--------------------------------------------------------------------------------------------------------------+
1468 |Operation Type      |POST                                                                                                          |
1469 +--------------------+--------------------------------------------------------------------------------------------------------------+
1470
1471 Request Parameters:
1472
1473 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1474 |Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
1475 +==============================+=========+===========+=======+=====================================================================================+
1476 |assetType                     |M        |1          |String |The requested asset type.valid values are resources/services.                        |
1477 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1478 |Uuid                          |M        |1          |String |The uuid of the asset as published in the metadata                                   |
1479 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1480 |artifactUUID                  |M        |1          |String |The uuid of the artifact as published in the response of the upload/update operation |
1481 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1482 |resourceInstanceNormalizedName|M        |1          |String |Normalized name of resource                                                          |
1483 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1484
1485 Request Headers:
1486
1487 +-------------------+---------+-----------------------------------------------------------------------------------------+
1488 |Header Name        |Qualifier|Description                                                                              |
1489 +===================+=========+=========================================================================================+
1490 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1491 +-------------------+---------+-----------------------------------------------------------------------------------------+
1492 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1493 +-------------------+---------+-----------------------------------------------------------------------------------------+
1494 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1495 +-------------------+---------+-----------------------------------------------------------------------------------------+
1496 |Authorization      |Y        |Base64 encoded username:password                                                         |
1497 +-------------------+---------+-----------------------------------------------------------------------------------------+
1498 |USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
1499 +-------------------+---------+-----------------------------------------------------------------------------------------+
1500 |Content-Type       |Y        |Valid value is : application/json                                                        |
1501 +-------------------+---------+-----------------------------------------------------------------------------------------+
1502 |Content-MD5        |Y        |The value for this header must be the MD5 checksum over the whole json body              |
1503 +-------------------+---------+-----------------------------------------------------------------------------------------+
1504
1505 Request Body:
1506
1507 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1508 |Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
1509 +==============================+=========+===========+=======+=====================================================================================+
1510 |payloadData                   |M        |1          |String |The data of the artifact after Base64 encoding                                       |
1511 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1512 |artifactLabel                 |M        |1          |String |Identifier of the artifact within the VF / Service.                                  |
1513 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1514 |artifactName                  |M        |1          |String |The name of the artifact                                                             |
1515 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1516 |artifactType                  |M        |1          |String |The type of the artifact                                                             |
1517 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1518 |artifactGroupType             |M        |1          |String |Whether the artifact is informational or deployment.                                 |
1519 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1520 |description                   |M        |1          |String |Description of the artifact                                                          |
1521 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1522
1523 Response:
1524
1525 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1526 |Attribute           |Qualifier|Content|Description                                                                                        |
1527 +====================+=========+=======+===================================================================================================+
1528 |artifactName        |M        |String |Artifact File name                                                                                 |
1529 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1530 |artifactType        |M        |String |Artifact Type                                                                                      |
1531 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1532 |artifactURL         |M        |String |Relative artifact’s URL.                                                                           |
1533 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1534 |artifactDescription |M        |String |Artifact Description.                                                                              |
1535 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1536 |artifactTimeout     |N        |String |Will be populated only if its value is not 0.                                                      |
1537 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1538 |artifactChecksum    |Y        |String |Base-64 encoded MD5 checksum of the artifact’s payload.                                            |
1539 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1540 |artifactUUID        |Y        |String |Global UUID generated by SDC each time  when artifact payload is  updated.                         |
1541 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1542 |artifactVersion     |Y        |String |Service Version .                                                                                  |
1543 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1544 |generatedFromUUID   |N        |String |This attribute will be sent only  in the case of an artifact generated on basis of other artifact  |
1545 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1546
1547 Delete Artifact
1548 +++++++++++++++
1549
1550 +--------------------+--------------------------------------------------------------------------------------------------------------+
1551 |Interface Definition|Description                                                                                                   |
1552 +====================+==============================================================================================================+
1553 |URI                 |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
1554 +--------------------+--------------------------------------------------------------------------------------------------------------+
1555 |Operation Type      |DELETE                                                                                                        |
1556 +--------------------+--------------------------------------------------------------------------------------------------------------+
1557
1558 Request Parameters:
1559
1560 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1561 |Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
1562 +==============================+=========+===========+=======+=====================================================================================+
1563 |assetType                     |M        |1          |String |The requested asset type.valid values are resources/services.                        |
1564 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1565 |Uuid                          |M        |1          |String |The uuid of the asset as published in the metadata                                   |
1566 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1567 |artifactUUID                  |M        |1          |String |The uuid of the artifact as published in the response of the upload/update operation |
1568 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1569 |resourceInstanceNormalizedName|M        |1          |String |Normalized name of resource                                                          |
1570 +------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
1571
1572 Request Headers:
1573
1574 +-------------------+---------+-----------------------------------------------------------------------------------------+
1575 |Header Name        |Qualifier|Description                                                                              |
1576 +===================+=========+=========================================================================================+
1577 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1578 +-------------------+---------+-----------------------------------------------------------------------------------------+
1579 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1580 +-------------------+---------+-----------------------------------------------------------------------------------------+
1581 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1582 +-------------------+---------+-----------------------------------------------------------------------------------------+
1583 |Authorization      |Y        |Base64 encoded username:password                                                         |
1584 +-------------------+---------+-----------------------------------------------------------------------------------------+
1585 |USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
1586 +-------------------+---------+-----------------------------------------------------------------------------------------+
1587
1588 Response:
1589
1590 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1591 |Attribute           |Qualifier|Content|Description                                                                                        |
1592 +====================+=========+=======+===================================================================================================+
1593 |artifactUUID        |Y        |String |Global UUID generated by SDC each time  when artifact payload is  updated.                         |
1594 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1595
1596 Update Lifecycle
1597 ++++++++++++++++
1598
1599 +--------------------+--------------------------------------------------------------------------------------------------------------+
1600 |Interface Definition|Description                                                                                                   |
1601 +====================+==============================================================================================================+
1602 |URI                 |/sdc/v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation}                                        |
1603 +--------------------+--------------------------------------------------------------------------------------------------------------+
1604 |Operation Type      |POST                                                                                                          |
1605 +--------------------+--------------------------------------------------------------------------------------------------------------+
1606
1607 Request Parameters:
1608
1609 +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1610 |Attribute                     |Qualifier|Cardinality|Content|Description                                                                                          |
1611 +==============================+=========+===========+=======+=====================================================================================================+
1612 |assetType                     |M        |1          |String |The requested asset type.valid values are resources/services.                                        |
1613 +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1614 |Uuid                          |M        |1          |String |The uuid of the asset as published in the metadata                                                   |
1615 +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1616 |lifecycleOperation            |M        |1          |String |The lifecycle operation to be performed on the asset.Valid values are: Checkin / Checkout /  Certify |
1617 +------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
1618
1619 Request Headers:
1620
1621 +-------------------+---------+-----------------------------------------------------------------------------------------+
1622 |Header Name        |Qualifier|Description                                                                              |
1623 +===================+=========+=========================================================================================+
1624 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1625 +-------------------+---------+-----------------------------------------------------------------------------------------+
1626 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1627 +-------------------+---------+-----------------------------------------------------------------------------------------+
1628 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1629 +-------------------+---------+-----------------------------------------------------------------------------------------+
1630 |Authorization      |Y        |Base64 encoded username:password                                                         |
1631 +-------------------+---------+-----------------------------------------------------------------------------------------+
1632 |USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
1633 +-------------------+---------+-----------------------------------------------------------------------------------------+
1634
1635 Request Parameters:
1636
1637 +-------------------+---------+-----------------------------------------------------------------------------------------+
1638 |Attribute          |Qualifier|Description                                                                              |
1639 +===================+=========+=========================================================================================+
1640 |userRemarks        |N        |Short description (free text) about the asset version being changed                      |
1641 +-------------------+---------+-----------------------------------------------------------------------------------------+
1642
1643 Response:
1644
1645 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1646 |Attribute           |Qualifier|Content|Description                                                                                        |
1647 +====================+=========+=======+===================================================================================================+
1648 |uuid                |Y        |String |UUID generated by SDC per each major version of the asset                                          |
1649 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1650 |invariantUUID       |Y        |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions        |
1651 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1652 |name                |Y        |String |The name of the asset.                                                                             |
1653 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1654 |version             |Y        |String |The asset version in SDC catalog                                                                   |
1655 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1656 |category            |Y        |String |Category of the asset.                                                                             |
1657 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1658 |subcategory         |Y        |String |Sub-category of the asset.                                                                         |
1659 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1660 |resourceType        |Y        |String |The type of resource.                                                                              |
1661 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1662 |lifecycleState      |Y        |String |The lifecycle state of the asset.                                                                  |
1663 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1664 |lastUpdaterUserId   |Y        |String |User ID of the SDC designer who was the last to update the asset for this major version.           |
1665 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1666
1667 Create Resource
1668 +++++++++++++++
1669
1670 +--------------------+--------------------------------------------------------------------------------------------------------------+
1671 |Interface Definition|Description                                                                                                   |
1672 +====================+==============================================================================================================+
1673 |URI                 |/sdc/v1/catalog/resources                                                                                     |
1674 +--------------------+--------------------------------------------------------------------------------------------------------------+
1675 |Operation Type      |POST                                                                                                          |
1676 +--------------------+--------------------------------------------------------------------------------------------------------------+
1677
1678 Request Headers:
1679
1680 +-------------------+---------+-----------------------------------------------------------------------------------------+
1681 |Header Name        |Qualifier|Description                                                                              |
1682 +===================+=========+=========================================================================================+
1683 |X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
1684 +-------------------+---------+-----------------------------------------------------------------------------------------+
1685 |X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
1686 +-------------------+---------+-----------------------------------------------------------------------------------------+
1687 |Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
1688 +-------------------+---------+-----------------------------------------------------------------------------------------+
1689 |Authorization      |Y        |Base64 encoded username:password                                                         |
1690 +-------------------+---------+-----------------------------------------------------------------------------------------+
1691 |USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
1692 +-------------------+---------+-----------------------------------------------------------------------------------------+
1693 |Content-Type       |Y        |Valid value is : application/json                                                        |
1694 +-------------------+---------+-----------------------------------------------------------------------------------------+
1695
1696 Request Parameters:
1697
1698 +-------------------+---------+-----------------------------------------------------------------------------------------+
1699 |Attribute          |Qualifier|Description                                                                              |
1700 +===================+=========+=========================================================================================+
1701 |name               |Y        |The name of the resource                                                                 |
1702 +-------------------+---------+-----------------------------------------------------------------------------------------+
1703 |description        |Y        |Short description of the resource                                                        |
1704 +-------------------+---------+-----------------------------------------------------------------------------------------+
1705 |resourceType       |Y        |“VFCMT” / “VF” / “PNF”                                                                   |
1706 +-------------------+---------+-----------------------------------------------------------------------------------------+
1707 |category           |Y        |VFCMT category is “Template”.                                                            |
1708 +-------------------+---------+-----------------------------------------------------------------------------------------+
1709 |subcategory        |Y        |VFCMT subcategory is “Monitoring Template”.                                              |
1710 +-------------------+---------+-----------------------------------------------------------------------------------------+
1711 |vendorName         |Y        |Vendor Name                                                                              |
1712 +-------------------+---------+-----------------------------------------------------------------------------------------+
1713 |vendorRelease      |Y        |Vendor Release                                                                           |
1714 +-------------------+---------+-----------------------------------------------------------------------------------------+
1715 |tags               |Y        |The tags are used for search options.                                                    |
1716 +-------------------+---------+-----------------------------------------------------------------------------------------+
1717 |icon               |Y        |The icon should be pre-defined in SDC.                                                   |
1718 +-------------------+---------+-----------------------------------------------------------------------------------------+
1719 |contactId          |Y        |The user ID of user responsible for this VFCMT.                                          |
1720 +-------------------+---------+-----------------------------------------------------------------------------------------+
1721
1722 Response:
1723
1724 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1725 |Attribute           |Qualifier|Content|Description                                                                                        |
1726 +====================+=========+=======+===================================================================================================+
1727 |uuid                |Y        |String |UUID generated by SDC per each major version of the asset                                          |
1728 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1729 |invariantUUID       |Y        |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions        |
1730 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1731 |name                |Y        |String |The name of the asset.                                                                             |
1732 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1733 |version             |Y        |String |The asset version in SDC catalog                                                                   |
1734 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1735 |category            |Y        |String |Category of the asset.                                                                             |
1736 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1737 |subcategory         |Y        |String |Sub-category of the asset.                                                                         |
1738 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1739 |resourceType        |Y        |String |The type of resource.                                                                              |
1740 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1741 |lifecycleState      |Y        |String |The lifecycle state of the asset.                                                                  |
1742 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1743 |lastUpdaterUserId   |Y        |String |User ID of the SDC designer who was the last to update the asset for this major version.           |
1744 +--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
1745
1746 UUI API
1747 ----------------
1748 Create E2E service instance
1749 ++++++++++++++++++++++++++++
1750
1751 +--------------------+-------------------------------------+
1752 |Interface Definition|Description                          |
1753 +====================+=====================================+
1754 |URI                 |{serverRoot}/e2eServiceInstances/v3  |
1755 +--------------------+-------------------------------------+
1756 |Operation Type      |POST                                 |
1757 +--------------------+-------------------------------------+
1758 |Content-Type        |application/json                     |
1759 +--------------------+-------------------------------------+
1760
1761 Request Body:
1762
1763 +---------+---------+-----------+--------------------------+-----------------------------+
1764 |Attribute|Qualifier|Cardinality|Content                   |Description                  |
1765 +=========+=========+===========+==========================+=============================+
1766 |service  |M        |1          |Service Object            |Content of service object.   |
1767 +---------+---------+-----------+--------------------------+-----------------------------+
1768
1769 Service Object
1770
1771 +------------------------------+-----------------+------------------------------------+
1772 |Attribute                     |Content          |Description                         |
1773 +==============================+=================+====================================+
1774 |modelName                     |String           |Service instance name.              |
1775 +------------------------------+-----------------+------------------------------------+
1776 |description                   |String           |Service instance description        |
1777 +------------------------------+-----------------+------------------------------------+
1778 |modelUUID                     |String           |Model UUID                          |
1779 +------------------------------+-----------------+------------------------------------+
1780 |modelInvariantUUID            |String           |Model Invariant UUID                |
1781 +------------------------------+-----------------+------------------------------------+
1782 |created                       |Timestamp        |Cretaed Timestamp                   |
1783 +------------------------------+-----------------+------------------------------------+
1784 |toscaCsarArtifactUUID         |String           |tosca Csar Artifact UUID            |
1785 +------------------------------+-----------------+------------------------------------+
1786 |modelVersion                  |String           |Model Version                       |
1787 +------------------------------+-----------------+------------------------------------+
1788 |category                      |String           |category                            |
1789 +------------------------------+-----------------+------------------------------------+
1790 |serviceType                   |String           |service Type                        |
1791 +------------------------------+-----------------+------------------------------------+
1792 |serviceRole                   |String           |service Role                        |
1793 +------------------------------+-----------------+------------------------------------+
1794 |environmentContext            |String           |environment Context                 |
1795 +------------------------------+-----------------+------------------------------------+
1796 |workloadContext               |String           |workload Context                    |
1797 +------------------------------+-----------------+------------------------------------+
1798 |recipes                       |Object           |recipes                             |
1799 +------------------------------+-----------------+------------------------------------+
1800 |serviceResourceCustomizations |Object           |serviceResourceCustomizations       |
1801 +------------------------------+-----------------+------------------------------------+
1802
1803 Response:
1804
1805 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1806 |Attribute    |Qualifier|Cardinality|Content|Description                                                             |
1807 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1808 |serviceId    |M        |1          |String |Service instance ID.                                                    |
1809 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1810 |operationId  |M        |1          |String |Service Operation ID.                                                   |
1811 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1812
1813 Delete E2E service instance
1814 ++++++++++++++++++++++++++++
1815
1816 +--------------------+-----------------------------------------------+
1817 |Interface Definition|Description                                    |
1818 +====================+===============================================+
1819 |URI                 |{serverRoot}/e2eServiceInstances/v3/{serviceId}|
1820 +--------------------+-----------------------------------------------+
1821 |Operation Type      |DELETE                                         |
1822 +--------------------+-----------------------------------------------+
1823
1824 Request Parameters:
1825
1826 +-------------------+---------+-----------+-------+----------------------------------------+
1827 |Attribute          |Qualifier|Cardinality|Content|Description                             |
1828 +===================+=========+===========+=======+========================================+
1829 |globalSubscriberId |M        |1          |String |The subscriber id. It is defined in AAI |
1830 +-------------------+---------+-----------+-------+----------------------------------------+
1831 |serviceType        |M        |1          |String |The service type. It is defined in AAI  |
1832 +-------------------+---------+-----------+-------+----------------------------------------+
1833
1834 Response:
1835
1836 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1837 |Attribute    |Qualifier|Cardinality|Content|Description                                                             |
1838 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1839 |operationId  |M        |1          |String |The operation id.                                                       |
1840 +-------------+---------+-----------+-------+------------------------------------------------------------------------+
1841
1842 Query E2E service operation result
1843 ++++++++++++++++++++++++++
1844
1845 +--------------------+------------------------------------------------------------------------+
1846 |Interface Definition|Description                                                             |
1847 +====================+========================================================================+
1848 |URI                 |{serverRoot}/e2eServiceInstances/v3/{serviceId}/operations/{operationId}|
1849 +--------------------+------------------------------------------------------------------------+
1850 |Operation Type      |GET                                                                     |
1851 +--------------------+------------------------------------------------------------------------+
1852
1853 Request Parameters:
1854
1855 +--------------+---------+-----------+-------+--------------+
1856 |Attribute     |Qualifier|Cardinality|Content|Description   |
1857 +==============+=========+===========+=======+==============+
1858 |serviceId     |M        |1          |Service instance ID.  |
1859 +--------------+---------+-----------+-------+--------------+
1860 |operationId   |M        |1          |Service Operation ID. |
1861 +--------------+---------+-----------+-------+--------------+
1862
1863 Response:
1864
1865 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1866 |Attribute         |Qualifier|Cardinality|Content|Description                                                             |
1867 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1868 |operation         |M        |1          |String |Operation object identify.                                              |
1869 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1870 |operationId       |M        |1          |String |Operation ID.                                                           |
1871 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1872 |operation         |M        |1          |String |Operation type, create|delete.                                          |
1873 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1874 |result            |M        |1          |String |Operation result: finished, error, processing.                          |
1875 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1876 |reason            |M        |1          |String |If failing, need to write fail reason.                                  |
1877 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1878 |userId            |M        |1          |String |Operation user ID.                                                      |
1879 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1880 |operationContent  |M        |1          |String |The status detail of current operation which is being executing.        |
1881 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1882 |progress          |M        |1          |String |Current operation progress.                                             |
1883 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1884 |operateAt         |M        |1          |String |Time that it starts to execute operation.                               |
1885 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1886 |finishedAt        |M        |1          |String |Time that it finished executing operation.                              |
1887 +------------------+---------+-----------+-------+------------------------------------------------------------------------+
1888
1889 Inventory APIs
1890 ----------------
1891
1892 create or update an existing service-instance
1893 +++++++++++++++++++++++++++++++++++++++++++++
1894
1895 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1896 |Interface Definition|Description                                                                                                                                                         |
1897 +====================+====================================================================================================================================================================+
1898 |URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1899 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1900 |Operation Type      |PUT                                                                                                                                                                 |
1901 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1902
1903 Request Parameters:
1904
1905 +-------------------+---------+-----------+-------+-----------------------+
1906 |Attribute          |Qualifier|Cardinality|Content|Description            |
1907 +===================+=========+===========+=======+=======================+
1908 |global-customer-id |M        |1          |String |Global Customer ID     |
1909 +-------------------+---------+-----------+-------+-----------------------+
1910 |service-type       |M        |1          |String |Service Type           |
1911 +-------------------+---------+-----------+-------+-----------------------+
1912 |service-instance-id|M        |1          |String |Service Instance ID    |
1913 +-------------------+---------+-----------+-------+-----------------------+
1914
1915 Response:
1916
1917 +---------+---------+-----------+-------+-------------------+
1918 |Attribute|Qualifier|Cardinality|Content|Description        |
1919 +---------+---------+-----------+-------+-------------------+
1920 |HTTP code|M        |1          |Integer|HTTP response code |
1921 +---------+---------+-----------+-------+-------------------+
1922
1923 delete an existing service-instance
1924 +++++++++++++++++++++++++++++++++++
1925
1926 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1927 |Interface Definition|Description                                                                                                                                                         |
1928 +====================+====================================================================================================================================================================+
1929 |URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1930 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1931 |Operation Type      |DELETE                                                                                                                                                              |
1932 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1933
1934 Request Parameters:
1935
1936 +-------------------+---------+-----------+-------+-----------------------+
1937 |Attribute          |Qualifier|Cardinality|Content|Description            |
1938 +===================+=========+===========+=======+=======================+
1939 |global-customer-id |M        |1          |String |Global Customer ID     |
1940 +-------------------+---------+-----------+-------+-----------------------+
1941 |service-type       |M        |1          |String |Service Type           |
1942 +-------------------+---------+-----------+-------+-----------------------+
1943 |service-instance-id|M        |1          |String |Service Instance ID    |
1944 +-------------------+---------+-----------+-------+-----------------------+
1945
1946 Response:
1947
1948 +---------+---------+-----------+-------+-------------------+
1949 |Attribute|Qualifier|Cardinality|Content|Description        |
1950 +---------+---------+-----------+-------+-------------------+
1951 |HTTP code|M        |1          |Integer|HTTP response code |
1952 +---------+---------+-----------+-------+-------------------+
1953
1954 get service-instances
1955 +++++++++++++++++++++
1956
1957 +--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1958 |Interface Definition|Description                                                                                                                  |
1959 +====================+=============================================================================================================================+
1960 |URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances|
1961 +--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1962 |Operation Type      |GET                                                                                                                          |
1963 +--------------------+-----------------------------------------------------------------------------------------------------------------------------+
1964
1965 Request Parameters:
1966
1967 +-------------------+---------+-----------+-------+-----------------------+
1968 |Attribute          |Qualifier|Cardinality|Content|Description            |
1969 +===================+=========+===========+=======+=======================+
1970 |global-customer-id |M        |1          |String |Global Customer ID     |
1971 +-------------------+---------+-----------+-------+-----------------------+
1972 |service-type       |M        |1          |String |Service Type           |
1973 +-------------------+---------+-----------+-------+-----------------------+
1974
1975 Response:
1976
1977 +-----------------+---------+-----------+----------------+-------------------+
1978 |Attribute        |Qualifier|Cardinality|Content         |Description        |
1979 +-----------------+---------+-----------+----------------+-------------------+
1980 |service-instances|M        |1          |ServiceInstances|Service Instances  |
1981 +-----------------+---------+-----------+----------------+-------------------+
1982
1983 get service-instance
1984 ++++++++++++++++++++
1985
1986 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1987 |Interface Definition|Description                                                                                                                                                         |
1988 +====================+====================================================================================================================================================================+
1989 |URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
1990 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1991 |Operation Type      |GET                                                                                                                                                                 |
1992 +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1993
1994 Request Parameters:
1995
1996 +-------------------+---------+-----------+-------+-----------------------+
1997 |Attribute          |Qualifier|Cardinality|Content|Description            |
1998 +===================+=========+===========+=======+=======================+
1999 |global-customer-id |M        |1          |String |Global Customer ID     |
2000 +-------------------+---------+-----------+-------+-----------------------+
2001 |service-type       |M        |1          |String |Service Type           |
2002 +-------------------+---------+-----------+-------+-----------------------+
2003 |service-instance-id|M        |1          |String |Service instance ID    |
2004 +-------------------+---------+-----------+-------+-----------------------+
2005
2006 Response:
2007
2008 +-----------------+---------+-----------+----------------+-------------------+
2009 |Attribute        |Qualifier|Cardinality|Content         |Description        |
2010 +-----------------+---------+-----------+----------------+-------------------+
2011 |service-instance |M        |1          |ServiceInstance |Service Instance   |
2012 +-----------------+---------+-----------+----------------+-------------------+
2013
2014 see node definition for valid relationships
2015 +++++++++++++++++++++++++++++++++++++++++++
2016
2017 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2018 |Interface Definition|Description                                                                                                                                                                                        |
2019 +====================+===================================================================================================================================================================================================+
2020 |URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
2021 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2022 |Operation Type      |PUT                                                                                                                                                                                                |
2023 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2024
2025 Request Parameters:
2026
2027 +-------------------+---------+-----------+-------+-----------------------+
2028 |Attribute          |Qualifier|Cardinality|Content|Description            |
2029 +===================+=========+===========+=======+=======================+
2030 |global-customer-id |M        |1          |String |Global Customer ID     |
2031 +-------------------+---------+-----------+-------+-----------------------+
2032 |service-type       |M        |1          |String |Service Type           |
2033 +-------------------+---------+-----------+-------+-----------------------+
2034 |service-instance-id|M        |1          |String |Service instance ID    |
2035 +-------------------+---------+-----------+-------+-----------------------+
2036
2037 Response:
2038
2039 +---------+---------+-----------+-------+-------------------+
2040 |Attribute|Qualifier|Cardinality|Content|Description        |
2041 +---------+---------+-----------+-------+-------------------+
2042 |HTTP code|M        |1          |Integer|HTTP response code |
2043 +---------+---------+-----------+-------+-------------------+
2044
2045 delete an existing relationship
2046 +++++++++++++++++++++++++++++++
2047
2048 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2049 |Interface Definition|Description                                                                                                                                                                                        |
2050 +====================+===================================================================================================================================================================================================+
2051 |URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
2052 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2053 |Operation Type      |DELETE                                                                                                                                                                                             |
2054 +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2055
2056 Request Parameters:
2057
2058 +-------------------+---------+-----------+-------+-----------------------+
2059 |Attribute          |Qualifier|Cardinality|Content|Description            |
2060 +===================+=========+===========+=======+=======================+
2061 |global-customer-id |M        |1          |String |Global Customer ID     |
2062 +-------------------+---------+-----------+-------+-----------------------+
2063 |service-type       |M        |1          |String |Service Type           |
2064 +-------------------+---------+-----------+-------+-----------------------+
2065 |service-instance-id|M        |1          |String |Service instance ID    |
2066 +-------------------+---------+-----------+-------+-----------------------+
2067
2068 Response:
2069
2070 +---------+---------+-----------+-------+-------------------+
2071 |Attribute|Qualifier|Cardinality|Content|Description        |
2072 +---------+---------+-----------+-------+-------------------+
2073 |HTTP code|M        |1          |Integer|HTTP response code |
2074 +---------+---------+-----------+-------+-------------------+
2075
2076
2077 VFC APIs
2078 ---------
2079
2080 Create NS
2081 +++++++++++
2082
2083 +--------------------+-------------------+
2084 |Interface Definition|Description        |
2085 +====================+===================+
2086 |URI                 |/ns                |
2087 +--------------------+-------------------+
2088 |Operation Type      |POST               |
2089 +--------------------+-------------------+
2090 |Content-Type        |application/json   |
2091 +--------------------+-------------------+
2092
2093 Request Parameters:
2094
2095 +-------------------+---------+-----------+-------+-----------------------+
2096 |Attribute          |Qualifier|Cardinality|Content|Description            |
2097 +===================+=========+===========+=======+=======================+
2098 |context            |M        |1          |Object |Context                |
2099 +-------------------+---------+-----------+-------+-----------------------+
2100 |csarId             |M        |1          |String |csarId                 |
2101 +-------------------+---------+-----------+-------+-----------------------+
2102 |nsName             |M        |1          |String |Name of the NS         |
2103 +-------------------+---------+-----------+-------+-----------------------+
2104 |description        |M        |1          |String |description            |
2105 +-------------------+---------+-----------+-------+-----------------------+
2106
2107 Response:
2108
2109 +-----------------+---------+-----------+----------------+-------------------+
2110 |Attribute        |Qualifier|Cardinality|Content         |Description        |
2111 +-----------------+---------+-----------+----------------+-------------------+
2112 |nsInstanceId     |M        |1          |String          |nsInstanceId       |
2113 +-----------------+---------+-----------+----------------+-------------------+
2114
2115 Get NS
2116 +++++++
2117
2118 +--------------------+-------------------+
2119 |Interface Definition|Description        |
2120 +====================+===================+
2121 |URI                 |/ns                |
2122 +--------------------+-------------------+
2123 |Operation Type      |GET                |
2124 +--------------------+-------------------+
2125 |Content-Type        |application/json   |
2126 +--------------------+-------------------+
2127
2128 Response:
2129
2130 +-----------------+---------+-----------+----------------+-------------------+
2131 |Attribute        |Qualifier|Cardinality|Content         |Description        |
2132 +-----------------+---------+-----------+----------------+-------------------+
2133 |nsInstanceId     |M        |1          |String          |nsInstanceId       |
2134 +-----------------+---------+-----------+----------------+-------------------+
2135 |nsName           |M        |1          |String          |The name of ns     |
2136 +-----------------+---------+-----------+----------------+-------------------+
2137 |description      |M        |1          |String          |description        |
2138 +-----------------+---------+-----------+----------------+-------------------+
2139 |nsdId            |M        |1          |String          |ID of ns           |
2140 +-----------------+---------+-----------+----------------+-------------------+
2141 |vnfInfo          |M        |1          |Array           |Vnf information    |
2142 +-----------------+---------+-----------+----------------+-------------------+
2143 |vlInfo           |M        |1          |Array           |vl information     |
2144 +-----------------+---------+-----------+----------------+-------------------+
2145 |vnffgInfo        |M        |1          |Array           |vnffg information  |
2146 +-----------------+---------+-----------+----------------+-------------------+
2147 |nsState          |M        |1          |String          |state of ns        |
2148 +-----------------+---------+-----------+----------------+-------------------+
2149
2150 vnfInfo Object:
2151
2152 +-----------------+---------+-----------+----------------+-------------------+
2153 |Attribute        |Qualifier|Cardinality|Content         |Description        |
2154 +-----------------+---------+-----------+----------------+-------------------+
2155 |vnfInstanceId    |M        |1          |String          |vnfInstanceId      |
2156 +-----------------+---------+-----------+----------------+-------------------+
2157 |vnfInstanceName  |M        |1          |String          |vnfInstanceName    |
2158 +-----------------+---------+-----------+----------------+-------------------+
2159 |vnfdId           |M        |1          |String          |vnfdId             |
2160 +-----------------+---------+-----------+----------------+-------------------+
2161
2162 vlInfo Object:
2163
2164 +----------------------+---------+-----------+----------------+-------------------+
2165 |Attribute             |Qualifier|Cardinality|Content         |Description        |
2166 +----------------------+---------+-----------+----------------+-------------------+
2167 |vlInstanceId          |M        |1          |String          |vlInstanceId       |
2168 +----------------------+---------+-----------+----------------+-------------------+
2169 |vlInstanceName        |M        |1          |String          |vlInstanceName     |
2170 +----------------------+---------+-----------+----------------+-------------------+
2171 |vldId                 |M        |1          |String          |vldId              |
2172 +----------------------+---------+-----------+----------------+-------------------+
2173 |relatedCpInstanceId   |M        |1          |Array           |relatedCpInstanceId|
2174 +----------------------+---------+-----------+----------------+-------------------+
2175
2176 relatedCpInstanceId Array:
2177
2178 +----------------------+---------+-----------+----------------+-------------------+
2179 |Attribute             |Qualifier|Cardinality|Content         |Description        |
2180 +----------------------+---------+-----------+----------------+-------------------+
2181 |cpInstanceId          |M        |1          |String          |cpInstanceId       |
2182 +----------------------+---------+-----------+----------------+-------------------+
2183 |cpInstanceName        |M        |1          |String          |cpInstanceName     |
2184 +----------------------+---------+-----------+----------------+-------------------+
2185 |cpdId                 |M        |1          |String          |cpdId              |
2186 +----------------------+---------+-----------+----------------+-------------------+
2187
2188 vnffgInfo Array:
2189
2190 +----------------------+---------+-----------+----------------+-------------------+
2191 |Attribute             |Qualifier|Cardinality|Content         |Description        |
2192 +----------------------+---------+-----------+----------------+-------------------+
2193 |vnffgInstanceId       |M        |1          |String          |vnffgInstanceId    |
2194 +----------------------+---------+-----------+----------------+-------------------+
2195 |vnfId                 |M        |1          |String          |vnfId              |
2196 +----------------------+---------+-----------+----------------+-------------------+
2197 |pnfId                 |M        |1          |String          |pnfId              |
2198 +----------------------+---------+-----------+----------------+-------------------+
2199 |virtualLinkId         |M        |1          |Array           |virtualLinkId      |
2200 +----------------------+---------+-----------+----------------+-------------------+
2201 |cpId                  |M        |1          |Array           |cpId               |
2202 +----------------------+---------+-----------+----------------+-------------------+
2203 |nfp                   |M        |1          |Array           |nfp                |
2204 +----------------------+---------+-----------+----------------+-------------------+
2205
2206 Instantiate NS
2207 +++++++++++++++
2208
2209 +--------------------+-------------------------------------+
2210 |Interface Definition|Description                          |
2211 +====================+=====================================+
2212 |URI                 |/ns/{nsInstanceId}/Instantiate       |
2213 +--------------------+-------------------------------------+
2214 |Operation Type      |POST                                 |
2215 +--------------------+-------------------------------------+
2216 |Content-Type        |application/json                     |
2217 +--------------------+-------------------------------------+
2218
2219 Request Parameters:
2220
2221 +----------------------+---------+-----------+-------+-----------------------+
2222 |Attribute             |Qualifier|Cardinality|Content|Description            |
2223 +======================+=========+===========+=======+=======================+
2224 |LocationConstraints   |M        |1          |Array  |LocationConstraints    |
2225 +----------------------+---------+-----------+-------+-----------------------+
2226 |additionalParamForNs  |M        |1          |String |additionalParamForNs   |
2227 +----------------------+---------+-----------+-------+-----------------------+
2228 |nsInstanceId          |M        |1          |String |nsInstanceId           |
2229 +----------------------+---------+-----------+-------+-----------------------+
2230
2231 LocationConstraints Array:
2232
2233 +----------------------+---------+-----------+-------+-----------------------+
2234 |Attribute             |Qualifier|Cardinality|Content|Description            |
2235 +======================+=========+===========+=======+=======================+
2236 |vnfProfileId          |M        |1          |String  |vnfProfileId          |
2237 +----------------------+---------+-----------+-------+-----------------------+
2238 |vimid                 |M        |1          |String |vimid                  |
2239 +----------------------+---------+-----------+-------+-----------------------+
2240
2241 Response:
2242
2243 +--------------+---------+-----------+-------+-----------------------+
2244 |Attribute     |Qualifier|Cardinality|Content|Description            |
2245 +==============+=========+===========+=======+=======================+
2246 |jobId         |M        |1          |String |jobId                  |
2247 +--------------+---------+-----------+-------+-----------------------+
2248
2249 Terminate NS
2250 +++++++++++++++
2251
2252 +--------------------+-------------------------------------+
2253 |Interface Definition|Description                          |
2254 +====================+=====================================+
2255 |URI                 |/ns/{ns_instance_id}/terminate       |
2256 +--------------------+-------------------------------------+
2257 |Operation Type      |POST                                 |
2258 +--------------------+-------------------------------------+
2259 |Content-Type        |application/json                     |
2260 +--------------------+-------------------------------------+
2261
2262 Request Parameters:
2263
2264 +----------------------------+---------+-----------+-------+-----------------------------+
2265 |Attribute                   |Qualifier|Cardinality|Content|Description                  |
2266 +============================+=========+===========+=======+=============================+
2267 |terminationType             |M        |1          |String |terminationType              |
2268 +----------------------------+---------+-----------+-------+-----------------------------+
2269 |gracefulTerminationTimeout  |M        |1          |String |gracefulTerminationTimeout   |
2270 +----------------------------+---------+-----------+-------+-----------------------------+
2271 |nsInstanceId                |M        |1          |String |nsInstanceId                 |
2272 +----------------------------+---------+-----------+-------+-----------------------------+
2273
2274 Response:
2275
2276 +--------------+---------+-----------+-------+-----------------------+
2277 |Attribute     |Qualifier|Cardinality|Content|Description            |
2278 +==============+=========+===========+=======+=======================+
2279 |jobId         |M        |1          |String |jobId                  |
2280 +--------------+---------+-----------+-------+-----------------------+
2281
2282 Delete NS
2283 +++++++++++++++
2284
2285 +--------------------+-------------------------------------+
2286 |Interface Definition|Description                          |
2287 +====================+=====================================+
2288 |URI                 |/ns/{ns_instance_id}                 |
2289 +--------------------+-------------------------------------+
2290 |Operation Type      |DELETE                               |
2291 +--------------------+-------------------------------------+
2292
2293 Request Parameters:
2294
2295 +----------------------------+---------+-----------+-------+-----------------------------+
2296 |Attribute                   |Qualifier|Cardinality|Content|Description                  |
2297 +============================+=========+===========+=======+=============================+
2298 |nsInstanceId                |M        |1          |String |nsInstanceId                 |
2299 +----------------------------+---------+-----------+-------+-----------------------------+
2300
2301 MultiVIM API
2302 ----------------
2303 Get token
2304 ++++++++++
2305
2306 https://developer.openstack.org/api-ref/identity/v3/#password-authentication-with-unscoped-authorization
2307
2308 +--------------------+-----------------------------------------------------------------------------------------------+
2309 |Interface Definition|Description                                                                                    |
2310 +====================+===============================================================================================+
2311 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/identity/v3/auth/tokens     |
2312 +--------------------+-----------------------------------------------------------------------------------------------+
2313 |Operation Type      |POST                                                                                           |
2314 +--------------------+-----------------------------------------------------------------------------------------------+
2315 |Content-Type        |application/json                                                                               |
2316 +--------------------+-----------------------------------------------------------------------------------------------+
2317
2318 Request Body:
2319
2320 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2321 |Attribute       |Qualifier|Cardinality|Content                   |Description                                                                                                                                     |
2322 +================+=========+===========+==========================+================================================================================================================================================+
2323 |nocatalog       |O        |1          |string                    |The authentication response excludes the service catalog. By default, the response includes the service catalog.                                |
2324 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2325 |name            |O        |1          |string                    |The user name. Required if you do not specify the ID of the user. If you specify the user name, you must also specify the domain, by ID or name.|
2326 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2327 |auth            |M        |1          |object                    |An auth object.                                                                                                                                 |
2328 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2329 |user            |M        |1          |object                    |A user object.                                                                                                                                  |
2330 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2331 |scope           |O        |1          |string                    |The authorization scope, including either a project or a domain                                                                                 |
2332 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2333 |password        |M        |1          |object                    |The password object, contains the authentication information.                                                                                   |
2334 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2335 |id              |O        |1          |string                    |The ID of the user. Required if you do not specify the user name.                                                                               |
2336 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2337 |identity        |M        |1          |object                    |An identity object.                                                                                                                             |
2338 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2339 |methods         |M        |1          |array                     |The authentication method. For password authentication, specify password.                                                                       |
2340 +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
2341
2342 Response:
2343
2344 +-------------------------+------------------+--------------------------------------------------------------------------+
2345 |Attribute                |Content           |Description                                                               |
2346 +=========================+==================+==========================================================================+
2347 |X-Subject-Token          |String            |The authentication token.                                                 |
2348 +-------------------------+------------------+--------------------------------------------------------------------------+
2349 |domain                   |object            |A domain object, containing:                                              |
2350 +-------------------------+------------------+--------------------------------------------------------------------------+
2351 |region_id                |String            |The ID of the region that contains the service endpoint.                  |
2352 +-------------------------+------------------+--------------------------------------------------------------------------+
2353 |methods                  |array             |The authentication method. For password authentication, specify password. |
2354 +-------------------------+------------------+--------------------------------------------------------------------------+
2355 |roles                    |array             |A list of role objects, each containing:                                  |
2356 +-------------------------+------------------+--------------------------------------------------------------------------+
2357 |url                      |String            |The endpoint URL.                                                         |
2358 +-------------------------+------------------+--------------------------------------------------------------------------+
2359 |region                   |String            |The geographic location of the service endpoint.                          |
2360 +-------------------------+------------------+--------------------------------------------------------------------------+
2361 |token                    |object            |A token object.                                                           |
2362 +-------------------------+------------------+--------------------------------------------------------------------------+
2363 |expires_at               |String            |The date and time when the token expires.                                 |
2364 +-------------------------+------------------+--------------------------------------------------------------------------+
2365 |project                  |object            |A project object, containing:                                             |
2366 +-------------------------+------------------+--------------------------------------------------------------------------+
2367 |issued_at                |String            |The date and time when the token was issued.                              |
2368 +-------------------------+------------------+--------------------------------------------------------------------------+
2369 |catalog                  |array             |A catalog object.                                                         |
2370 +-------------------------+------------------+--------------------------------------------------------------------------+
2371 |extras                   |object            |A set of metadata key and value pairs, if any.                            |
2372 +-------------------------+------------------+--------------------------------------------------------------------------+
2373 |user                     |object            |A user object.                                                            |
2374 +-------------------------+------------------+--------------------------------------------------------------------------+
2375 |audit_ids                |array             |A list of one or two audit IDs.                                           |
2376 +-------------------------+------------------+--------------------------------------------------------------------------+
2377 |interface                |String            |The interface type, which describes the visibility of the endpoint.       |
2378 +-------------------------+------------------+--------------------------------------------------------------------------+
2379 |endpoints                |array             |A list of endpoint objects.                                               |
2380 +-------------------------+------------------+--------------------------------------------------------------------------+
2381 |type                     |String            |The endpoint type.                                                        |
2382 +-------------------------+------------------+--------------------------------------------------------------------------+
2383 |id                       |String            |The ID of the user. Required if you do not specify the user name.         |
2384 +-------------------------+------------------+--------------------------------------------------------------------------+
2385 |name                     |String            |The user name.                                                            |
2386 +-------------------------+------------------+--------------------------------------------------------------------------+
2387
2388 Create stack
2389 +++++++++++++
2390
2391 https://developer.openstack.org/api-ref/orchestration/v1/#create-stack
2392
2393 +--------------------+-----------------------------------------------------------------------------------------------+
2394 |Interface Definition|Description                                                                                    |
2395 +====================+===============================================================================================+
2396 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks  |
2397 +--------------------+-----------------------------------------------------------------------------------------------+
2398 |Operation Type      |POST                                                                                           |
2399 +--------------------+-----------------------------------------------------------------------------------------------+
2400 |Content-Type        |application/json                                                                               |
2401 +--------------------+-----------------------------------------------------------------------------------------------+
2402
2403 Request Body:
2404
2405 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2406 |Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
2407 +==================+=========+===========+==========================+=================================================================================================+
2408 |tenant_id         |M        |1          |string                    |The UUID of the tenant. A tenant is also known as a project.                                     |
2409 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2410 |disable_rollback  |O        |1          |boolean                   |Enables or disables deletion of all stack resources when stack creation fails.                   |
2411 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2412 |environment       |O        |1          |object                    |A JSON environment for the stack.                                                                |
2413 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2414 |files             |O        |1          |object                    |Supplies the contents of files referenced in the template or the environment.                    |
2415 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2416 |parameters        |O        |1          |object                    |Supplies arguments for parameters defined in the stack template.                                 |
2417 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2418 |stack_name        |M        |1          |string                    |A name for the stack.                                                                            |
2419 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2420 |tags              |O        |1          |string                    |One or more simple string tags to associate with the stack.                                      |
2421 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2422 |template          |O        |1          |object                    |The stack template on which to perform the operation.                                            |
2423 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2424 |template_url      |O        |1          |string                    |A URI to the location containing the stack template on which to perform the operation.           |
2425 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2426 |timeout_mins      |O        |1          |integer                   |The timeout for stack creation in minutes.                                                       |
2427 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2428
2429 Response:
2430
2431 +-------------------------+------------------+--------------------------------------------------------------------------+
2432 |Attribute                |Content           |Description                                                               |
2433 +=========================+==================+==========================================================================+
2434 |location                 |String            |For asynchronous resource operations.                                     |
2435 +-------------------------+------------------+--------------------------------------------------------------------------+
2436 |X-Openstack-Reqeuest-Id  |object            |A domain object, containing:                                              |
2437 +-------------------------+------------------+--------------------------------------------------------------------------+
2438 |stack                    |String            |The ID of the region that contains the service endpoint.                  |
2439 +-------------------------+------------------+--------------------------------------------------------------------------+
2440 |id                       |String            |The authentication method. For password authentication, specify password. |
2441 +-------------------------+------------------+--------------------------------------------------------------------------+
2442 |links                    |String            |The authentication method. For password authentication, specify password. |
2443 +-------------------------+------------------+--------------------------------------------------------------------------+
2444
2445 Get stack
2446 +++++++++++++
2447
2448 https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2449
2450 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2451 |Interface Definition|Description                                                                                                            |
2452 +====================+=======================================================================================================================+
2453 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id}  |
2454 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2455 |Operation Type      |GET                                                                                                                    |
2456 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2457 |Content-Type        |application/json                                                                                                       |
2458 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2459
2460 Request Body:
2461
2462 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2463 |Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
2464 +==================+=========+===========+==========================+=================================================================================================+
2465 |tenant_id         |M        |1          |string                    |The UUID of the tenant. A tenant is also known as a project.                                     |
2466 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2467 |stack_name        |M        |1          |string                    |The name of a stack.                                                                             |
2468 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2469 |stack_id          |M        |1          |string                    |The UUID of the stack.                                                                           |
2470 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2471 |resolve_outputs   |O        |1          |boolean                   |A boolean indicating whether the outputs section of a stack should be resolved.                  |
2472 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2473
2474 Response:
2475
2476 +-------------------------+------------------+------------------------------------------------------------------------------+
2477 |Attribute                |Content           |Description                                                                   |
2478 +=========================+==================+==============================================================================+
2479 |X-Openstack-Reqeuest-Id  |String            |A unique ID for tracking service request.                                     |
2480 +-------------------------+------------------+------------------------------------------------------------------------------+
2481 |stack                    |Object            |The stack object.                                                             |
2482 +-------------------------+------------------+------------------------------------------------------------------------------+
2483 |capabilities             |array             |List of stack capabilities for stack.                                         |
2484 +-------------------------+------------------+------------------------------------------------------------------------------+
2485 |creation_time            |String            |The date and time when the resource was created.                              |
2486 +-------------------------+------------------+------------------------------------------------------------------------------+
2487 |deletion_time            |String            |The date and time when the resource was (soft-) deleted.                      |
2488 +-------------------------+------------------+------------------------------------------------------------------------------+
2489 |description              |String            |The description of the stack resource.                                        |
2490 +-------------------------+------------------+------------------------------------------------------------------------------+
2491 |disable_rollback         |boolean           |Whether deletion of all stack resources when stack creation fails is enabled. |
2492 +-------------------------+------------------+------------------------------------------------------------------------------+
2493 |id                       |String            |The UUID of the stack.                                                        |
2494 +-------------------------+------------------+------------------------------------------------------------------------------+
2495 |links                    |array             |A list of URLs for the stack.                                                 |
2496 +-------------------------+------------------+------------------------------------------------------------------------------+
2497 |notification_topics      |array             |List of notification topics for stack.                                        |
2498 +-------------------------+------------------+------------------------------------------------------------------------------+
2499 |outputs                  |array             |A list of stack outputs.                                                      |
2500 +-------------------------+------------------+------------------------------------------------------------------------------+
2501 |parameters               |object            |  A group of key-value pairs                                                  |
2502 +-------------------------+------------------+------------------------------------------------------------------------------+
2503 |parent                   |String            |The stack ID of the parent stack, if this is a nested stack.                  |
2504 +-------------------------+------------------+------------------------------------------------------------------------------+
2505 |stack_name               |String            |A name for the stack.                                                         |
2506 +-------------------------+------------------+------------------------------------------------------------------------------+
2507 |stack_owner              |String            |The owner of the stack.                                                       |
2508 +-------------------------+------------------+------------------------------------------------------------------------------+
2509 |stack_status             |String            |The status of the stack.                                                      |
2510 +-------------------------+------------------+------------------------------------------------------------------------------+
2511 |stack_status_reason      |String            |The reason for the current status of the stack.                               |
2512 +-------------------------+------------------+------------------------------------------------------------------------------+
2513 |stack_user_project_id    |String            |The project UUID of the stack user.                                           |
2514 +-------------------------+------------------+------------------------------------------------------------------------------+
2515 |tags                     |array             |The stack tags.                                                               |
2516 +-------------------------+------------------+------------------------------------------------------------------------------+
2517 |template_description     |String            |The description of the stack template.                                        |
2518 +-------------------------+------------------+------------------------------------------------------------------------------+
2519 |timeout_mins             |integer           |The timeout for stack creation in minutes.                                    |
2520 +-------------------------+------------------+------------------------------------------------------------------------------+
2521 |updated_time             |String            |The date and time when the object was updated.                                |
2522 +-------------------------+------------------+------------------------------------------------------------------------------+
2523
2524 Delete stack
2525 +++++++++++++
2526
2527 https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
2528
2529 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2530 |Interface Definition|Description                                                                                                            |
2531 +====================+=======================================================================================================================+
2532 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id}  |
2533 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2534 |Operation Type      |DELETE                                                                                                                 |
2535 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2536 |Content-Type        |application/json                                                                                                       |
2537 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2538
2539 Request Body:
2540
2541 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2542 |Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
2543 +==================+=========+===========+==========================+=================================================================================================+
2544 |tenant_id         |M        |1          |string                    |The UUID of the tenant. A tenant is also known as a project.                                     |
2545 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2546 |stack_name        |M        |1          |string                    |The name of a stack.                                                                             |
2547 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2548 |stack_id          |M        |1          |string                    |The UUID of the stack.                                                                           |
2549 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2550
2551 Create server
2552 +++++++++++++
2553
2554 https://developer.openstack.org/api-ref/compute/#create-server
2555
2556 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2557 |Interface Definition|Description                                                                                                            |
2558 +====================+=======================================================================================================================+
2559 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers                       |
2560 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2561 |Operation Type      |POST                                                                                                                   |
2562 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2563 |Content-Type        |application/json                                                                                                       |
2564 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2565
2566 Request Body:
2567
2568 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2569 |Attribute                                       |Qualifier|Cardinality|Content                   |Description                                                                                      |
2570 +================================================+=========+===========+==========================+=================================================================================================+
2571 |server                                          |M        |1          |object                    |A server object.                                                                                 |
2572 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2573 |name                                            |M        |1          |string                    |The server name.                                                                                 |
2574 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2575 |flavorRef                                       |M        |1          |string                    |The flavor reference, as an ID (including a UUID) or full URL                                    |
2576 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2577 |imageRef                                        |M        |1          |string                    |The UUID of the image to use for your server instance                                            |
2578 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2579 |security_groups                                 |O        |1          |array                     |One or more security groups.                                                                     |
2580 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2581 |metadata                                        |O        |1          |object                    |Metadata key and value pairs.                                                                    |
2582 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2583 |accessIPv4                                      |O        |1          |string                    |IPv4 address that should be used to access this server.                                          |
2584 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2585 |accessIPv6                                      |O        |1          |string                    |IPv6 address that should be used to access this server.                                          |
2586 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2587 |adminPass                                       |O        |1          |string                    |The administrative password of the server.                                                       |
2588 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2589 |user_data                                       |O        |1          |string                    |Configuration information or scripts to use upon launch.                                         |
2590 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2591 |availability_zone                               |O        |1          |string                    |The availability zone from which to launch the server.                                           |
2592 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2593 |networks                                        |M        |1          |object                    |A networks object.                                                                               |
2594 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2595 |networks.uuid                                   |O        |1          |string                    |To provision the server instance with a NIC for a network                                        |
2596 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2597 |networks.port                                   |O        |1          |string                    |To provision the server instance with a NIC for an already existing port                         |
2598 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2599 |networks.fixed_ip                               |O        |1          |string                    |A fixed IPv4 address for the NIC                                                                 |
2600 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2601 |networks.tag                                    |O        |1          |string                    |A device role tag that can be applied to a network interface.                                    |
2602 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2603 |personality                                     |O        |1          |array                     |The file path and contents, text only, to inject into the server at launch.                      |
2604 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2605 |block_device_mapping_v2                         |O        |1          |array                     |Enables fine grained control of the block device mapping for an instance.                        |
2606 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2607 |block_device_mapping_v2.device_name             |M        |1          |string                    |A path to the device for the volume that you want to use to boot the server.                     |
2608 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2609 |block_device_mapping_v2.source_type             |M        |1          |string                    |The source type of the volume.                                                                   |
2610 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2611 |block_device_mapping_v2.destination_type        |O        |1          |string                    |Defines where the volume comes from.                                                             |
2612 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2613 |block_device_mapping_v2.delete_on_termination   |O        |1          |string                    |To delete the boot volume when the server is destroyed, specify true.                            |
2614 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2615 |block_device_mapping_v2.guest_format            |M        |1          |string                    |Specifies the guest server disk file system format, such as ephemeral or swap.                   |
2616 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2617 |block_device_mapping_v2.boot_index              |M        |1          |string                    |Defines the order in which a hypervisor tries devices                                            |
2618 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2619 |block_device_mapping_v2.uuid                    |O        |1          |string                    |This is the uuid of source resource.                                                             |
2620 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2621 |block_device_mapping_v2.tag                     |O        |1          |string                    |A device role tag that can be applied to a block device.                                         |
2622 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2623 |block_device_mapping_v2.disk_bus                |O        |1          |string                    |Disk bus type, some hypervisors (currently only libvirt) support specify this parameter          |
2624 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2625 |config_drive                                    |O        |1          |boolean                   |Indicates whether a configuration drive enables metadata injection.                              |
2626 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2627 |key_name                                        |O        |1          |string                    |Key pair name.                                                                                   |
2628 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2629 |os:scheduler_hints                              |O        |1          |object                    |The dictionary of data to send to the scheduler.                                                 |
2630 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2631 |OS-DCF:diskConfig                               |O        |1          |string                    |Controls how the API partitions the disk when you create, rebuild, or resize servers.            |
2632 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2633 |description                                     |O        |1          |string                    |A free form description of the server.                                                           |
2634 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2635 |tags                                            |O        |1          |array                     |A list of tags.                                                                                  |
2636 +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2637
2638 Response:
2639
2640 +-------------------------+------------------+------------------------------------------------------------------------------+
2641 |Attribute                |Content           |Description                                                                   |
2642 +=========================+==================+==============================================================================+
2643 |server                   |object            |A server object.                                                              |
2644 +-------------------------+------------------+------------------------------------------------------------------------------+
2645 |id                       |String            |The UUID of the server.                                                       |
2646 +-------------------------+------------------+------------------------------------------------------------------------------+
2647 |links                    |array             |Links to the resources in question.                                           |
2648 +-------------------------+------------------+------------------------------------------------------------------------------+
2649 |OS-DCF:diskConfig        |String            |Disk configuration.                                                           |
2650 +-------------------------+------------------+------------------------------------------------------------------------------+
2651 |security_groups          |array             |One or more security groups objects.                                          |
2652 +-------------------------+------------------+------------------------------------------------------------------------------+
2653 |security_groups.name     |String            |The security group name.                                                      |
2654 +-------------------------+------------------+------------------------------------------------------------------------------+
2655 |adminPass                |String            |The administrative password for the server.                                   |
2656 +-------------------------+------------------+------------------------------------------------------------------------------+
2657
2658 Delete server
2659 +++++++++++++
2660
2661 https://developer.openstack.org/api-ref/compute/#delete-server
2662
2663 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2664 |Interface Definition|Description                                                                                                            |
2665 +====================+=======================================================================================================================+
2666 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers/{server_id}           |
2667 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2668 |Operation Type      |DELETE                                                                                                                 |
2669 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2670 |Content-Type        |application/json                                                                                                       |
2671 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2672
2673 Request Body:
2674
2675 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2676 |Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
2677 +==================+=========+===========+==========================+=================================================================================================+
2678 |server_id         |M        |1          |string                    |The UUID of the server.                                                                          |
2679 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2680
2681 Create Keypair
2682 +++++++++++++++
2683
2684 https://developer.openstack.org/api-ref/compute/#create-or-import-keypair
2685
2686 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2687 |Interface Definition|Description                                                                                                            |
2688 +====================+=======================================================================================================================+
2689 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs                   |
2690 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2691 |Operation Type      |POST                                                                                                                   |
2692 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2693 |Content-Type        |application/json                                                                                                       |
2694 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2695
2696 Request Body:
2697
2698 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2699 |Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
2700 +==================+=========+===========+==========================+=================================================================================================+
2701 |keypair           |M        |1          |Object                    |Keypair object                                                                                   |
2702 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2703 |name              |M        |1          |string                    |A name for the keypair which will be used to reference it later.                                 |
2704 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2705 |public_key        |O        |1          |string                    |The public ssh key to import. If you omit this value, a keypair is generated for you.            |
2706 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2707 |type              |O        |1          |string                    |The type of the keypair.                                                                         |
2708 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2709 |user_id           |O        |1          |string                    |The user_id for a keypair.                                                                       |
2710 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2711
2712 Response:
2713
2714 +-----------------+------------------+------------------------------------------------------------------------------+
2715 |Attribute        |Content           |Description                                                                   |
2716 +=================+==================+==============================================================================+
2717 |keypair          |object            |Keypair object                                                                |
2718 +-----------------+------------------+------------------------------------------------------------------------------+
2719 |name             |String            |A name for the keypair which will be used to reference it later.              |
2720 +-----------------+------------------+------------------------------------------------------------------------------+
2721 |public_key       |String            |The keypair public key.                                                       |
2722 +-----------------+------------------+------------------------------------------------------------------------------+
2723 |fingerprint      |String            |The fingerprint for the keypair.                                              |
2724 +-----------------+------------------+------------------------------------------------------------------------------+
2725 |user_id          |String            |The user_id for a keypair.                                                    |
2726 +-----------------+------------------+------------------------------------------------------------------------------+
2727 |private_key      |String            |If you do not provide a public key on create                                  |
2728 +-----------------+------------------+------------------------------------------------------------------------------+
2729 |type             |String            |The type of the keypair.                                                      |
2730 +-----------------+------------------+------------------------------------------------------------------------------+
2731
2732 Delete Keypair
2733 +++++++++++++++
2734
2735 https://developer.openstack.org/api-ref/compute/#delete-keypair
2736
2737 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2738 |Interface Definition|Description                                                                                                            |
2739 +====================+=======================================================================================================================+
2740 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs/{keypair-id}      |
2741 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2742 |Operation Type      |DELETE                                                                                                                 |
2743 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2744 |Content-Type        |application/json                                                                                                       |
2745 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2746
2747 Request Body:
2748
2749 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2750 |Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
2751 +==================+=========+===========+==========================+=================================================================================================+
2752 |keypair_name      |M        |1          |String                    |The keypair name.                                                                                |
2753 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2754 |user_id           |O        |1          |String                    |This allows administrative users to operate key-pairs of specified user ID.                      |
2755 +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2756
2757 Create Network
2758 +++++++++++++++
2759
2760 https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#create-network
2761
2762 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2763 |Interface Definition|Description                                                                                                            |
2764 +====================+=======================================================================================================================+
2765 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks                               |
2766 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2767 |Operation Type      |POST                                                                                                                   |
2768 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2769 |Content-Type        |application/json                                                                                                       |
2770 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2771
2772 Request Body:
2773
2774 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2775 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                                                      |
2776 +============================+=========+===========+==========================+=================================================================================================+
2777 |network                     |M        |1          |Object                    |A network object.                                                                                |
2778 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2779 |admin_state_up              |O        |1          |boolean                   |The administrative state of the network, which is up (true) or down (false).                     |
2780 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2781 |dns_domain                  |O        |1          |string                    |A valid DNS domain.                                                                              |
2782 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2783 |mtu                         |O        |1          |integer                   |The maximum transmission unit (MTU) value to address fragmentation.                              |
2784 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2785 |name                        |O        |1          |string                    |Human-readable name of the network.                                                              |
2786 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2787 |port_security_enabled       |O        |1          |boolean                   |The port security status of the network.                                                         |
2788 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2789 |project_id                  |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
2790 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2791 |provider:network_type       |O        |1          |string                    |The type of physical network that this network should be mapped to.                              |
2792 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2793 |provider:physical_network   |O        |1          |string                    |The physical network where this network should be implemented.                                   |
2794 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2795 |provider:segmentation_id    |O        |1          |integer                   |The ID of the isolated segment on the physical network.                                          |
2796 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2797 |qos_policy_id               |O        |1          |string                    |The ID of the QoS policy.                                                                        |
2798 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2799 |router:external             |O        |1          |boolean                   |Indicates whether this network can provide floating IPs via a router.                            |
2800 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2801 |segments                    |O        |1          |array                     |A list of provider segment objects.                                                              |
2802 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2803 |shared                      |O        |1          |boolean                   |Indicates whether this network is shared across all tenants.                                     |
2804 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2805 |tenant_id                   |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
2806 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2807 |vlan_transparent            |O        |1          |boolean                   |Indicates the VLAN transparency mode of the network,                                             |
2808 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2809 |description                 |O        |1          |string                    |A human-readable description for the resource.                                                   |
2810 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2811
2812 Response:
2813
2814 +-----------------------------+------------------+------------------------------------------------------------------------------+
2815 |Attribute                    |Content           |Description                                                                   |
2816 +=============================+==================+==============================================================================+
2817 |network                      |object            |A network object.                                                             |
2818 +-----------------------------+------------------+------------------------------------------------------------------------------+
2819 |admin_state_up               |boolean           |The administrative state of the network, which is up (true) or down (false).  |
2820 +-----------------------------+------------------+------------------------------------------------------------------------------+
2821 |availability_zone_hints      |array             |The availability zone candidate for the network.                              |
2822 +-----------------------------+------------------+------------------------------------------------------------------------------+
2823 |availability_zones           |array             |The availability zone for the network.                                        |
2824 +-----------------------------+------------------+------------------------------------------------------------------------------+
2825 |dns_domain                   |String            |A valid DNS domain.                                                           |
2826 +-----------------------------+------------------+------------------------------------------------------------------------------+
2827 |id                           |String            |The ID of the network.                                                        |
2828 +-----------------------------+------------------+------------------------------------------------------------------------------+
2829 |mtu                          |integer           |The maximum transmission unit (MTU) value to address fragmentation.           |
2830 +-----------------------------+------------------+------------------------------------------------------------------------------+
2831 |name                         |String            |Human-readable name of the network.                                           |
2832 +-----------------------------+------------------+------------------------------------------------------------------------------+
2833 |port_security_enabled        |boolean           |The port security status of the network.                                      |
2834 +-----------------------------+------------------+------------------------------------------------------------------------------+
2835 |project_id                   |String            |The ID of the project.                                                        |
2836 +-----------------------------+------------------+------------------------------------------------------------------------------+
2837 |provider:network_type        |String            |The type of physical network that this network is mapped to.                  |
2838 +-----------------------------+------------------+------------------------------------------------------------------------------+
2839 |provider:physical_network    |String            |The physical network where this network is implemented.                       |
2840 +-----------------------------+------------------+------------------------------------------------------------------------------+
2841 |provider:segmentation_id     |integer           |The ID of the isolated segment on the physical network.                       |
2842 +-----------------------------+------------------+------------------------------------------------------------------------------+
2843 |qos_policy_id                |String            |The ID of the QoS policy.                                                     |
2844 +-----------------------------+------------------+------------------------------------------------------------------------------+
2845 |revision_number              |integer           |The revision number of the resource.                                          |
2846 +-----------------------------+------------------+------------------------------------------------------------------------------+
2847 |router:external              |boolean           |Indicates whether this network can provide floating IPs via a router.         |
2848 +-----------------------------+------------------+------------------------------------------------------------------------------+
2849 |segments                     |array             |A list of provider segment objects.                                           |
2850 +-----------------------------+------------------+------------------------------------------------------------------------------+
2851 |shared                       |boolean           |Indicates whether this network is shared across all tenants.                  |
2852 +-----------------------------+------------------+------------------------------------------------------------------------------+
2853 |status                       |String            |The network status. Values are ACTIVE, DOWN, BUILD or ERROR.                  |
2854 +-----------------------------+------------------+------------------------------------------------------------------------------+
2855 |subnets                      |array             |The associated subnets.                                                       |
2856 +-----------------------------+------------------+------------------------------------------------------------------------------+
2857 |tenant_id                    |String            |The ID of the project.                                                        |
2858 +-----------------------------+------------------+------------------------------------------------------------------------------+
2859 |vlan_transparent             |boolean           |Indicates the VLAN transparency mode of the network.                          |
2860 +-----------------------------+------------------+------------------------------------------------------------------------------+
2861 |description                  |String            |A human-readable description for the resource.                                |
2862 +-----------------------------+------------------+------------------------------------------------------------------------------+
2863
2864 Delete Network
2865 +++++++++++++++
2866
2867 https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#delete-network
2868
2869 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2870 |Interface Definition|Description                                                                                                            |
2871 +====================+=======================================================================================================================+
2872 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks/{network-id}                  |
2873 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2874 |Operation Type      |DELETE                                                                                                                 |
2875 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2876 |Content-Type        |application/json                                                                                                       |
2877 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2878
2879 Request Body:
2880
2881 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2882 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
2883 +============================+=========+===========+==========================+==============================================================+
2884 |network_id                  |M        |1          |Object                    |The ID of the network.                                        |
2885 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
2886
2887 Create Subnet
2888 +++++++++++++++
2889
2890 https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail,create-subnet-detail#create-subnet
2891
2892 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2893 |Interface Definition|Description                                                                                                            |
2894 +====================+=======================================================================================================================+
2895 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets                                |
2896 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2897 |Operation Type      |POST                                                                                                                   |
2898 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2899 |Content-Type        |application/json                                                                                                       |
2900 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
2901
2902 Request Body:
2903
2904 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2905 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                                                      |
2906 +============================+=========+===========+==========================+=================================================================================================+
2907 |subnet                      |M        |1          |string                    |A subnet object.                                                                                 |
2908 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2909 |tenant_id                   |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
2910 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2911 |project_id                  |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
2912 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2913 |name                        |O        |1          |string                    |Human-readable name of the resource.                                                             |
2914 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2915 |enable_dhcp                 |O        |1          |boolean                   |Indicates whether dhcp is enabled or disabled for the subnet.                                    |
2916 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2917 |network_id                  |M        |1          |string                    |The ID of the network to which the subnet belongs.                                               |
2918 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2919 |dns_nameservers             |O        |1          |array                     |List of dns name servers associated with the subnet.                                             |
2920 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2921 |allocation_pools            |O        |1          |array                     |Allocation pools with start and end IP addresses for this subnet.                                |
2922 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2923 |host_routes                 |O        |1          |array                     |Additional routes for the subnet.                                                                |
2924 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2925 |ip_version                  |M        |1          |integer                   |The IP protocol version. Value is 4 or 6.                                                        |
2926 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2927 |gateway_ip                  |O        |1          |string                    |Gateway IP of this subnet.                                                                       |
2928 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2929 |cidr                        |M        |1          |string                    |The CIDR of the subnet.                                                                          |
2930 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2931 |description                 |O        |1          |string                    |A human-readable description for the resource.                                                   |
2932 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2933 |ipv6_address_mode           |O        |1          |string                    |The IPv6 address modes specifies mechanisms for assigning IP addresses.                          |
2934 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2935 |ipv6_ra_mode                |O        |1          |string                    |The IPv6 router advertisement specifies whether the networking service                           |
2936 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2937 |segment_id                  |O        |1          |string                    |The ID of a network segment the subnet is associated with.                                       |
2938 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2939 |subnetpool_id               |O        |1          |string                    |The ID of the subnet pool associated with the subnet.                                            |
2940 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2941 |use_default_subnetpool      |O        |1          |boolean                   |Whether to allocate this subnet from the default subnet pool.                                    |
2942 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
2943
2944 Response:
2945
2946 +-----------------------------+------------------+------------------------------------------------------------------------------+
2947 |Attribute                    |Content           |Description                                                                   |
2948 +=============================+==================+==============================================================================+
2949 |subnet                       |string            |A subnet object.                                                              |
2950 +-----------------------------+------------------+------------------------------------------------------------------------------+
2951 |id                           |string            |The ID of the subnet.                                                         |
2952 +-----------------------------+------------------+------------------------------------------------------------------------------+
2953 |tenant_id                    |string            |The ID of the project.                                                        |
2954 +-----------------------------+------------------+------------------------------------------------------------------------------+
2955 |project_id                   |string            |The ID of the project.                                                        |
2956 +-----------------------------+------------------+------------------------------------------------------------------------------+
2957 |name                         |String            |Human-readable name of the resource.                                          |
2958 +-----------------------------+------------------+------------------------------------------------------------------------------+
2959 |enable_dhcp                  |boolean           |Indicates whether dhcp is enabled or disabled for the subnet.                 |
2960 +-----------------------------+------------------+------------------------------------------------------------------------------+
2961 |network_id                   |String            |The ID of the network to which the subnet belongs.                            |
2962 +-----------------------------+------------------+------------------------------------------------------------------------------+
2963 |dns_nameservers              |array             |List of dns name servers associated with the subnet.                          |
2964 +-----------------------------+------------------+------------------------------------------------------------------------------+
2965 |allocation_pools             |array             |Allocation pools with start and end IP addresses for this subnet.             |
2966 +-----------------------------+------------------+------------------------------------------------------------------------------+
2967 |host_routes                  |array             |Additional routes for the subnet.                                             |
2968 +-----------------------------+------------------+------------------------------------------------------------------------------+
2969 |ip_version                   |integer           |The IP protocol version. Value is 4 or 6.                                     |
2970 +-----------------------------+------------------+------------------------------------------------------------------------------+
2971 |gateway_ip                   |string            |Gateway IP of this subnet.                                                    |
2972 +-----------------------------+------------------+------------------------------------------------------------------------------+
2973 |cidr                         |string            |The CIDR of the subnet.                                                       |
2974 +-----------------------------+------------------+------------------------------------------------------------------------------+
2975 |created_at                   |string            |Time at which the subnet has been created.                                    |
2976 +-----------------------------+------------------+------------------------------------------------------------------------------+
2977 |description                  |string            |A human-readable description for the resource.                                |
2978 +-----------------------------+------------------+------------------------------------------------------------------------------+
2979 |ipv6_address_mode            |string            |The IPv6 address modes specifies mechanisms for assigning IP addresses.       |
2980 +-----------------------------+------------------+------------------------------------------------------------------------------+
2981 |ipv6_ra_mode                 |string            |The IPv6 router advertisement specifies whether the networking service        |
2982 +-----------------------------+------------------+------------------------------------------------------------------------------+
2983 |revision_number              |integer           |The revision number of the resource.                                          |
2984 +-----------------------------+------------------+------------------------------------------------------------------------------+
2985 |service_types                |string            |The service types associated with the subnet.                                 |
2986 +-----------------------------+------------------+------------------------------------------------------------------------------+
2987 |subnetpool_id                |string            |The ID of the subnet pool associated with the subnet.                         |
2988 +-----------------------------+------------------+------------------------------------------------------------------------------+
2989 |segment_id                   |string            |The ID of a network segment the subnet is associated with.                    |
2990 +-----------------------------+------------------+------------------------------------------------------------------------------+
2991 |updated_at                   |string            |Time at which the subnet has been updated.                                    |
2992 +-----------------------------+------------------+------------------------------------------------------------------------------+
2993
2994 Delete Subnet
2995 +++++++++++++++
2996
2997 https://developer.openstack.org/api-ref/networking/v2/?expanded=create-network-detail,delete-subnet-detail#delete-subnet
2998
2999 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3000 |Interface Definition|Description                                                                                                            |
3001 +====================+=======================================================================================================================+
3002 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets/{subnet-id}                    |
3003 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3004 |Operation Type      |DELETE                                                                                                                 |
3005 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3006 |Content-Type        |application/json                                                                                                       |
3007 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3008
3009 Request Body:
3010
3011 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3012 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
3013 +============================+=========+===========+==========================+==============================================================+
3014 |subnet_id                   |M        |1          |String                    |The ID of the subnet.                                         |
3015 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3016
3017 Create Port
3018 +++++++++++++++
3019
3020 https://developer.openstack.org/api-ref/networking/v2/#create-port
3021
3022 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3023 |Interface Definition|Description                                                                                                            |
3024 +====================+=======================================================================================================================+
3025 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports                                  |
3026 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3027 |Operation Type      |POST                                                                                                                   |
3028 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3029 |Content-Type        |application/json                                                                                                       |
3030 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3031
3032 Request Body:
3033
3034 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3035 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                                                      |
3036 +============================+=========+===========+==========================+=================================================================================================+
3037 |port                        |M        |1          |object                    |A port object.                                                                                   |
3038 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3039 |admin_state_up              |O        |1          |boolean                   |The administrative state of the resource.                                                        |
3040 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3041 |allowed_address_pairs       |O        |1          |array                     |A set of zero or more allowed address pairs.                                                     |
3042 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3043 |binding:host_id             |O        |1          |string                    |The ID of the host where the port resides.                                                       |
3044 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3045 |binding:profile             |O        |1          |string                    |A dictionary that enables the application running on the specific host                           |
3046 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3047 |binding:vnic_type           |O        |1          |string                    |The type of vNIC which this port should be attached to.                                          |
3048 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3049 |description                 |O        |1          |string                    |A human-readable description for the resource.                                                   |
3050 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3051 |device_id                   |O        |1          |string                    |The ID of the device that uses this port.                                                        |
3052 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3053 |device_owner                |O        |1          |string                    |The entity type that uses this port.                                                             |
3054 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3055 |dns_domain                  |O        |1          |string                    |A valid DNS domain.                                                                              |
3056 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3057 |dns_name                    |O        |1          |string                    |A valid DNS name.                                                                                |
3058 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3059 |extra_dhcp_opts             |O        |1          |array                     |A set of zero or more extra DHCP option pairs.                                                   |
3060 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3061 |fixed_ips                   |O        |1          |array                     |The IP addresses for the port.                                                                   |
3062 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3063 |mac_address                 |O        |1          |string                    |The MAC address of the port.                                                                     |
3064 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3065 |name                        |O        |1          |string                    |Human-readable name of the resource.                                                             |
3066 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3067 |network_id                  |M        |1          |string                    |The ID of the attached network.                                                                  |
3068 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3069 |port_security_enabled       |O        |1          |boolean                   |The port security status.                                                                        |
3070 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3071 |project_id                  |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
3072 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3073 |security_groups             |O        |1          |array                     |The IDs of security groups applied to the port.                                                  |
3074 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3075 |tenant_id                   |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
3076 +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
3077
3078 Response:
3079
3080 +-----------------------------+------------------+------------------------------------------------------------------------------+
3081 |Attribute                    |Content           |Description                                                                   |
3082 +=============================+==================+==============================================================================+
3083 |port                         |object            |A port object.                                                                |
3084 +-----------------------------+------------------+------------------------------------------------------------------------------+
3085 |admin_state_up               |boolean           |The administrative state of the resource.                                     |
3086 +-----------------------------+------------------+------------------------------------------------------------------------------+
3087 |allowed_address_pairs        |array             |A set of zero or more allowed address pairs.                                  |
3088 +-----------------------------+------------------+------------------------------------------------------------------------------+
3089 |binding:host_id              |string            |The ID of the host where the port resides.                                    |
3090 +-----------------------------+------------------+------------------------------------------------------------------------------+
3091 |binding:profile              |String            |A dictionary that enables the application running on the specific host        |
3092 +-----------------------------+------------------+------------------------------------------------------------------------------+
3093 |binding:vif_details          |object            |A dictionary which contains additional information on the port.               |
3094 +-----------------------------+------------------+------------------------------------------------------------------------------+
3095 |binding:vif_type             |String            |The type of which mechanism is used for the port.                             |
3096 +-----------------------------+------------------+------------------------------------------------------------------------------+
3097 |binding:vnic_type            |string            |The type of vNIC which this port should be attached to.                       |
3098 +-----------------------------+------------------+------------------------------------------------------------------------------+
3099 |created_at                   |string            |Time at which port has been created.                                          |
3100 +-----------------------------+------------------+------------------------------------------------------------------------------+
3101 |data_plane_status            |string            |Status of the underlying data plane of a port.                                |
3102 +-----------------------------+------------------+------------------------------------------------------------------------------+
3103 |description                  |string            |A human-readable description for the resource.                                |
3104 +-----------------------------+------------------+------------------------------------------------------------------------------+
3105 |device_id                    |string            |The ID of the device that uses this port.                                     |
3106 +-----------------------------+------------------+------------------------------------------------------------------------------+
3107 |device_owner                 |string            |The entity type that uses this port.                                          |
3108 +-----------------------------+------------------+------------------------------------------------------------------------------+
3109 |dns_assignment               |object            |Data assigned to a port by the Networking internal DNS                        |
3110 +-----------------------------+------------------+------------------------------------------------------------------------------+
3111 |dns_domain                   |string            |A valid DNS domain.                                                           |
3112 +-----------------------------+------------------+------------------------------------------------------------------------------+
3113 |dns_name                     |string            |A valid DNS name.                                                             |
3114 +-----------------------------+------------------+------------------------------------------------------------------------------+
3115 |extra_dhcp_opts              |array             |A set of zero or more extra DHCP option pairs.                                |
3116 +-----------------------------+------------------+------------------------------------------------------------------------------+
3117 |fixed_ips                    |array             |The IP addresses for the port.                                                |
3118 +-----------------------------+------------------+------------------------------------------------------------------------------+
3119 |id                           |string            |The ID of the resource.                                                       |
3120 +-----------------------------+------------------+------------------------------------------------------------------------------+
3121 |mac_address                  |string            |The MAC address of the port.                                                  |
3122 +-----------------------------+------------------+------------------------------------------------------------------------------+
3123 |name                         |string            |Human-readable name of the resource.                                          |
3124 +-----------------------------+------------------+------------------------------------------------------------------------------+
3125 |network_id                   |string            |The ID of the attached network.                                               |
3126 +-----------------------------+------------------+------------------------------------------------------------------------------+
3127 |port_security_enabled        |boolean           |The port security status.                                                     |
3128 +-----------------------------+------------------+------------------------------------------------------------------------------+
3129 |project_id                   |string            |The ID of the project.                                                        |
3130 +-----------------------------+------------------+------------------------------------------------------------------------------+
3131 |revision_number              |integer           |The revision number of the resource.                                          |
3132 +-----------------------------+------------------+------------------------------------------------------------------------------+
3133 |security_groups              |array             |The IDs of security groups applied to the port.                               |
3134 +-----------------------------+------------------+------------------------------------------------------------------------------+
3135 |status                       |string            |The port status. Values are ACTIVE, DOWN, BUILD and ERROR.                    |
3136 +-----------------------------+------------------+------------------------------------------------------------------------------+
3137 |tenant_id                    |string            |The ID of the project.                                                        |
3138 +-----------------------------+------------------+------------------------------------------------------------------------------+
3139 |updated_at                   |string            |Time at which port has been updated.                                          |
3140 +-----------------------------+------------------+------------------------------------------------------------------------------+
3141
3142 Delete Port
3143 +++++++++++++++
3144
3145 https://developer.openstack.org/api-ref/network/v2/#delete-port
3146
3147 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3148 |Interface Definition|Description                                                                                                            |
3149 +====================+=======================================================================================================================+
3150 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports/{port-id}                        |
3151 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3152 |Operation Type      |DELETE                                                                                                                 |
3153 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3154 |Content-Type        |application/json                                                                                                       |
3155 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3156
3157 Request Body:
3158
3159 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3160 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
3161 +============================+=========+===========+==========================+==============================================================+
3162 |port_id                     |M        |1          |String                    |The ID of the port.                                           |
3163 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3164
3165 Create Security Group
3166 ++++++++++++++++++++++
3167
3168 https://developer.openstack.org/api-ref/network/v2/#create-security-group
3169
3170 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3171 |Interface Definition|Description                                                                                                            |
3172 +====================+=======================================================================================================================+
3173 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups                        |
3174 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3175 |Operation Type      |POST                                                                                                                   |
3176 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3177 |Content-Type        |application/json                                                                                                       |
3178 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3179
3180 Request Body:
3181
3182 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3183 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
3184 +============================+=========+===========+==========================+==============================================================+
3185 |security_group              |M        |1          |object                    |A security_group object.                                      |
3186 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3187 |tenant_id                   |M        |1          |string                    |The ID of the project.                                        |
3188 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3189 |project_id                  |M        |1          |string                    |The ID of the project.                                        |
3190 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3191 |description                 |O        |1          |string                    |A human-readable description for the resource.                |
3192 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3193 |name                        |M        |1          |string                    |Human-readable name of the resource.                          |
3194 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3195
3196 Response:
3197
3198 +-----------------------------+------------------+------------------------------------------------------------------------------+
3199 |Attribute                    |Content           |Description                                                                   |
3200 +=============================+==================+==============================================================================+
3201 |security_group               |object            |A security_group object.                                                      |
3202 +-----------------------------+------------------+------------------------------------------------------------------------------+
3203 |id                           |string            |The ID of the security group.                                                 |
3204 +-----------------------------+------------------+------------------------------------------------------------------------------+
3205 |tenant_id                    |string            |The ID of the project.                                                        |
3206 +-----------------------------+------------------+------------------------------------------------------------------------------+
3207 |project_id                   |string            |The ID of the project.                                                        |
3208 +-----------------------------+------------------+------------------------------------------------------------------------------+
3209 |revision_number              |integer           |The revision number of the resource.                                          |
3210 +-----------------------------+------------------+------------------------------------------------------------------------------+
3211 |name                         |string            |Human-readable name of the resource.                                          |
3212 +-----------------------------+------------------+------------------------------------------------------------------------------+
3213 |description                  |string            |A human-readable description for the resource.                                |
3214 +-----------------------------+------------------+------------------------------------------------------------------------------+
3215 |security_group_rules         |array             |A list of security_group_rule objects.                                        |
3216 +-----------------------------+------------------+------------------------------------------------------------------------------+
3217
3218 Delete security group
3219 ++++++++++++++++++++++
3220
3221 https://developer.openstack.org/api-ref/network/v2/#delete-security-group
3222
3223 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3224 |Interface Definition|Description                                                                                                            |
3225 +====================+=======================================================================================================================+
3226 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups/{security-group-id}    |
3227 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3228 |Operation Type      |DELETE                                                                                                                 |
3229 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3230 |Content-Type        |application/json                                                                                                       |
3231 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3232
3233 Request Body:
3234
3235 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3236 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
3237 +============================+=========+===========+==========================+==============================================================+
3238 |security_group_id           |M        |1          |String                    |The ID of the security group.                                 |
3239 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3240
3241 Create Security Group Rule
3242 ++++++++++++++++++++++++++
3243
3244 https://developer.openstack.org/api-ref/network/v2/#create-security-group-rule
3245
3246 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3247 |Interface Definition|Description                                                                                                            |
3248 +====================+=======================================================================================================================+
3249 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules                   |
3250 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3251 |Operation Type      |POST                                                                                                                   |
3252 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3253 |Content-Type        |application/json                                                                                                       |
3254 +--------------------+-----------------------------------------------------------------------------------------------------------------------+
3255
3256 Request Body:
3257
3258 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3259 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                                                     |
3260 +============================+=========+===========+==========================+================================================================================================+
3261 |security_group_rule         |M        |1          |object                    |A security_group_rule object.                                                                   |
3262 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3263 |remote_group_id             |O        |1          |string                    |The remote group UUID to associate with this security group rule.                               |
3264 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3265 |direction                   |M        |1          |string                    |Ingress or egress, which is the direction in which the metering rule is applied.                |
3266 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3267 |protocol                    |M        |1          |string                    |The IP protocol can be represented by a string, an integer, or null.                            |
3268 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3269 |ethertype                   |O        |1          |string                    |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
3270 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3271 |port_range_max              |O        |1          |integer                   |The maximum port number in the range that is matched by the security group rule.                |
3272 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3273 |security_group_id           |M        |1          |string                    |The security group ID to associate with this security group rule.                               |
3274 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3275 |port_range_min              |O        |1          |integer                   |The minimum port number in the range that is matched by the security group rule.                |
3276 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3277 |remote_ip_prefix            |M        |1          |string                    |The remote IP prefix to associate with this metering rule packet.                               |
3278 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3279 |description                 |O        |1          |string                    |A human-readable description for the resource. Default is an empty string.                      |
3280 +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
3281
3282 Response:
3283
3284 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3285 |Attribute                    |Content           |Description                                                                                      |
3286 +=============================+==================+=================================================================================================+
3287 |security_group_rule          |object            |A security_group_rule object.                                                                    |
3288 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3289 |remote_group_id              |string            |The remote group UUID to associate with this security group rule.                                |
3290 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3291 |direction                    |string            |Ingress or egress, which is the direction in which the metering rule is applied.                 |
3292 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3293 |protocol                     |string            |The IP protocol can be represented by a string, an integer, or null.                             |
3294 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3295 |ethertype                    |string            |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules.  |
3296 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3297 |port_range_max               |integer           |The maximum port number in the range that is matched by the security group rule.                 |
3298 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3299 |security_group_id            |string            |The security group ID to associate with this security group rule.                                |
3300 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3301 |tenant_id                    |string            |The ID of the project.                                                                           |
3302 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3303 |project_id                   |string            |The ID of the project.                                                                           |
3304 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3305 |port_range_min               |integer           |The minimum port number in the range that is matched by the security group rule.                 |
3306 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3307 |remote_ip_prefix             |string            |The remote IP prefix to associate with this metering rule packet.                                |
3308 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3309 |revision_number              |integer           |The revision number of the resource.                                                             |
3310 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3311 |id                           |string            |The ID of the security group rule.                                                               |
3312 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3313 |description                  |string            |A human-readable description for the resource.                                                   |
3314 +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
3315
3316 Delete security group
3317 ++++++++++++++++++++++
3318
3319 https://developer.openstack.org/api-ref/networking/v2/#delete-security-group-rule
3320
3321 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3322 |Interface Definition|Description                                                                                                                      |
3323 +====================+=================================================================================================================================+
3324 |URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules/{security-group-rule-id}    |
3325 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3326 |Operation Type      |DELETE                                                                                                                           |
3327 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3328 |Content-Type        |application/json                                                                                                                 |
3329 +--------------------+---------------------------------------------------------------------------------------------------------------------------------+
3330
3331 Request Body:
3332
3333 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3334 |Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
3335 +============================+=========+===========+==========================+==============================================================+
3336 |security_group_rule_id      |M        |1          |String                    |The ID of the security group rule.                            |
3337 +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
3338
3339 Policy API
3340 ----------
3341
3342 Create a dictionary item
3343 ++++++++++++++++++++++++
3344
3345 +--------------------+--------------------------+
3346 |Interface Definition|Description               |
3347 +====================+==========================+
3348 |URI                 |/createDictionaryItem     |
3349 +--------------------+--------------------------+
3350 |Operation Type      |PUT                       |
3351 +--------------------+--------------------------+
3352
3353 Request Parameters:
3354
3355 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3356 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3357 +===================+=========+===========+=======+=============================================================+
3358 |dictionory         |M        |1          |String |                                                             |
3359 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3360 |dictionaryJson     |M        |1          |String |                                                             |
3361 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3362 |dictionaryType     |M        |1          |String |                                                             |
3363 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3364 |requestId          |M        |1          |String |                                                             |
3365 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3366
3367 Request Headers:
3368
3369 +-------------------+---------+-----------------------------------------------------------------------------------------+
3370 |Header Name        |Qualifier|Description                                                                              |
3371 +===================+=========+=========================================================================================+
3372 |ClientAuth         |Y        |encoded client authentication details                                                    |
3373 +-------------------+---------+-----------------------------------------------------------------------------------------+
3374 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3375 +-------------------+---------+-----------------------------------------------------------------------------------------+
3376 |Environment        |Y        |execution environments                                                                   |
3377 +-------------------+---------+-----------------------------------------------------------------------------------------+
3378 |Authorization      |Y        |Base64 encoded username:password                                                         |
3379 +-------------------+---------+-----------------------------------------------------------------------------------------+
3380
3381 HTTP Response Code:
3382
3383 +------------------+---------------------+
3384 |HTTP CODE         |Description          |
3385 +==================+=====================+
3386 |200               |successful           |
3387 +------------------+---------------------+
3388 |400               |Invalid Request      |
3389 +------------------+---------------------+
3390 |401               |Unauthorized         |
3391 +------------------+---------------------+
3392 |500               |Error                |
3393 +------------------+---------------------+
3394
3395 Create Policy
3396 +++++++++++++
3397
3398 +--------------------+--------------------------+
3399 |Interface Definition|Description               |
3400 +====================+==========================+
3401 |URI                 |/createPolicy             |
3402 +--------------------+--------------------------+
3403 |Operation Type      |PUT                       |
3404 +--------------------+--------------------------+
3405
3406 Request Parameters:
3407
3408 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3409 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3410 +===================+=========+===========+=======+=============================================================+
3411 |attributes         |M        |1          |Object |set of attributes in key value pair                          |
3412 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3413 |configBody         |M        |1          |String |                                                             |
3414 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3415 |configBodyType     |M        |1          |String |                                                             |
3416 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3417 |configName         |M        |1          |String |                                                             |
3418 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3419 |ecompName          |M        |1          |String |                                                             |
3420 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3421 |policyClass        |M        |1          |String |                                                             |
3422 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3423 |policyConfigType   |M        |1          |String |                                                             |
3424 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3425 |policyDescription  |M        |1          |String |                                                             |
3426 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3427 |policyName         |M        |1          |String |                                                             |
3428 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3429 |requestID          |M        |1          |String |request ID                                                   |
3430 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3431
3432 Request Headers:
3433
3434 +-------------------+---------+-----------------------------------------------------------------------------------------+
3435 |Header Name        |Qualifier|Description                                                                              |
3436 +===================+=========+=========================================================================================+
3437 |ClientAuth         |Y        |encoded client authentication details                                                    |
3438 +-------------------+---------+-----------------------------------------------------------------------------------------+
3439 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3440 +-------------------+---------+-----------------------------------------------------------------------------------------+
3441 |Environment        |Y        |execution environments                                                                   |
3442 +-------------------+---------+-----------------------------------------------------------------------------------------+
3443 |Authorization      |Y        |Base64 encoded username:password                                                         |
3444 +-------------------+---------+-----------------------------------------------------------------------------------------+
3445
3446 HTTP Response Code:
3447
3448 +------------------+---------------------+
3449 |HTTP CODE         |Description          |
3450 +==================+=====================+
3451 |200               |successful           |
3452 +------------------+---------------------+
3453 |400               |Invalid Request      |
3454 +------------------+---------------------+
3455 |401               |Unauthorized         |
3456 +------------------+---------------------+
3457 |500               |Error                |
3458 +------------------+---------------------+
3459
3460 Delete Policy
3461 +++++++++++++
3462
3463 +--------------------+--------------------------+
3464 |Interface Definition|Description               |
3465 +====================+==========================+
3466 |URI                 |/deletePolicy             |
3467 +--------------------+--------------------------+
3468 |Operation Type      |DELETE                    |
3469 +--------------------+--------------------------+
3470
3471 Request Parameters:
3472
3473 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3474 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3475 +===================+=========+===========+=======+=============================================================+
3476 |deleteCondition    |M        |1          |String |                                                             |
3477 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3478 |pdpGroup           |M        |1          |String |                                                             |
3479 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3480 |policyComponent    |M        |1          |String |                                                             |
3481 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3482 |policyName         |M        |1          |String |                                                             |
3483 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3484 |policyType         |M        |1          |String |                                                             |
3485 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3486 |requestID          |M        |1          |String |request ID                                                   |
3487 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3488
3489 Request Headers:
3490
3491 +-------------------+---------+-----------------------------------------------------------------------------------------+
3492 |Header Name        |Qualifier|Description                                                                              |
3493 +===================+=========+=========================================================================================+
3494 |ClientAuth         |Y        |encoded client authentication details                                                    |
3495 +-------------------+---------+-----------------------------------------------------------------------------------------+
3496 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3497 +-------------------+---------+-----------------------------------------------------------------------------------------+
3498 |Environment        |Y        |execution environments                                                                   |
3499 +-------------------+---------+-----------------------------------------------------------------------------------------+
3500 |Authorization      |Y        |Base64 encoded username:password                                                         |
3501 +-------------------+---------+-----------------------------------------------------------------------------------------+
3502
3503 HTTP Response Code:
3504
3505 +------------------+---------------------+
3506 |HTTP CODE         |Description          |
3507 +==================+=====================+
3508 |200               |successful           |
3509 +------------------+---------------------+
3510 |400               |Invalid Request      |
3511 +------------------+---------------------+
3512 |401               |Unauthorized         |
3513 +------------------+---------------------+
3514 |500               |Error                |
3515 +------------------+---------------------+
3516
3517 Get Configuration
3518 +++++++++++++++++
3519
3520 +--------------------+--------------------------+
3521 |Interface Definition|Description               |
3522 +====================+==========================+
3523 |URI                 |/getConfig                |
3524 +--------------------+--------------------------+
3525 |Operation Type      |POST                      |
3526 +--------------------+--------------------------+
3527
3528 Request Parameters:
3529
3530 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3531 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3532 +===================+=========+===========+=======+=============================================================+
3533 |configAttributes   |M        |1          |String |                                                             |
3534 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3535 |configName         |M        |1          |String |                                                             |
3536 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3537 |ecompName          |M        |1          |String |                                                             |
3538 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3539 |policyName         |M        |1          |String |                                                             |
3540 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3541 |unique             |M        |1          |Boolean|                                                             |
3542 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3543 |requestID          |M        |1          |String |request ID                                                   |
3544 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3545
3546 Request Headers:
3547
3548 +-------------------+---------+-----------------------------------------------------------------------------------------+
3549 |Header Name        |Qualifier|Description                                                                              |
3550 +===================+=========+=========================================================================================+
3551 |ClientAuth         |Y        |encoded client authentication details                                                    |
3552 +-------------------+---------+-----------------------------------------------------------------------------------------+
3553 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3554 +-------------------+---------+-----------------------------------------------------------------------------------------+
3555 |Environment        |Y        |execution environments                                                                   |
3556 +-------------------+---------+-----------------------------------------------------------------------------------------+
3557 |Authorization      |Y        |Base64 encoded username:password                                                         |
3558 +-------------------+---------+-----------------------------------------------------------------------------------------+
3559
3560 HTTP Response Code:
3561
3562 +------------------+---------------------+
3563 |HTTP CODE         |Description          |
3564 +==================+=====================+
3565 |200               |successful           |
3566 +------------------+---------------------+
3567 |400               |Invalid Request      |
3568 +------------------+---------------------+
3569 |401               |Unauthorized         |
3570 +------------------+---------------------+
3571 |500               |Error                |
3572 +------------------+---------------------+
3573
3574 Get Decision
3575 ++++++++++++
3576
3577 +--------------------+--------------------------+
3578 |Interface Definition|Description               |
3579 +====================+==========================+
3580 |URI                 |/getDecision              |
3581 +--------------------+--------------------------+
3582 |Operation Type      |POST                      |
3583 +--------------------+--------------------------+
3584
3585 Request Parameters:
3586
3587 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3588 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3589 +===================+=========+===========+=======+=============================================================+
3590 |decisionAttributes |M        |1          |Object |                                                             |
3591 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3592 |ecompComponentName |M        |1          |String |                                                             |
3593 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3594 |requestID          |M        |1          |String |request ID                                                   |
3595 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3596
3597 Request Headers:
3598
3599 +-------------------+---------+-----------------------------------------------------------------------------------------+
3600 |Header Name        |Qualifier|Description                                                                              |
3601 +===================+=========+=========================================================================================+
3602 |ClientAuth         |Y        |encoded client authentication details                                                    |
3603 +-------------------+---------+-----------------------------------------------------------------------------------------+
3604 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3605 +-------------------+---------+-----------------------------------------------------------------------------------------+
3606 |Environment        |Y        |execution environments                                                                   |
3607 +-------------------+---------+-----------------------------------------------------------------------------------------+
3608 |Authorization      |Y        |Base64 encoded username:password                                                         |
3609 +-------------------+---------+-----------------------------------------------------------------------------------------+
3610
3611 HTTP Response Code:
3612
3613 +------------------+---------------------+
3614 |HTTP CODE         |Description          |
3615 +==================+=====================+
3616 |200               |successful           |
3617 +------------------+---------------------+
3618 |400               |Invalid Request      |
3619 +------------------+---------------------+
3620 |401               |Unauthorized         |
3621 +------------------+---------------------+
3622 |500               |Error                |
3623 +------------------+---------------------+
3624
3625 Response Parameters:
3626
3627 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3628 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3629 +===================+=========+===========+=======+=============================================================+
3630 |decision           |N        |1          |String |                                                             |
3631 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3632 |details            |N        |1          |String |                                                             |
3633 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3634
3635 Get Dictionary Items
3636 ++++++++++++++++++++
3637
3638 +--------------------+--------------------------+
3639 |Interface Definition|Description               |
3640 +====================+==========================+
3641 |URI                 |/getDictionaryItems       |
3642 +--------------------+--------------------------+
3643 |Operation Type      |POST                      |
3644 +--------------------+--------------------------+
3645
3646 Request Parameters:
3647
3648 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3649 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3650 +===================+=========+===========+=======+=============================================================+
3651 |dictionary         |N        |1          |String |                                                             |
3652 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3653 |dictionaryJson     |N        |1          |String |                                                             |
3654 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3655 |dictionaryType     |N        |1          |String |                                                             |
3656 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3657 |requestID          |M        |1          |String |request ID                                                   |
3658 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3659
3660 Request Headers:
3661
3662 +-------------------+---------+-----------------------------------------------------------------------------------------+
3663 |Header Name        |Qualifier|Description                                                                              |
3664 +===================+=========+=========================================================================================+
3665 |ClientAuth         |Y        |encoded client authentication details                                                    |
3666 +-------------------+---------+-----------------------------------------------------------------------------------------+
3667 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3668 +-------------------+---------+-----------------------------------------------------------------------------------------+
3669 |Environment        |Y        |execution environments                                                                   |
3670 +-------------------+---------+-----------------------------------------------------------------------------------------+
3671 |Authorization      |Y        |Base64 encoded username:password                                                         |
3672 +-------------------+---------+-----------------------------------------------------------------------------------------+
3673
3674 HTTP Response Code:
3675
3676 +------------------+---------------------+
3677 |HTTP CODE         |Description          |
3678 +==================+=====================+
3679 |200               |successful           |
3680 +------------------+---------------------+
3681 |400               |Invalid Request      |
3682 +------------------+---------------------+
3683 |401               |Unauthorized         |
3684 +------------------+---------------------+
3685 |500               |Error                |
3686 +------------------+---------------------+
3687
3688 Response Parameters:
3689
3690 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3691 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3692 +===================+=========+===========+=======+=============================================================+
3693 |dictionaryData     |N        |1          |Object |                                                             |
3694 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3695 |dictionaryJson     |N        |1          |Object |                                                             |
3696 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3697 |responseCode       |N        |1          |Integer|                                                             |
3698 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3699 |responseMessage    |N        |1          |Object |                                                             |
3700 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3701
3702 Get Metrics
3703 +++++++++++
3704
3705 +--------------------+--------------------------+
3706 |Interface Definition|Description               |
3707 +====================+==========================+
3708 |URI                 |/getMetrics               |
3709 +--------------------+--------------------------+
3710 |Operation Type      |GET                       |
3711 +--------------------+--------------------------+
3712
3713 Request Headers:
3714
3715 +-------------------+---------+-----------------------------------------------------------------------------------------+
3716 |Header Name        |Qualifier|Description                                                                              |
3717 +===================+=========+=========================================================================================+
3718 |ClientAuth         |Y        |encoded client authentication details                                                    |
3719 +-------------------+---------+-----------------------------------------------------------------------------------------+
3720 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3721 +-------------------+---------+-----------------------------------------------------------------------------------------+
3722 |Environment        |Y        |execution environments                                                                   |
3723 +-------------------+---------+-----------------------------------------------------------------------------------------+
3724 |Authorization      |Y        |Base64 encoded username:password                                                         |
3725 +-------------------+---------+-----------------------------------------------------------------------------------------+
3726
3727 HTTP Response Code:
3728
3729 +------------------+---------------------+
3730 |HTTP CODE         |Description          |
3731 +==================+=====================+
3732 |200               |successful           |
3733 +------------------+---------------------+
3734 |400               |Invalid Request      |
3735 +------------------+---------------------+
3736 |401               |Unauthorized         |
3737 +------------------+---------------------+
3738 |500               |Error                |
3739 +------------------+---------------------+
3740
3741 Response Parameters:
3742
3743 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3744 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3745 +===================+=========+===========+=======+=============================================================+
3746 |metricsTotal       |N        |1          |Integer|                                                             |
3747 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3748 |papMetrics         |N        |1          |Integer|                                                             |
3749 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3750 |pdpMetrics         |N        |1          |Integer|                                                             |
3751 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3752 |responseCode       |N        |1          |Object |                                                             |
3753 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3754 |responseMessage    |N        |1          |String |                                                             |
3755 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3756
3757 Get Notification
3758 ++++++++++++++++
3759
3760 +--------------------+--------------------------+
3761 |Interface Definition|Description               |
3762 +====================+==========================+
3763 |URI                 |/getNotification          |
3764 +--------------------+--------------------------+
3765 |Operation Type      |POST                      |
3766 +--------------------+--------------------------+
3767
3768 Request Headers:
3769
3770 +-------------------+---------+-----------------------------------------------------------------------------------------+
3771 |Header Name        |Qualifier|Description                                                                              |
3772 +===================+=========+=========================================================================================+
3773 |ClientAuth         |Y        |encoded client authentication details                                                    |
3774 +-------------------+---------+-----------------------------------------------------------------------------------------+
3775 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3776 +-------------------+---------+-----------------------------------------------------------------------------------------+
3777 |Environment        |Y        |execution environments                                                                   |
3778 +-------------------+---------+-----------------------------------------------------------------------------------------+
3779 |Authorization      |Y        |Base64 encoded username:password                                                         |
3780 +-------------------+---------+-----------------------------------------------------------------------------------------+
3781
3782 HTTP Response Code:
3783
3784 +------------------+---------------------+
3785 |HTTP CODE         |Description          |
3786 +==================+=====================+
3787 |200               |successful           |
3788 +------------------+---------------------+
3789 |400               |Invalid Request      |
3790 +------------------+---------------------+
3791 |401               |Unauthorized         |
3792 +------------------+---------------------+
3793 |500               |Error                |
3794 +------------------+---------------------+
3795
3796 Response Parameters:
3797
3798 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3799 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3800 +===================+=========+===========+=======+=============================================================+
3801 |metricsTotal       |N        |1          |Integer|                                                             |
3802 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3803 |papMetrics         |N        |1          |Integer|                                                             |
3804 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3805 |pdpMetrics         |N        |1          |Integer|                                                             |
3806 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3807 |responseCode       |N        |1          |Object |                                                             |
3808 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3809 |responseMessage    |N        |1          |String |                                                             |
3810 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3811
3812 List Configuration
3813 ++++++++++++++++++
3814
3815 +--------------------+--------------------------+
3816 |Interface Definition|Description               |
3817 +====================+==========================+
3818 |URI                 |/listConfiguration        |
3819 +--------------------+--------------------------+
3820 |Operation Type      |POST                      |
3821 +--------------------+--------------------------+
3822
3823 Request Headers:
3824
3825 +-------------------+---------+-----------------------------------------------------------------------------------------+
3826 |Header Name        |Qualifier|Description                                                                              |
3827 +===================+=========+=========================================================================================+
3828 |ClientAuth         |Y        |encoded client authentication details                                                    |
3829 +-------------------+---------+-----------------------------------------------------------------------------------------+
3830 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3831 +-------------------+---------+-----------------------------------------------------------------------------------------+
3832 |Environment        |Y        |execution environments                                                                   |
3833 +-------------------+---------+-----------------------------------------------------------------------------------------+
3834 |Authorization      |Y        |Base64 encoded username:password                                                         |
3835 +-------------------+---------+-----------------------------------------------------------------------------------------+
3836
3837 Request Parameters:
3838
3839 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3840 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3841 +===================+=========+===========+=======+=============================================================+
3842 |configAttributes   |N        |1          |Object |                                                             |
3843 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3844 |configName         |N        |1          |String |                                                             |
3845 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3846 |ecompName          |N        |1          |String |                                                             |
3847 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3848 |policyName         |N        |1          |String |                                                             |
3849 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3850 |requestID          |N        |1          |String |                                                             |
3851 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3852 |unique             |N        |1          |Boolean|                                                             |
3853 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3854
3855 HTTP Response Code:
3856
3857 +------------------+---------------------+
3858 |HTTP CODE         |Description          |
3859 +==================+=====================+
3860 |200               |successful           |
3861 +------------------+---------------------+
3862 |400               |Invalid Request      |
3863 +------------------+---------------------+
3864 |401               |Unauthorized         |
3865 +------------------+---------------------+
3866 |500               |Error                |
3867 +------------------+---------------------+
3868
3869 Import policy
3870 +++++++++++++
3871
3872 +--------------------+--------------------------+
3873 |Interface Definition|Description               |
3874 +====================+==========================+
3875 |URI                 |/policyEngineImport       |
3876 +--------------------+--------------------------+
3877 |Operation Type      |POST                      |
3878 +--------------------+--------------------------+
3879
3880 Request Headers:
3881
3882 +-------------------+---------+-----------------------------------------------------------------------------------------+
3883 |Header Name        |Qualifier|Description                                                                              |
3884 +===================+=========+=========================================================================================+
3885 |ClientAuth         |Y        |encoded client authentication details                                                    |
3886 +-------------------+---------+-----------------------------------------------------------------------------------------+
3887 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3888 +-------------------+---------+-----------------------------------------------------------------------------------------+
3889 |Environment        |Y        |execution environments                                                                   |
3890 +-------------------+---------+-----------------------------------------------------------------------------------------+
3891 |Authorization      |Y        |Base64 encoded username:password                                                         |
3892 +-------------------+---------+-----------------------------------------------------------------------------------------+
3893
3894 Request Parameters:
3895
3896 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3897 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3898 +===================+=========+===========+=======+=============================================================+
3899 |importParameterJson|Y        |1          |String |                                                             |
3900 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3901 |file               |Y        |1          |File   |                                                             |
3902 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3903
3904 HTTP Response Code:
3905
3906 +------------------+---------------------+
3907 |HTTP CODE         |Description          |
3908 +==================+=====================+
3909 |200               |successful           |
3910 +------------------+---------------------+
3911 |400               |Invalid Request      |
3912 +------------------+---------------------+
3913 |401               |Unauthorized         |
3914 +------------------+---------------------+
3915 |500               |Error                |
3916 +------------------+---------------------+
3917
3918 Push Policy
3919 +++++++++++
3920
3921 +--------------------+--------------------------+
3922 |Interface Definition|Description               |
3923 +====================+==========================+
3924 |URI                 |/pushPolicy               |
3925 +--------------------+--------------------------+
3926 |Operation Type      |PUT                       |
3927 +--------------------+--------------------------+
3928
3929 Request Headers:
3930
3931 +-------------------+---------+-----------------------------------------------------------------------------------------+
3932 |Header Name        |Qualifier|Description                                                                              |
3933 +===================+=========+=========================================================================================+
3934 |ClientAuth         |Y        |encoded client authentication details                                                    |
3935 +-------------------+---------+-----------------------------------------------------------------------------------------+
3936 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3937 +-------------------+---------+-----------------------------------------------------------------------------------------+
3938 |Environment        |Y        |execution environments                                                                   |
3939 +-------------------+---------+-----------------------------------------------------------------------------------------+
3940 |Authorization      |Y        |Base64 encoded username:password                                                         |
3941 +-------------------+---------+-----------------------------------------------------------------------------------------+
3942
3943 Request Parameters:
3944
3945 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3946 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3947 +===================+=========+===========+=======+=============================================================+
3948 |pdpGroup           |N        |1          |String |                                                             |
3949 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3950 |policyName         |N        |1          |String |                                                             |
3951 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3952 |policyType         |N        |1          |String |                                                             |
3953 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3954
3955 HTTP Response Code:
3956
3957 +------------------+---------------------+
3958 |HTTP CODE         |Description          |
3959 +==================+=====================+
3960 |200               |successful           |
3961 +------------------+---------------------+
3962 |400               |Invalid Request      |
3963 +------------------+---------------------+
3964 |401               |Unauthorized         |
3965 +------------------+---------------------+
3966 |500               |Error                |
3967 +------------------+---------------------+
3968
3969 Send Event
3970 ++++++++++
3971
3972 +--------------------+--------------------------+
3973 |Interface Definition|Description               |
3974 +====================+==========================+
3975 |URI                 |/sendEvent                |
3976 +--------------------+--------------------------+
3977 |Operation Type      |POST                      |
3978 +--------------------+--------------------------+
3979
3980 Request Headers:
3981
3982 +-------------------+---------+-----------------------------------------------------------------------------------------+
3983 |Header Name        |Qualifier|Description                                                                              |
3984 +===================+=========+=========================================================================================+
3985 |ClientAuth         |Y        |encoded client authentication details                                                    |
3986 +-------------------+---------+-----------------------------------------------------------------------------------------+
3987 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
3988 +-------------------+---------+-----------------------------------------------------------------------------------------+
3989 |Environment        |Y        |execution environments                                                                   |
3990 +-------------------+---------+-----------------------------------------------------------------------------------------+
3991 |Authorization      |Y        |Base64 encoded username:password                                                         |
3992 +-------------------+---------+-----------------------------------------------------------------------------------------+
3993
3994 Request Parameters:
3995
3996 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
3997 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
3998 +===================+=========+===========+=======+=============================================================+
3999 |eventAttributes    |N        |1          |Object |                                                             |
4000 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4001 |requestID          |N        |1          |String |                                                             |
4002 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4003
4004 HTTP Response Code:
4005
4006 +------------------+---------------------+
4007 |HTTP CODE         |Description          |
4008 +==================+=====================+
4009 |200               |successful           |
4010 +------------------+---------------------+
4011 |400               |Invalid Request      |
4012 +------------------+---------------------+
4013 |401               |Unauthorized         |
4014 +------------------+---------------------+
4015 |500               |Error                |
4016 +------------------+---------------------+
4017
4018 Send Heartbeat
4019 ++++++++++++++
4020
4021 +--------------------+--------------------------+
4022 |Interface Definition|Description               |
4023 +====================+==========================+
4024 |URI                 |/sendEvent                |
4025 +--------------------+--------------------------+
4026 |Operation Type      |POST                      |
4027 +--------------------+--------------------------+
4028
4029 Request Headers:
4030
4031 +-------------------+---------+-----------------------------------------------------------------------------------------+
4032 |Header Name        |Qualifier|Description                                                                              |
4033 +===================+=========+=========================================================================================+
4034 |ClientAuth         |Y        |encoded client authentication details                                                    |
4035 +-------------------+---------+-----------------------------------------------------------------------------------------+
4036 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
4037 +-------------------+---------+-----------------------------------------------------------------------------------------+
4038 |Environment        |Y        |execution environments                                                                   |
4039 +-------------------+---------+-----------------------------------------------------------------------------------------+
4040 |Authorization      |Y        |Base64 encoded username:password                                                         |
4041 +-------------------+---------+-----------------------------------------------------------------------------------------+
4042
4043 Request Parameters:
4044
4045 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4046 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
4047 +===================+=========+===========+=======+=============================================================+
4048 |notificationTopic  |Y        |1          |String |                                                             |
4049 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4050
4051 HTTP Response Code:
4052
4053 +------------------+---------------------+
4054 |HTTP CODE         |Description          |
4055 +==================+=====================+
4056 |200               |successful           |
4057 +------------------+---------------------+
4058 |400               |Invalid Request      |
4059 +------------------+---------------------+
4060 |401               |Unauthorized         |
4061 +------------------+---------------------+
4062 |500               |Error                |
4063 +------------------+---------------------+
4064
4065 Stop Notification
4066 +++++++++++++++++
4067
4068 +--------------------+--------------------------+
4069 |Interface Definition|Description               |
4070 +====================+==========================+
4071 |URI                 |/stopNotification         |
4072 +--------------------+--------------------------+
4073 |Operation Type      |POST                      |
4074 +--------------------+--------------------------+
4075
4076 Request Headers:
4077
4078 +-------------------+---------+-----------------------------------------------------------------------------------------+
4079 |Header Name        |Qualifier|Description                                                                              |
4080 +===================+=========+=========================================================================================+
4081 |ClientAuth         |Y        |encoded client authentication details                                                    |
4082 +-------------------+---------+-----------------------------------------------------------------------------------------+
4083 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
4084 +-------------------+---------+-----------------------------------------------------------------------------------------+
4085 |Environment        |Y        |execution environments                                                                   |
4086 +-------------------+---------+-----------------------------------------------------------------------------------------+
4087 |Authorization      |Y        |Base64 encoded username:password                                                         |
4088 +-------------------+---------+-----------------------------------------------------------------------------------------+
4089
4090 Request Parameters:
4091
4092 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4093 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
4094 +===================+=========+===========+=======+=============================================================+
4095 |notificationTopic  |Y        |1          |String |                                                             |
4096 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4097
4098 HTTP Response Code:
4099
4100 +------------------+---------------------+
4101 |HTTP CODE         |Description          |
4102 +==================+=====================+
4103 |200               |successful           |
4104 +------------------+---------------------+
4105 |400               |Invalid Request      |
4106 +------------------+---------------------+
4107 |401               |Unauthorized         |
4108 +------------------+---------------------+
4109 |500               |Error                |
4110 +------------------+---------------------+
4111
4112 Update Dictionary
4113 +++++++++++++++++
4114
4115 +--------------------+--------------------------+
4116 |Interface Definition|Description               |
4117 +====================+==========================+
4118 |URI                 |/updateDictionaryItem     |
4119 +--------------------+--------------------------+
4120 |Operation Type      |PUT                       |
4121 +--------------------+--------------------------+
4122
4123 Request Headers:
4124
4125 +-------------------+---------+-----------------------------------------------------------------------------------------+
4126 |Header Name        |Qualifier|Description                                                                              |
4127 +===================+=========+=========================================================================================+
4128 |ClientAuth         |Y        |encoded client authentication details                                                    |
4129 +-------------------+---------+-----------------------------------------------------------------------------------------+
4130 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
4131 +-------------------+---------+-----------------------------------------------------------------------------------------+
4132 |Environment        |Y        |execution environments                                                                   |
4133 +-------------------+---------+-----------------------------------------------------------------------------------------+
4134 |Authorization      |Y        |Base64 encoded username:password                                                         |
4135 +-------------------+---------+-----------------------------------------------------------------------------------------+
4136
4137 Request Parameters:
4138
4139 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4140 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
4141 +===================+=========+===========+=======+=============================================================+
4142 |dictionary         |N        |1          |String |                                                             |
4143 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4144 |dictionaryJson     |N        |1          |String |                                                             |
4145 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4146 |dictionaryType     |N        |1          |String |                                                             |
4147 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4148 |requestID          |N        |1          |String |                                                             |
4149 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4150
4151 HTTP Response Code:
4152
4153 +------------------+---------------------+
4154 |HTTP CODE         |Description          |
4155 +==================+=====================+
4156 |200               |successful           |
4157 +------------------+---------------------+
4158 |400               |Invalid Request      |
4159 +------------------+---------------------+
4160 |401               |Unauthorized         |
4161 +------------------+---------------------+
4162 |500               |Error                |
4163 +------------------+---------------------+
4164
4165 Update Policy
4166 +++++++++++++
4167
4168 +--------------------+--------------------------+
4169 |Interface Definition|Description               |
4170 +====================+==========================+
4171 |URI                 |/updatePolicy             |
4172 +--------------------+--------------------------+
4173 |Operation Type      |PUT                       |
4174 +--------------------+--------------------------+
4175
4176 Request Headers:
4177
4178 +-------------------+---------+-----------------------------------------------------------------------------------------+
4179 |Header Name        |Qualifier|Description                                                                              |
4180 +===================+=========+=========================================================================================+
4181 |ClientAuth         |Y        |encoded client authentication details                                                    |
4182 +-------------------+---------+-----------------------------------------------------------------------------------------+
4183 |X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
4184 +-------------------+---------+-----------------------------------------------------------------------------------------+
4185 |Environment        |Y        |execution environments                                                                   |
4186 +-------------------+---------+-----------------------------------------------------------------------------------------+
4187 |Authorization      |Y        |Base64 encoded username:password                                                         |
4188 +-------------------+---------+-----------------------------------------------------------------------------------------+
4189
4190 Request Parameters:
4191
4192 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4193 |Attribute          |Qualifier|Cardinality|Content|Description                                                  |
4194 +===================+=========+===========+=======+=============================================================+
4195 |attributes         |N        |1          |Object |                                                             |
4196 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4197 |configBody         |N        |1          |String |                                                             |
4198 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4199 |configBodyType     |N        |1          |String |                                                             |
4200 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4201 |configName         |N        |1          |String |                                                             |
4202 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4203 |ecompName          |N        |1          |String |                                                             |
4204 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4205 |policyClass        |N        |1          |String |                                                             |
4206 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4207 |policyConfigType   |N        |1          |String |                                                             |
4208 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4209 |policyDescription  |N        |1          |String |                                                             |
4210 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4211 |policyName         |N        |1          |String |                                                             |
4212 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4213 |requestID          |N        |1          |String |                                                             |
4214 +-------------------+---------+-----------+-------+-------------------------------------------------------------+
4215
4216 HTTP Response Code:
4217
4218 +------------------+---------------------+
4219 |HTTP CODE         |Description          |
4220 +==================+=====================+
4221 |200               |successful           |
4222 +------------------+---------------------+
4223 |400               |Invalid Request      |
4224 +------------------+---------------------+
4225 |401               |Unauthorized         |
4226 +------------------+---------------------+
4227 |500               |Error                |
4228 +------------------+---------------------+