docs/offeredapis.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 Offered APIs
   5 ============
   6
   7 :Date:   2017-10-18
   8
   9 .. contents::
  10    :depth: 3
  11 ..
  12
  13 Overview
  14 ========
  15
  16 Version information
  17 -------------------
  18
  19 *Version* : 1.0.0
  20
  21 URI scheme
  22 ----------
  23
  24 *Host* : localhost:8080 *BasePath* : /sdc2/rest *Schemes* : HTTP
  25
  26 Tags
  27 ----
  28
  29 -  Additional Information Servlet
  30
  31 -  BE Monitoring
  32
  33 -  Catalog Types Upload
  34
  35 -  Component Servlet
  36
  37 -  Consumer Servlet
  38
  39 -  Distribution Service Servlet
  40
  41 -  Element Servlet
  42
  43 -  Input Catalog
  44
  45 -  Lifecycle Actions Servlet
  46
  47 -  Product Catalog
  48
  49 -  Resource Artifact Servlet
  50
  51 -  Resource Attribute Servlet
  52
  53 -  Resource Group Servlet
  54
  55 -  Resource Instance Servlet
  56
  57 -  Resource Property Servlet
  58
  59 -  Resources Catalog
  60
  61 -  Resources Catalog Upload
  62
  63 -  Service Catalog
  64
  65 -  Types Fetch Servlet
  66
  67 -  User Administration
  68
  69 Paths
  70 =====
  71
  72 return aggregate BE health check of Titan, ES and BE
  73 ----------------------------------------------------
  74
  75 ::
  76
  77     GET /healthCheck
  78
  79 Description
  80 ~~~~~~~~~~~
  81
  82 return BE health check
  83
  84 Responses
  85 ~~~~~~~~~
  86
  87 +---------+----------------------------------------------------+----------------+
  88 | HTTP    | Description                                        | Schema         |
  89 | Code    |                                                    |                |
  90 +=========+====================================================+================+
  91 | **200** | Titan, ES and BE are all up                        | No Content     |
  92 +---------+----------------------------------------------------+----------------+
  93 | **500** | One or more BE components (Titan, ES, BE) are down | No Content     |
  94 +---------+----------------------------------------------------+----------------+
  95
  96 Consumes
  97 ~~~~~~~~
  98
  99 -  ``application/json``
 100
 101 Produces
 102 ~~~~~~~~
 103
 104 -  ``application/json``
 105
 106 Tags
 107 ~~~~
 108
 109 -  BE Monitoring
 110
 111 POST /monitoring
 112 ----------------
 113
 114 Parameters
 115 ~~~~~~~~~~
 116
 117 +------------------+--------------------------+----------------------------------+
 118 | Type             | Name                     | Schema                           |
 119 +==================+==========================+==================================+
 120 | **Body**         | **body**\ *optional*     | string                           |
 121 +------------------+--------------------------+----------------------------------+
 122
 123 Responses
 124 ~~~~~~~~~
 125
 126 +---------+----------------------------------------------------+----------------+
 127 | HTTP    | Description                                        | Schema         |
 128 | Code    |                                                    |                |
 129 +=========+====================================================+================+
 130 | **defau | successful operation                               | No Content     |
 131 | lt**    |                                                    |                |
 132 +---------+----------------------------------------------------+----------------+
 133
 134 Consumes
 135 ~~~~~~~~
 136
 137 -  ``application/json``
 138
 139 Produces
 140 ~~~~~~~~
 141
 142 -  ``application/json``
 143
 144 Tags
 145 ~~~~
 146
 147 -  BE Monitoring
 148
 149 Retrieve all artifactTypes
 150 --------------------------
 151
 152 ::
 153
 154     GET /v1/artifactTypes
 155
 156 Description
 157 ~~~~~~~~~~~
 158
 159 Retrieve all artifactTypes
 160
 161 Parameters
 162 ~~~~~~~~~~
 163
 164 +------------------+--------------------------+----------------------------------+
 165 | Type             | Name                     | Schema                           |
 166 +==================+==========================+==================================+
 167 | **Header**       | **USER\_ID**\ *optional* | string                           |
 168 +------------------+--------------------------+----------------------------------+
 169
 170 Responses
 171 ~~~~~~~~~
 172
 173 +---------+----------------------------------------------------+----------------+
 174 | HTTP    | Description                                        | Schema         |
 175 | Code    |                                                    |                |
 176 +=========+====================================================+================+
 177 | **200** | Returns artifactTypes Ok                           | No Content     |
 178 +---------+----------------------------------------------------+----------------+
 179 | **404** | No artifactTypes were found                        | No Content     |
 180 +---------+----------------------------------------------------+----------------+
 181 | **500** | Internal Server Error                              | No Content     |
 182 +---------+----------------------------------------------------+----------------+
 183
 184 Consumes
 185 ~~~~~~~~
 186
 187 -  ``application/json``
 188
 189 Produces
 190 ~~~~~~~~
 191
 192 -  ``application/json``
 193
 194 Tags
 195 ~~~~
 196
 197 -  Element Servlet
 198
 199 get component audit records
 200 ---------------------------
 201
 202 ::
 203
 204     GET /v1/catalog/audit-records/{componentType}/{componentUniqueId}
 205
 206 Description
 207 ~~~~~~~~~~~
 208
 209 get audit records for a service or a resource
 210
 211 Parameters
 212 ~~~~~~~~~~
 213
 214 +------------------+--------------------------+----------------------------------+
 215 | Type             | Name                     | Schema                           |
 216 +==================+==========================+==================================+
 217 | **Header**       | **USER\_ID**\ *optional* | string                           |
 218 +------------------+--------------------------+----------------------------------+
 219 | **Path**         | **componentType**\ *requ | string                           |
 220 |                  | ired*                    |                                  |
 221 +------------------+--------------------------+----------------------------------+
 222 | **Path**         | **componentUniqueId**\ * | string                           |
 223 |                  | required*                |                                  |
 224 +------------------+--------------------------+----------------------------------+
 225
 226 Responses
 227 ~~~~~~~~~
 228
 229 +---------+----------------------------------------------------+----------------+
 230 | HTTP    | Description                                        | Schema         |
 231 | Code    |                                                    |                |
 232 +=========+====================================================+================+
 233 | **200** | Service found                                      | No Content     |
 234 +---------+----------------------------------------------------+----------------+
 235 | **403** | Restricted operation                               | No Content     |
 236 +---------+----------------------------------------------------+----------------+
 237
 238 Consumes
 239 ~~~~~~~~
 240
 241 -  ``application/json``
 242
 243 Produces
 244 ~~~~~~~~
 245
 246 -  ``application/json``
 247
 248 Tags
 249 ~~~~
 250
 251 -  Service Catalog
 252
 253 Get data types
 254 --------------
 255
 256 ::
 257
 258     GET /v1/catalog/dataTypes
 259
 260 Description
 261 ~~~~~~~~~~~
 262
 263 Returns data types
 264
 265 Parameters
 266 ~~~~~~~~~~
 267
 268 +------------------+--------------------------+----------------------------------+
 269 | Type             | Name                     | Schema                           |
 270 +==================+==========================+==================================+
 271 | **Header**       | **USER\_ID**\ *optional* | string                           |
 272 +------------------+--------------------------+----------------------------------+
 273
 274 Responses
 275 ~~~~~~~~~
 276
 277 +---------+----------------------------------------------------+----------------+
 278 | HTTP    | Description                                        | Schema         |
 279 | Code    |                                                    |                |
 280 +=========+====================================================+================+
 281 | **200** | datatypes                                          | No Content     |
 282 +---------+----------------------------------------------------+----------------+
 283 | **400** | Invalid content / Missing content                  | No Content     |
 284 +---------+----------------------------------------------------+----------------+
 285 | **403** | Restricted operation                               | No Content     |
 286 +---------+----------------------------------------------------+----------------+
 287 | **404** | Data types not found                               | No Content     |
 288 +---------+----------------------------------------------------+----------------+
 289
 290 Consumes
 291 ~~~~~~~~
 292
 293 -  ``application/json``
 294
 295 Produces
 296 ~~~~~~~~
 297
 298 -  ``application/json``
 299
 300 Tags
 301 ~~~~
 302
 303 -  Types Fetch Servlet
 304
 305 Create product
 306 --------------
 307
 308 ::
 309
 310     POST /v1/catalog/products
 311
 312 Description
 313 ~~~~~~~~~~~
 314
 315 Returns created product
 316
 317 Parameters
 318 ~~~~~~~~~~
 319
 320 +----------+-------------+--------------------------------------+------------------+
 321 | Type     | Name        | Description                          | Schema           |
 322 +==========+=============+======================================+==================+
 323 | **Header | **USER\_ID* | USER\_ID of product strategist user  | string           |
 324 | **       | *\ *require |                                      |                  |
 325 |          | d*          |                                      |                  |
 326 +----------+-------------+--------------------------------------+------------------+
 327 | **Body** | **body**\ * | Product object to be created         | string           |
 328 |          | required*   |                                      |                  |
 329 +----------+-------------+--------------------------------------+------------------+
 330
 331 Responses
 332 ~~~~~~~~~
 333
 334 +---------+----------------------------------------------------+----------------+
 335 | HTTP    | Description                                        | Schema         |
 336 | Code    |                                                    |                |
 337 +=========+====================================================+================+
 338 | **200** | successful operation                               | `Product <#_pr |
 339 |         |                                                    | oduct>`__      |
 340 +---------+----------------------------------------------------+----------------+
 341 | **201** | Product created                                    | No Content     |
 342 +---------+----------------------------------------------------+----------------+
 343 | **400** | Invalid/missing content                            | No Content     |
 344 +---------+----------------------------------------------------+----------------+
 345 | **403** | Restricted operation / Empty USER\_ID header       | No Content     |
 346 +---------+----------------------------------------------------+----------------+
 347 | **409** | Product already exists / User not found / Wrong    | No Content     |
 348 |         | user role                                          |                |
 349 +---------+----------------------------------------------------+----------------+
 350
 351 Consumes
 352 ~~~~~~~~
 353
 354 -  ``application/json``
 355
 356 Produces
 357 ~~~~~~~~
 358
 359 -  ``application/json``
 360
 361 Tags
 362 ~~~~
 363
 364 -  Product Catalog
 365
 366 Retrieve Service
 367 ----------------
 368
 369 ::
 370
 371     GET /v1/catalog/products/productName/{productName}/productVersion/{productVersion}
 372
 373 Description
 374 ~~~~~~~~~~~
 375
 376 Returns product according to name and version
 377
 378 Parameters
 379 ~~~~~~~~~~
 380
 381 +------------------+--------------------------+----------------------------------+
 382 | Type             | Name                     | Schema                           |
 383 +==================+==========================+==================================+
 384 | **Header**       | **USER\_ID**\ *optional* | string                           |
 385 +------------------+--------------------------+----------------------------------+
 386 | **Path**         | **productName**\ *requir | string                           |
 387 |                  | ed*                      |                                  |
 388 +------------------+--------------------------+----------------------------------+
 389 | **Path**         | **productVersion**\ *req | string                           |
 390 |                  | uired*                   |                                  |
 391 +------------------+--------------------------+----------------------------------+
 392
 393 Responses
 394 ~~~~~~~~~
 395
 396 +---------+----------------------------------------------------+----------------+
 397 | HTTP    | Description                                        | Schema         |
 398 | Code    |                                                    |                |
 399 +=========+====================================================+================+
 400 | **200** | Product found                                      | No Content     |
 401 +---------+----------------------------------------------------+----------------+
 402 | **403** | Restricted operation                               | No Content     |
 403 +---------+----------------------------------------------------+----------------+
 404 | **404** | Product not found                                  | No Content     |
 405 +---------+----------------------------------------------------+----------------+
 406
 407 Consumes
 408 ~~~~~~~~
 409
 410 -  ``application/json``
 411
 412 Produces
 413 ~~~~~~~~
 414
 415 -  ``application/json``
 416
 417 Tags
 418 ~~~~
 419
 420 -  Product Catalog
 421
 422 validate product name
 423 ---------------------
 424
 425 ::
 426
 427     GET /v1/catalog/products/validate-name/{productName}
 428
 429 Description
 430 ~~~~~~~~~~~
 431
 432 checks if the chosen product name is available
 433
 434 Parameters
 435 ~~~~~~~~~~
 436
 437 +------------------+--------------------------+----------------------------------+
 438 | Type             | Name                     | Schema                           |
 439 +==================+==========================+==================================+
 440 | **Header**       | **USER\_ID**\ *optional* | string                           |
 441 +------------------+--------------------------+----------------------------------+
 442 | **Path**         | **productName**\ *requir | string                           |
 443 |                  | ed*                      |                                  |
 444 +------------------+--------------------------+----------------------------------+
 445
 446 Responses
 447 ~~~~~~~~~
 448
 449 +---------+----------------------------------------------------+----------------+
 450 | HTTP    | Description                                        | Schema         |
 451 | Code    |                                                    |                |
 452 +=========+====================================================+================+
 453 | **200** | Service found                                      | No Content     |
 454 +---------+----------------------------------------------------+----------------+
 455 | **403** | Restricted operation                               | No Content     |
 456 +---------+----------------------------------------------------+----------------+
 457
 458 Consumes
 459 ~~~~~~~~
 460
 461 -  ``application/json``
 462
 463 Produces
 464 ~~~~~~~~
 465
 466 -  ``application/json``
 467
 468 Tags
 469 ~~~~
 470
 471 -  Product Catalog
 472
 473 Retrieve product
 474 ----------------
 475
 476 ::
 477
 478     GET /v1/catalog/products/{productId}
 479
 480 Description
 481 ~~~~~~~~~~~
 482
 483 Returns product according to productId
 484
 485 Parameters
 486 ~~~~~~~~~~
 487
 488 +------------------+--------------------------+----------------------------------+
 489 | Type             | Name                     | Schema                           |
 490 +==================+==========================+==================================+
 491 | **Header**       | **USER\_ID**\ *optional* | string                           |
 492 +------------------+--------------------------+----------------------------------+
 493 | **Path**         | **productId**\ *required | string                           |
 494 |                  | *                        |                                  |
 495 +------------------+--------------------------+----------------------------------+
 496
 497 Responses
 498 ~~~~~~~~~
 499
 500 +---------+----------------------------------------------------+----------------+
 501 | HTTP    | Description                                        | Schema         |
 502 | Code    |                                                    |                |
 503 +=========+====================================================+================+
 504 | **200** | Product found                                      | No Content     |
 505 +---------+----------------------------------------------------+----------------+
 506 | **403** | Missing information                                | No Content     |
 507 +---------+----------------------------------------------------+----------------+
 508 | **404** | Product not found                                  | No Content     |
 509 +---------+----------------------------------------------------+----------------+
 510 | **409** | Restricted operation                               | No Content     |
 511 +---------+----------------------------------------------------+----------------+
 512 | **500** | Internal Server Error                              | No Content     |
 513 +---------+----------------------------------------------------+----------------+
 514
 515 Consumes
 516 ~~~~~~~~
 517
 518 -  ``application/json``
 519
 520 Produces
 521 ~~~~~~~~
 522
 523 -  ``application/json``
 524
 525 Tags
 526 ~~~~
 527
 528 -  Product Catalog
 529
 530 DELETE /v1/catalog/products/{productid}
 531 ---------------------------------------
 532
 533 Parameters
 534 ~~~~~~~~~~
 535
 536 +------------------+--------------------------+----------------------------------+
 537 | Type             | Name                     | Schema                           |
 538 +==================+==========================+==================================+
 539 | **Path**         | **productId**\ *required | string                           |
 540 |                  | *                        |                                  |
 541 +------------------+--------------------------+----------------------------------+
 542
 543 Responses
 544 ~~~~~~~~~
 545
 546 +---------+----------------------------------------------------+----------------+
 547 | HTTP    | Description                                        | Schema         |
 548 | Code    |                                                    |                |
 549 +=========+====================================================+================+
 550 | **defau | successful operation                               | No Content     |
 551 | lt**    |                                                    |                |
 552 +---------+----------------------------------------------------+----------------+
 553
 554 Tags
 555 ~~~~
 556
 557 -  Product Catalog
 558
 559 Update Product Metadata
 560 -----------------------
 561
 562 ::
 563
 564     PUT /v1/catalog/products/{productId}/metadata
 565
 566 Description
 567 ~~~~~~~~~~~
 568
 569 Returns updated product
 570
 571 Parameters
 572 ~~~~~~~~~~
 573
 574 +----------+-------------+--------------------------------------+------------------+
 575 | Type     | Name        | Description                          | Schema           |
 576 +==========+=============+======================================+==================+
 577 | **Header | **USER\_ID* |                                      | string           |
 578 | **       | *\ *optiona |                                      |                  |
 579 |          | l*          |                                      |                  |
 580 +----------+-------------+--------------------------------------+------------------+
 581 | **Path** | **productId |                                      | string           |
 582 |          | **\ *requir |                                      |                  |
 583 |          | ed*         |                                      |                  |
 584 +----------+-------------+--------------------------------------+------------------+
 585 | **Body** | **body**\ * | Product object to be Updated         | string           |
 586 |          | required*   |                                      |                  |
 587 +----------+-------------+--------------------------------------+------------------+
 588
 589 Responses
 590 ~~~~~~~~~
 591
 592 +---------+----------------------------------------------------+----------------+
 593 | HTTP    | Description                                        | Schema         |
 594 | Code    |                                                    |                |
 595 +=========+====================================================+================+
 596 | **200** | Product Updated                                    | No Content     |
 597 +---------+----------------------------------------------------+----------------+
 598 | **400** | Invalid content / Missing content                  | No Content     |
 599 +---------+----------------------------------------------------+----------------+
 600 | **403** | Restricted operation                               | No Content     |
 601 +---------+----------------------------------------------------+----------------+
 602
 603 Consumes
 604 ~~~~~~~~
 605
 606 -  ``application/json``
 607
 608 Produces
 609 ~~~~~~~~
 610
 611 -  ``application/json``
 612
 613 Tags
 614 ~~~~
 615
 616 -  Product Catalog
 617
 618 Create Resource
 619 ---------------
 620
 621 ::
 622
 623     POST /v1/catalog/resources
 624
 625 Description
 626 ~~~~~~~~~~~
 627
 628 Returns created resource
 629
 630 Parameters
 631 ~~~~~~~~~~
 632
 633 +----------+-------------+--------------------------------------+------------------+
 634 | Type     | Name        | Description                          | Schema           |
 635 +==========+=============+======================================+==================+
 636 | **Header | **USER\_ID* |                                      | string           |
 637 | **       | *\ *optiona |                                      |                  |
 638 |          | l*          |                                      |                  |
 639 +----------+-------------+--------------------------------------+------------------+
 640 | **Body** | **body**\ * | Resource object to be created        | string           |
 641 |          | required*   |                                      |                  |
 642 +----------+-------------+--------------------------------------+------------------+
 643
 644 Responses
 645 ~~~~~~~~~
 646
 647 +---------+----------------------------------------------------+----------------+
 648 | HTTP    | Description                                        | Schema         |
 649 | Code    |                                                    |                |
 650 +=========+====================================================+================+
 651 | **200** | successful operation                               | `Resource <#_r |
 652 |         |                                                    | esource>`__    |
 653 +---------+----------------------------------------------------+----------------+
 654 | **201** | Resource created                                   | No Content     |
 655 +---------+----------------------------------------------------+----------------+
 656 | **400** | Invalid content / Missing content                  | No Content     |
 657 +---------+----------------------------------------------------+----------------+
 658 | **403** | Restricted operation                               | No Content     |
 659 +---------+----------------------------------------------------+----------------+
 660 | **409** | Resource already exist                             | No Content     |
 661 +---------+----------------------------------------------------+----------------+
 662
 663 Consumes
 664 ~~~~~~~~
 665
 666 -  ``application/json``
 667
 668 Produces
 669 ~~~~~~~~
 670
 671 -  ``application/json``
 672
 673 Tags
 674 ~~~~
 675
 676 -  Resources Catalog
 677
 678 GET /v1/catalog/resources/certified/abstract
 679 --------------------------------------------
 680
 681 Parameters
 682 ~~~~~~~~~~
 683
 684 +------------------+--------------------------+----------------------------------+
 685 | Type             | Name                     | Schema                           |
 686 +==================+==========================+==================================+
 687 | **Header**       | **USER\_ID**\ *optional* | string                           |
 688 +------------------+--------------------------+----------------------------------+
 689
 690 Responses
 691 ~~~~~~~~~
 692
 693 +---------+----------------------------------------------------+----------------+
 694 | HTTP    | Description                                        | Schema         |
 695 | Code    |                                                    |                |
 696 +=========+====================================================+================+
 697 | **defau | successful operation                               | No Content     |
 698 | lt**    |                                                    |                |
 699 +---------+----------------------------------------------------+----------------+
 700
 701 Consumes
 702 ~~~~~~~~
 703
 704 -  ``application/json``
 705
 706 Produces
 707 ~~~~~~~~
 708
 709 -  ``application/json``
 710
 711 Tags
 712 ~~~~
 713
 714 -  Resources Catalog
 715
 716 GET /v1/catalog/resources/certified/notabstract
 717 -----------------------------------------------
 718
 719 Parameters
 720 ~~~~~~~~~~
 721
 722 +------------------+--------------------------+----------------------------------+
 723 | Type             | Name                     | Schema                           |
 724 +==================+==========================+==================================+
 725 | **Header**       | **USER\_ID**\ *optional* | string                           |
 726 +------------------+--------------------------+----------------------------------+
 727
 728 Responses
 729 ~~~~~~~~~
 730
 731 +---------+----------------------------------------------------+----------------+
 732 | HTTP    | Description                                        | Schema         |
 733 | Code    |                                                    |                |
 734 +=========+====================================================+================+
 735 | **defau | successful operation                               | No Content     |
 736 | lt**    |                                                    |                |
 737 +---------+----------------------------------------------------+----------------+
 738
 739 Consumes
 740 ~~~~~~~~
 741
 742 -  ``application/json``
 743
 744 Produces
 745 ~~~~~~~~
 746
 747 -  ``application/json``
 748
 749 Tags
 750 ~~~~
 751
 752 -  Resources Catalog
 753
 754 Create Resource
 755 ---------------
 756
 757 ::
 758
 759     POST /v1/catalog/resources/csar/{csaruuid}
 760
 761 Description
 762 ~~~~~~~~~~~
 763
 764 Returns resource created from csar uuid
 765
 766 Parameters
 767 ~~~~~~~~~~
 768
 769 +------------------+--------------------------+----------------------------------+
 770 | Type             | Name                     | Schema                           |
 771 +==================+==========================+==================================+
 772 | **Header**       | **USER\_ID**\ *optional* | string                           |
 773 +------------------+--------------------------+----------------------------------+
 774 | **Path**         | **csaruuid**\ *required* | string                           |
 775 +------------------+--------------------------+----------------------------------+
 776
 777 Responses
 778 ~~~~~~~~~
 779
 780 +---------+----------------------------------------------------+----------------+
 781 | HTTP    | Description                                        | Schema         |
 782 | Code    |                                                    |                |
 783 +=========+====================================================+================+
 784 | **200** | successful operation                               | `Resource <#_r |
 785 |         |                                                    | esource>`__    |
 786 +---------+----------------------------------------------------+----------------+
 787 | **201** | Resource retrieced                                 | No Content     |
 788 +---------+----------------------------------------------------+----------------+
 789 | **400** | Invalid content / Missing content                  | No Content     |
 790 +---------+----------------------------------------------------+----------------+
 791 | **403** | Restricted operation                               | No Content     |
 792 +---------+----------------------------------------------------+----------------+
 793
 794 Consumes
 795 ~~~~~~~~
 796
 797 -  ``application/json``
 798
 799 Produces
 800 ~~~~~~~~
 801
 802 -  ``application/json``
 803
 804 Tags
 805 ~~~~
 806
 807 -  Resources Catalog
 808
 809 Retrieve Resource by name and version
 810 -------------------------------------
 811
 812 ::
 813
 814     GET /v1/catalog/resources/resourceName/{resourceName}/resourceVersion/{resourceVersion}
 815
 816 Description
 817 ~~~~~~~~~~~
 818
 819 Returns resource according to resourceId
 820
 821 Parameters
 822 ~~~~~~~~~~
 823
 824 +------------------+--------------------------+----------------------------------+
 825 | Type             | Name                     | Schema                           |
 826 +==================+==========================+==================================+
 827 | **Header**       | **USER\_ID**\ *optional* | string                           |
 828 +------------------+--------------------------+----------------------------------+
 829 | **Path**         | **resourceName**\ *requi | string                           |
 830 |                  | red*                     |                                  |
 831 +------------------+--------------------------+----------------------------------+
 832 | **Path**         | **resourceVersion**\ *re | string                           |
 833 |                  | quired*                  |                                  |
 834 +------------------+--------------------------+----------------------------------+
 835
 836 Responses
 837 ~~~~~~~~~
 838
 839 +---------+----------------------------------------------------+----------------+
 840 | HTTP    | Description                                        | Schema         |
 841 | Code    |                                                    |                |
 842 +=========+====================================================+================+
 843 | **200** | Resource found                                     | No Content     |
 844 +---------+----------------------------------------------------+----------------+
 845 | **403** | Restricted operation                               | No Content     |
 846 +---------+----------------------------------------------------+----------------+
 847 | **404** | Resource not found                                 | No Content     |
 848 +---------+----------------------------------------------------+----------------+
 849
 850 Consumes
 851 ~~~~~~~~
 852
 853 -  ``application/json``
 854
 855 Produces
 856 ~~~~~~~~
 857
 858 -  ``application/json``
 859
 860 Tags
 861 ~~~~
 862
 863 -  Resources Catalog
 864
 865 validate resource name
 866 ----------------------
 867
 868 ::
 869
 870     GET /v1/catalog/resources/validate-name/{resourceName}
 871
 872 Description
 873 ~~~~~~~~~~~
 874
 875 checks if the chosen resource name is available
 876
 877 Parameters
 878 ~~~~~~~~~~
 879
 880 +------------------+--------------------------+----------------------------------+
 881 | Type             | Name                     | Schema                           |
 882 +==================+==========================+==================================+
 883 | **Header**       | **USER\_ID**\ *optional* | string                           |
 884 +------------------+--------------------------+----------------------------------+
 885 | **Path**         | **resourceName**\ *requi | string                           |
 886 |                  | red*                     |                                  |
 887 +------------------+--------------------------+----------------------------------+
 888 | **Query**        | **subtype**\ *optional*  | string                           |
 889 +------------------+--------------------------+----------------------------------+
 890
 891 Responses
 892 ~~~~~~~~~
 893
 894 +---------+----------------------------------------------------+----------------+
 895 | HTTP    | Description                                        | Schema         |
 896 | Code    |                                                    |                |
 897 +=========+====================================================+================+
 898 | **200** | Resource found                                     | No Content     |
 899 +---------+----------------------------------------------------+----------------+
 900 | **403** | Restricted operation                               | No Content     |
 901 +---------+----------------------------------------------------+----------------+
 902
 903 Consumes
 904 ~~~~~~~~
 905
 906 -  ``application/json``
 907
 908 Produces
 909 ~~~~~~~~
 910
 911 -  ``application/json``
 912
 913 Tags
 914 ~~~~
 915
 916 -  Resources Catalog
 917
 918 Retrieve Resource
 919 -----------------
 920
 921 ::
 922
 923     GET /v1/catalog/resources/{resourceId}
 924
 925 Description
 926 ~~~~~~~~~~~
 927
 928 Returns resource according to resourceId
 929
 930 Parameters
 931 ~~~~~~~~~~
 932
 933 +------------------+--------------------------+----------------------------------+
 934 | Type             | Name                     | Schema                           |
 935 +==================+==========================+==================================+
 936 | **Header**       | **USER\_ID**\ *optional* | string                           |
 937 +------------------+--------------------------+----------------------------------+
 938 | **Path**         | **resourceId**\ *require | string                           |
 939 |                  | d*                       |                                  |
 940 +------------------+--------------------------+----------------------------------+
 941
 942 Responses
 943 ~~~~~~~~~
 944
 945 +---------+----------------------------------------------------+----------------+
 946 | HTTP    | Description                                        | Schema         |
 947 | Code    |                                                    |                |
 948 +=========+====================================================+================+
 949 | **200** | Resource found                                     | No Content     |
 950 +---------+----------------------------------------------------+----------------+
 951 | **403** | Restricted operation                               | No Content     |
 952 +---------+----------------------------------------------------+----------------+
 953 | **404** | Resource not found                                 | No Content     |
 954 +---------+----------------------------------------------------+----------------+
 955
 956 Consumes
 957 ~~~~~~~~
 958
 959 -  ``application/json``
 960
 961 Produces
 962 ~~~~~~~~
 963
 964 -  ``application/json``
 965
 966 Tags
 967 ~~~~
 968
 969 -  Resources Catalog
 970
 971 Update Resource
 972 ---------------
 973
 974 ::
 975
 976     PUT /v1/catalog/resources/{resourceId}
 977
 978 Description
 979 ~~~~~~~~~~~
 980
 981 Returns updated resource
 982
 983 Parameters
 984 ~~~~~~~~~~
 985
 986 +----------+-------------+--------------------------------------+------------------+
 987 | Type     | Name        | Description                          | Schema           |
 988 +==========+=============+======================================+==================+
 989 | **Header | **USER\_ID* |                                      | string           |
 990 | **       | *\ *optiona |                                      |                  |
 991 |          | l*          |                                      |                  |
 992 +----------+-------------+--------------------------------------+------------------+
 993 | **Path** | **resourceI |                                      | string           |
 994 |          | d**\ *requi |                                      |                  |
 995 |          | red*        |                                      |                  |
 996 +----------+-------------+--------------------------------------+------------------+
 997 | **Body** | **body**\ * | Resource object to be updated        | string           |
 998 |          | required*   |                                      |                  |
 999 +----------+-------------+--------------------------------------+------------------+
1000
1001 Responses
1002 ~~~~~~~~~
1003
1004 +---------+----------------------------------------------------+----------------+
1005 | HTTP    | Description                                        | Schema         |
1006 | Code    |                                                    |                |
1007 +=========+====================================================+================+
1008 | **200** | Resource updated                                   | No Content     |
1009 +---------+----------------------------------------------------+----------------+
1010 | **400** | Invalid content / Missing content                  | No Content     |
1011 +---------+----------------------------------------------------+----------------+
1012 | **403** | Restricted operation                               | No Content     |
1013 +---------+----------------------------------------------------+----------------+
1014 | **409** | Resource already exist                             | No Content     |
1015 +---------+----------------------------------------------------+----------------+
1016
1017 Consumes
1018 ~~~~~~~~
1019
1020 -  ``application/json``
1021
1022 Produces
1023 ~~~~~~~~
1024
1025 -  ``application/json``
1026
1027 Tags
1028 ~~~~
1029
1030 -  Resources Catalog
1031
1032 DELETE /v1/catalog/resources/{resourceid}
1033 -----------------------------------------
1034
1035 Parameters
1036 ~~~~~~~~~~
1037
1038 +------------------+--------------------------+----------------------------------+
1039 | Type             | Name                     | Schema                           |
1040 +==================+==========================+==================================+
1041 | **Path**         | **resourceId**\ *require | string                           |
1042 |                  | d*                       |                                  |
1043 +------------------+--------------------------+----------------------------------+
1044
1045 Responses
1046 ~~~~~~~~~
1047
1048 +---------+----------------------------------------------------+----------------+
1049 | HTTP    | Description                                        | Schema         |
1050 | Code    |                                                    |                |
1051 +=========+====================================================+================+
1052 | **defau | successful operation                               | No Content     |
1053 | lt**    |                                                    |                |
1054 +---------+----------------------------------------------------+----------------+
1055
1056 Tags
1057 ~~~~
1058
1059 -  Resources Catalog
1060
1061 Create Additional Information Label and Value
1062 ---------------------------------------------
1063
1064 ::
1065
1066     POST /v1/catalog/resources/{resourceId}/additionalinfo
1067
1068 Description
1069 ~~~~~~~~~~~
1070
1071 Returns created Additional Inforamtion property
1072
1073 Parameters
1074 ~~~~~~~~~~
1075
1076 +----------+-------------+--------------------------------------+------------------+
1077 | Type     | Name        | Description                          | Schema           |
1078 +==========+=============+======================================+==================+
1079 | **Header | **USER\_ID* |                                      | string           |
1080 | **       | *\ *optiona |                                      |                  |
1081 |          | l*          |                                      |                  |
1082 +----------+-------------+--------------------------------------+------------------+
1083 | **Path** | **resourceI | resource id to update with new       | string           |
1084 |          | d**\ *requi | property                             |                  |
1085 |          | red*        |                                      |                  |
1086 +----------+-------------+--------------------------------------+------------------+
1087 | **Body** | **body**\ * | Additional information key value to  | string           |
1088 |          | required*   | be created                           |                  |
1089 +----------+-------------+--------------------------------------+------------------+
1090
1091 Responses
1092 ~~~~~~~~~
1093
1094 +---------+----------------------------------------------------+----------------+
1095 | HTTP    | Description                                        | Schema         |
1096 | Code    |                                                    |                |
1097 +=========+====================================================+================+
1098 | **201** | Additional information created                     | No Content     |
1099 +---------+----------------------------------------------------+----------------+
1100 | **400** | Invalid content / Missing content                  | No Content     |
1101 +---------+----------------------------------------------------+----------------+
1102 | **403** | Restricted operation                               | No Content     |
1103 +---------+----------------------------------------------------+----------------+
1104 | **409** | Additional information key already exist           | No Content     |
1105 +---------+----------------------------------------------------+----------------+
1106
1107 Consumes
1108 ~~~~~~~~
1109
1110 -  ``application/json``
1111
1112 Produces
1113 ~~~~~~~~
1114
1115 -  ``application/json``
1116
1117 Tags
1118 ~~~~
1119
1120 -  Additional Information Servlet
1121
1122 Get all Additional Information under resource
1123 ---------------------------------------------
1124
1125 ::
1126
1127     GET /v1/catalog/resources/{resourceId}/additionalinfo
1128
1129 Description
1130 ~~~~~~~~~~~
1131
1132 Returns Additional Inforamtion property
1133
1134 Parameters
1135 ~~~~~~~~~~
1136
1137 +----------+-------------+--------------------------------------+------------------+
1138 | Type     | Name        | Description                          | Schema           |
1139 +==========+=============+======================================+==================+
1140 | **Header | **USER\_ID* |                                      | string           |
1141 | **       | *\ *optiona |                                      |                  |
1142 |          | l*          |                                      |                  |
1143 +----------+-------------+--------------------------------------+------------------+
1144 | **Path** | **resourceI | resource id to update with new       | string           |
1145 |          | d**\ *requi | property                             |                  |
1146 |          | red*        |                                      |                  |
1147 +----------+-------------+--------------------------------------+------------------+
1148
1149 Responses
1150 ~~~~~~~~~
1151
1152 +---------+----------------------------------------------------+----------------+
1153 | HTTP    | Description                                        | Schema         |
1154 | Code    |                                                    |                |
1155 +=========+====================================================+================+
1156 | **200** | list of additional information                     | No Content     |
1157 +---------+----------------------------------------------------+----------------+
1158 | **400** | Invalid content / Missing content                  | No Content     |
1159 +---------+----------------------------------------------------+----------------+
1160 | **403** | Restricted operation                               | No Content     |
1161 +---------+----------------------------------------------------+----------------+
1162 | **409** | Additional information key already exist           | No Content     |
1163 +---------+----------------------------------------------------+----------------+
1164
1165 Consumes
1166 ~~~~~~~~
1167
1168 -  ``application/json``
1169
1170 Produces
1171 ~~~~~~~~
1172
1173 -  ``application/json``
1174
1175 Tags
1176 ~~~~
1177
1178 -  Additional Information Servlet
1179
1180 Get Additional Information by id
1181 --------------------------------
1182
1183 ::
1184
1185     GET /v1/catalog/resources/{resourceId}/additionalinfo/{labelId}
1186
1187 Description
1188 ~~~~~~~~~~~
1189
1190 Returns Additional Inforamtion property
1191
1192 Parameters
1193 ~~~~~~~~~~
1194
1195 +----------+-------------+--------------------------------------+------------------+
1196 | Type     | Name        | Description                          | Schema           |
1197 +==========+=============+======================================+==================+
1198 | **Header | **USER\_ID* |                                      | string           |
1199 | **       | *\ *optiona |                                      |                  |
1200 |          | l*          |                                      |                  |
1201 +----------+-------------+--------------------------------------+------------------+
1202 | **Path** | **labelId** | label id                             | string           |
1203 |          | \ *required |                                      |                  |
1204 |          | *           |                                      |                  |
1205 +----------+-------------+--------------------------------------+------------------+
1206 | **Path** | **resourceI | resource id to update with new       | string           |
1207 |          | d**\ *requi | property                             |                  |
1208 |          | red*        |                                      |                  |
1209 +----------+-------------+--------------------------------------+------------------+
1210
1211 Responses
1212 ~~~~~~~~~
1213
1214 +---------+----------------------------------------------------+----------------+
1215 | HTTP    | Description                                        | Schema         |
1216 | Code    |                                                    |                |
1217 +=========+====================================================+================+
1218 | **200** | fetched additional information                     | No Content     |
1219 +---------+----------------------------------------------------+----------------+
1220 | **400** | Invalid content / Missing content                  | No Content     |
1221 +---------+----------------------------------------------------+----------------+
1222 | **403** | Restricted operation                               | No Content     |
1223 +---------+----------------------------------------------------+----------------+
1224 | **409** | Additional information key already exist           | No Content     |
1225 +---------+----------------------------------------------------+----------------+
1226
1227 Consumes
1228 ~~~~~~~~
1229
1230 -  ``application/json``
1231
1232 Produces
1233 ~~~~~~~~
1234
1235 -  ``application/json``
1236
1237 Tags
1238 ~~~~
1239
1240 -  Additional Information Servlet
1241
1242 Update Additional Information Label and Value
1243 ---------------------------------------------
1244
1245 ::
1246
1247     PUT /v1/catalog/resources/{resourceId}/additionalinfo/{labelId}
1248
1249 Description
1250 ~~~~~~~~~~~
1251
1252 Returns updated Additional Inforamtion property
1253
1254 Parameters
1255 ~~~~~~~~~~
1256
1257 +----------+-------------+--------------------------------------+------------------+
1258 | Type     | Name        | Description                          | Schema           |
1259 +==========+=============+======================================+==================+
1260 | **Header | **USER\_ID* |                                      | string           |
1261 | **       | *\ *optiona |                                      |                  |
1262 |          | l*          |                                      |                  |
1263 +----------+-------------+--------------------------------------+------------------+
1264 | **Path** | **labelId** | label id                             | string           |
1265 |          | \ *required |                                      |                  |
1266 |          | *           |                                      |                  |
1267 +----------+-------------+--------------------------------------+------------------+
1268 | **Path** | **resourceI | resource id to update with new       | string           |
1269 |          | d**\ *requi | property                             |                  |
1270 |          | red*        |                                      |                  |
1271 +----------+-------------+--------------------------------------+------------------+
1272 | **Body** | **body**\ * | Additional information key value to  | string           |
1273 |          | required*   | be created                           |                  |
1274 +----------+-------------+--------------------------------------+------------------+
1275
1276 Responses
1277 ~~~~~~~~~
1278
1279 +---------+----------------------------------------------------+----------------+
1280 | HTTP    | Description                                        | Schema         |
1281 | Code    |                                                    |                |
1282 +=========+====================================================+================+
1283 | **200** | Additional information updated                     | No Content     |
1284 +---------+----------------------------------------------------+----------------+
1285 | **400** | Invalid content / Missing content                  | No Content     |
1286 +---------+----------------------------------------------------+----------------+
1287 | **403** | Restricted operation                               | No Content     |
1288 +---------+----------------------------------------------------+----------------+
1289 | **409** | Additional information key already exist           | No Content     |
1290 +---------+----------------------------------------------------+----------------+
1291
1292 Consumes
1293 ~~~~~~~~
1294
1295 -  ``application/json``
1296
1297 Produces
1298 ~~~~~~~~
1299
1300 -  ``application/json``
1301
1302 Tags
1303 ~~~~
1304
1305 -  Additional Information Servlet
1306
1307 Create Additional Information Label and Value
1308 ---------------------------------------------
1309
1310 ::
1311
1312     DELETE /v1/catalog/resources/{resourceId}/additionalinfo/{labelId}
1313
1314 Description
1315 ~~~~~~~~~~~
1316
1317 Returns deleted Additional Inforamtion property
1318
1319 Parameters
1320 ~~~~~~~~~~
1321
1322 +----------+-------------+--------------------------------------+------------------+
1323 | Type     | Name        | Description                          | Schema           |
1324 +==========+=============+======================================+==================+
1325 | **Header | **USER\_ID* |                                      | string           |
1326 | **       | *\ *optiona |                                      |                  |
1327 |          | l*          |                                      |                  |
1328 +----------+-------------+--------------------------------------+------------------+
1329 | **Path** | **labelId** | label id                             | string           |
1330 |          | \ *required |                                      |                  |
1331 |          | *           |                                      |                  |
1332 +----------+-------------+--------------------------------------+------------------+
1333 | **Path** | **resourceI | resource id to update with new       | string           |
1334 |          | d**\ *requi | property                             |                  |
1335 |          | red*        |                                      |                  |
1336 +----------+-------------+--------------------------------------+------------------+
1337
1338 Responses
1339 ~~~~~~~~~
1340
1341 +---------+----------------------------------------------------+----------------+
1342 | HTTP    | Description                                        | Schema         |
1343 | Code    |                                                    |                |
1344 +=========+====================================================+================+
1345 | **200** | Additional information deleted                     | No Content     |
1346 +---------+----------------------------------------------------+----------------+
1347 | **400** | Invalid content / Missing content                  | No Content     |
1348 +---------+----------------------------------------------------+----------------+
1349 | **403** | Restricted operation                               | No Content     |
1350 +---------+----------------------------------------------------+----------------+
1351 | **409** | Additional information key already exist           | No Content     |
1352 +---------+----------------------------------------------------+----------------+
1353
1354 Consumes
1355 ~~~~~~~~
1356
1357 -  ``application/json``
1358
1359 Produces
1360 ~~~~~~~~
1361
1362 -  ``application/json``
1363
1364 Tags
1365 ~~~~
1366
1367 -  Additional Information Servlet
1368
1369 Create Artifact
1370 ---------------
1371
1372 ::
1373
1374     POST /v1/catalog/resources/{resourceId}/artifacts
1375
1376 Description
1377 ~~~~~~~~~~~
1378
1379 Returns created ArtifactDefinition
1380
1381 Parameters
1382 ~~~~~~~~~~
1383
1384 +----------+-------------+--------------------------------------+------------------+
1385 | Type     | Name        | Description                          | Schema           |
1386 +==========+=============+======================================+==================+
1387 | **Path** | **resourceI |                                      | string           |
1388 |          | d**\ *requi |                                      |                  |
1389 |          | red*        |                                      |                  |
1390 +----------+-------------+--------------------------------------+------------------+
1391 | **Body** | **body**\ * | json describe the artifact           | string           |
1392 |          | required*   |                                      |                  |
1393 +----------+-------------+--------------------------------------+------------------+
1394
1395 Responses
1396 ~~~~~~~~~
1397
1398 +---------+----------------------------------------------------+----------------+
1399 | HTTP    | Description                                        | Schema         |
1400 | Code    |                                                    |                |
1401 +=========+====================================================+================+
1402 | **201** | Resource created                                   | No Content     |
1403 +---------+----------------------------------------------------+----------------+
1404 | **400** | Invalid content / Missing content                  | No Content     |
1405 +---------+----------------------------------------------------+----------------+
1406 | **403** | Restricted operation                               | No Content     |
1407 +---------+----------------------------------------------------+----------------+
1408 | **409** | Artifact already exist                             | No Content     |
1409 +---------+----------------------------------------------------+----------------+
1410
1411 Consumes
1412 ~~~~~~~~
1413
1414 -  ``application/json``
1415
1416 Produces
1417 ~~~~~~~~
1418
1419 -  ``application/json``
1420
1421 Tags
1422 ~~~~
1423
1424 -  Resource Artifact Servlet
1425
1426 Update Artifact
1427 ---------------
1428
1429 ::
1430
1431     POST /v1/catalog/resources/{resourceId}/artifacts/{artifactId}
1432
1433 Description
1434 ~~~~~~~~~~~
1435
1436 Returns updated artifact
1437
1438 Parameters
1439 ~~~~~~~~~~
1440
1441 +----------+-------------+--------------------------------------+------------------+
1442 | Type     | Name        | Description                          | Schema           |
1443 +==========+=============+======================================+==================+
1444 | **Path** | **artifactI |                                      | string           |
1445 |          | d**\ *requi |                                      |                  |
1446 |          | red*        |                                      |                  |
1447 +----------+-------------+--------------------------------------+------------------+
1448 | **Path** | **resourceI |                                      | string           |
1449 |          | d**\ *requi |                                      |                  |
1450 |          | red*        |                                      |                  |
1451 +----------+-------------+--------------------------------------+------------------+
1452 | **Body** | **body**\ * | json describe the artifact           | string           |
1453 |          | required*   |                                      |                  |
1454 +----------+-------------+--------------------------------------+------------------+
1455
1456 Responses
1457 ~~~~~~~~~
1458
1459 +---------+----------------------------------------------------+----------------+
1460 | HTTP    | Description                                        | Schema         |
1461 | Code    |                                                    |                |
1462 +=========+====================================================+================+
1463 | **201** | Resource created                                   | No Content     |
1464 +---------+----------------------------------------------------+----------------+
1465 | **400** | Invalid content / Missing content                  | No Content     |
1466 +---------+----------------------------------------------------+----------------+
1467 | **403** | Restricted operation                               | No Content     |
1468 +---------+----------------------------------------------------+----------------+
1469
1470 Consumes
1471 ~~~~~~~~
1472
1473 -  ``application/json``
1474
1475 Produces
1476 ~~~~~~~~
1477
1478 -  ``application/json``
1479
1480 Tags
1481 ~~~~
1482
1483 -  Resource Artifact Servlet
1484
1485 Download resource Artifact in Base64
1486 ------------------------------------
1487
1488 ::
1489
1490     GET /v1/catalog/resources/{resourceId}/artifacts/{artifactId}
1491
1492 Description
1493 ~~~~~~~~~~~
1494
1495 Returns downloaded artifact
1496
1497 Parameters
1498 ~~~~~~~~~~
1499
1500 +------------------+--------------------------+----------------------------------+
1501 | Type             | Name                     | Schema                           |
1502 +==================+==========================+==================================+
1503 | **Path**         | **artifactId**\ *require | string                           |
1504 |                  | d*                       |                                  |
1505 +------------------+--------------------------+----------------------------------+
1506 | **Path**         | **resourceId**\ *require | string                           |
1507 |                  | d*                       |                                  |
1508 +------------------+--------------------------+----------------------------------+
1509
1510 Responses
1511 ~~~~~~~~~
1512
1513 +---------+----------------------------------------------------+----------------+
1514 | HTTP    | Description                                        | Schema         |
1515 | Code    |                                                    |                |
1516 +=========+====================================================+================+
1517 | **200** | Resource artifact downloaded                       | No Content     |
1518 +---------+----------------------------------------------------+----------------+
1519 | **404** | Resource/Artifact not found                        | No Content     |
1520 +---------+----------------------------------------------------+----------------+
1521
1522 Consumes
1523 ~~~~~~~~
1524
1525 -  ``application/json``
1526
1527 Produces
1528 ~~~~~~~~
1529
1530 -  ``application/json``
1531
1532 Tags
1533 ~~~~
1534
1535 -  Resource Artifact Servlet
1536
1537 Delete Artifact
1538 ---------------
1539
1540 ::
1541
1542     DELETE /v1/catalog/resources/{resourceId}/artifacts/{artifactId}
1543
1544 Description
1545 ~~~~~~~~~~~
1546
1547 Returns delete artifact
1548
1549 Parameters
1550 ~~~~~~~~~~
1551
1552 +------------------+--------------------------+----------------------------------+
1553 | Type             | Name                     | Schema                           |
1554 +==================+==========================+==================================+
1555 | **Path**         | **artifactId**\ *require | string                           |
1556 |                  | d*                       |                                  |
1557 +------------------+--------------------------+----------------------------------+
1558 | **Path**         | **resourceId**\ *require | string                           |
1559 |                  | d*                       |                                  |
1560 +------------------+--------------------------+----------------------------------+
1561
1562 Responses
1563 ~~~~~~~~~
1564
1565 +---------+----------------------------------------------------+----------------+
1566 | HTTP    | Description                                        | Schema         |
1567 | Code    |                                                    |                |
1568 +=========+====================================================+================+
1569 | **201** | Resource created                                   | No Content     |
1570 +---------+----------------------------------------------------+----------------+
1571 | **400** | Invalid content / Missing content                  | No Content     |
1572 +---------+----------------------------------------------------+----------------+
1573 | **403** | Restricted operation                               | No Content     |
1574 +---------+----------------------------------------------------+----------------+
1575
1576 Consumes
1577 ~~~~~~~~
1578
1579 -  ``application/json``
1580
1581 Produces
1582 ~~~~~~~~
1583
1584 -  ``application/json``
1585
1586 Tags
1587 ~~~~
1588
1589 -  Resource Artifact Servlet
1590
1591 Create Resource Attribute
1592 -------------------------
1593
1594 ::
1595
1596     POST /v1/catalog/resources/{resourceId}/attributes
1597
1598 Description
1599 ~~~~~~~~~~~
1600
1601 Returns created resource attribute
1602
1603 Parameters
1604 ~~~~~~~~~~
1605
1606 +----------+-------------+--------------------------------------+------------------+
1607 | Type     | Name        | Description                          | Schema           |
1608 +==========+=============+======================================+==================+
1609 | **Header | **USER\_ID* |                                      | string           |
1610 | **       | *\ *optiona |                                      |                  |
1611 |          | l*          |                                      |                  |
1612 +----------+-------------+--------------------------------------+------------------+
1613 | **Path** | **resourceI | resource id to update with new       | string           |
1614 |          | d**\ *requi | attribute                            |                  |
1615 |          | red*        |                                      |                  |
1616 +----------+-------------+--------------------------------------+------------------+
1617 | **Body** | **body**\ * | Resource attribute to be created     | string           |
1618 |          | required*   |                                      |                  |
1619 +----------+-------------+--------------------------------------+------------------+
1620
1621 Responses
1622 ~~~~~~~~~
1623
1624 +---------+----------------------------------------------------+----------------+
1625 | HTTP    | Description                                        | Schema         |
1626 | Code    |                                                    |                |
1627 +=========+====================================================+================+
1628 | **201** | Resource property created                          | No Content     |
1629 +---------+----------------------------------------------------+----------------+
1630 | **400** | Invalid content / Missing content                  | No Content     |
1631 +---------+----------------------------------------------------+----------------+
1632 | **403** | Restricted operation                               | No Content     |
1633 +---------+----------------------------------------------------+----------------+
1634 | **409** | Resource attribute already exist                   | No Content     |
1635 +---------+----------------------------------------------------+----------------+
1636
1637 Consumes
1638 ~~~~~~~~
1639
1640 -  ``application/json``
1641
1642 Produces
1643 ~~~~~~~~
1644
1645 -  ``application/json``
1646
1647 Tags
1648 ~~~~
1649
1650 -  Resource Attribute Servlet
1651
1652 Update Resource Attribute
1653 -------------------------
1654
1655 ::
1656
1657     PUT /v1/catalog/resources/{resourceId}/attributes/{attributeId}
1658
1659 Description
1660 ~~~~~~~~~~~
1661
1662 Returns updated attribute
1663
1664 Parameters
1665 ~~~~~~~~~~
1666
1667 +----------+-------------+--------------------------------------+------------------+
1668 | Type     | Name        | Description                          | Schema           |
1669 +==========+=============+======================================+==================+
1670 | **Header | **USER\_ID* |                                      | string           |
1671 | **       | *\ *optiona |                                      |                  |
1672 |          | l*          |                                      |                  |
1673 +----------+-------------+--------------------------------------+------------------+
1674 | **Path** | **attribute | attribute id to update               | string           |
1675 |          | Id**\ *requ |                                      |                  |
1676 |          | ired*       |                                      |                  |
1677 +----------+-------------+--------------------------------------+------------------+
1678 | **Path** | **resourceI | resource id to update with new       | string           |
1679 |          | d**\ *requi | attribute                            |                  |
1680 |          | red*        |                                      |                  |
1681 +----------+-------------+--------------------------------------+------------------+
1682 | **Body** | **body**\ * | Resource attribute to update         | string           |
1683 |          | required*   |                                      |                  |
1684 +----------+-------------+--------------------------------------+------------------+
1685
1686 Responses
1687 ~~~~~~~~~
1688
1689 +---------+----------------------------------------------------+----------------+
1690 | HTTP    | Description                                        | Schema         |
1691 | Code    |                                                    |                |
1692 +=========+====================================================+================+
1693 | **200** | Resource attribute updated                         | No Content     |
1694 +---------+----------------------------------------------------+----------------+
1695 | **400** | Invalid content / Missing content                  | No Content     |
1696 +---------+----------------------------------------------------+----------------+
1697 | **403** | Restricted operation                               | No Content     |
1698 +---------+----------------------------------------------------+----------------+
1699
1700 Consumes
1701 ~~~~~~~~
1702
1703 -  ``application/json``
1704
1705 Produces
1706 ~~~~~~~~
1707
1708 -  ``application/json``
1709
1710 Tags
1711 ~~~~
1712
1713 -  Resource Attribute Servlet
1714
1715 Create Resource Attribute
1716 -------------------------
1717
1718 ::
1719
1720     DELETE /v1/catalog/resources/{resourceId}/attributes/{attributeId}
1721
1722 Description
1723 ~~~~~~~~~~~
1724
1725 Returns deleted attribute
1726
1727 Parameters
1728 ~~~~~~~~~~
1729
1730 +----------+-------------+--------------------------------------+------------------+
1731 | Type     | Name        | Description                          | Schema           |
1732 +==========+=============+======================================+==================+
1733 | **Header | **USER\_ID* |                                      | string           |
1734 | **       | *\ *optiona |                                      |                  |
1735 |          | l*          |                                      |                  |
1736 +----------+-------------+--------------------------------------+------------------+
1737 | **Path** | **attribute | Attribute id to delete               | string           |
1738 |          | Id**\ *requ |                                      |                  |
1739 |          | ired*       |                                      |                  |
1740 +----------+-------------+--------------------------------------+------------------+
1741 | **Path** | **resourceI | resource id of attribute             | string           |
1742 |          | d**\ *requi |                                      |                  |
1743 |          | red*        |                                      |                  |
1744 +----------+-------------+--------------------------------------+------------------+
1745
1746 Responses
1747 ~~~~~~~~~
1748
1749 +---------+----------------------------------------------------+----------------+
1750 | HTTP    | Description                                        | Schema         |
1751 | Code    |                                                    |                |
1752 +=========+====================================================+================+
1753 | **204** | deleted attribute                                  | No Content     |
1754 +---------+----------------------------------------------------+----------------+
1755 | **400** | Invalid content / Missing content                  | No Content     |
1756 +---------+----------------------------------------------------+----------------+
1757 | **403** | Restricted operation                               | No Content     |
1758 +---------+----------------------------------------------------+----------------+
1759 | **404** | Resource property not found                        | No Content     |
1760 +---------+----------------------------------------------------+----------------+
1761
1762 Consumes
1763 ~~~~~~~~
1764
1765 -  ``application/json``
1766
1767 Produces
1768 ~~~~~~~~
1769
1770 -  ``application/json``
1771
1772 Tags
1773 ~~~~
1774
1775 -  Resource Attribute Servlet
1776
1777 Update Resource Metadata
1778 ------------------------
1779
1780 ::
1781
1782     PUT /v1/catalog/resources/{resourceId}/metadata
1783
1784 Description
1785 ~~~~~~~~~~~
1786
1787 Returns updated resource metadata
1788
1789 Parameters
1790 ~~~~~~~~~~
1791
1792 +----------+-------------+--------------------------------------+------------------+
1793 | Type     | Name        | Description                          | Schema           |
1794 +==========+=============+======================================+==================+
1795 | **Header | **USER\_ID* |                                      | string           |
1796 | **       | *\ *optiona |                                      |                  |
1797 |          | l*          |                                      |                  |
1798 +----------+-------------+--------------------------------------+------------------+
1799 | **Path** | **resourceI |                                      | string           |
1800 |          | d**\ *requi |                                      |                  |
1801 |          | red*        |                                      |                  |
1802 +----------+-------------+--------------------------------------+------------------+
1803 | **Body** | **body**\ * | Resource metadata to be updated      | string           |
1804 |          | required*   |                                      |                  |
1805 +----------+-------------+--------------------------------------+------------------+
1806
1807 Responses
1808 ~~~~~~~~~
1809
1810 +---------+----------------------------------------------------+----------------+
1811 | HTTP    | Description                                        | Schema         |
1812 | Code    |                                                    |                |
1813 +=========+====================================================+================+
1814 | **200** | Resource metadata updated                          | No Content     |
1815 +---------+----------------------------------------------------+----------------+
1816 | **400** | Invalid content                                    | No Content     |
1817 +---------+----------------------------------------------------+----------------+
1818 | **403** | Restricted operation                               | No Content     |
1819 +---------+----------------------------------------------------+----------------+
1820
1821 Consumes
1822 ~~~~~~~~
1823
1824 -  ``application/json``
1825
1826 Produces
1827 ~~~~~~~~
1828
1829 -  ``application/json``
1830
1831 Tags
1832 ~~~~
1833
1834 -  Resources Catalog
1835
1836 Create Resource Property
1837 ------------------------
1838
1839 ::
1840
1841     POST /v1/catalog/resources/{resourceId}/properties
1842
1843 Description
1844 ~~~~~~~~~~~
1845
1846 Returns created resource property
1847
1848 Parameters
1849 ~~~~~~~~~~
1850
1851 +----------+-------------+--------------------------------------+------------------+
1852 | Type     | Name        | Description                          | Schema           |
1853 +==========+=============+======================================+==================+
1854 | **Header | **USER\_ID* |                                      | string           |
1855 | **       | *\ *optiona |                                      |                  |
1856 |          | l*          |                                      |                  |
1857 +----------+-------------+--------------------------------------+------------------+
1858 | **Path** | **resourceI | resource id to update with new       | string           |
1859 |          | d**\ *requi | property                             |                  |
1860 |          | red*        |                                      |                  |
1861 +----------+-------------+--------------------------------------+------------------+
1862 | **Body** | **body**\ * | Resource property to be created      | string           |
1863 |          | required*   |                                      |                  |
1864 +----------+-------------+--------------------------------------+------------------+
1865
1866 Responses
1867 ~~~~~~~~~
1868
1869 +---------+----------------------------------------------------+----------------+
1870 | HTTP    | Description                                        | Schema         |
1871 | Code    |                                                    |                |
1872 +=========+====================================================+================+
1873 | **201** | Resource property created                          | No Content     |
1874 +---------+----------------------------------------------------+----------------+
1875 | **400** | Invalid content / Missing content                  | No Content     |
1876 +---------+----------------------------------------------------+----------------+
1877 | **403** | Restricted operation                               | No Content     |
1878 +---------+----------------------------------------------------+----------------+
1879 | **409** | Resource property already exist                    | No Content     |
1880 +---------+----------------------------------------------------+----------------+
1881
1882 Consumes
1883 ~~~~~~~~
1884
1885 -  ``application/json``
1886
1887 Produces
1888 ~~~~~~~~
1889
1890 -  ``application/json``
1891
1892 Tags
1893 ~~~~
1894
1895 -  Resource Property Servlet
1896
1897 Create Resource Property
1898 ------------------------
1899
1900 ::
1901
1902     GET /v1/catalog/resources/{resourceId}/properties/{propertyId}
1903
1904 Description
1905 ~~~~~~~~~~~
1906
1907 Returns property of resource
1908
1909 Parameters
1910 ~~~~~~~~~~
1911
1912 +----------+-------------+--------------------------------------+------------------+
1913 | Type     | Name        | Description                          | Schema           |
1914 +==========+=============+======================================+==================+
1915 | **Header | **USER\_ID* |                                      | string           |
1916 | **       | *\ *optiona |                                      |                  |
1917 |          | l*          |                                      |                  |
1918 +----------+-------------+--------------------------------------+------------------+
1919 | **Path** | **propertyI | proerty id to get                    | string           |
1920 |          | d**\ *requi |                                      |                  |
1921 |          | red*        |                                      |                  |
1922 +----------+-------------+--------------------------------------+------------------+
1923 | **Path** | **resourceI | resource id of property              | string           |
1924 |          | d**\ *requi |                                      |                  |
1925 |          | red*        |                                      |                  |
1926 +----------+-------------+--------------------------------------+------------------+
1927
1928 Responses
1929 ~~~~~~~~~
1930
1931 +---------+----------------------------------------------------+----------------+
1932 | HTTP    | Description                                        | Schema         |
1933 | Code    |                                                    |                |
1934 +=========+====================================================+================+
1935 | **200** | property                                           | No Content     |
1936 +---------+----------------------------------------------------+----------------+
1937 | **400** | Invalid content / Missing content                  | No Content     |
1938 +---------+----------------------------------------------------+----------------+
1939 | **403** | Restricted operation                               | No Content     |
1940 +---------+----------------------------------------------------+----------------+
1941 | **404** | Resource property not found                        | No Content     |
1942 +---------+----------------------------------------------------+----------------+
1943
1944 Consumes
1945 ~~~~~~~~
1946
1947 -  ``application/json``
1948
1949 Produces
1950 ~~~~~~~~
1951
1952 -  ``application/json``
1953
1954 Tags
1955 ~~~~
1956
1957 -  Resource Property Servlet
1958
1959 Update Resource Property
1960 ------------------------
1961
1962 ::
1963
1964     PUT /v1/catalog/resources/{resourceId}/properties/{propertyId}
1965
1966 Description
1967 ~~~~~~~~~~~
1968
1969 Returns updated property
1970
1971 Parameters
1972 ~~~~~~~~~~
1973
1974 +----------+-------------+--------------------------------------+------------------+
1975 | Type     | Name        | Description                          | Schema           |
1976 +==========+=============+======================================+==================+
1977 | **Header | **USER\_ID* |                                      | string           |
1978 | **       | *\ *optiona |                                      |                  |
1979 |          | l*          |                                      |                  |
1980 +----------+-------------+--------------------------------------+------------------+
1981 | **Path** | **propertyI | proerty id to update                 | string           |
1982 |          | d**\ *requi |                                      |                  |
1983 |          | red*        |                                      |                  |
1984 +----------+-------------+--------------------------------------+------------------+
1985 | **Path** | **resourceI | resource id to update with new       | string           |
1986 |          | d**\ *requi | property                             |                  |
1987 |          | red*        |                                      |                  |
1988 +----------+-------------+--------------------------------------+------------------+
1989 | **Body** | **body**\ * | Resource property to update          | string           |
1990 |          | required*   |                                      |                  |
1991 +----------+-------------+--------------------------------------+------------------+
1992
1993 Responses
1994 ~~~~~~~~~
1995
1996 +---------+----------------------------------------------------+----------------+
1997 | HTTP    | Description                                        | Schema         |
1998 | Code    |                                                    |                |
1999 +=========+====================================================+================+
2000 | **200** | Resource property updated                          | No Content     |
2001 +---------+----------------------------------------------------+----------------+
2002 | **400** | Invalid content / Missing content                  | No Content     |
2003 +---------+----------------------------------------------------+----------------+
2004 | **403** | Restricted operation                               | No Content     |
2005 +---------+----------------------------------------------------+----------------+
2006
2007 Consumes
2008 ~~~~~~~~
2009
2010 -  ``application/json``
2011
2012 Produces
2013 ~~~~~~~~
2014
2015 -  ``application/json``
2016
2017 Tags
2018 ~~~~
2019
2020 -  Resource Property Servlet
2021
2022 Create Resource Property
2023 ------------------------
2024
2025 ::
2026
2027     DELETE /v1/catalog/resources/{resourceId}/properties/{propertyId}
2028
2029 Description
2030 ~~~~~~~~~~~
2031
2032 Returns deleted property
2033
2034 Parameters
2035 ~~~~~~~~~~
2036
2037 +----------+-------------+--------------------------------------+------------------+
2038 | Type     | Name        | Description                          | Schema           |
2039 +==========+=============+======================================+==================+
2040 | **Header | **USER\_ID* |                                      | string           |
2041 | **       | *\ *optiona |                                      |                  |
2042 |          | l*          |                                      |                  |
2043 +----------+-------------+--------------------------------------+------------------+
2044 | **Path** | **propertyI | Property id to delete                | string           |
2045 |          | d**\ *requi |                                      |                  |
2046 |          | red*        |                                      |                  |
2047 +----------+-------------+--------------------------------------+------------------+
2048 | **Path** | **resourceI | resource id of property              | string           |
2049 |          | d**\ *requi |                                      |                  |
2050 |          | red*        |                                      |                  |
2051 +----------+-------------+--------------------------------------+------------------+
2052
2053 Responses
2054 ~~~~~~~~~
2055
2056 +---------+----------------------------------------------------+----------------+
2057 | HTTP    | Description                                        | Schema         |
2058 | Code    |                                                    |                |
2059 +=========+====================================================+================+
2060 | **204** | deleted property                                   | No Content     |
2061 +---------+----------------------------------------------------+----------------+
2062 | **400** | Invalid content / Missing content                  | No Content     |
2063 +---------+----------------------------------------------------+----------------+
2064 | **403** | Restricted operation                               | No Content     |
2065 +---------+----------------------------------------------------+----------------+
2066 | **404** | Resource property not found                        | No Content     |
2067 +---------+----------------------------------------------------+----------------+
2068
2069 Consumes
2070 ~~~~~~~~
2071
2072 -  ``application/json``
2073
2074 Produces
2075 ~~~~~~~~
2076
2077 -  ``application/json``
2078
2079 Tags
2080 ~~~~
2081
2082 -  Resource Property Servlet
2083
2084 Create Artifact and Attach to interface
2085 ---------------------------------------
2086
2087 ::
2088
2089     POST /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts
2090
2091 Description
2092 ~~~~~~~~~~~
2093
2094 Returns created resource
2095
2096 Parameters
2097 ~~~~~~~~~~
2098
2099 +----------+-------------+--------------------------------------+------------------+
2100 | Type     | Name        | Description                          | Schema           |
2101 +==========+=============+======================================+==================+
2102 | **Header | **Content-M |                                      | string           |
2103 | **       | D5**\ *opti |                                      |                  |
2104 |          | onal*       |                                      |                  |
2105 +----------+-------------+--------------------------------------+------------------+
2106 | **Header | **USER\_ID* |                                      | string           |
2107 | **       | *\ *optiona |                                      |                  |
2108 |          | l*          |                                      |                  |
2109 +----------+-------------+--------------------------------------+------------------+
2110 | **Path** | **interface |                                      | string           |
2111 |          | Type**\ *re |                                      |                  |
2112 |          | quired*     |                                      |                  |
2113 +----------+-------------+--------------------------------------+------------------+
2114 | **Path** | **operation |                                      | string           |
2115 |          | **\ *requir |                                      |                  |
2116 |          | ed*         |                                      |                  |
2117 +----------+-------------+--------------------------------------+------------------+
2118 | **Path** | **resourceI |                                      | string           |
2119 |          | d**\ *requi |                                      |                  |
2120 |          | red*        |                                      |                  |
2121 +----------+-------------+--------------------------------------+------------------+
2122 | **Body** | **body**\ * | json describe the artifact           | string           |
2123 |          | required*   |                                      |                  |
2124 +----------+-------------+--------------------------------------+------------------+
2125
2126 Responses
2127 ~~~~~~~~~
2128
2129 +---------+----------------------------------------------------+----------------+
2130 | HTTP    | Description                                        | Schema         |
2131 | Code    |                                                    |                |
2132 +=========+====================================================+================+
2133 | **201** | Resource created                                   | No Content     |
2134 +---------+----------------------------------------------------+----------------+
2135 | **400** | Invalid content / Missing content                  | No Content     |
2136 +---------+----------------------------------------------------+----------------+
2137 | **403** | Restricted operation                               | No Content     |
2138 +---------+----------------------------------------------------+----------------+
2139 | **409** | Artifact already exist                             | No Content     |
2140 +---------+----------------------------------------------------+----------------+
2141
2142 Consumes
2143 ~~~~~~~~
2144
2145 -  ``application/json``
2146
2147 Produces
2148 ~~~~~~~~
2149
2150 -  ``application/json``
2151
2152 Tags
2153 ~~~~
2154
2155 -  Resource Artifact Servlet
2156
2157 update Artifact Attach to interface
2158 -----------------------------------
2159
2160 ::
2161
2162     POST /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts/{artifactId}
2163
2164 Description
2165 ~~~~~~~~~~~
2166
2167 updates artifact by interface
2168
2169 Parameters
2170 ~~~~~~~~~~
2171
2172 +----------+-------------+--------------------------------------+------------------+
2173 | Type     | Name        | Description                          | Schema           |
2174 +==========+=============+======================================+==================+
2175 | **Header | **Content-M |                                      | string           |
2176 | **       | D5**\ *opti |                                      |                  |
2177 |          | onal*       |                                      |                  |
2178 +----------+-------------+--------------------------------------+------------------+
2179 | **Header | **USER\_ID* |                                      | string           |
2180 | **       | *\ *optiona |                                      |                  |
2181 |          | l*          |                                      |                  |
2182 +----------+-------------+--------------------------------------+------------------+
2183 | **Path** | **artifactI |                                      | string           |
2184 |          | d**\ *requi |                                      |                  |
2185 |          | red*        |                                      |                  |
2186 +----------+-------------+--------------------------------------+------------------+
2187 | **Path** | **interface |                                      | string           |
2188 |          | Type**\ *re |                                      |                  |
2189 |          | quired*     |                                      |                  |
2190 +----------+-------------+--------------------------------------+------------------+
2191 | **Path** | **operation |                                      | string           |
2192 |          | **\ *requir |                                      |                  |
2193 |          | ed*         |                                      |                  |
2194 +----------+-------------+--------------------------------------+------------------+
2195 | **Path** | **resourceI |                                      | string           |
2196 |          | d**\ *requi |                                      |                  |
2197 |          | red*        |                                      |                  |
2198 +----------+-------------+--------------------------------------+------------------+
2199 | **Body** | **body**\ * | json describe the artifact           | string           |
2200 |          | required*   |                                      |                  |
2201 +----------+-------------+--------------------------------------+------------------+
2202
2203 Responses
2204 ~~~~~~~~~
2205
2206 +---------+----------------------------------------------------+----------------+
2207 | HTTP    | Description                                        | Schema         |
2208 | Code    |                                                    |                |
2209 +=========+====================================================+================+
2210 | **201** | delete artifact under interface deleted            | No Content     |
2211 +---------+----------------------------------------------------+----------------+
2212 | **400** | Invalid content / Missing content                  | No Content     |
2213 +---------+----------------------------------------------------+----------------+
2214 | **403** | Restricted operation                               | No Content     |
2215 +---------+----------------------------------------------------+----------------+
2216 | **409** | Artifact already exist                             | No Content     |
2217 +---------+----------------------------------------------------+----------------+
2218
2219 Consumes
2220 ~~~~~~~~
2221
2222 -  ``application/json``
2223
2224 Produces
2225 ~~~~~~~~
2226
2227 -  ``application/json``
2228
2229 Tags
2230 ~~~~
2231
2232 -  Resource Artifact Servlet
2233
2234 delete Artifact from interface
2235 ------------------------------
2236
2237 ::
2238
2239     DELETE /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts/{artifactId}
2240
2241 Description
2242 ~~~~~~~~~~~
2243
2244 delete matching artifact from interface
2245
2246 Parameters
2247 ~~~~~~~~~~
2248
2249 +------------------+--------------------------+----------------------------------+
2250 | Type             | Name                     | Schema                           |
2251 +==================+==========================+==================================+
2252 | **Path**         | **artifactId**\ *require | string                           |
2253 |                  | d*                       |                                  |
2254 +------------------+--------------------------+----------------------------------+
2255 | **Path**         | **interfaceType**\ *requ | string                           |
2256 |                  | ired*                    |                                  |
2257 +------------------+--------------------------+----------------------------------+
2258 | **Path**         | **operation**\ *required | string                           |
2259 |                  | *                        |                                  |
2260 +------------------+--------------------------+----------------------------------+
2261 | **Path**         | **resourceId**\ *require | string                           |
2262 |                  | d*                       |                                  |
2263 +------------------+--------------------------+----------------------------------+
2264
2265 Responses
2266 ~~~~~~~~~
2267
2268 +---------+----------------------------------------------------+----------------+
2269 | HTTP    | Description                                        | Schema         |
2270 | Code    |                                                    |                |
2271 +=========+====================================================+================+
2272 | **201** | delete artifact under interface deleted            | No Content     |
2273 +---------+----------------------------------------------------+----------------+
2274 | **400** | Invalid content / Missing content                  | No Content     |
2275 +---------+----------------------------------------------------+----------------+
2276 | **403** | Restricted operation                               | No Content     |
2277 +---------+----------------------------------------------------+----------------+
2278 | **409** | Artifact already exist                             | No Content     |
2279 +---------+----------------------------------------------------+----------------+
2280
2281 Consumes
2282 ~~~~~~~~
2283
2284 -  ``application/json``
2285
2286 Produces
2287 ~~~~~~~~
2288
2289 -  ``application/json``
2290
2291 Tags
2292 ~~~~
2293
2294 -  Resource Artifact Servlet
2295
2296 DELETE /v1/catalog/resources/{resourcename}/{version}
2297 -----------------------------------------------------
2298
2299 Parameters
2300 ~~~~~~~~~~
2301
2302 +------------------+--------------------------+----------------------------------+
2303 | Type             | Name                     | Schema                           |
2304 +==================+==========================+==================================+
2305 | **Path**         | **resourceName**\ *requi | string                           |
2306 |                  | red*                     |                                  |
2307 +------------------+--------------------------+----------------------------------+
2308 | **Path**         | **version**\ *required*  | string                           |
2309 +------------------+--------------------------+----------------------------------+
2310
2311 Responses
2312 ~~~~~~~~~
2313
2314 +---------+----------------------------------------------------+----------------+
2315 | HTTP    | Description                                        | Schema         |
2316 | Code    |                                                    |                |
2317 +=========+====================================================+================+
2318 | **defau | successful operation                               | No Content     |
2319 | lt**    |                                                    |                |
2320 +---------+----------------------------------------------------+----------------+
2321
2322 Tags
2323 ~~~~
2324
2325 -  Resources Catalog
2326
2327 Create Service
2328 --------------
2329
2330 ::
2331
2332     POST /v1/catalog/services
2333
2334 Description
2335 ~~~~~~~~~~~
2336
2337 Returns created service
2338
2339 Parameters
2340 ~~~~~~~~~~
2341
2342 +----------+-------------+--------------------------------------+------------------+
2343 | Type     | Name        | Description                          | Schema           |
2344 +==========+=============+======================================+==================+
2345 | **Header | **USER\_ID* |                                      | string           |
2346 | **       | *\ *optiona |                                      |                  |
2347 |          | l*          |                                      |                  |
2348 +----------+-------------+--------------------------------------+------------------+
2349 | **Body** | **body**\ * | Service object to be created         | string           |
2350 |          | required*   |                                      |                  |
2351 +----------+-------------+--------------------------------------+------------------+
2352
2353 Responses
2354 ~~~~~~~~~
2355
2356 +---------+----------------------------------------------------+----------------+
2357 | HTTP    | Description                                        | Schema         |
2358 | Code    |                                                    |                |
2359 +=========+====================================================+================+
2360 | **200** | successful operation                               | `Service <#_se |
2361 |         |                                                    | rvice>`__      |
2362 +---------+----------------------------------------------------+----------------+
2363 | **201** | Service created                                    | No Content     |
2364 +---------+----------------------------------------------------+----------------+
2365 | **400** | Invalid content / Missing content                  | No Content     |
2366 +---------+----------------------------------------------------+----------------+
2367 | **403** | Restricted operation                               | No Content     |
2368 +---------+----------------------------------------------------+----------------+
2369 | **409** | Service already exist                              | No Content     |
2370 +---------+----------------------------------------------------+----------------+
2371
2372 Consumes
2373 ~~~~~~~~
2374
2375 -  ``application/json``
2376
2377 Produces
2378 ~~~~~~~~
2379
2380 -  ``application/json``
2381
2382 Tags
2383 ~~~~
2384
2385 -  Service Catalog
2386
2387 Retrieve Distributions
2388 ----------------------
2389
2390 ::
2391
2392     GET /v1/catalog/services/distribution/{did}
2393
2394 Description
2395 ~~~~~~~~~~~
2396
2397 Return the list of distribution status objects
2398
2399 Parameters
2400 ~~~~~~~~~~
2401
2402 +------------------+--------------------------+----------------------------------+
2403 | Type             | Name                     | Schema                           |
2404 +==================+==========================+==================================+
2405 | **Header**       | **USER\_ID**\ *optional* | string                           |
2406 +------------------+--------------------------+----------------------------------+
2407 | **Path**         | **did**\ *required*      | string                           |
2408 +------------------+--------------------------+----------------------------------+
2409
2410 Responses
2411 ~~~~~~~~~
2412
2413 +---------+----------------------------------------------------+----------------+
2414 | HTTP    | Description                                        | Schema         |
2415 | Code    |                                                    |                |
2416 +=========+====================================================+================+
2417 | **200** | Service found                                      | No Content     |
2418 +---------+----------------------------------------------------+----------------+
2419 | **403** | Restricted operation                               | No Content     |
2420 +---------+----------------------------------------------------+----------------+
2421 | **404** | Status not found                                   | No Content     |
2422 +---------+----------------------------------------------------+----------------+
2423
2424 Consumes
2425 ~~~~~~~~
2426
2427 -  ``application/json``
2428
2429 Produces
2430 ~~~~~~~~
2431
2432 -  ``application/json``
2433
2434 Tags
2435 ~~~~
2436
2437 -  Distribution Service Servlet
2438
2439 Retrieve Service
2440 ----------------
2441
2442 ::
2443
2444     GET /v1/catalog/services/serviceName/{serviceName}/serviceVersion/{serviceVersion}
2445
2446 Description
2447 ~~~~~~~~~~~
2448
2449 Returns service according to name and version
2450
2451 Parameters
2452 ~~~~~~~~~~
2453
2454 +------------------+--------------------------+----------------------------------+
2455 | Type             | Name                     | Schema                           |
2456 +==================+==========================+==================================+
2457 | **Header**       | **USER\_ID**\ *optional* | string                           |
2458 +------------------+--------------------------+----------------------------------+
2459 | **Path**         | **serviceName**\ *requir | string                           |
2460 |                  | ed*                      |                                  |
2461 +------------------+--------------------------+----------------------------------+
2462 | **Path**         | **serviceVersion**\ *req | string                           |
2463 |                  | uired*                   |                                  |
2464 +------------------+--------------------------+----------------------------------+
2465
2466 Responses
2467 ~~~~~~~~~
2468
2469 +---------+----------------------------------------------------+----------------+
2470 | HTTP    | Description                                        | Schema         |
2471 | Code    |                                                    |                |
2472 +=========+====================================================+================+
2473 | **200** | Service found                                      | No Content     |
2474 +---------+----------------------------------------------------+----------------+
2475 | **403** | Restricted operation                               | No Content     |
2476 +---------+----------------------------------------------------+----------------+
2477 | **404** | Service not found                                  | No Content     |
2478 +---------+----------------------------------------------------+----------------+
2479
2480 Consumes
2481 ~~~~~~~~
2482
2483 -  ``application/json``
2484
2485 Produces
2486 ~~~~~~~~
2487
2488 -  ``application/json``
2489
2490 Tags
2491 ~~~~
2492
2493 -  Service Catalog
2494
2495 Download service artifact
2496 -------------------------
2497
2498 ::
2499
2500     GET /v1/catalog/services/toscatoheat/{artifactName}
2501
2502 Description
2503 ~~~~~~~~~~~
2504
2505 Returns downloaded artifact
2506
2507 Parameters
2508 ~~~~~~~~~~
2509
2510 +------------------+--------------------------+----------------------------------+
2511 | Type             | Name                     | Schema                           |
2512 +==================+==========================+==================================+
2513 | **Path**         | **artifactName**\ *requi | string                           |
2514 |                  | red*                     |                                  |
2515 +------------------+--------------------------+----------------------------------+
2516
2517 Responses
2518 ~~~~~~~~~
2519
2520 +---------+----------------------------------------------------+----------------+
2521 | HTTP    | Description                                        | Schema         |
2522 | Code    |                                                    |                |
2523 +=========+====================================================+================+
2524 | **200** | Artifact downloaded                                | No Content     |
2525 +---------+----------------------------------------------------+----------------+
2526 | **401** | Authorization required                             | No Content     |
2527 +---------+----------------------------------------------------+----------------+
2528 | **403** | Restricted operation                               | No Content     |
2529 +---------+----------------------------------------------------+----------------+
2530 | **404** | Artifact not found                                 | No Content     |
2531 +---------+----------------------------------------------------+----------------+
2532
2533 Consumes
2534 ~~~~~~~~
2535
2536 -  ``application/json``
2537
2538 Produces
2539 ~~~~~~~~
2540
2541 -  ``application/octet-stream``
2542
2543 Tags
2544 ~~~~
2545
2546 -  Service Catalog
2547
2548 validate service name
2549 ---------------------
2550
2551 ::
2552
2553     GET /v1/catalog/services/validate-name/{serviceName}
2554
2555 Description
2556 ~~~~~~~~~~~
2557
2558 checks if the chosen service name is available
2559
2560 Parameters
2561 ~~~~~~~~~~
2562
2563 +------------------+--------------------------+----------------------------------+
2564 | Type             | Name                     | Schema                           |
2565 +==================+==========================+==================================+
2566 | **Header**       | **USER\_ID**\ *optional* | string                           |
2567 +------------------+--------------------------+----------------------------------+
2568 | **Path**         | **serviceName**\ *requir | string                           |
2569 |                  | ed*                      |                                  |
2570 +------------------+--------------------------+----------------------------------+
2571
2572 Responses
2573 ~~~~~~~~~
2574
2575 +---------+----------------------------------------------------+----------------+
2576 | HTTP    | Description                                        | Schema         |
2577 | Code    |                                                    |                |
2578 +=========+====================================================+================+
2579 | **200** | Service found                                      | No Content     |
2580 +---------+----------------------------------------------------+----------------+
2581 | **403** | Restricted operation                               | No Content     |
2582 +---------+----------------------------------------------------+----------------+
2583
2584 Consumes
2585 ~~~~~~~~
2586
2587 -  ``application/json``
2588
2589 Produces
2590 ~~~~~~~~
2591
2592 -  ``application/json``
2593
2594 Tags
2595 ~~~~
2596
2597 -  Service Catalog
2598
2599 Get Inputs only
2600 ---------------
2601
2602 ::
2603
2604     GET /v1/catalog/services/{componentId}/inputs
2605
2606 Description
2607 ~~~~~~~~~~~
2608
2609 Returns Inputs list
2610
2611 Parameters
2612 ~~~~~~~~~~
2613
2614 +------------------+--------------------------+----------------------------------+
2615 | Type             | Name                     | Schema                           |
2616 +==================+==========================+==================================+
2617 | **Header**       | **USER\_ID**\ *optional* | string                           |
2618 +------------------+--------------------------+----------------------------------+
2619 | **Path**         | **componentId**\ *requir | string                           |
2620 |                  | ed*                      |                                  |
2621 +------------------+--------------------------+----------------------------------+
2622 | **Path**         | **componentType**\ *requ | string                           |
2623 |                  | ired*                    |                                  |
2624 +------------------+--------------------------+----------------------------------+
2625 | **Query**        | **amount**\ *optional*   | integer (int32)                  |
2626 +------------------+--------------------------+----------------------------------+
2627 | **Query**        | **fromId**\ *optional*   | string                           |
2628 +------------------+--------------------------+----------------------------------+
2629
2630 Responses
2631 ~~~~~~~~~
2632
2633 +---------+----------------------------------------------------+----------------+
2634 | HTTP    | Description                                        | Schema         |
2635 | Code    |                                                    |                |
2636 +=========+====================================================+================+
2637 | **200** | Component found                                    | No Content     |
2638 +---------+----------------------------------------------------+----------------+
2639 | **403** | Restricted operation                               | No Content     |
2640 +---------+----------------------------------------------------+----------------+
2641 | **404** | Component not found                                | No Content     |
2642 +---------+----------------------------------------------------+----------------+
2643
2644 Consumes
2645 ~~~~~~~~
2646
2647 -  ``application/json``
2648
2649 Produces
2650 ~~~~~~~~
2651
2652 -  ``application/json``
2653
2654 Tags
2655 ~~~~
2656
2657 -  Input Catalog
2658
2659 Retrieve Service
2660 ----------------
2661
2662 ::
2663
2664     GET /v1/catalog/services/{serviceId}
2665
2666 Description
2667 ~~~~~~~~~~~
2668
2669 Returns service according to serviceId
2670
2671 Parameters
2672 ~~~~~~~~~~
2673
2674 +------------------+--------------------------+----------------------------------+
2675 | Type             | Name                     | Schema                           |
2676 +==================+==========================+==================================+
2677 | **Header**       | **USER\_ID**\ *optional* | string                           |
2678 +------------------+--------------------------+----------------------------------+
2679 | **Path**         | **serviceId**\ *required | string                           |
2680 |                  | *                        |                                  |
2681 +------------------+--------------------------+----------------------------------+
2682
2683 Responses
2684 ~~~~~~~~~
2685
2686 +---------+----------------------------------------------------+----------------+
2687 | HTTP    | Description                                        | Schema         |
2688 | Code    |                                                    |                |
2689 +=========+====================================================+================+
2690 | **200** | Service found                                      | No Content     |
2691 +---------+----------------------------------------------------+----------------+
2692 | **403** | Restricted operation                               | No Content     |
2693 +---------+----------------------------------------------------+----------------+
2694 | **404** | Service not found                                  | No Content     |
2695 +---------+----------------------------------------------------+----------------+
2696
2697 Consumes
2698 ~~~~~~~~
2699
2700 -  ``application/json``
2701
2702 Produces
2703 ~~~~~~~~
2704
2705 -  ``application/json``
2706
2707 Tags
2708 ~~~~
2709
2710 -  Service Catalog
2711
2712 DELETE /v1/catalog/services/{serviceid}
2713 ---------------------------------------
2714
2715 Parameters
2716 ~~~~~~~~~~
2717
2718 +------------------+--------------------------+----------------------------------+
2719 | Type             | Name                     | Schema                           |
2720 +==================+==========================+==================================+
2721 | **Path**         | **serviceId**\ *required | string                           |
2722 |                  | *                        |                                  |
2723 +------------------+--------------------------+----------------------------------+
2724
2725 Responses
2726 ~~~~~~~~~
2727
2728 +---------+----------------------------------------------------+----------------+
2729 | HTTP    | Description                                        | Schema         |
2730 | Code    |                                                    |                |
2731 +=========+====================================================+================+
2732 | **defau | successful operation                               | No Content     |
2733 | lt**    |                                                    |                |
2734 +---------+----------------------------------------------------+----------------+
2735
2736 Tags
2737 ~~~~
2738
2739 -  Service Catalog
2740
2741 Create Additional Information Label and Value
2742 ---------------------------------------------
2743
2744 ::
2745
2746     POST /v1/catalog/services/{serviceId}/additionalinfo
2747
2748 Description
2749 ~~~~~~~~~~~
2750
2751 Returns created Additional Inforamtion property
2752
2753 Parameters
2754 ~~~~~~~~~~
2755
2756 +----------+-------------+--------------------------------------+------------------+
2757 | Type     | Name        | Description                          | Schema           |
2758 +==========+=============+======================================+==================+
2759 | **Header | **USER\_ID* |                                      | string           |
2760 | **       | *\ *optiona |                                      |                  |
2761 |          | l*          |                                      |                  |
2762 +----------+-------------+--------------------------------------+------------------+
2763 | **Path** | **serviceId | service id to update with new        | string           |
2764 |          | **\ *requir | property                             |                  |
2765 |          | ed*         |                                      |                  |
2766 +----------+-------------+--------------------------------------+------------------+
2767 | **Body** | **body**\ * | Additional information key value to  | string           |
2768 |          | required*   | be created                           |                  |
2769 +----------+-------------+--------------------------------------+------------------+
2770
2771 Responses
2772 ~~~~~~~~~
2773
2774 +---------+----------------------------------------------------+----------------+
2775 | HTTP    | Description                                        | Schema         |
2776 | Code    |                                                    |                |
2777 +=========+====================================================+================+
2778 | **201** | Additional information created                     | No Content     |
2779 +---------+----------------------------------------------------+----------------+
2780 | **400** | Invalid content / Missing content                  | No Content     |
2781 +---------+----------------------------------------------------+----------------+
2782 | **403** | Restricted operation                               | No Content     |
2783 +---------+----------------------------------------------------+----------------+
2784 | **409** | Additional information key already exist           | No Content     |
2785 +---------+----------------------------------------------------+----------------+
2786
2787 Consumes
2788 ~~~~~~~~
2789
2790 -  ``application/json``
2791
2792 Produces
2793 ~~~~~~~~
2794
2795 -  ``application/json``
2796
2797 Tags
2798 ~~~~
2799
2800 -  Additional Information Servlet
2801
2802 Get all Additional Information under service
2803 --------------------------------------------
2804
2805 ::
2806
2807     GET /v1/catalog/services/{serviceId}/additionalinfo
2808
2809 Description
2810 ~~~~~~~~~~~
2811
2812 Returns Additional Inforamtion property
2813
2814 Parameters
2815 ~~~~~~~~~~
2816
2817 +----------+-------------+--------------------------------------+------------------+
2818 | Type     | Name        | Description                          | Schema           |
2819 +==========+=============+======================================+==================+
2820 | **Header | **USER\_ID* |                                      | string           |
2821 | **       | *\ *optiona |                                      |                  |
2822 |          | l*          |                                      |                  |
2823 +----------+-------------+--------------------------------------+------------------+
2824 | **Path** | **serviceId | service id to update with new        | string           |
2825 |          | **\ *requir | property                             |                  |
2826 |          | ed*         |                                      |                  |
2827 +----------+-------------+--------------------------------------+------------------+
2828
2829 Responses
2830 ~~~~~~~~~
2831
2832 +---------+----------------------------------------------------+----------------+
2833 | HTTP    | Description                                        | Schema         |
2834 | Code    |                                                    |                |
2835 +=========+====================================================+================+
2836 | **200** | list of additional information                     | No Content     |
2837 +---------+----------------------------------------------------+----------------+
2838 | **400** | Invalid content / Missing content                  | No Content     |
2839 +---------+----------------------------------------------------+----------------+
2840 | **403** | Restricted operation                               | No Content     |
2841 +---------+----------------------------------------------------+----------------+
2842 | **409** | Additional information key already exist           | No Content     |
2843 +---------+----------------------------------------------------+----------------+
2844
2845 Consumes
2846 ~~~~~~~~
2847
2848 -  ``application/json``
2849
2850 Produces
2851 ~~~~~~~~
2852
2853 -  ``application/json``
2854
2855 Tags
2856 ~~~~
2857
2858 -  Additional Information Servlet
2859
2860 Get Additional Information by id
2861 --------------------------------
2862
2863 ::
2864
2865     GET /v1/catalog/services/{serviceId}/additionalinfo/{labelId}
2866
2867 Description
2868 ~~~~~~~~~~~
2869
2870 Returns Additional Inforamtion property
2871
2872 Parameters
2873 ~~~~~~~~~~
2874
2875 +----------+-------------+--------------------------------------+------------------+
2876 | Type     | Name        | Description                          | Schema           |
2877 +==========+=============+======================================+==================+
2878 | **Header | **USER\_ID* |                                      | string           |
2879 | **       | *\ *optiona |                                      |                  |
2880 |          | l*          |                                      |                  |
2881 +----------+-------------+--------------------------------------+------------------+
2882 | **Path** | **labelId** | label id                             | string           |
2883 |          | \ *required |                                      |                  |
2884 |          | *           |                                      |                  |
2885 +----------+-------------+--------------------------------------+------------------+
2886 | **Path** | **serviceId | service id to update with new        | string           |
2887 |          | **\ *requir | property                             |                  |
2888 |          | ed*         |                                      |                  |
2889 +----------+-------------+--------------------------------------+------------------+
2890
2891 Responses
2892 ~~~~~~~~~
2893
2894 +---------+----------------------------------------------------+----------------+
2895 | HTTP    | Description                                        | Schema         |
2896 | Code    |                                                    |                |
2897 +=========+====================================================+================+
2898 | **200** | fetched additional information                     | No Content     |
2899 +---------+----------------------------------------------------+----------------+
2900 | **400** | Invalid content / Missing content                  | No Content     |
2901 +---------+----------------------------------------------------+----------------+
2902 | **403** | Restricted operation                               | No Content     |
2903 +---------+----------------------------------------------------+----------------+
2904 | **409** | Additional information key already exist           | No Content     |
2905 +---------+----------------------------------------------------+----------------+
2906
2907 Consumes
2908 ~~~~~~~~
2909
2910 -  ``application/json``
2911
2912 Produces
2913 ~~~~~~~~
2914
2915 -  ``application/json``
2916
2917 Tags
2918 ~~~~
2919
2920 -  Additional Information Servlet
2921
2922 Update Additional Information Label and Value
2923 ---------------------------------------------
2924
2925 ::
2926
2927     PUT /v1/catalog/services/{serviceId}/additionalinfo/{labelId}
2928
2929 Description
2930 ~~~~~~~~~~~
2931
2932 Returns updated Additional Inforamtion property
2933
2934 Parameters
2935 ~~~~~~~~~~
2936
2937 +----------+-------------+--------------------------------------+------------------+
2938 | Type     | Name        | Description                          | Schema           |
2939 +==========+=============+======================================+==================+
2940 | **Header | **USER\_ID* |                                      | string           |
2941 | **       | *\ *optiona |                                      |                  |
2942 |          | l*          |                                      |                  |
2943 +----------+-------------+--------------------------------------+------------------+
2944 | **Path** | **labelId** | label id                             | string           |
2945 |          | \ *required |                                      |                  |
2946 |          | *           |                                      |                  |
2947 +----------+-------------+--------------------------------------+------------------+
2948 | **Path** | **serviceId | service id to update with new        | string           |
2949 |          | **\ *requir | property                             |                  |
2950 |          | ed*         |                                      |                  |
2951 +----------+-------------+--------------------------------------+------------------+
2952 | **Body** | **body**\ * | Additional information key value to  | string           |
2953 |          | required*   | be created                           |                  |
2954 +----------+-------------+--------------------------------------+------------------+
2955
2956 Responses
2957 ~~~~~~~~~
2958
2959 +---------+----------------------------------------------------+----------------+
2960 | HTTP    | Description                                        | Schema         |
2961 | Code    |                                                    |                |
2962 +=========+====================================================+================+
2963 | **200** | Additional information updated                     | No Content     |
2964 +---------+----------------------------------------------------+----------------+
2965 | **400** | Invalid content / Missing content                  | No Content     |
2966 +---------+----------------------------------------------------+----------------+
2967 | **403** | Restricted operation                               | No Content     |
2968 +---------+----------------------------------------------------+----------------+
2969 | **409** | Additional information key already exist           | No Content     |
2970 +---------+----------------------------------------------------+----------------+
2971
2972 Consumes
2973 ~~~~~~~~
2974
2975 -  ``application/json``
2976
2977 Produces
2978 ~~~~~~~~
2979
2980 -  ``application/json``
2981
2982 Tags
2983 ~~~~
2984
2985 -  Additional Information Servlet
2986
2987 Create Additional Information Label and Value
2988 ---------------------------------------------
2989
2990 ::
2991
2992     DELETE /v1/catalog/services/{serviceId}/additionalinfo/{labelId}
2993
2994 Description
2995 ~~~~~~~~~~~
2996
2997 Returns deleted Additional Inforamtion property
2998
2999 Parameters
3000 ~~~~~~~~~~
3001
3002 +----------+-------------+--------------------------------------+------------------+
3003 | Type     | Name        | Description                          | Schema           |
3004 +==========+=============+======================================+==================+
3005 | **Header | **USER\_ID* |                                      | string           |
3006 | **       | *\ *optiona |                                      |                  |
3007 |          | l*          |                                      |                  |
3008 +----------+-------------+--------------------------------------+------------------+
3009 | **Path** | **labelId** | label id                             | string           |
3010 |          | \ *required |                                      |                  |
3011 |          | *           |                                      |                  |
3012 +----------+-------------+--------------------------------------+------------------+
3013 | **Path** | **serviceId | service id to update with new        | string           |
3014 |          | **\ *requir | property                             |                  |
3015 |          | ed*         |                                      |                  |
3016 +----------+-------------+--------------------------------------+------------------+
3017
3018 Responses
3019 ~~~~~~~~~
3020
3021 +---------+----------------------------------------------------+----------------+
3022 | HTTP    | Description                                        | Schema         |
3023 | Code    |                                                    |                |
3024 +=========+====================================================+================+
3025 | **200** | Additional information deleted                     | No Content     |
3026 +---------+----------------------------------------------------+----------------+
3027 | **400** | Invalid content / Missing content                  | No Content     |
3028 +---------+----------------------------------------------------+----------------+
3029 | **403** | Restricted operation                               | No Content     |
3030 +---------+----------------------------------------------------+----------------+
3031 | **409** | Additional information key already exist           | No Content     |
3032 +---------+----------------------------------------------------+----------------+
3033
3034 Consumes
3035 ~~~~~~~~
3036
3037 -  ``application/json``
3038
3039 Produces
3040 ~~~~~~~~
3041
3042 -  ``application/json``
3043
3044 Tags
3045 ~~~~
3046
3047 -  Additional Information Servlet
3048
3049 Create Artifact
3050 ---------------
3051
3052 ::
3053
3054     POST /v1/catalog/services/{serviceId}/artifacts
3055
3056 Description
3057 ~~~~~~~~~~~
3058
3059 Returns created ArtifactDefinition
3060
3061 Parameters
3062 ~~~~~~~~~~
3063
3064 +----------+-------------+--------------------------------------+------------------+
3065 | Type     | Name        | Description                          | Schema           |
3066 +==========+=============+======================================+==================+
3067 | **Path** | **serviceId |                                      | string           |
3068 |          | **\ *requir |                                      |                  |
3069 |          | ed*         |                                      |                  |
3070 +----------+-------------+--------------------------------------+------------------+
3071 | **Body** | **body**\ * | json describe the artifact           | string           |
3072 |          | required*   |                                      |                  |
3073 +----------+-------------+--------------------------------------+------------------+
3074
3075 Responses
3076 ~~~~~~~~~
3077
3078 +---------+----------------------------------------------------+----------------+
3079 | HTTP    | Description                                        | Schema         |
3080 | Code    |                                                    |                |
3081 +=========+====================================================+================+
3082 | **201** | Resource created                                   | No Content     |
3083 +---------+----------------------------------------------------+----------------+
3084 | **400** | Invalid content / Missing content                  | No Content     |
3085 +---------+----------------------------------------------------+----------------+
3086 | **403** | Restricted operation                               | No Content     |
3087 +---------+----------------------------------------------------+----------------+
3088 | **409** | Artifact already exist                             | No Content     |
3089 +---------+----------------------------------------------------+----------------+
3090
3091 Consumes
3092 ~~~~~~~~
3093
3094 -  ``application/json``
3095
3096 Produces
3097 ~~~~~~~~
3098
3099 -  ``application/json``
3100
3101 Tags
3102 ~~~~
3103
3104 -  Resource Artifact Servlet
3105
3106 Update Api Artifact
3107 -------------------
3108
3109 ::
3110
3111     POST /v1/catalog/services/{serviceId}/artifacts/api/{artifactId}
3112
3113 Description
3114 ~~~~~~~~~~~
3115
3116 Returns created ArtifactDefinition
3117
3118 Parameters
3119 ~~~~~~~~~~
3120
3121 +----------+-------------+--------------------------------------+------------------+
3122 | Type     | Name        | Description                          | Schema           |
3123 +==========+=============+======================================+==================+
3124 | **Header | **Content-M |                                      | string           |
3125 | **       | D5**\ *opti |                                      |                  |
3126 |          | onal*       |                                      |                  |
3127 +----------+-------------+--------------------------------------+------------------+
3128 | **Header | **USER\_ID* |                                      | string           |
3129 | **       | *\ *optiona |                                      |                  |
3130 |          | l*          |                                      |                  |
3131 +----------+-------------+--------------------------------------+------------------+
3132 | **Path** | **artifactI |                                      | string           |
3133 |          | d**\ *requi |                                      |                  |
3134 |          | red*        |                                      |                  |
3135 +----------+-------------+--------------------------------------+------------------+
3136 | **Path** | **serviceId |                                      | string           |
3137 |          | **\ *requir |                                      |                  |
3138 |          | ed*         |                                      |                  |
3139 +----------+-------------+--------------------------------------+------------------+
3140 | **Body** | **body**\ * | json describe the artifact           | string           |
3141 |          | required*   |                                      |                  |
3142 +----------+-------------+--------------------------------------+------------------+
3143
3144 Responses
3145 ~~~~~~~~~
3146
3147 +---------+----------------------------------------------------+----------------+
3148 | HTTP    | Description                                        | Schema         |
3149 | Code    |                                                    |                |
3150 +=========+====================================================+================+
3151 | **200** | Api Artifact Updated                               | No Content     |
3152 +---------+----------------------------------------------------+----------------+
3153 | **400** | Invalid content / Missing content                  | No Content     |
3154 +---------+----------------------------------------------------+----------------+
3155 | **403** | Restricted operation                               | No Content     |
3156 +---------+----------------------------------------------------+----------------+
3157
3158 Consumes
3159 ~~~~~~~~
3160
3161 -  ``application/json``
3162
3163 Produces
3164 ~~~~~~~~
3165
3166 -  ``application/json``
3167
3168 Tags
3169 ~~~~
3170
3171 -  Resource Artifact Servlet
3172
3173 Delete Api Artifact
3174 -------------------
3175
3176 ::
3177
3178     DELETE /v1/catalog/services/{serviceId}/artifacts/api/{artifactId}
3179
3180 Description
3181 ~~~~~~~~~~~
3182
3183 Returns Deleted ArtifactDefinition
3184
3185 Parameters
3186 ~~~~~~~~~~
3187
3188 +------------------+--------------------------+----------------------------------+
3189 | Type             | Name                     | Schema                           |
3190 +==================+==========================+==================================+
3191 | **Header**       | **Content-MD5**\ *option | string                           |
3192 |                  | al*                      |                                  |
3193 +------------------+--------------------------+----------------------------------+
3194 | **Header**       | **USER\_ID**\ *optional* | string                           |
3195 +------------------+--------------------------+----------------------------------+
3196 | **Path**         | **artifactId**\ *require | string                           |
3197 |                  | d*                       |                                  |
3198 +------------------+--------------------------+----------------------------------+
3199 | **Path**         | **serviceId**\ *required | string                           |
3200 |                  | *                        |                                  |
3201 +------------------+--------------------------+----------------------------------+
3202
3203 Responses
3204 ~~~~~~~~~
3205
3206 +---------+----------------------------------------------------+----------------+
3207 | HTTP    | Description                                        | Schema         |
3208 | Code    |                                                    |                |
3209 +=========+====================================================+================+
3210 | **204** | Api Artifact deleted                               | No Content     |
3211 +---------+----------------------------------------------------+----------------+
3212 | **403** | Restricted operation                               | No Content     |
3213 +---------+----------------------------------------------------+----------------+
3214
3215 Consumes
3216 ~~~~~~~~
3217
3218 -  ``application/json``
3219
3220 Produces
3221 ~~~~~~~~
3222
3223 -  ``application/json``
3224
3225 Tags
3226 ~~~~
3227
3228 -  Resource Artifact Servlet
3229
3230 Update Artifact
3231 ---------------
3232
3233 ::
3234
3235     POST /v1/catalog/services/{serviceId}/artifacts/{artifactId}
3236
3237 Description
3238 ~~~~~~~~~~~
3239
3240 Returns updated artifact
3241
3242 Parameters
3243 ~~~~~~~~~~
3244
3245 +----------+-------------+--------------------------------------+------------------+
3246 | Type     | Name        | Description                          | Schema           |
3247 +==========+=============+======================================+==================+
3248 | **Path** | **artifactI |                                      | string           |
3249 |          | d**\ *requi |                                      |                  |
3250 |          | red*        |                                      |                  |
3251 +----------+-------------+--------------------------------------+------------------+
3252 | **Path** | **serviceId |                                      | string           |
3253 |          | **\ *requir |                                      |                  |
3254 |          | ed*         |                                      |                  |
3255 +----------+-------------+--------------------------------------+------------------+
3256 | **Body** | **body**\ * | json describe the artifact           | string           |
3257 |          | required*   |                                      |                  |
3258 +----------+-------------+--------------------------------------+------------------+
3259
3260 Responses
3261 ~~~~~~~~~
3262
3263 +---------+----------------------------------------------------+----------------+
3264 | HTTP    | Description                                        | Schema         |
3265 | Code    |                                                    |                |
3266 +=========+====================================================+================+
3267 | **201** | Service artifact created                           | No Content     |
3268 +---------+----------------------------------------------------+----------------+
3269 | **400** | Invalid content / Missing content                  | No Content     |
3270 +---------+----------------------------------------------------+----------------+
3271 | **403** | Restricted operation                               | No Content     |
3272 +---------+----------------------------------------------------+----------------+
3273
3274 Consumes
3275 ~~~~~~~~
3276
3277 -  ``application/json``
3278
3279 Produces
3280 ~~~~~~~~
3281
3282 -  ``application/json``
3283
3284 Tags
3285 ~~~~
3286
3287 -  Resource Artifact Servlet
3288
3289 Download service Artifact in Base64
3290 -----------------------------------
3291
3292 ::
3293
3294     GET /v1/catalog/services/{serviceId}/artifacts/{artifactId}
3295
3296 Description
3297 ~~~~~~~~~~~
3298
3299 Returns downloaded artifact
3300
3301 Parameters
3302 ~~~~~~~~~~
3303
3304 +------------------+--------------------------+----------------------------------+
3305 | Type             | Name                     | Schema                           |
3306 +==================+==========================+==================================+
3307 | **Path**         | **artifactId**\ *require | string                           |
3308 |                  | d*                       |                                  |
3309 +------------------+--------------------------+----------------------------------+
3310 | **Path**         | **serviceId**\ *required | string                           |
3311 |                  | *                        |                                  |
3312 +------------------+--------------------------+----------------------------------+
3313
3314 Responses
3315 ~~~~~~~~~
3316
3317 +---------+----------------------------------------------------+----------------+
3318 | HTTP    | Description                                        | Schema         |
3319 | Code    |                                                    |                |
3320 +=========+====================================================+================+
3321 | **200** | Service artifact downloaded                        | No Content     |
3322 +---------+----------------------------------------------------+----------------+
3323 | **404** | Service/Artifact not found                         | No Content     |
3324 +---------+----------------------------------------------------+----------------+
3325
3326 Consumes
3327 ~~~~~~~~
3328
3329 -  ``application/json``
3330
3331 Produces
3332 ~~~~~~~~
3333
3334 -  ``application/json``
3335
3336 Tags
3337 ~~~~
3338
3339 -  Resource Artifact Servlet
3340
3341 Delete Artifact
3342 ---------------
3343
3344 ::
3345
3346     DELETE /v1/catalog/services/{serviceId}/artifacts/{artifactId}
3347
3348 Description
3349 ~~~~~~~~~~~
3350
3351 Returns delete artifact
3352
3353 Parameters
3354 ~~~~~~~~~~
3355
3356 +------------------+--------------------------+----------------------------------+
3357 | Type             | Name                     | Schema                           |
3358 +==================+==========================+==================================+
3359 | **Path**         | **artifactId**\ *require | string                           |
3360 |                  | d*                       |                                  |
3361 +------------------+--------------------------+----------------------------------+
3362 | **Path**         | **serviceId**\ *required | string                           |
3363 |                  | *                        |                                  |
3364 +------------------+--------------------------+----------------------------------+
3365
3366 Responses
3367 ~~~~~~~~~
3368
3369 +---------+----------------------------------------------------+----------------+
3370 | HTTP    | Description                                        | Schema         |
3371 | Code    |                                                    |                |
3372 +=========+====================================================+================+
3373 | **201** | Service artifact deleted                           | No Content     |
3374 +---------+----------------------------------------------------+----------------+
3375 | **400** | Invalid content / Missing content                  | No Content     |
3376 +---------+----------------------------------------------------+----------------+
3377 | **403** | Restricted operation                               | No Content     |
3378 +---------+----------------------------------------------------+----------------+
3379
3380 Consumes
3381 ~~~~~~~~
3382
3383 -  ``application/json``
3384
3385 Produces
3386 ~~~~~~~~
3387
3388 -  ``application/json``
3389
3390 Tags
3391 ~~~~
3392
3393 -  Resource Artifact Servlet
3394
3395 Update Service Distribution State
3396 ---------------------------------
3397
3398 ::
3399
3400     POST /v1/catalog/services/{serviceId}/distribution-state/{state}
3401
3402 Description
3403 ~~~~~~~~~~~
3404
3405 service with the changed distribution status
3406
3407 Parameters
3408 ~~~~~~~~~~
3409
3410 +----------+-------------+--------------------------------------+------------------+
3411 | Type     | Name        | Description                          | Schema           |
3412 +==========+=============+======================================+==================+
3413 | **Header | **USER\_ID* |                                      | string           |
3414 | **       | *\ *optiona |                                      |                  |
3415 |          | l*          |                                      |                  |
3416 +----------+-------------+--------------------------------------+------------------+
3417 | **Path** | **serviceId |                                      | string           |
3418 |          | **\ *requir |                                      |                  |
3419 |          | ed*         |                                      |                  |
3420 +----------+-------------+--------------------------------------+------------------+
3421 | **Path** | **state**\  |                                      | enum (approve,   |
3422 |          | *required*  |                                      | reject)          |
3423 +----------+-------------+--------------------------------------+------------------+
3424 | **Body** | **body**\ * | DistributionChangeInfo - get comment | `LifecycleChange |
3425 |          | required*   | out of body                          | InfoWithAction < |
3426 |          |             |                                      | #_lifecyclechang |
3427 |          |             |                                      | einfowithaction> |
3428 |          |             |                                      | `__              |
3429 +----------+-------------+--------------------------------------+------------------+
3430
3431 Responses
3432 ~~~~~~~~~
3433
3434 +---------+----------------------------------------------------+----------------+
3435 | HTTP    | Description                                        | Schema         |
3436 | Code    |                                                    |                |
3437 +=========+====================================================+================+
3438 | **200** | Service distribution state changed                 | No Content     |
3439 +---------+----------------------------------------------------+----------------+
3440 | **400** | Invalid content / Missing content                  | No Content     |
3441 +---------+----------------------------------------------------+----------------+
3442 | **403** | Service is not available for distribution          | No Content     |
3443 +---------+----------------------------------------------------+----------------+
3444 | **404** | Requested service was not found                    | No Content     |
3445 +---------+----------------------------------------------------+----------------+
3446 | **409** | Restricted operation                               | No Content     |
3447 +---------+----------------------------------------------------+----------------+
3448 | **500** | Internal Server Error. Please try again later.     | No Content     |
3449 +---------+----------------------------------------------------+----------------+
3450
3451 Consumes
3452 ~~~~~~~~
3453
3454 -  ``application/json``
3455
3456 Produces
3457 ~~~~~~~~
3458
3459 -  ``application/json``
3460
3461 Tags
3462 ~~~~
3463
3464 -  Service Catalog
3465
3466 Mark distribution as deployed
3467 -----------------------------
3468
3469 ::
3470
3471     POST /v1/catalog/services/{serviceId}/distribution/{did}/markDeployed
3472
3473 Description
3474 ~~~~~~~~~~~
3475
3476 relevant audit record will be created
3477
3478 Parameters
3479 ~~~~~~~~~~
3480
3481 +------------------+--------------------------+----------------------------------+
3482 | Type             | Name                     | Schema                           |
3483 +==================+==========================+==================================+
3484 | **Header**       | **USER\_ID**\ *optional* | string                           |
3485 +------------------+--------------------------+----------------------------------+
3486 | **Path**         | **did**\ *required*      | string                           |
3487 +------------------+--------------------------+----------------------------------+
3488 | **Path**         | **serviceId**\ *required | string                           |
3489 |                  | *                        |                                  |
3490 +------------------+--------------------------+----------------------------------+
3491
3492 Responses
3493 ~~~~~~~~~
3494
3495 +---------+----------------------------------------------------+----------------+
3496 | HTTP    | Description                                        | Schema         |
3497 | Code    |                                                    |                |
3498 +=========+====================================================+================+
3499 | **200** | Service was marked as deployed                     | No Content     |
3500 +---------+----------------------------------------------------+----------------+
3501 | **400** | Invalid content / Missing content                  | No Content     |
3502 +---------+----------------------------------------------------+----------------+
3503 | **403** | Service is not available                           | No Content     |
3504 +---------+----------------------------------------------------+----------------+
3505 | **404** | Requested service was not found                    | No Content     |
3506 +---------+----------------------------------------------------+----------------+
3507 | **409** | Restricted operation                               | No Content     |
3508 +---------+----------------------------------------------------+----------------+
3509 | **500** | Internal Server Error. Please try again later.     | No Content     |
3510 +---------+----------------------------------------------------+----------------+
3511
3512 Consumes
3513 ~~~~~~~~
3514
3515 -  ``application/json``
3516
3517 Produces
3518 ~~~~~~~~
3519
3520 -  ``application/json``
3521
3522 Tags
3523 ~~~~
3524
3525 -  Service Catalog
3526
3527 Activate distribution
3528 ---------------------
3529
3530 ::
3531
3532     POST /v1/catalog/services/{serviceId}/distribution/{env}/activate
3533
3534 Description
3535 ~~~~~~~~~~~
3536
3537 activate distribution
3538
3539 Parameters
3540 ~~~~~~~~~~
3541
3542 +------------------+--------------------------+----------------------------------+
3543 | Type             | Name                     | Schema                           |
3544 +==================+==========================+==================================+
3545 | **Header**       | **USER\_ID**\ *optional* | string                           |
3546 +------------------+--------------------------+----------------------------------+
3547 | **Path**         | **env**\ *required*      | string                           |
3548 +------------------+--------------------------+----------------------------------+
3549 | **Path**         | **serviceId**\ *required | string                           |
3550 |                  | *                        |                                  |
3551 +------------------+--------------------------+----------------------------------+
3552
3553 Responses
3554 ~~~~~~~~~
3555
3556 +---------+----------------------------------------------------+----------------+
3557 | HTTP    | Description                                        | Schema         |
3558 | Code    |                                                    |                |
3559 +=========+====================================================+================+
3560 | **200** | OK                                                 | No Content     |
3561 +---------+----------------------------------------------------+----------------+
3562 | **404** | Requested service was not found                    | No Content     |
3563 +---------+----------------------------------------------------+----------------+
3564 | **409** | Service cannot be distributed due to missing       | No Content     |
3565 |         | deployment artifacts                               |                |
3566 +---------+----------------------------------------------------+----------------+
3567 | **500** | Internal Server Error. Please try again later.     | No Content     |
3568 +---------+----------------------------------------------------+----------------+
3569
3570 Consumes
3571 ~~~~~~~~
3572
3573 -  ``application/json``
3574
3575 Produces
3576 ~~~~~~~~
3577
3578 -  ``application/json``
3579
3580 Tags
3581 ~~~~
3582
3583 -  Service Catalog
3584
3585 Update Service Metadata
3586 -----------------------
3587
3588 ::
3589
3590     PUT /v1/catalog/services/{serviceId}/metadata
3591
3592 Description
3593 ~~~~~~~~~~~
3594
3595 Returns updated service
3596
3597 Parameters
3598 ~~~~~~~~~~
3599
3600 +----------+-------------+--------------------------------------+------------------+
3601 | Type     | Name        | Description                          | Schema           |
3602 +==========+=============+======================================+==================+
3603 | **Header | **USER\_ID* |                                      | string           |
3604 | **       | *\ *optiona |                                      |                  |
3605 |          | l*          |                                      |                  |
3606 +----------+-------------+--------------------------------------+------------------+
3607 | **Path** | **serviceId |                                      | string           |
3608 |          | **\ *requir |                                      |                  |
3609 |          | ed*         |                                      |                  |
3610 +----------+-------------+--------------------------------------+------------------+
3611 | **Body** | **body**\ * | Service object to be Updated         | string           |
3612 |          | required*   |                                      |                  |
3613 +----------+-------------+--------------------------------------+------------------+
3614
3615 Responses
3616 ~~~~~~~~~
3617
3618 +---------+----------------------------------------------------+----------------+
3619 | HTTP    | Description                                        | Schema         |
3620 | Code    |                                                    |                |
3621 +=========+====================================================+================+
3622 | **200** | Service Updated                                    | No Content     |
3623 +---------+----------------------------------------------------+----------------+
3624 | **400** | Invalid content / Missing content                  | No Content     |
3625 +---------+----------------------------------------------------+----------------+
3626 | **403** | Restricted operation                               | No Content     |
3627 +---------+----------------------------------------------------+----------------+
3628
3629 Consumes
3630 ~~~~~~~~
3631
3632 -  ``application/json``
3633
3634 Produces
3635 ~~~~~~~~
3636
3637 -  ``application/json``
3638
3639 Tags
3640 ~~~~
3641
3642 -  Service Catalog
3643
3644 POST /v1/catalog/services/{serviceid}/tempUrlToBeDeleted
3645 --------------------------------------------------------
3646
3647 Parameters
3648 ~~~~~~~~~~
3649
3650 +------------------+--------------------------+----------------------------------+
3651 | Type             | Name                     | Schema                           |
3652 +==================+==========================+==================================+
3653 | **Header**       | **USER\_ID**\ *optional* | string                           |
3654 +------------------+--------------------------+----------------------------------+
3655 | **Path**         | **serviceId**\ *required | string                           |
3656 |                  | *                        |                                  |
3657 +------------------+--------------------------+----------------------------------+
3658
3659 Responses
3660 ~~~~~~~~~
3661
3662 +---------+----------------------------------------------------+----------------+
3663 | HTTP    | Description                                        | Schema         |
3664 | Code    |                                                    |                |
3665 +=========+====================================================+================+
3666 | **200** | OK                                                 | No Content     |
3667 +---------+----------------------------------------------------+----------------+
3668 | **500** | Internal Server Error. Please try again later.     | No Content     |
3669 +---------+----------------------------------------------------+----------------+
3670
3671 Consumes
3672 ~~~~~~~~
3673
3674 -  ``application/json``
3675
3676 Produces
3677 ~~~~~~~~
3678
3679 -  ``application/json``
3680
3681 Tags
3682 ~~~~
3683
3684 -  Service Catalog
3685
3686 DELETE /v1/catalog/services/{servicename}/{version}
3687 ---------------------------------------------------
3688
3689 Parameters
3690 ~~~~~~~~~~
3691
3692 +------------------+--------------------------+----------------------------------+
3693 | Type             | Name                     | Schema                           |
3694 +==================+==========================+==================================+
3695 | **Path**         | **serviceName**\ *requir | string                           |
3696 |                  | ed*                      |                                  |
3697 +------------------+--------------------------+----------------------------------+
3698 | **Path**         | **version**\ *required*  | string                           |
3699 +------------------+--------------------------+----------------------------------+
3700
3701 Responses
3702 ~~~~~~~~~
3703
3704 +---------+----------------------------------------------------+----------------+
3705 | HTTP    | Description                                        | Schema         |
3706 | Code    |                                                    |                |
3707 +=========+====================================================+================+
3708 | **defau | successful operation                               | No Content     |
3709 | lt**    |                                                    |                |
3710 +---------+----------------------------------------------------+----------------+
3711
3712 Tags
3713 ~~~~
3714
3715 -  Service Catalog
3716
3717 Retrieve Distributions
3718 ----------------------
3719
3720 ::
3721
3722     GET /v1/catalog/services/{serviceUUID}/distribution
3723
3724 Description
3725 ~~~~~~~~~~~
3726
3727 Returns list bases on the information extracted from Auditing Records
3728 according to service uuid
3729
3730 Parameters
3731 ~~~~~~~~~~
3732
3733 +------------------+--------------------------+----------------------------------+
3734 | Type             | Name                     | Schema                           |
3735 +==================+==========================+==================================+
3736 | **Header**       | **USER\_ID**\ *optional* | string                           |
3737 +------------------+--------------------------+----------------------------------+
3738 | **Path**         | **serviceUUID**\ *requir | string                           |
3739 |                  | ed*                      |                                  |
3740 +------------------+--------------------------+----------------------------------+
3741
3742 Responses
3743 ~~~~~~~~~
3744
3745 +---------+----------------------------------------------------+----------------+
3746 | HTTP    | Description                                        | Schema         |
3747 | Code    |                                                    |                |
3748 +=========+====================================================+================+
3749 | **200** | Service found                                      | No Content     |
3750 +---------+----------------------------------------------------+----------------+
3751 | **403** | Restricted operation                               | No Content     |
3752 +---------+----------------------------------------------------+----------------+
3753 | **404** | Service not found                                  | No Content     |
3754 +---------+----------------------------------------------------+----------------+
3755
3756 Consumes
3757 ~~~~~~~~
3758
3759 -  ``application/json``
3760
3761 Produces
3762 ~~~~~~~~
3763
3764 -  ``application/json``
3765
3766 Tags
3767 ~~~~
3768
3769 -  Distribution Service Servlet
3770
3771 Create Resource from yaml
3772 -------------------------
3773
3774 ::
3775
3776     POST /v1/catalog/upload/{resourceAuthority}
3777
3778 Description
3779 ~~~~~~~~~~~
3780
3781 Returns created resource
3782
3783 Parameters
3784 ~~~~~~~~~~
3785
3786 +---------+------------+----------------------------------+----------------+---------+
3787 | Type    | Name       | Description                      | Schema         | Default |
3788 +=========+============+==================================+================+=========+
3789 | **Heade | **USER\_ID |                                  | string         |         |
3790 | r**     | **\ *optio |                                  |                |         |
3791 |         | nal*       |                                  |                |         |
3792 +---------+------------+----------------------------------+----------------+---------+
3793 | **Path* | **resource | validValues: normative-resource  | enum           |         |
3794 | *       | Authority* | / user-resource                  | (multipart,    |         |
3795 |         | *\ *requir |                                  | user-resource, |         |
3796 |         | ed*        |                                  | user-resource- |         |
3797 |         |            |                                  | ui-import)     |         |
3798 +---------+------------+----------------------------------+----------------+---------+
3799 | **Query | **createNe |                                  | boolean        | ``"true |
3800 | **      | wVersion** |                                  |                | "``     |
3801 |         | \ *optiona |                                  |                |         |
3802 |         | l*         |                                  |                |         |
3803 +---------+------------+----------------------------------+----------------+---------+
3804 | **FormD | **resource | resourceMetadata                 | string         |         |
3805 | ata**   | Metadata** |                                  |                |         |
3806 |         | \ *optiona |                                  |                |         |
3807 |         | l*         |                                  |                |         |
3808 +---------+------------+----------------------------------+----------------+---------+
3809 | **FormD | **resource | FileInputStream                  | file           |         |
3810 | ata**   | Zip**\ *op |                                  |                |         |
3811 |         | tional*    |                                  |                |         |
3812 +---------+------------+----------------------------------+----------------+---------+
3813
3814 Responses
3815 ~~~~~~~~~
3816
3817 +---------+----------------------------------------------------+----------------+
3818 | HTTP    | Description                                        | Schema         |
3819 | Code    |                                                    |                |
3820 +=========+====================================================+================+
3821 | **201** | Resource created                                   | No Content     |
3822 +---------+----------------------------------------------------+----------------+
3823 | **400** | Invalid content / Missing content                  | No Content     |
3824 +---------+----------------------------------------------------+----------------+
3825 | **403** | Restricted operation                               | No Content     |
3826 +---------+----------------------------------------------------+----------------+
3827 | **409** | Resource already exist                             | No Content     |
3828 +---------+----------------------------------------------------+----------------+
3829
3830 Consumes
3831 ~~~~~~~~
3832
3833 -  ``multipart/form-data``
3834
3835 Produces
3836 ~~~~~~~~
3837
3838 -  ``application/json``
3839
3840 Tags
3841 ~~~~
3842
3843 -  Resources Catalog Upload
3844
3845 Create Capability Type from yaml
3846 --------------------------------
3847
3848 ::
3849
3850     POST /v1/catalog/uploadType/capability
3851
3852 Description
3853 ~~~~~~~~~~~
3854
3855 Returns created Capability Type
3856
3857 Parameters
3858 ~~~~~~~~~~
3859
3860 +----------+-------------+--------------------------------------+------------------+
3861 | Type     | Name        | Description                          | Schema           |
3862 +==========+=============+======================================+==================+
3863 | **Header | **USER\_ID* |                                      | string           |
3864 | **       | *\ *optiona |                                      |                  |
3865 |          | l*          |                                      |                  |
3866 +----------+-------------+--------------------------------------+------------------+
3867 | **FormDa | **capabilit | FileInputStream                      | file             |
3868 | ta**     | yTypeZip**\ |                                      |                  |
3869 |          |  *optional* |                                      |                  |
3870 +----------+-------------+--------------------------------------+------------------+
3871
3872 Responses
3873 ~~~~~~~~~
3874
3875 +---------+----------------------------------------------------+----------------+
3876 | HTTP    | Description                                        | Schema         |
3877 | Code    |                                                    |                |
3878 +=========+====================================================+================+
3879 | **201** | Capability Type created                            | No Content     |
3880 +---------+----------------------------------------------------+----------------+
3881 | **400** | Invalid content / Missing content                  | No Content     |
3882 +---------+----------------------------------------------------+----------------+
3883 | **403** | Restricted operation                               | No Content     |
3884 +---------+----------------------------------------------------+----------------+
3885 | **409** | Capability Type already exist                      | No Content     |
3886 +---------+----------------------------------------------------+----------------+
3887
3888 Consumes
3889 ~~~~~~~~
3890
3891 -  ``multipart/form-data``
3892
3893 Produces
3894 ~~~~~~~~
3895
3896 -  ``application/json``
3897
3898 Tags
3899 ~~~~
3900
3901 -  Catalog Types Upload
3902
3903 Create Categories from yaml
3904 ---------------------------
3905
3906 ::
3907
3908     POST /v1/catalog/uploadType/categories
3909
3910 Description
3911 ~~~~~~~~~~~
3912
3913 Returns created categories
3914
3915 Parameters
3916 ~~~~~~~~~~
3917
3918 +----------+-------------+--------------------------------------+------------------+
3919 | Type     | Name        | Description                          | Schema           |
3920 +==========+=============+======================================+==================+
3921 | **Header | **USER\_ID* |                                      | string           |
3922 | **       | *\ *optiona |                                      |                  |
3923 |          | l*          |                                      |                  |
3924 +----------+-------------+--------------------------------------+------------------+
3925 | **FormDa | **categorie | FileInputStream                      | file             |
3926 | ta**     | sZip**\ *op |                                      |                  |
3927 |          | tional*     |                                      |                  |
3928 +----------+-------------+--------------------------------------+------------------+
3929
3930 Responses
3931 ~~~~~~~~~
3932
3933 +---------+----------------------------------------------------+----------------+
3934 | HTTP    | Description                                        | Schema         |
3935 | Code    |                                                    |                |
3936 +=========+====================================================+================+
3937 | **201** | Categories created                                 | No Content     |
3938 +---------+----------------------------------------------------+----------------+
3939 | **400** | Invalid content / Missing content                  | No Content     |
3940 +---------+----------------------------------------------------+----------------+
3941 | **403** | Restricted operation                               | No Content     |
3942 +---------+----------------------------------------------------+----------------+
3943 | **409** | Category already exist                             | No Content     |
3944 +---------+----------------------------------------------------+----------------+
3945
3946 Consumes
3947 ~~~~~~~~
3948
3949 -  ``multipart/form-data``
3950
3951 Produces
3952 ~~~~~~~~
3953
3954 -  ``application/json``
3955
3956 Tags
3957 ~~~~
3958
3959 -  Catalog Types Upload
3960
3961 Create Categories from yaml
3962 ---------------------------
3963
3964 ::
3965
3966     POST /v1/catalog/uploadType/datatypes
3967
3968 Description
3969 ~~~~~~~~~~~
3970
3971 Returns created data types
3972
3973 Parameters
3974 ~~~~~~~~~~
3975
3976 +----------+-------------+--------------------------------------+------------------+
3977 | Type     | Name        | Description                          | Schema           |
3978 +==========+=============+======================================+==================+
3979 | **Header | **USER\_ID* |                                      | string           |
3980 | **       | *\ *optiona |                                      |                  |
3981 |          | l*          |                                      |                  |
3982 +----------+-------------+--------------------------------------+------------------+
3983 | **FormDa | **dataTypes | FileInputStream                      | file             |
3984 | ta**     | Zip**\ *opt |                                      |                  |
3985 |          | ional*      |                                      |                  |
3986 +----------+-------------+--------------------------------------+------------------+
3987
3988 Responses
3989 ~~~~~~~~~
3990
3991 +---------+----------------------------------------------------+----------------+
3992 | HTTP    | Description                                        | Schema         |
3993 | Code    |                                                    |                |
3994 +=========+====================================================+================+
3995 | **201** | Data types created                                 | No Content     |
3996 +---------+----------------------------------------------------+----------------+
3997 | **400** | Invalid content / Missing content                  | No Content     |
3998 +---------+----------------------------------------------------+----------------+
3999 | **403** | Restricted operation                               | No Content     |
4000 +---------+----------------------------------------------------+----------------+
4001 | **409** | Data types already exist                           | No Content     |
4002 +---------+----------------------------------------------------+----------------+
4003
4004 Consumes
4005 ~~~~~~~~
4006
4007 -  ``multipart/form-data``
4008
4009 Produces
4010 ~~~~~~~~
4011
4012 -  ``application/json``
4013
4014 Tags
4015 ~~~~
4016
4017 -  Catalog Types Upload
4018
4019 Create GroupTypes from yaml
4020 ---------------------------
4021
4022 ::
4023
4024     POST /v1/catalog/uploadType/grouptypes
4025
4026 Description
4027 ~~~~~~~~~~~
4028
4029 Returns created group types
4030
4031 Parameters
4032 ~~~~~~~~~~
4033
4034 +----------+-------------+--------------------------------------+------------------+
4035 | Type     | Name        | Description                          | Schema           |
4036 +==========+=============+======================================+==================+
4037 | **Header | **USER\_ID* |                                      | string           |
4038 | **       | *\ *optiona |                                      |                  |
4039 |          | l*          |                                      |                  |
4040 +----------+-------------+--------------------------------------+------------------+
4041 | **FormDa | **groupType | FileInputStream                      | file             |
4042 | ta**     | sZip**\ *op |                                      |                  |
4043 |          | tional*     |                                      |                  |
4044 +----------+-------------+--------------------------------------+------------------+
4045
4046 Responses
4047 ~~~~~~~~~
4048
4049 +---------+----------------------------------------------------+----------------+
4050 | HTTP    | Description                                        | Schema         |
4051 | Code    |                                                    |                |
4052 +=========+====================================================+================+
4053 | **201** | group types created                                | No Content     |
4054 +---------+----------------------------------------------------+----------------+
4055 | **400** | Invalid content / Missing content                  | No Content     |
4056 +---------+----------------------------------------------------+----------------+
4057 | **403** | Restricted operation                               | No Content     |
4058 +---------+----------------------------------------------------+----------------+
4059 | **409** | group types already exist                          | No Content     |
4060 +---------+----------------------------------------------------+----------------+
4061
4062 Consumes
4063 ~~~~~~~~
4064
4065 -  ``multipart/form-data``
4066
4067 Produces
4068 ~~~~~~~~
4069
4070 -  ``application/json``
4071
4072 Tags
4073 ~~~~
4074
4075 -  Catalog Types Upload
4076
4077 Create Interface Lyfecycle Type from yaml
4078 -----------------------------------------
4079
4080 ::
4081
4082     POST /v1/catalog/uploadType/interfaceLifecycle
4083
4084 Description
4085 ~~~~~~~~~~~
4086
4087 Returns created Interface Lifecycle Type
4088
4089 Parameters
4090 ~~~~~~~~~~
4091
4092 +----------+-------------+--------------------------------------+------------------+
4093 | Type     | Name        | Description                          | Schema           |
4094 +==========+=============+======================================+==================+
4095 | **Header | **USER\_ID* |                                      | string           |
4096 | **       | *\ *optiona |                                      |                  |
4097 |          | l*          |                                      |                  |
4098 +----------+-------------+--------------------------------------+------------------+
4099 | **FormDa | **interface | FileInputStream                      | file             |
4100 | ta**     | LifecycleTy |                                      |                  |
4101 |          | peZip**\ *o |                                      |                  |
4102 |          | ptional*    |                                      |                  |
4103 +----------+-------------+--------------------------------------+------------------+
4104
4105 Responses
4106 ~~~~~~~~~
4107
4108 +---------+----------------------------------------------------+----------------+
4109 | HTTP    | Description                                        | Schema         |
4110 | Code    |                                                    |                |
4111 +=========+====================================================+================+
4112 | **201** | Interface Lifecycle Type created                   | No Content     |
4113 +---------+----------------------------------------------------+----------------+
4114 | **400** | Invalid content / Missing content                  | No Content     |
4115 +---------+----------------------------------------------------+----------------+
4116 | **403** | Restricted operation                               | No Content     |
4117 +---------+----------------------------------------------------+----------------+
4118 | **409** | Interface Lifecycle Type already exist             | No Content     |
4119 +---------+----------------------------------------------------+----------------+
4120
4121 Consumes
4122 ~~~~~~~~
4123
4124 -  ``multipart/form-data``
4125
4126 Produces
4127 ~~~~~~~~
4128
4129 -  ``application/json``
4130
4131 Tags
4132 ~~~~
4133
4134 -  Catalog Types Upload
4135
4136 Create PolicyTypes from yaml
4137 ----------------------------
4138
4139 ::
4140
4141     POST /v1/catalog/uploadType/policytypes
4142
4143 Description
4144 ~~~~~~~~~~~
4145
4146 Returns created policy types
4147
4148 Parameters
4149 ~~~~~~~~~~
4150
4151 +----------+-------------+--------------------------------------+------------------+
4152 | Type     | Name        | Description                          | Schema           |
4153 +==========+=============+======================================+==================+
4154 | **Header | **USER\_ID* |                                      | string           |
4155 | **       | *\ *optiona |                                      |                  |
4156 |          | l*          |                                      |                  |
4157 +----------+-------------+--------------------------------------+------------------+
4158 | **FormDa | **policyTyp | FileInputStream                      | file             |
4159 | ta**     | esZip**\ *o |                                      |                  |
4160 |          | ptional*    |                                      |                  |
4161 +----------+-------------+--------------------------------------+------------------+
4162
4163 Responses
4164 ~~~~~~~~~
4165
4166 +---------+----------------------------------------------------+----------------+
4167 | HTTP    | Description                                        | Schema         |
4168 | Code    |                                                    |                |
4169 +=========+====================================================+================+
4170 | **201** | policy types created                               | No Content     |
4171 +---------+----------------------------------------------------+----------------+
4172 | **400** | Invalid content / Missing content                  | No Content     |
4173 +---------+----------------------------------------------------+----------------+
4174 | **403** | Restricted operation                               | No Content     |
4175 +---------+----------------------------------------------------+----------------+
4176 | **409** | policy types already exist                         | No Content     |
4177 +---------+----------------------------------------------------+----------------+
4178
4179 Consumes
4180 ~~~~~~~~
4181
4182 -  ``multipart/form-data``
4183
4184 Produces
4185 ~~~~~~~~
4186
4187 -  ``application/json``
4188
4189 Tags
4190 ~~~~
4191
4192 -  Catalog Types Upload
4193
4194 Change Resource lifecycle State
4195 -------------------------------
4196
4197 ::
4198
4199     POST /v1/catalog/{componentCollection}/{componentId}/lifecycleState/{lifecycleOperation}
4200
4201 Parameters
4202 ~~~~~~~~~~
4203
4204 +----------+-------------+--------------------------------------+------------------+
4205 | Type     | Name        | Description                          | Schema           |
4206 +==========+=============+======================================+==================+
4207 | **Header | **USER\_ID* | id of user initiating the operation  | string           |
4208 | **       | *\ *optiona |                                      |                  |
4209 |          | l*          |                                      |                  |
4210 +----------+-------------+--------------------------------------+------------------+
4211 | **Path** | **component | validValues: resources / services /  | enum (resources, |
4212 |          | Collection* | products                             | services,        |
4213 |          | *\ *require |                                      | products)        |
4214 |          | d*          |                                      |                  |
4215 +----------+-------------+--------------------------------------+------------------+
4216 | **Path** | **component | id of component to be changed        | string           |
4217 |          | Id**\ *requ |                                      |                  |
4218 |          | ired*       |                                      |                  |
4219 +----------+-------------+--------------------------------------+------------------+
4220 | **Path** | **lifecycle |                                      | enum (checkout,  |
4221 |          | Operation** |                                      | undoCheckout,    |
4222 |          | \ *required |                                      | checkin,         |
4223 |          | *           |                                      | certificationReq |
4224 |          |             |                                      | uest,            |
4225 |          |             |                                      | startCertificati |
4226 |          |             |                                      | on,              |
4227 |          |             |                                      | failCertificatio |
4228 |          |             |                                      | n,               |
4229 |          |             |                                      | cancelCertificat |
4230 |          |             |                                      | ion,             |
4231 |          |             |                                      | certify)         |
4232 +----------+-------------+--------------------------------------+------------------+
4233 | **Body** | **body**\ * | LifecycleChangeInfo - relevant for   | string           |
4234 |          | optional*   | checkin, failCertification,          |                  |
4235 |          |             | cancelCertification                  |                  |
4236 +----------+-------------+--------------------------------------+------------------+
4237
4238 Responses
4239 ~~~~~~~~~
4240
4241 +---------+----------------------------------------------------+----------------+
4242 | HTTP    | Description                                        | Schema         |
4243 | Code    |                                                    |                |
4244 +=========+====================================================+================+
4245 | **200** | Resource state changed                             | No Content     |
4246 +---------+----------------------------------------------------+----------------+
4247 | **403** | Restricted operation                               | No Content     |
4248 +---------+----------------------------------------------------+----------------+
4249 | **409** | Resource already exist                             | No Content     |
4250 +---------+----------------------------------------------------+----------------+
4251
4252 Consumes
4253 ~~~~~~~~
4254
4255 -  ``application/json``
4256
4257 Produces
4258 ~~~~~~~~
4259
4260 -  ``application/json``
4261
4262 Tags
4263 ~~~~
4264
4265 -  Lifecycle Actions Servlet
4266
4267 Get Component Requirments And Capabilities
4268 ------------------------------------------
4269
4270 ::
4271
4272     GET /v1/catalog/{componentType}/latestversion/notabstract
4273
4274 Description
4275 ~~~~~~~~~~~
4276
4277 Returns Requirments And Capabilities according to componentId
4278
4279 Parameters
4280 ~~~~~~~~~~
4281
4282 +----------+-------------+--------------------------------------+------------------+
4283 | Type     | Name        | Description                          | Schema           |
4284 +==========+=============+======================================+==================+
4285 | **Header | **USER\_ID* |                                      | string           |
4286 | **       | *\ *optiona |                                      |                  |
4287 |          | l*          |                                      |                  |
4288 +----------+-------------+--------------------------------------+------------------+
4289 | **Path** | **component |                                      | string           |
4290 |          | Type**\ *re |                                      |                  |
4291 |          | quired*     |                                      |                  |
4292 +----------+-------------+--------------------------------------+------------------+
4293 | **Query* | **internalC |                                      | string           |
4294 | *        | omponentTyp |                                      |                  |
4295 |          | e**\ *optio |                                      |                  |
4296 |          | nal*        |                                      |                  |
4297 +----------+-------------+--------------------------------------+------------------+
4298 | **Body** | **body**\ * | Consumer Object to be created        | < string > array |
4299 |          | required*   |                                      |                  |
4300 +----------+-------------+--------------------------------------+------------------+
4301
4302 Responses
4303 ~~~~~~~~~
4304
4305 +---------+----------------------------------------------------+----------------+
4306 | HTTP    | Description                                        | Schema         |
4307 | Code    |                                                    |                |
4308 +=========+====================================================+================+
4309 | **200** | Component found                                    | No Content     |
4310 +---------+----------------------------------------------------+----------------+
4311 | **403** | Restricted operation                               | No Content     |
4312 +---------+----------------------------------------------------+----------------+
4313 | **404** | Component not found                                | No Content     |
4314 +---------+----------------------------------------------------+----------------+
4315
4316 Consumes
4317 ~~~~~~~~
4318
4319 -  ``application/json``
4320
4321 Produces
4322 ~~~~~~~~
4323
4324 -  ``application/json``
4325
4326 Tags
4327 ~~~~
4328
4329 -  Component Servlet
4330
4331 Get Component uid only
4332 ----------------------
4333
4334 ::
4335
4336     GET /v1/catalog/{componentType}/latestversion/notabstract/metadata
4337
4338 Description
4339 ~~~~~~~~~~~
4340
4341 Returns componentId
4342
4343 Parameters
4344 ~~~~~~~~~~
4345
4346 +----------+-------------+--------------------------------------+------------------+
4347 | Type     | Name        | Description                          | Schema           |
4348 +==========+=============+======================================+==================+
4349 | **Header | **USER\_ID* |                                      | string           |
4350 | **       | *\ *optiona |                                      |                  |
4351 |          | l*          |                                      |                  |
4352 +----------+-------------+--------------------------------------+------------------+
4353 | **Path** | **component |                                      | string           |
4354 |          | Type**\ *re |                                      |                  |
4355 |          | quired*     |                                      |                  |
4356 +----------+-------------+--------------------------------------+------------------+
4357 | **Query* | **internalC |                                      | string           |
4358 | *        | omponentTyp |                                      |                  |
4359 |          | e**\ *optio |                                      |                  |
4360 |          | nal*        |                                      |                  |
4361 +----------+-------------+--------------------------------------+------------------+
4362 | **Body** | **body**\ * | uid list                             | string           |
4363 |          | required*   |                                      |                  |
4364 +----------+-------------+--------------------------------------+------------------+
4365
4366 Responses
4367 ~~~~~~~~~
4368
4369 +---------+----------------------------------------------------+----------------+
4370 | HTTP    | Description                                        | Schema         |
4371 | Code    |                                                    |                |
4372 +=========+====================================================+================+
4373 | **200** | Component found                                    | No Content     |
4374 +---------+----------------------------------------------------+----------------+
4375 | **403** | Restricted operation                               | No Content     |
4376 +---------+----------------------------------------------------+----------------+
4377 | **404** | Component not found                                | No Content     |
4378 +---------+----------------------------------------------------+----------------+
4379
4380 Consumes
4381 ~~~~~~~~
4382
4383 -  ``application/json``
4384
4385 Produces
4386 ~~~~~~~~
4387
4388 -  ``application/json``
4389
4390 Tags
4391 ~~~~
4392
4393 -  Component Servlet
4394
4395 Get Component instances
4396 -----------------------
4397
4398 ::
4399
4400     GET /v1/catalog/{componentType}/{componentId}/componentInstances
4401
4402 Description
4403 ~~~~~~~~~~~
4404
4405 Returns component instances
4406
4407 Parameters
4408 ~~~~~~~~~~
4409
4410 +----------+-------------+--------------------------------------+------------------+
4411 | Type     | Name        | Description                          | Schema           |
4412 +==========+=============+======================================+==================+
4413 | **Header | **USER\_ID* |                                      | string           |
4414 | **       | *\ *optiona |                                      |                  |
4415 |          | l*          |                                      |                  |
4416 +----------+-------------+--------------------------------------+------------------+
4417 | **Path** | **component |                                      | string           |
4418 |          | Id**\ *requ |                                      |                  |
4419 |          | ired*       |                                      |                  |
4420 +----------+-------------+--------------------------------------+------------------+
4421 | **Path** | **component |                                      | string           |
4422 |          | Type**\ *re |                                      |                  |
4423 |          | quired*     |                                      |                  |
4424 +----------+-------------+--------------------------------------+------------------+
4425 | **Query* | **searchTex |                                      | string           |
4426 | *        | t**\ *optio |                                      |                  |
4427 |          | nal*        |                                      |                  |
4428 +----------+-------------+--------------------------------------+------------------+
4429 | **Body** | **body**\ * | uid list                             | string           |
4430 |          | required*   |                                      |                  |
4431 +----------+-------------+--------------------------------------+------------------+
4432
4433 Responses
4434 ~~~~~~~~~
4435
4436 +---------+----------------------------------------------------+----------------+
4437 | HTTP    | Description                                        | Schema         |
4438 | Code    |                                                    |                |
4439 +=========+====================================================+================+
4440 | **200** | Component found                                    | No Content     |
4441 +---------+----------------------------------------------------+----------------+
4442 | **403** | Restricted operation                               | No Content     |
4443 +---------+----------------------------------------------------+----------------+
4444 | **404** | Component not found                                | No Content     |
4445 +---------+----------------------------------------------------+----------------+
4446
4447 Consumes
4448 ~~~~~~~~
4449
4450 -  ``application/json``
4451
4452 Produces
4453 ~~~~~~~~
4454
4455 -  ``application/json``
4456
4457 Tags
4458 ~~~~
4459
4460 -  Component Servlet
4461
4462 Get properties
4463 --------------
4464
4465 ::
4466
4467     GET /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{inputId}/properties
4468
4469 Description
4470 ~~~~~~~~~~~
4471
4472 Returns properties list
4473
4474 Parameters
4475 ~~~~~~~~~~
4476
4477 +------------------+--------------------------+----------------------------------+
4478 | Type             | Name                     | Schema                           |
4479 +==================+==========================+==================================+
4480 | **Header**       | **USER\_ID**\ *optional* | string                           |
4481 +------------------+--------------------------+----------------------------------+
4482 | **Path**         | **componentId**\ *requir | string                           |
4483 |                  | ed*                      |                                  |
4484 +------------------+--------------------------+----------------------------------+
4485 | **Path**         | **componentType**\ *requ | string                           |
4486 |                  | ired*                    |                                  |
4487 +------------------+--------------------------+----------------------------------+
4488 | **Path**         | **inputId**\ *required*  | string                           |
4489 +------------------+--------------------------+----------------------------------+
4490 | **Path**         | **instanceId**\ *require | string                           |
4491 |                  | d*                       |                                  |
4492 +------------------+--------------------------+----------------------------------+
4493
4494 Responses
4495 ~~~~~~~~~
4496
4497 +---------+----------------------------------------------------+----------------+
4498 | HTTP    | Description                                        | Schema         |
4499 | Code    |                                                    |                |
4500 +=========+====================================================+================+
4501 | **200** | Component found                                    | No Content     |
4502 +---------+----------------------------------------------------+----------------+
4503 | **403** | Restricted operation                               | No Content     |
4504 +---------+----------------------------------------------------+----------------+
4505 | **404** | Component not found                                | No Content     |
4506 +---------+----------------------------------------------------+----------------+
4507
4508 Consumes
4509 ~~~~~~~~
4510
4511 -  ``application/json``
4512
4513 Produces
4514 ~~~~~~~~
4515
4516 -  ``application/json``
4517
4518 Tags
4519 ~~~~
4520
4521 -  Input Catalog
4522
4523 Get Inputs only
4524 ---------------
4525
4526 ::
4527
4528     GET /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/inputs
4529
4530 Description
4531 ~~~~~~~~~~~
4532
4533 Returns Inputs list
4534
4535 Parameters
4536 ~~~~~~~~~~
4537
4538 +------------------+--------------------------+----------------------------------+
4539 | Type             | Name                     | Schema                           |
4540 +==================+==========================+==================================+
4541 | **Header**       | **USER\_ID**\ *optional* | string                           |
4542 +------------------+--------------------------+----------------------------------+
4543 | **Path**         | **componentId**\ *requir | string                           |
4544 |                  | ed*                      |                                  |
4545 +------------------+--------------------------+----------------------------------+
4546 | **Path**         | **componentType**\ *requ | string                           |
4547 |                  | ired*                    |                                  |
4548 +------------------+--------------------------+----------------------------------+
4549 | **Path**         | **instanceId**\ *require | string                           |
4550 |                  | d*                       |                                  |
4551 +------------------+--------------------------+----------------------------------+
4552 | **Path**         | **originComponentUid**\  | string                           |
4553 |                  | *required*               |                                  |
4554 +------------------+--------------------------+----------------------------------+
4555
4556 Responses
4557 ~~~~~~~~~
4558
4559 +---------+----------------------------------------------------+----------------+
4560 | HTTP    | Description                                        | Schema         |
4561 | Code    |                                                    |                |
4562 +=========+====================================================+================+
4563 | **200** | Component found                                    | No Content     |
4564 +---------+----------------------------------------------------+----------------+
4565 | **403** | Restricted operation                               | No Content     |
4566 +---------+----------------------------------------------------+----------------+
4567 | **404** | Component not found                                | No Content     |
4568 +---------+----------------------------------------------------+----------------+
4569
4570 Consumes
4571 ~~~~~~~~
4572
4573 -  ``application/json``
4574
4575 Produces
4576 ~~~~~~~~
4577
4578 -  ``application/json``
4579
4580 Tags
4581 ~~~~
4582
4583 -  Input Catalog
4584
4585 Create inputs on service
4586 ------------------------
4587
4588 ::
4589
4590     POST /v1/catalog/{componentType}/{componentId}/create/inputs
4591
4592 Description
4593 ~~~~~~~~~~~
4594
4595 Return inputs list
4596
4597 Parameters
4598 ~~~~~~~~~~
4599
4600 +----------+-------------+--------------------------------------+------------------+
4601 | Type     | Name        | Description                          | Schema           |
4602 +==========+=============+======================================+==================+
4603 | **Header | **USER\_ID* |                                      | string           |
4604 | **       | *\ *optiona |                                      |                  |
4605 |          | l*          |                                      |                  |
4606 +----------+-------------+--------------------------------------+------------------+
4607 | **Path** | **component |                                      | string           |
4608 |          | Id**\ *requ |                                      |                  |
4609 |          | ired*       |                                      |                  |
4610 +----------+-------------+--------------------------------------+------------------+
4611 | **Path** | **component |                                      | string           |
4612 |          | Type**\ *re |                                      |                  |
4613 |          | quired*     |                                      |                  |
4614 +----------+-------------+--------------------------------------+------------------+
4615 | **Body** | **body**\ * | ComponentIns Inputs Object to be     | string           |
4616 |          | required*   | created                              |                  |
4617 +----------+-------------+--------------------------------------+------------------+
4618
4619 Responses
4620 ~~~~~~~~~
4621
4622 +---------+----------------------------------------------------+----------------+
4623 | HTTP    | Description                                        | Schema         |
4624 | Code    |                                                    |                |
4625 +=========+====================================================+================+
4626 | **200** | Component found                                    | No Content     |
4627 +---------+----------------------------------------------------+----------------+
4628 | **403** | Restricted operation                               | No Content     |
4629 +---------+----------------------------------------------------+----------------+
4630 | **404** | Component not found                                | No Content     |
4631 +---------+----------------------------------------------------+----------------+
4632
4633 Consumes
4634 ~~~~~~~~
4635
4636 -  ``application/json``
4637
4638 Produces
4639 ~~~~~~~~
4640
4641 -  ``application/json``
4642
4643 Tags
4644 ~~~~
4645
4646 -  Input Catalog
4647
4648 Delete input from service
4649 -------------------------
4650
4651 ::
4652
4653     DELETE /v1/catalog/{componentType}/{componentId}/delete/{inputId}/input
4654
4655 Description
4656 ~~~~~~~~~~~
4657
4658 Delete service input
4659
4660 Parameters
4661 ~~~~~~~~~~
4662
4663 +----------+-------------+--------------------------------------+------------------+
4664 | Type     | Name        | Description                          | Schema           |
4665 +==========+=============+======================================+==================+
4666 | **Header | **USER\_ID* |                                      | string           |
4667 | **       | *\ *optiona |                                      |                  |
4668 |          | l*          |                                      |                  |
4669 +----------+-------------+--------------------------------------+------------------+
4670 | **Path** | **component |                                      | string           |
4671 |          | Id**\ *requ |                                      |                  |
4672 |          | ired*       |                                      |                  |
4673 +----------+-------------+--------------------------------------+------------------+
4674 | **Path** | **component |                                      | string           |
4675 |          | Type**\ *re |                                      |                  |
4676 |          | quired*     |                                      |                  |
4677 +----------+-------------+--------------------------------------+------------------+
4678 | **Path** | **inputId** |                                      | string           |
4679 |          | \ *required |                                      |                  |
4680 |          | *           |                                      |                  |
4681 +----------+-------------+--------------------------------------+------------------+
4682 | **Body** | **body**\ * | Service Input to be deleted          | string           |
4683 |          | required*   |                                      |                  |
4684 +----------+-------------+--------------------------------------+------------------+
4685
4686 Responses
4687 ~~~~~~~~~
4688
4689 +---------+----------------------------------------------------+----------------+
4690 | HTTP    | Description                                        | Schema         |
4691 | Code    |                                                    |                |
4692 +=========+====================================================+================+
4693 | **200** | Input deleted                                      | No Content     |
4694 +---------+----------------------------------------------------+----------------+
4695 | **403** | Restricted operation                               | No Content     |
4696 +---------+----------------------------------------------------+----------------+
4697 | **404** | Input not found                                    | No Content     |
4698 +---------+----------------------------------------------------+----------------+
4699
4700 Consumes
4701 ~~~~~~~~
4702
4703 -  ``application/json``
4704
4705 Produces
4706 ~~~~~~~~
4707
4708 -  ``application/json``
4709
4710 Tags
4711 ~~~~
4712
4713 -  Input Catalog
4714
4715 Retrieve Resource
4716 -----------------
4717
4718 ::
4719
4720     GET /v1/catalog/{componentType}/{componentId}/filteredDataByParams
4721
4722 Description
4723 ~~~~~~~~~~~
4724
4725 Returns resource according to resourceId
4726
4727 Parameters
4728 ~~~~~~~~~~
4729
4730 +------------------+--------------------------+----------------------------------+
4731 | Type             | Name                     | Schema                           |
4732 +==================+==========================+==================================+
4733 | **Header**       | **USER\_ID**\ *optional* | string                           |
4734 +------------------+--------------------------+----------------------------------+
4735 | **Path**         | **componentId**\ *requir | string                           |
4736 |                  | ed*                      |                                  |
4737 +------------------+--------------------------+----------------------------------+
4738 | **Path**         | **componentType**\ *requ | string                           |
4739 |                  | ired*                    |                                  |
4740 +------------------+--------------------------+----------------------------------+
4741 | **Query**        | **include**\ *optional*  | < string > array(multi)          |
4742 +------------------+--------------------------+----------------------------------+
4743
4744 Responses
4745 ~~~~~~~~~
4746
4747 +---------+----------------------------------------------------+----------------+
4748 | HTTP    | Description                                        | Schema         |
4749 | Code    |                                                    |                |
4750 +=========+====================================================+================+
4751 | **200** | Resource found                                     | No Content     |
4752 +---------+----------------------------------------------------+----------------+
4753 | **403** | Restricted operation                               | No Content     |
4754 +---------+----------------------------------------------------+----------------+
4755 | **404** | Resource not found                                 | No Content     |
4756 +---------+----------------------------------------------------+----------------+
4757
4758 Consumes
4759 ~~~~~~~~
4760
4761 -  ``application/json``
4762
4763 Produces
4764 ~~~~~~~~
4765
4766 -  ``application/json``
4767
4768 Tags
4769 ~~~~
4770
4771 -  Component Servlet
4772
4773 Retrieve properties belonging to component instances of specific component by name and optionally resource type
4774 ---------------------------------------------------------------------------------------------------------------
4775
4776 ::
4777
4778     GET /v1/catalog/{componentType}/{componentId}/filteredproperties/{propertyNameFragment}
4779
4780 Description
4781 ~~~~~~~~~~~
4782
4783 Returns properties belonging to component instances of specific
4784 component by name and optionally resource type
4785
4786 Parameters
4787 ~~~~~~~~~~
4788
4789 +------------------+--------------------------+----------------------------------+
4790 | Type             | Name                     | Schema                           |
4791 +==================+==========================+==================================+
4792 | **Header**       | **USER\_ID**\ *optional* | string                           |
4793 +------------------+--------------------------+----------------------------------+
4794 | **Path**         | **componentId**\ *requir | string                           |
4795 |                  | ed*                      |                                  |
4796 +------------------+--------------------------+----------------------------------+
4797 | **Path**         | **componentType**\ *requ | string                           |
4798 |                  | ired*                    |                                  |
4799 +------------------+--------------------------+----------------------------------+
4800 | **Path**         | **propertyNameFragment** | string                           |
4801 |                  | \ *required*             |                                  |
4802 +------------------+--------------------------+----------------------------------+
4803 | **Query**        | **resourceType**\ *optio | < string > array(multi)          |
4804 |                  | nal*                     |                                  |
4805 +------------------+--------------------------+----------------------------------+
4806
4807 Responses
4808 ~~~~~~~~~
4809
4810 +---------+----------------------------------------------------+----------------+
4811 | HTTP    | Description                                        | Schema         |
4812 | Code    |                                                    |                |
4813 +=========+====================================================+================+
4814 | **200** | Component found                                    | No Content     |
4815 +---------+----------------------------------------------------+----------------+
4816 | **403** | Restricted operation                               | No Content     |
4817 +---------+----------------------------------------------------+----------------+
4818 | **404** | Component not found                                | No Content     |
4819 +---------+----------------------------------------------------+----------------+
4820
4821 Consumes
4822 ~~~~~~~~
4823
4824 -  ``application/json``
4825
4826 Produces
4827 ~~~~~~~~
4828
4829 -  ``application/json``
4830
4831 Tags
4832 ~~~~
4833
4834 -  Component Servlet
4835
4836 Get inputs
4837 ----------
4838
4839 ::
4840
4841     GET /v1/catalog/{componentType}/{componentId}/inputs/{inputId}
4842
4843 Description
4844 ~~~~~~~~~~~
4845
4846 Returns inputs list
4847
4848 Parameters
4849 ~~~~~~~~~~
4850
4851 +------------------+--------------------------+----------------------------------+
4852 | Type             | Name                     | Schema                           |
4853 +==================+==========================+==================================+
4854 | **Header**       | **USER\_ID**\ *optional* | string                           |
4855 +------------------+--------------------------+----------------------------------+
4856 | **Path**         | **componentId**\ *requir | string                           |
4857 |                  | ed*                      |                                  |
4858 +------------------+--------------------------+----------------------------------+
4859 | **Path**         | **componentType**\ *requ | string                           |
4860 |                  | ired*                    |                                  |
4861 +------------------+--------------------------+----------------------------------+
4862 | **Path**         | **inputId**\ *required*  | string                           |
4863 +------------------+--------------------------+----------------------------------+
4864
4865 Responses
4866 ~~~~~~~~~
4867
4868 +---------+----------------------------------------------------+----------------+
4869 | HTTP    | Description                                        | Schema         |
4870 | Code    |                                                    |                |
4871 +=========+====================================================+================+
4872 | **200** | Component found                                    | No Content     |
4873 +---------+----------------------------------------------------+----------------+
4874 | **403** | Restricted operation                               | No Content     |
4875 +---------+----------------------------------------------------+----------------+
4876 | **404** | Component not found                                | No Content     |
4877 +---------+----------------------------------------------------+----------------+
4878
4879 Consumes
4880 ~~~~~~~~
4881
4882 -  ``application/json``
4883
4884 Produces
4885 ~~~~~~~~
4886
4887 -  ``application/json``
4888
4889 Tags
4890 ~~~~
4891
4892 -  Input Catalog
4893
4894 Get inputs
4895 ----------
4896
4897 ::
4898
4899     GET /v1/catalog/{componentType}/{componentId}/inputs/{inputId}/inputs
4900
4901 Description
4902 ~~~~~~~~~~~
4903
4904 Returns inputs list
4905
4906 Parameters
4907 ~~~~~~~~~~
4908
4909 +------------------+--------------------------+----------------------------------+
4910 | Type             | Name                     | Schema                           |
4911 +==================+==========================+==================================+
4912 | **Header**       | **USER\_ID**\ *optional* | string                           |
4913 +------------------+--------------------------+----------------------------------+
4914 | **Path**         | **componentId**\ *requir | string                           |
4915 |                  | ed*                      |                                  |
4916 +------------------+--------------------------+----------------------------------+
4917 | **Path**         | **componentType**\ *requ | string                           |
4918 |                  | ired*                    |                                  |
4919 +------------------+--------------------------+----------------------------------+
4920 | **Path**         | **inputId**\ *required*  | string                           |
4921 +------------------+--------------------------+----------------------------------+
4922
4923 Responses
4924 ~~~~~~~~~
4925
4926 +---------+----------------------------------------------------+----------------+
4927 | HTTP    | Description                                        | Schema         |
4928 | Code    |                                                    |                |
4929 +=========+====================================================+================+
4930 | **200** | Component found                                    | No Content     |
4931 +---------+----------------------------------------------------+----------------+
4932 | **403** | Restricted operation                               | No Content     |
4933 +---------+----------------------------------------------------+----------------+
4934 | **404** | Component not found                                | No Content     |
4935 +---------+----------------------------------------------------+----------------+
4936
4937 Consumes
4938 ~~~~~~~~
4939
4940 -  ``application/json``
4941
4942 Produces
4943 ~~~~~~~~
4944
4945 -  ``application/json``
4946
4947 Tags
4948 ~~~~
4949
4950 -  Input Catalog
4951
4952 Get Component Requirments And Capabilities
4953 ------------------------------------------
4954
4955 ::
4956
4957     GET /v1/catalog/{componentType}/{componentId}/requirmentsCapabilities
4958
4959 Description
4960 ~~~~~~~~~~~
4961
4962 Returns Requirements And Capabilities according to componentId
4963
4964 Parameters
4965 ~~~~~~~~~~
4966
4967 +------------------+--------------------------+----------------------------------+
4968 | Type             | Name                     | Schema                           |
4969 +==================+==========================+==================================+
4970 | **Header**       | **USER\_ID**\ *optional* | string                           |
4971 +------------------+--------------------------+----------------------------------+
4972 | **Path**         | **componentId**\ *requir | string                           |
4973 |                  | ed*                      |                                  |
4974 +------------------+--------------------------+----------------------------------+
4975 | **Path**         | **componentType**\ *requ | string                           |
4976 |                  | ired*                    |                                  |
4977 +------------------+--------------------------+----------------------------------+
4978
4979 Responses
4980 ~~~~~~~~~
4981
4982 +---------+----------------------------------------------------+----------------+
4983 | HTTP    | Description                                        | Schema         |
4984 | Code    |                                                    |                |
4985 +=========+====================================================+================+
4986 | **200** | Component found                                    | No Content     |
4987 +---------+----------------------------------------------------+----------------+
4988 | **403** | Restricted operation                               | No Content     |
4989 +---------+----------------------------------------------------+----------------+
4990 | **404** | Component not found                                | No Content     |
4991 +---------+----------------------------------------------------+----------------+
4992
4993 Consumes
4994 ~~~~~~~~
4995
4996 -  ``application/json``
4997
4998 Produces
4999 ~~~~~~~~
5000
5001 -  ``application/json``
5002
5003 Tags
5004 ~~~~
5005
5006 -  Component Servlet
5007
5008 Validate Component Conformance Level
5009 ------------------------------------
5010
5011 ::
5012
5013     GET /v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation
5014
5015 Description
5016 ~~~~~~~~~~~
5017
5018 Returns the result according to conformance level in BE config
5019
5020 Parameters
5021 ~~~~~~~~~~
5022
5023 +------------------+--------------------------+----------------------------------+
5024 | Type             | Name                     | Schema                           |
5025 +==================+==========================+==================================+
5026 | **Header**       | **USER\_ID**\ *optional* | string                           |
5027 +------------------+--------------------------+----------------------------------+
5028 | **Path**         | **componentType**\ *requ | string                           |
5029 |                  | ired*                    |                                  |
5030 +------------------+--------------------------+----------------------------------+
5031 | **Path**         | **componentUuid**\ *requ | string                           |
5032 |                  | ired*                    |                                  |
5033 +------------------+--------------------------+----------------------------------+
5034
5035 Responses
5036 ~~~~~~~~~
5037
5038 +---------+----------------------------------------------------+----------------+
5039 | HTTP    | Description                                        | Schema         |
5040 | Code    |                                                    |                |
5041 +=========+====================================================+================+
5042 | **200** | Component found                                    | No Content     |
5043 +---------+----------------------------------------------------+----------------+
5044 | **403** | Restricted operation                               | No Content     |
5045 +---------+----------------------------------------------------+----------------+
5046 | **404** | Component not found                                | No Content     |
5047 +---------+----------------------------------------------------+----------------+
5048
5049 Consumes
5050 ~~~~~~~~
5051
5052 -  ``application/json``
5053
5054 Produces
5055 ~~~~~~~~
5056
5057 -  ``application/json``
5058
5059 Tags
5060 ~~~~
5061
5062 -  Component Servlet
5063
5064 Get component Artifacts
5065 -----------------------
5066
5067 ::
5068
5069     GET /v1/catalog/{containerComponentType}/{componentId}/artifactsByType/{artifactGroupType}
5070
5071 Description
5072 ~~~~~~~~~~~
5073
5074 Returns artifacts
5075
5076 Parameters
5077 ~~~~~~~~~~
5078
5079 +----------+-------------+--------------------------------------+------------------+
5080 | Type     | Name        | Description                          | Schema           |
5081 +==========+=============+======================================+==================+
5082 | **Path** | **artifactG |                                      | string           |
5083 |          | roupType**\ |                                      |                  |
5084 |          |  *required* |                                      |                  |
5085 +----------+-------------+--------------------------------------+------------------+
5086 | **Path** | **component |                                      | string           |
5087 |          | Id**\ *requ |                                      |                  |
5088 |          | ired*       |                                      |                  |
5089 +----------+-------------+--------------------------------------+------------------+
5090 | **Path** | **container | valid values: resources / services   | enum (resources, |
5091 |          | ComponentTy |                                      | services)        |
5092 |          | pe**\ *requ |                                      |                  |
5093 |          | ired*       |                                      |                  |
5094 +----------+-------------+--------------------------------------+------------------+
5095
5096 Responses
5097 ~~~~~~~~~
5098
5099 +---------+----------------------------------------------------+----------------+
5100 | HTTP    | Description                                        | Schema         |
5101 | Code    |                                                    |                |
5102 +=========+====================================================+================+
5103 | **200** | Component artifacts                                | No Content     |
5104 +---------+----------------------------------------------------+----------------+
5105 | **404** | Resource/Artifact not found                        | No Content     |
5106 +---------+----------------------------------------------------+----------------+
5107
5108 Consumes
5109 ~~~~~~~~
5110
5111 -  ``application/json``
5112
5113 Produces
5114 ~~~~~~~~
5115
5116 -  ``application/json``
5117
5118 Tags
5119 ~~~~
5120
5121 -  Resource Artifact Servlet
5122
5123 Get group artifacts
5124 -------------------
5125
5126 ::
5127
5128     GET /v1/catalog/{containerComponentType}/{componentId}/groups/{groupId}
5129
5130 Description
5131 ~~~~~~~~~~~
5132
5133 Returns artifacts metadata according to groupId
5134
5135 Parameters
5136 ~~~~~~~~~~
5137
5138 +------------------+--------------------------+----------------------------------+
5139 | Type             | Name                     | Schema                           |
5140 +==================+==========================+==================================+
5141 | **Header**       | **USER\_ID**\ *optional* | string                           |
5142 +------------------+--------------------------+----------------------------------+
5143 | **Path**         | **componentId**\ *requir | string                           |
5144 |                  | ed*                      |                                  |
5145 +------------------+--------------------------+----------------------------------+
5146 | **Path**         | **containerComponentType | string                           |
5147 |                  | **\ *required*           |                                  |
5148 +------------------+--------------------------+----------------------------------+
5149 | **Path**         | **groupId**\ *required*  | string                           |
5150 +------------------+--------------------------+----------------------------------+
5151
5152 Responses
5153 ~~~~~~~~~
5154
5155 +---------+----------------------------------------------------+----------------+
5156 | HTTP    | Description                                        | Schema         |
5157 | Code    |                                                    |                |
5158 +=========+====================================================+================+
5159 | **200** | group found                                        | No Content     |
5160 +---------+----------------------------------------------------+----------------+
5161 | **403** | Restricted operation                               | No Content     |
5162 +---------+----------------------------------------------------+----------------+
5163 | **404** | Group not found                                    | No Content     |
5164 +---------+----------------------------------------------------+----------------+
5165
5166 Consumes
5167 ~~~~~~~~
5168
5169 -  ``application/json``
5170
5171 Produces
5172 ~~~~~~~~
5173
5174 -  ``application/json``
5175
5176 Tags
5177 ~~~~
5178
5179 -  Resource Group Servlet
5180
5181 Update Group Metadata
5182 ---------------------
5183
5184 ::
5185
5186     PUT /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/metadata
5187
5188 Description
5189 ~~~~~~~~~~~
5190
5191 Returns updated group definition
5192
5193 Parameters
5194 ~~~~~~~~~~
5195
5196 +----------+-------------+--------------------------------------+------------------+
5197 | Type     | Name        | Description                          | Schema           |
5198 +==========+=============+======================================+==================+
5199 | **Header | **USER\_ID* |                                      | string           |
5200 | **       | *\ *optiona |                                      |                  |
5201 |          | l*          |                                      |                  |
5202 +----------+-------------+--------------------------------------+------------------+
5203 | **Path** | **component |                                      | string           |
5204 |          | Id**\ *requ |                                      |                  |
5205 |          | ired*       |                                      |                  |
5206 +----------+-------------+--------------------------------------+------------------+
5207 | **Path** | **container |                                      | string           |
5208 |          | ComponentTy |                                      |                  |
5209 |          | pe**\ *requ |                                      |                  |
5210 |          | ired*       |                                      |                  |
5211 +----------+-------------+--------------------------------------+------------------+
5212 | **Path** | **groupUniq |                                      | string           |
5213 |          | ueId**\ *re |                                      |                  |
5214 |          | quired*     |                                      |                  |
5215 +----------+-------------+--------------------------------------+------------------+
5216 | **Body** | **body**\ * | Service object to be Updated         | string           |
5217 |          | required*   |                                      |                  |
5218 +----------+-------------+--------------------------------------+------------------+
5219
5220 Responses
5221 ~~~~~~~~~
5222
5223 +---------+----------------------------------------------------+----------------+
5224 | HTTP    | Description                                        | Schema         |
5225 | Code    |                                                    |                |
5226 +=========+====================================================+================+
5227 | **200** | Group Updated                                      | No Content     |
5228 +---------+----------------------------------------------------+----------------+
5229 | **400** | Invalid content / Missing content                  | No Content     |
5230 +---------+----------------------------------------------------+----------------+
5231 | **403** | Restricted operation                               | No Content     |
5232 +---------+----------------------------------------------------+----------------+
5233
5234 Consumes
5235 ~~~~~~~~
5236
5237 -  ``application/json``
5238
5239 Produces
5240 ~~~~~~~~
5241
5242 -  ``application/json``
5243
5244 Tags
5245 ~~~~
5246
5247 -  Resource Group Servlet
5248
5249 Updates List of properties on a group (only values)
5250 ---------------------------------------------------
5251
5252 ::
5253
5254     PUT /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties
5255
5256 Description
5257 ~~~~~~~~~~~
5258
5259 Returns updated list of properties
5260
5261 Parameters
5262 ~~~~~~~~~~
5263
5264 +----------+-------------+--------------------------------------+------------------+
5265 | Type     | Name        | Description                          | Schema           |
5266 +==========+=============+======================================+==================+
5267 | **Header | **USER\_ID* |                                      | string           |
5268 | **       | *\ *optiona |                                      |                  |
5269 |          | l*          |                                      |                  |
5270 +----------+-------------+--------------------------------------+------------------+
5271 | **Path** | **component |                                      | string           |
5272 |          | Id**\ *requ |                                      |                  |
5273 |          | ired*       |                                      |                  |
5274 +----------+-------------+--------------------------------------+------------------+
5275 | **Path** | **container |                                      | string           |
5276 |          | ComponentTy |                                      |                  |
5277 |          | pe**\ *requ |                                      |                  |
5278 |          | ired*       |                                      |                  |
5279 +----------+-------------+--------------------------------------+------------------+
5280 | **Path** | **groupUniq |                                      | string           |
5281 |          | ueId**\ *re |                                      |                  |
5282 |          | quired*     |                                      |                  |
5283 +----------+-------------+--------------------------------------+------------------+
5284 | **Body** | **body**\ * | Service object to be Updated         | string           |
5285 |          | required*   |                                      |                  |
5286 +----------+-------------+--------------------------------------+------------------+
5287
5288 Responses
5289 ~~~~~~~~~
5290
5291 +---------+----------------------------------------------------+----------------+
5292 | HTTP    | Description                                        | Schema         |
5293 | Code    |                                                    |                |
5294 +=========+====================================================+================+
5295 | **200** | Group Updated                                      | No Content     |
5296 +---------+----------------------------------------------------+----------------+
5297 | **400** | Invalid content / Missing content                  | No Content     |
5298 +---------+----------------------------------------------------+----------------+
5299 | **403** | Restricted operation                               | No Content     |
5300 +---------+----------------------------------------------------+----------------+
5301
5302 Consumes
5303 ~~~~~~~~
5304
5305 -  ``application/json``
5306
5307 Produces
5308 ~~~~~~~~
5309
5310 -  ``application/json``
5311
5312 Tags
5313 ~~~~
5314
5315 -  Resource Group Servlet
5316
5317 Create ComponentInstance
5318 ------------------------
5319
5320 ::
5321
5322     POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance
5323
5324 Description
5325 ~~~~~~~~~~~
5326
5327 Returns created ComponentInstance
5328
5329 Parameters
5330 ~~~~~~~~~~
5331
5332 +----------+-------------+--------------------------------------+------------------+
5333 | Type     | Name        | Description                          | Schema           |
5334 +==========+=============+======================================+==================+
5335 | **Header | **USER\_ID* | USER\_ID of modifier user            | string           |
5336 | **       | *\ *require |                                      |                  |
5337 |          | d*          |                                      |                  |
5338 +----------+-------------+--------------------------------------+------------------+
5339 | **Path** | **component |                                      | string           |
5340 |          | Id**\ *requ |                                      |                  |
5341 |          | ired*       |                                      |                  |
5342 +----------+-------------+--------------------------------------+------------------+
5343 | **Path** | **container | valid values: resources / services   | enum (resources, |
5344 |          | ComponentTy |                                      | services)        |
5345 |          | pe**\ *requ |                                      |                  |
5346 |          | ired*       |                                      |                  |
5347 +----------+-------------+--------------------------------------+------------------+
5348 | **Body** | **body**\ * | RI object to be created              | string           |
5349 |          | required*   |                                      |                  |
5350 +----------+-------------+--------------------------------------+------------------+
5351
5352 Responses
5353 ~~~~~~~~~
5354
5355 +---------+----------------------------------------------------+----------------+
5356 | HTTP    | Description                                        | Schema         |
5357 | Code    |                                                    |                |
5358 +=========+====================================================+================+
5359 | **201** | Component created                                  | No Content     |
5360 +---------+----------------------------------------------------+----------------+
5361 | **400** | Invalid content / Missing content                  | No Content     |
5362 +---------+----------------------------------------------------+----------------+
5363 | **403** | Restricted operation                               | No Content     |
5364 +---------+----------------------------------------------------+----------------+
5365 | **409** | Component instance already exist                   | No Content     |
5366 +---------+----------------------------------------------------+----------------+
5367
5368 Consumes
5369 ~~~~~~~~
5370
5371 -  ``application/json``
5372
5373 Produces
5374 ~~~~~~~~
5375
5376 -  ``application/json``
5377
5378 Tags
5379 ~~~~
5380
5381 -  Resource Instance Servlet
5382
5383 Associate RI to RI
5384 ------------------
5385
5386 ::
5387
5388     POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate
5389
5390 Description
5391 ~~~~~~~~~~~
5392
5393 Returns created RelationshipInfo
5394
5395 Parameters
5396 ~~~~~~~~~~
5397
5398 +----------+-------------+--------------------------------------+------------------+
5399 | Type     | Name        | Description                          | Schema           |
5400 +==========+=============+======================================+==================+
5401 | **Header | **USER\_ID* |                                      | string           |
5402 | **       | *\ *optiona |                                      |                  |
5403 |          | l*          |                                      |                  |
5404 +----------+-------------+--------------------------------------+------------------+
5405 | **Path** | **component | unique id of the container component | string           |
5406 |          | Id**\ *requ |                                      |                  |
5407 |          | ired*       |                                      |                  |
5408 +----------+-------------+--------------------------------------+------------------+
5409 | **Path** | **container | allowed values are resources         | enum (resources, |
5410 |          | ComponentTy | /services / products                 | services,        |
5411 |          | pe**\ *requ |                                      | products)        |
5412 |          | ired*       |                                      |                  |
5413 +----------+-------------+--------------------------------------+------------------+
5414 | **Body** | **body**\ * | RelationshipInfo                     | string           |
5415 |          | required*   |                                      |                  |
5416 +----------+-------------+--------------------------------------+------------------+
5417
5418 Responses
5419 ~~~~~~~~~
5420
5421 +---------+----------------------------------------------------+----------------+
5422 | HTTP    | Description                                        | Schema         |
5423 | Code    |                                                    |                |
5424 +=========+====================================================+================+
5425 | **201** | Relationship created                               | No Content     |
5426 +---------+----------------------------------------------------+----------------+
5427 | **400** | Invalid content / Missing content                  | No Content     |
5428 +---------+----------------------------------------------------+----------------+
5429 | **403** | Missing information                                | No Content     |
5430 +---------+----------------------------------------------------+----------------+
5431 | **409** | Relationship already exist                         | No Content     |
5432 +---------+----------------------------------------------------+----------------+
5433
5434 Consumes
5435 ~~~~~~~~
5436
5437 -  ``application/json``
5438
5439 Produces
5440 ~~~~~~~~
5441
5442 -  ``application/json``
5443
5444 Tags
5445 ~~~~
5446
5447 -  Resource Instance Servlet
5448
5449 Create RI and associate RI to RI
5450 --------------------------------
5451
5452 ::
5453
5454     POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate
5455
5456 Description
5457 ~~~~~~~~~~~
5458
5459 Returns created RI and RelationshipInfo
5460
5461 Parameters
5462 ~~~~~~~~~~
5463
5464 +----------+-------------+--------------------------------------+------------------+
5465 | Type     | Name        | Description                          | Schema           |
5466 +==========+=============+======================================+==================+
5467 | **Path** | **component |                                      | string           |
5468 |          | Id**\ *requ |                                      |                  |
5469 |          | ired*       |                                      |                  |
5470 +----------+-------------+--------------------------------------+------------------+
5471 | **Path** | **container | valid values: resources / services   | enum (resources, |
5472 |          | ComponentTy |                                      | services)        |
5473 |          | pe**\ *requ |                                      |                  |
5474 |          | ired*       |                                      |                  |
5475 +----------+-------------+--------------------------------------+------------------+
5476
5477 Responses
5478 ~~~~~~~~~
5479
5480 +---------+----------------------------------------------------+----------------+
5481 | HTTP    | Description                                        | Schema         |
5482 | Code    |                                                    |                |
5483 +=========+====================================================+================+
5484 | **201** | RI created                                         | No Content     |
5485 +---------+----------------------------------------------------+----------------+
5486 | **400** | Invalid content / Missing content                  | No Content     |
5487 +---------+----------------------------------------------------+----------------+
5488 | **403** | Restricted operation                               | No Content     |
5489 +---------+----------------------------------------------------+----------------+
5490 | **409** | Relationship already exist                         | No Content     |
5491 +---------+----------------------------------------------------+----------------+
5492
5493 Consumes
5494 ~~~~~~~~
5495
5496 -  ``application/json``
5497
5498 Produces
5499 ~~~~~~~~
5500
5501 -  ``application/json``
5502
5503 Tags
5504 ~~~~
5505
5506 -  Resource Instance Servlet
5507
5508 Dissociate RI from RI
5509 ---------------------
5510
5511 ::
5512
5513     PUT /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/dissociate
5514
5515 Description
5516 ~~~~~~~~~~~
5517
5518 Returns deleted RelationshipInfo
5519
5520 Parameters
5521 ~~~~~~~~~~
5522
5523 +----------+-------------+--------------------------------------+------------------+
5524 | Type     | Name        | Description                          | Schema           |
5525 +==========+=============+======================================+==================+
5526 | **Header | **USER\_ID* |                                      | string           |
5527 | **       | *\ *optiona |                                      |                  |
5528 |          | l*          |                                      |                  |
5529 +----------+-------------+--------------------------------------+------------------+
5530 | **Path** | **component | unique id of the container component | string           |
5531 |          | Id**\ *requ |                                      |                  |
5532 |          | ired*       |                                      |                  |
5533 +----------+-------------+--------------------------------------+------------------+
5534 | **Path** | **container | allowed values are resources         | enum (resources, |
5535 |          | ComponentTy | /services / products                 | services,        |
5536 |          | pe**\ *requ |                                      | products)        |
5537 |          | ired*       |                                      |                  |
5538 +----------+-------------+--------------------------------------+------------------+
5539 | **Body** | **body**\ * | RelationshipInfo                     | string           |
5540 |          | required*   |                                      |                  |
5541 +----------+-------------+--------------------------------------+------------------+
5542
5543 Responses
5544 ~~~~~~~~~
5545
5546 +---------+----------------------------------------------------+----------------+
5547 | HTTP    | Description                                        | Schema         |
5548 | Code    |                                                    |                |
5549 +=========+====================================================+================+
5550 | **201** | Relationship deleted                               | No Content     |
5551 +---------+----------------------------------------------------+----------------+
5552 | **400** | Invalid content / Missing content                  | No Content     |
5553 +---------+----------------------------------------------------+----------------+
5554 | **403** | Missing information                                | No Content     |
5555 +---------+----------------------------------------------------+----------------+
5556
5557 Consumes
5558 ~~~~~~~~
5559
5560 -  ``application/json``
5561
5562 Produces
5563 ~~~~~~~~
5564
5565 -  ``application/json``
5566
5567 Tags
5568 ~~~~
5569
5570 -  Resource Instance Servlet
5571
5572 Update resource instance multiple component
5573 -------------------------------------------
5574
5575 ::
5576
5577     POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance
5578
5579 Description
5580 ~~~~~~~~~~~
5581
5582 Returns updated resource instance
5583
5584 Parameters
5585 ~~~~~~~~~~
5586
5587 +----------+-------------+--------------------------------------+------------------+
5588 | Type     | Name        | Description                          | Schema           |
5589 +==========+=============+======================================+==================+
5590 | **Path** | **component |                                      | string           |
5591 |          | Id**\ *requ |                                      |                  |
5592 |          | ired*       |                                      |                  |
5593 +----------+-------------+--------------------------------------+------------------+
5594 | **Path** | **container | valid values: resources / services / | enum (resources, |
5595 |          | ComponentTy | products                             | services,        |
5596 |          | pe**\ *requ |                                      | products)        |
5597 |          | ired*       |                                      |                  |
5598 +----------+-------------+--------------------------------------+------------------+
5599 | **Body** | **body**\ * | Component Instance JSON Array        | string           |
5600 |          | required*   |                                      |                  |
5601 +----------+-------------+--------------------------------------+------------------+
5602
5603 Responses
5604 ~~~~~~~~~
5605
5606 +---------+----------------------------------------------------+----------------+
5607 | HTTP    | Description                                        | Schema         |
5608 | Code    |                                                    |                |
5609 +=========+====================================================+================+
5610 | **200** | Resource instance updated                          | No Content     |
5611 +---------+----------------------------------------------------+----------------+
5612 | **400** | Invalid content / Missing content                  | No Content     |
5613 +---------+----------------------------------------------------+----------------+
5614 | **403** | Restricted operation                               | No Content     |
5615 +---------+----------------------------------------------------+----------------+
5616
5617 Consumes
5618 ~~~~~~~~
5619
5620 -  ``application/json``
5621
5622 Produces
5623 ~~~~~~~~
5624
5625 -  ``application/json``
5626
5627 Tags
5628 ~~~~
5629
5630 -  Resource Instance Servlet
5631
5632 Update resource instance
5633 ------------------------
5634
5635 ::
5636
5637     POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}
5638
5639 Description
5640 ~~~~~~~~~~~
5641
5642 Returns updated resource instance
5643
5644 Parameters
5645 ~~~~~~~~~~
5646
5647 +----------+-------------+--------------------------------------+------------------+
5648 | Type     | Name        | Description                          | Schema           |
5649 +==========+=============+======================================+==================+
5650 | **Path** | **component |                                      | string           |
5651 |          | Id**\ *requ |                                      |                  |
5652 |          | ired*       |                                      |                  |
5653 +----------+-------------+--------------------------------------+------------------+
5654 | **Path** | **component |                                      | string           |
5655 |          | InstanceId* |                                      |                  |
5656 |          | *\ *require |                                      |                  |
5657 |          | d*          |                                      |                  |
5658 +----------+-------------+--------------------------------------+------------------+
5659 | **Path** | **container | valid values: resources / services / | enum (resources, |
5660 |          | ComponentTy | products                             | services,        |
5661 |          | pe**\ *requ |                                      | products)        |
5662 |          | ired*       |                                      |                  |
5663 +----------+-------------+--------------------------------------+------------------+
5664
5665 Responses
5666 ~~~~~~~~~
5667
5668 +---------+----------------------------------------------------+----------------+
5669 | HTTP    | Description                                        | Schema         |
5670 | Code    |                                                    |                |
5671 +=========+====================================================+================+
5672 | **200** | Resource instance updated                          | No Content     |
5673 +---------+----------------------------------------------------+----------------+
5674 | **400** | Invalid content / Missing content                  | No Content     |
5675 +---------+----------------------------------------------------+----------------+
5676 | **403** | Restricted operation                               | No Content     |
5677 +---------+----------------------------------------------------+----------------+
5678
5679 Consumes
5680 ~~~~~~~~
5681
5682 -  ``application/json``
5683
5684 Produces
5685 ~~~~~~~~
5686
5687 -  ``application/json``
5688
5689 Tags
5690 ~~~~
5691
5692 -  Resource Instance Servlet
5693
5694 Load Resource Instance artifact payload
5695 ---------------------------------------
5696
5697 ::
5698
5699     POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts
5700
5701 Description
5702 ~~~~~~~~~~~
5703
5704 Returns updated artifact
5705
5706 Parameters
5707 ~~~~~~~~~~
5708
5709 +----------+-------------+--------------------------------------+------------------+
5710 | Type     | Name        | Description                          | Schema           |
5711 +==========+=============+======================================+==================+
5712 | **Header | **Content-M |                                      | string           |
5713 | **       | D5**\ *opti |                                      |                  |
5714 |          | onal*       |                                      |                  |
5715 +----------+-------------+--------------------------------------+------------------+
5716 | **Header | **USER\_ID* |                                      | string           |
5717 | **       | *\ *optiona |                                      |                  |
5718 |          | l*          |                                      |                  |
5719 +----------+-------------+--------------------------------------+------------------+
5720 | **Path** | **component |                                      | string           |
5721 |          | Id**\ *requ |                                      |                  |
5722 |          | ired*       |                                      |                  |
5723 +----------+-------------+--------------------------------------+------------------+
5724 | **Path** | **component |                                      | string           |
5725 |          | InstanceId* |                                      |                  |
5726 |          | *\ *require |                                      |                  |
5727 |          | d*          |                                      |                  |
5728 +----------+-------------+--------------------------------------+------------------+
5729 | **Path** | **container | valid values: resources / services   | enum (resources, |
5730 |          | ComponentTy |                                      | services)        |
5731 |          | pe**\ *requ |                                      |                  |
5732 |          | ired*       |                                      |                  |
5733 +----------+-------------+--------------------------------------+------------------+
5734 | **Body** | **body**\ * | json describe the artifact           | string           |
5735 |          | required*   |                                      |                  |
5736 +----------+-------------+--------------------------------------+------------------+
5737
5738 Responses
5739 ~~~~~~~~~
5740
5741 +---------+----------------------------------------------------+----------------+
5742 | HTTP    | Description                                        | Schema         |
5743 | Code    |                                                    |                |
5744 +=========+====================================================+================+
5745 | **200** | Artifact updated                                   | No Content     |
5746 +---------+----------------------------------------------------+----------------+
5747 | **400** | Invalid content / Missing content                  | No Content     |
5748 +---------+----------------------------------------------------+----------------+
5749 | **403** | Restricted operation                               | No Content     |
5750 +---------+----------------------------------------------------+----------------+
5751
5752 Consumes
5753 ~~~~~~~~
5754
5755 -  ``application/json``
5756
5757 Produces
5758 ~~~~~~~~
5759
5760 -  ``application/json``
5761
5762 Tags
5763 ~~~~
5764
5765 -  Resource Artifact Servlet
5766
5767 Delete Resource Instance artifact
5768 ---------------------------------
5769
5770 ::
5771
5772     POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}
5773
5774 Description
5775 ~~~~~~~~~~~
5776
5777 Returns deleted artifact
5778
5779 Parameters
5780 ~~~~~~~~~~
5781
5782 +----------+-------------+--------------------------------------+------------------+
5783 | Type     | Name        | Description                          | Schema           |
5784 +==========+=============+======================================+==================+
5785 | **Header | **Content-M |                                      | string           |
5786 | **       | D5**\ *opti |                                      |                  |
5787 |          | onal*       |                                      |                  |
5788 +----------+-------------+--------------------------------------+------------------+
5789 | **Header | **USER\_ID* |                                      | string           |
5790 | **       | *\ *optiona |                                      |                  |
5791 |          | l*          |                                      |                  |
5792 +----------+-------------+--------------------------------------+------------------+
5793 | **Path** | **artifactI |                                      | string           |
5794 |          | d**\ *requi |                                      |                  |
5795 |          | red*        |                                      |                  |
5796 +----------+-------------+--------------------------------------+------------------+
5797 | **Path** | **component |                                      | string           |
5798 |          | Id**\ *requ |                                      |                  |
5799 |          | ired*       |                                      |                  |
5800 +----------+-------------+--------------------------------------+------------------+
5801 | **Path** | **component |                                      | string           |
5802 |          | InstanceId* |                                      |                  |
5803 |          | *\ *require |                                      |                  |
5804 |          | d*          |                                      |                  |
5805 +----------+-------------+--------------------------------------+------------------+
5806 | **Path** | **container | valid values: resources / services   | enum (resources, |
5807 |          | ComponentTy |                                      | services)        |
5808 |          | pe**\ *requ |                                      |                  |
5809 |          | ired*       |                                      |                  |
5810 +----------+-------------+--------------------------------------+------------------+
5811 | **Body** | **body**\ * | json describe the artifact           | string           |
5812 |          | required*   |                                      |                  |
5813 +----------+-------------+--------------------------------------+------------------+
5814
5815 Responses
5816 ~~~~~~~~~
5817
5818 +---------+----------------------------------------------------+----------------+
5819 | HTTP    | Description                                        | Schema         |
5820 | Code    |                                                    |                |
5821 +=========+====================================================+================+
5822 | **200** | Artifact updated                                   | No Content     |
5823 +---------+----------------------------------------------------+----------------+
5824 | **400** | Invalid content / Missing content                  | No Content     |
5825 +---------+----------------------------------------------------+----------------+
5826 | **403** | Restricted operation                               | No Content     |
5827 +---------+----------------------------------------------------+----------------+
5828
5829 Consumes
5830 ~~~~~~~~
5831
5832 -  ``application/json``
5833
5834 Produces
5835 ~~~~~~~~
5836
5837 -  ``application/json``
5838
5839 Tags
5840 ~~~~
5841
5842 -  Resource Artifact Servlet
5843
5844 Update Resource Instance HEAT\_ENV parameters
5845 ---------------------------------------------
5846
5847 ::
5848
5849     POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams
5850
5851 Description
5852 ~~~~~~~~~~~
5853
5854 Returns updated artifact
5855
5856 Parameters
5857 ~~~~~~~~~~
5858
5859 +----------+-------------+--------------------------------------+------------------+
5860 | Type     | Name        | Description                          | Schema           |
5861 +==========+=============+======================================+==================+
5862 | **Path** | **artifactI |                                      | string           |
5863 |          | d**\ *requi |                                      |                  |
5864 |          | red*        |                                      |                  |
5865 +----------+-------------+--------------------------------------+------------------+
5866 | **Path** | **component |                                      | string           |
5867 |          | Id**\ *requ |                                      |                  |
5868 |          | ired*       |                                      |                  |
5869 +----------+-------------+--------------------------------------+------------------+
5870 | **Path** | **component |                                      | string           |
5871 |          | InstanceId* |                                      |                  |
5872 |          | *\ *require |                                      |                  |
5873 |          | d*          |                                      |                  |
5874 +----------+-------------+--------------------------------------+------------------+
5875 | **Path** | **container | valid values: resources / services   | enum (resources, |
5876 |          | ComponentTy |                                      | services)        |
5877 |          | pe**\ *requ |                                      |                  |
5878 |          | ired*       |                                      |                  |
5879 +----------+-------------+--------------------------------------+------------------+
5880 | **Body** | **body**\ * | json describe the artifact           | string           |
5881 |          | required*   |                                      |                  |
5882 +----------+-------------+--------------------------------------+------------------+
5883
5884 Responses
5885 ~~~~~~~~~
5886
5887 +---------+----------------------------------------------------+----------------+
5888 | HTTP    | Description                                        | Schema         |
5889 | Code    |                                                    |                |
5890 +=========+====================================================+================+
5891 | **200** | Artifact updated                                   | No Content     |
5892 +---------+----------------------------------------------------+----------------+
5893 | **400** | Invalid content / Missing content                  | No Content     |
5894 +---------+----------------------------------------------------+----------------+
5895 | **403** | Restricted operation                               | No Content     |
5896 +---------+----------------------------------------------------+----------------+
5897
5898 Consumes
5899 ~~~~~~~~
5900
5901 -  ``application/json``
5902
5903 Produces
5904 ~~~~~~~~
5905
5906 -  ``application/json``
5907
5908 Tags
5909 ~~~~
5910
5911 -  Resource Artifact Servlet
5912
5913 Update resource instance attribute
5914 ----------------------------------
5915
5916 ::
5917
5918     POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attribute
5919
5920 Description
5921 ~~~~~~~~~~~
5922
5923 Returns updated resource instance attribute
5924
5925 Parameters
5926 ~~~~~~~~~~
5927
5928 +----------+-------------+--------------------------------------+------------------+
5929 | Type     | Name        | Description                          | Schema           |
5930 +==========+=============+======================================+==================+
5931 | **Header | **USER\_ID* | id of user initiating the operation  | string           |
5932 | **       | *\ *optiona |                                      |                  |
5933 |          | l*          |                                      |                  |
5934 +----------+-------------+--------------------------------------+------------------+
5935 | **Path** | **component | service id                           | string           |
5936 |          | Id**\ *requ |                                      |                  |
5937 |          | ired*       |                                      |                  |
5938 +----------+-------------+--------------------------------------+------------------+
5939 | **Path** | **component | resource instance id                 | string           |
5940 |          | InstanceId* |                                      |                  |
5941 |          | *\ *require |                                      |                  |
5942 |          | d*          |                                      |                  |
5943 +----------+-------------+--------------------------------------+------------------+
5944 | **Path** | **container | valid values: resources / services   | enum (resources, |
5945 |          | ComponentTy |                                      | services)        |
5946 |          | pe**\ *requ |                                      |                  |
5947 |          | ired*       |                                      |                  |
5948 +----------+-------------+--------------------------------------+------------------+
5949
5950 Responses
5951 ~~~~~~~~~
5952
5953 +---------+----------------------------------------------------+----------------+
5954 | HTTP    | Description                                        | Schema         |
5955 | Code    |                                                    |                |
5956 +=========+====================================================+================+
5957 | **201** | Resource instance created                          | No Content     |
5958 +---------+----------------------------------------------------+----------------+
5959 | **400** | Invalid content / Missing content                  | No Content     |
5960 +---------+----------------------------------------------------+----------------+
5961 | **403** | Restricted operation                               | No Content     |
5962 +---------+----------------------------------------------------+----------------+
5963
5964 Consumes
5965 ~~~~~~~~
5966
5967 -  ``application/json``
5968
5969 Produces
5970 ~~~~~~~~
5971
5972 -  ``application/json``
5973
5974 Tags
5975 ~~~~
5976
5977 -  Resource Instance Servlet
5978
5979 Update resource instance
5980 ------------------------
5981
5982 ::
5983
5984     POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion
5985
5986 Description
5987 ~~~~~~~~~~~
5988
5989 Returns updated resource instance
5990
5991 Parameters
5992 ~~~~~~~~~~
5993
5994 +----------+-------------+--------------------------------------+------------------+
5995 | Type     | Name        | Description                          | Schema           |
5996 +==========+=============+======================================+==================+
5997 | **Path** | **component |                                      | string           |
5998 |          | Id**\ *requ |                                      |                  |
5999 |          | ired*       |                                      |                  |
6000 +----------+-------------+--------------------------------------+------------------+
6001 | **Path** | **component |                                      | string           |
6002 |          | InstanceId* |                                      |                  |
6003 |          | *\ *require |                                      |                  |
6004 |          | d*          |                                      |                  |
6005 +----------+-------------+--------------------------------------+------------------+
6006 | **Path** | **container | valid values: resources / services   | enum (resources, |
6007 |          | ComponentTy |                                      | services)        |
6008 |          | pe**\ *requ |                                      |                  |
6009 |          | ired*       |                                      |                  |
6010 +----------+-------------+--------------------------------------+------------------+
6011
6012 Responses
6013 ~~~~~~~~~
6014
6015 +---------+----------------------------------------------------+----------------+
6016 | HTTP    | Description                                        | Schema         |
6017 | Code    |                                                    |                |
6018 +=========+====================================================+================+
6019 | **201** | Resource instance created                          | No Content     |
6020 +---------+----------------------------------------------------+----------------+
6021 | **400** | Invalid content / Missing content                  | No Content     |
6022 +---------+----------------------------------------------------+----------------+
6023 | **403** | Restricted operation                               | No Content     |
6024 +---------+----------------------------------------------------+----------------+
6025
6026 Consumes
6027 ~~~~~~~~
6028
6029 -  ``application/json``
6030
6031 Produces
6032 ~~~~~~~~
6033
6034 -  ``application/json``
6035
6036 Tags
6037 ~~~~
6038
6039 -  Resource Instance Servlet
6040
6041 Get group artifacts
6042 -------------------
6043
6044 ::
6045
6046     GET /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstId}
6047
6048 Description
6049 ~~~~~~~~~~~
6050
6051 Returns artifacts metadata according to groupInstId
6052
6053 Parameters
6054 ~~~~~~~~~~
6055
6056 +------------------+--------------------------+----------------------------------+
6057 | Type             | Name                     | Schema                           |
6058 +==================+==========================+==================================+
6059 | **Header**       | **USER\_ID**\ *optional* | string                           |
6060 +------------------+--------------------------+----------------------------------+
6061 | **Path**         | **componentId**\ *requir | string                           |
6062 |                  | ed*                      |                                  |
6063 +------------------+--------------------------+----------------------------------+
6064 | **Path**         | **componentInstanceId**\ | string                           |
6065 |                  |  *required*              |                                  |
6066 +------------------+--------------------------+----------------------------------+
6067 | **Path**         | **containerComponentType | string                           |
6068 |                  | **\ *required*           |                                  |
6069 +------------------+--------------------------+----------------------------------+
6070 | **Path**         | **groupInstId**\ *requir | string                           |
6071 |                  | ed*                      |                                  |
6072 +------------------+--------------------------+----------------------------------+
6073
6074 Responses
6075 ~~~~~~~~~
6076
6077 +---------+----------------------------------------------------+----------------+
6078 | HTTP    | Description                                        | Schema         |
6079 | Code    |                                                    |                |
6080 +=========+====================================================+================+
6081 | **200** | group found                                        | No Content     |
6082 +---------+----------------------------------------------------+----------------+
6083 | **403** | Restricted operation                               | No Content     |
6084 +---------+----------------------------------------------------+----------------+
6085 | **404** | Group not found                                    | No Content     |
6086 +---------+----------------------------------------------------+----------------+
6087
6088 Consumes
6089 ~~~~~~~~
6090
6091 -  ``application/json``
6092
6093 Produces
6094 ~~~~~~~~
6095
6096 -  ``application/json``
6097
6098 Tags
6099 ~~~~
6100
6101 -  Resource Instance Servlet
6102
6103 Update resource instance property
6104 ---------------------------------
6105
6106 ::
6107
6108     POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property
6109
6110 Description
6111 ~~~~~~~~~~~
6112
6113 Returns updated resource instance property
6114
6115 Parameters
6116 ~~~~~~~~~~
6117
6118 +----------+-------------+--------------------------------------+------------------+
6119 | Type     | Name        | Description                          | Schema           |
6120 +==========+=============+======================================+==================+
6121 | **Header | **USER\_ID* | id of user initiating the operation  | string           |
6122 | **       | *\ *optiona |                                      |                  |
6123 |          | l*          |                                      |                  |
6124 +----------+-------------+--------------------------------------+------------------+
6125 | **Path** | **component | service id                           | string           |
6126 |          | Id**\ *requ |                                      |                  |
6127 |          | ired*       |                                      |                  |
6128 +----------+-------------+--------------------------------------+------------------+
6129 | **Path** | **component | resource instance id                 | string           |
6130 |          | InstanceId* |                                      |                  |
6131 |          | *\ *require |                                      |                  |
6132 |          | d*          |                                      |                  |
6133 +----------+-------------+--------------------------------------+------------------+
6134 | **Path** | **container | valid values: resources / services   | enum (resources, |
6135 |          | ComponentTy |                                      | services)        |
6136 |          | pe**\ *requ |                                      |                  |
6137 |          | ired*       |                                      |                  |
6138 +----------+-------------+--------------------------------------+------------------+
6139 | **Path** | **groupInst | group instance id                    | string           |
6140 |          | anceId**\ * |                                      |                  |
6141 |          | required*   |                                      |                  |
6142 +----------+-------------+--------------------------------------+------------------+
6143
6144 Responses
6145 ~~~~~~~~~
6146
6147 +---------+----------------------------------------------------+----------------+
6148 | HTTP    | Description                                        | Schema         |
6149 | Code    |                                                    |                |
6150 +=========+====================================================+================+
6151 | **201** | Resource instance created                          | No Content     |
6152 +---------+----------------------------------------------------+----------------+
6153 | **400** | Invalid content / Missing content                  | No Content     |
6154 +---------+----------------------------------------------------+----------------+
6155 | **403** | Restricted operation                               | No Content     |
6156 +---------+----------------------------------------------------+----------------+
6157
6158 Consumes
6159 ~~~~~~~~
6160
6161 -  ``application/json``
6162
6163 Produces
6164 ~~~~~~~~
6165
6166 -  ``application/json``
6167
6168 Tags
6169 ~~~~
6170
6171 -  Resource Instance Servlet
6172
6173 Update resource instance property
6174 ---------------------------------
6175
6176 ::
6177
6178     POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/input
6179
6180 Description
6181 ~~~~~~~~~~~
6182
6183 Returns updated resource instance property
6184
6185 Parameters
6186 ~~~~~~~~~~
6187
6188 +----------+-------------+--------------------------------------+------------------+
6189 | Type     | Name        | Description                          | Schema           |
6190 +==========+=============+======================================+==================+
6191 | **Header | **USER\_ID* | id of user initiating the operation  | string           |
6192 | **       | *\ *optiona |                                      |                  |
6193 |          | l*          |                                      |                  |
6194 +----------+-------------+--------------------------------------+------------------+
6195 | **Path** | **component | service id                           | string           |
6196 |          | Id**\ *requ |                                      |                  |
6197 |          | ired*       |                                      |                  |
6198 +----------+-------------+--------------------------------------+------------------+
6199 | **Path** | **component | resource instance id                 | string           |
6200 |          | InstanceId* |                                      |                  |
6201 |          | *\ *require |                                      |                  |
6202 |          | d*          |                                      |                  |
6203 +----------+-------------+--------------------------------------+------------------+
6204 | **Path** | **container | valid values: resources / services   | enum (resources, |
6205 |          | ComponentTy |                                      | services)        |
6206 |          | pe**\ *requ |                                      |                  |
6207 |          | ired*       |                                      |                  |
6208 +----------+-------------+--------------------------------------+------------------+
6209
6210 Responses
6211 ~~~~~~~~~
6212
6213 +---------+----------------------------------------------------+----------------+
6214 | HTTP    | Description                                        | Schema         |
6215 | Code    |                                                    |                |
6216 +=========+====================================================+================+
6217 | **201** | Resource instance created                          | No Content     |
6218 +---------+----------------------------------------------------+----------------+
6219 | **400** | Invalid content / Missing content                  | No Content     |
6220 +---------+----------------------------------------------------+----------------+
6221 | **403** | Restricted operation                               | No Content     |
6222 +---------+----------------------------------------------------+----------------+
6223
6224 Consumes
6225 ~~~~~~~~
6226
6227 -  ``application/json``
6228
6229 Produces
6230 ~~~~~~~~
6231
6232 -  ``application/json``
6233
6234 Tags
6235 ~~~~
6236
6237 -  Resource Instance Servlet
6238
6239 Update resource instance property
6240 ---------------------------------
6241
6242 ::
6243
6244     POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property
6245
6246 Description
6247 ~~~~~~~~~~~
6248
6249 Returns updated resource instance property
6250
6251 Parameters
6252 ~~~~~~~~~~
6253
6254 +----------+-------------+--------------------------------------+------------------+
6255 | Type     | Name        | Description                          | Schema           |
6256 +==========+=============+======================================+==================+
6257 | **Header | **USER\_ID* | id of user initiating the operation  | string           |
6258 | **       | *\ *optiona |                                      |                  |
6259 |          | l*          |                                      |                  |
6260 +----------+-------------+--------------------------------------+------------------+
6261 | **Path** | **component | service id                           | string           |
6262 |          | Id**\ *requ |                                      |                  |
6263 |          | ired*       |                                      |                  |
6264 +----------+-------------+--------------------------------------+------------------+
6265 | **Path** | **component | resource instance id                 | string           |
6266 |          | InstanceId* |                                      |                  |
6267 |          | *\ *require |                                      |                  |
6268 |          | d*          |                                      |                  |
6269 +----------+-------------+--------------------------------------+------------------+
6270 | **Path** | **container | valid values: resources / services   | enum (resources, |
6271 |          | ComponentTy |                                      | services)        |
6272 |          | pe**\ *requ |                                      |                  |
6273 |          | ired*       |                                      |                  |
6274 +----------+-------------+--------------------------------------+------------------+
6275
6276 Responses
6277 ~~~~~~~~~
6278
6279 +---------+----------------------------------------------------+----------------+
6280 | HTTP    | Description                                        | Schema         |
6281 | Code    |                                                    |                |
6282 +=========+====================================================+================+
6283 | **201** | Resource instance created                          | No Content     |
6284 +---------+----------------------------------------------------+----------------+
6285 | **400** | Invalid content / Missing content                  | No Content     |
6286 +---------+----------------------------------------------------+----------------+
6287 | **403** | Restricted operation                               | No Content     |
6288 +---------+----------------------------------------------------+----------------+
6289
6290 Consumes
6291 ~~~~~~~~
6292
6293 -  ``application/json``
6294
6295 Produces
6296 ~~~~~~~~
6297
6298 -  ``application/json``
6299
6300 Tags
6301 ~~~~
6302
6303 -  Resource Instance Servlet
6304
6305 Update resource instance
6306 ------------------------
6307
6308 ::
6309
6310     DELETE /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId}
6311
6312 Description
6313 ~~~~~~~~~~~
6314
6315 Returns deleted resource instance property
6316
6317 Parameters
6318 ~~~~~~~~~~
6319
6320 +----------+-------------+--------------------------------------+------------------+
6321 | Type     | Name        | Description                          | Schema           |
6322 +==========+=============+======================================+==================+
6323 | **Header | **USER\_ID* | id of user initiating the operation  | string           |
6324 | **       | *\ *optiona |                                      |                  |
6325 |          | l*          |                                      |                  |
6326 +----------+-------------+--------------------------------------+------------------+
6327 | **Path** | **component | service id                           | string           |
6328 |          | Id**\ *requ |                                      |                  |
6329 |          | ired*       |                                      |                  |
6330 +----------+-------------+--------------------------------------+------------------+
6331 | **Path** | **component | resource instance id                 | string           |
6332 |          | InstanceId* |                                      |                  |
6333 |          | *\ *require |                                      |                  |
6334 |          | d*          |                                      |                  |
6335 +----------+-------------+--------------------------------------+------------------+
6336 | **Path** | **container | valid values: resources / services   | enum (resources, |
6337 |          | ComponentTy |                                      | services)        |
6338 |          | pe**\ *requ |                                      |                  |
6339 |          | ired*       |                                      |                  |
6340 +----------+-------------+--------------------------------------+------------------+
6341 | **Path** | **propertyI | property id                          | string           |
6342 |          | d**\ *requi |                                      |                  |
6343 |          | red*        |                                      |                  |
6344 +----------+-------------+--------------------------------------+------------------+
6345
6346 Responses
6347 ~~~~~~~~~
6348
6349 +---------+----------------------------------------------------+----------------+
6350 | HTTP    | Description                                        | Schema         |
6351 | Code    |                                                    |                |
6352 +=========+====================================================+================+
6353 | **201** | Resource instance created                          | No Content     |
6354 +---------+----------------------------------------------------+----------------+
6355 | **400** | Invalid content / Missing content                  | No Content     |
6356 +---------+----------------------------------------------------+----------------+
6357 | **403** | Restricted operation                               | No Content     |
6358 +---------+----------------------------------------------------+----------------+
6359
6360 Consumes
6361 ~~~~~~~~
6362
6363 -  ``application/json``
6364
6365 Produces
6366 ~~~~~~~~
6367
6368 -  ``application/json``
6369
6370 Tags
6371 ~~~~
6372
6373 -  Resource Instance Servlet
6374
6375 Delete ResourceInstance
6376 -----------------------
6377
6378 ::
6379
6380     DELETE /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId}
6381
6382 Description
6383 ~~~~~~~~~~~
6384
6385 Returns delete resourceInstance
6386
6387 Parameters
6388 ~~~~~~~~~~
6389
6390 +----------+-------------+--------------------------------------+------------------+
6391 | Type     | Name        | Description                          | Schema           |
6392 +==========+=============+======================================+==================+
6393 | **Path** | **component |                                      | string           |
6394 |          | Id**\ *requ |                                      |                  |
6395 |          | ired*       |                                      |                  |
6396 +----------+-------------+--------------------------------------+------------------+
6397 | **Path** | **container | valid values: resources / services / | enum (resources, |
6398 |          | ComponentTy | products                             | services,        |
6399 |          | pe**\ *requ |                                      | products)        |
6400 |          | ired*       |                                      |                  |
6401 +----------+-------------+--------------------------------------+------------------+
6402 | **Path** | **resourceI |                                      | string           |
6403 |          | nstanceId** |                                      |                  |
6404 |          | \ *required |                                      |                  |
6405 |          | *           |                                      |                  |
6406 +----------+-------------+--------------------------------------+------------------+
6407
6408 Responses
6409 ~~~~~~~~~
6410
6411 +---------+----------------------------------------------------+----------------+
6412 | HTTP    | Description                                        | Schema         |
6413 | Code    |                                                    |                |
6414 +=========+====================================================+================+
6415 | **201** | ResourceInstance deleted                           | No Content     |
6416 +---------+----------------------------------------------------+----------------+
6417 | **400** | Invalid content / Missing content                  | No Content     |
6418 +---------+----------------------------------------------------+----------------+
6419 | **403** | Restricted operation                               | No Content     |
6420 +---------+----------------------------------------------------+----------------+
6421
6422 Consumes
6423 ~~~~~~~~
6424
6425 -  ``application/json``
6426
6427 Produces
6428 ~~~~~~~~
6429
6430 -  ``application/json``
6431
6432 Tags
6433 ~~~~
6434
6435 -  Resource Instance Servlet
6436
6437 Download component Artifact in Base64
6438 -------------------------------------
6439
6440 ::
6441
6442     GET /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifacts/{artifactId}
6443
6444 Description
6445 ~~~~~~~~~~~
6446
6447 Returns downloaded artifact
6448
6449 Parameters
6450 ~~~~~~~~~~
6451
6452 +----------+-------------+--------------------------------------+------------------+
6453 | Type     | Name        | Description                          | Schema           |
6454 +==========+=============+======================================+==================+
6455 | **Path** | **artifactI |                                      | string           |
6456 |          | d**\ *requi |                                      |                  |
6457 |          | red*        |                                      |                  |
6458 +----------+-------------+--------------------------------------+------------------+
6459 | **Path** | **component |                                      | string           |
6460 |          | Id**\ *requ |                                      |                  |
6461 |          | ired*       |                                      |                  |
6462 +----------+-------------+--------------------------------------+------------------+
6463 | **Path** | **component |                                      | string           |
6464 |          | InstanceId* |                                      |                  |
6465 |          | *\ *require |                                      |                  |
6466 |          | d*          |                                      |                  |
6467 +----------+-------------+--------------------------------------+------------------+
6468 | **Path** | **container | valid values: resources / services   | enum (resources, |
6469 |          | ComponentTy |                                      | services)        |
6470 |          | pe**\ *requ |                                      |                  |
6471 |          | ired*       |                                      |                  |
6472 +----------+-------------+--------------------------------------+------------------+
6473
6474 Responses
6475 ~~~~~~~~~
6476
6477 +---------+----------------------------------------------------+----------------+
6478 | HTTP    | Description                                        | Schema         |
6479 | Code    |                                                    |                |
6480 +=========+====================================================+================+
6481 | **200** | ResourceInstance artifact downloaded               | No Content     |
6482 +---------+----------------------------------------------------+----------------+
6483 | **404** | ResourceInstance/Artifact not found                | No Content     |
6484 +---------+----------------------------------------------------+----------------+
6485
6486 Consumes
6487 ~~~~~~~~
6488
6489 -  ``application/json``
6490
6491 Produces
6492 ~~~~~~~~
6493
6494 -  ``application/json``
6495
6496 Tags
6497 ~~~~
6498
6499 -  Resource Artifact Servlet
6500
6501 Get component Artifacts
6502 -----------------------
6503
6504 ::
6505
6506     GET /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType}
6507
6508 Description
6509 ~~~~~~~~~~~
6510
6511 Returns artifacts
6512
6513 Parameters
6514 ~~~~~~~~~~
6515
6516 +----------+-------------+--------------------------------------+------------------+
6517 | Type     | Name        | Description                          | Schema           |
6518 +==========+=============+======================================+==================+
6519 | **Path** | **artifactG |                                      | string           |
6520 |          | roupType**\ |                                      |                  |
6521 |          |  *required* |                                      |                  |
6522 +----------+-------------+--------------------------------------+------------------+
6523 | **Path** | **component |                                      | string           |
6524 |          | Id**\ *requ |                                      |                  |
6525 |          | ired*       |                                      |                  |
6526 +----------+-------------+--------------------------------------+------------------+
6527 | **Path** | **component |                                      | string           |
6528 |          | InstanceId* |                                      |                  |
6529 |          | *\ *require |                                      |                  |
6530 |          | d*          |                                      |                  |
6531 +----------+-------------+--------------------------------------+------------------+
6532 | **Path** | **container | valid values: resources / services   | enum (resources, |
6533 |          | ComponentTy |                                      | services)        |
6534 |          | pe**\ *requ |                                      |                  |
6535 |          | ired*       |                                      |                  |
6536 +----------+-------------+--------------------------------------+------------------+
6537
6538 Responses
6539 ~~~~~~~~~
6540
6541 +---------+----------------------------------------------------+----------------+
6542 | HTTP    | Description                                        | Schema         |
6543 | Code    |                                                    |                |
6544 +=========+====================================================+================+
6545 | **200** | Component artifacts                                | No Content     |
6546 +---------+----------------------------------------------------+----------------+
6547 | **404** | Resource/Artifact not found                        | No Content     |
6548 +---------+----------------------------------------------------+----------------+
6549
6550 Consumes
6551 ~~~~~~~~
6552
6553 -  ``application/json``
6554
6555 Produces
6556 ~~~~~~~~
6557
6558 -  ``application/json``
6559
6560 Tags
6561 ~~~~
6562
6563 -  Resource Artifact Servlet
6564
6565 Update resource inputs
6566 ----------------------
6567
6568 ::
6569
6570     POST /v1/catalog/{containerComponentType}/{componentId}/update/inputs
6571
6572 Description
6573 ~~~~~~~~~~~
6574
6575 Returns updated input
6576
6577 Parameters
6578 ~~~~~~~~~~
6579
6580 +----------+-------------+--------------------------------------+------------------+
6581 | Type     | Name        | Description                          | Schema           |
6582 +==========+=============+======================================+==================+
6583 | **Path** | **component |                                      | string           |
6584 |          | Id**\ *requ |                                      |                  |
6585 |          | ired*       |                                      |                  |
6586 +----------+-------------+--------------------------------------+------------------+
6587 | **Path** | **container | valid values: resources / services   | enum (resources, |
6588 |          | ComponentTy |                                      | services)        |
6589 |          | pe**\ *requ |                                      |                  |
6590 |          | ired*       |                                      |                  |
6591 +----------+-------------+--------------------------------------+------------------+
6592 | **Body** | **body**\ * | json describe the input              | string           |
6593 |          | required*   |                                      |                  |
6594 +----------+-------------+--------------------------------------+------------------+
6595
6596 Responses
6597 ~~~~~~~~~
6598
6599 +---------+----------------------------------------------------+----------------+
6600 | HTTP    | Description                                        | Schema         |
6601 | Code    |                                                    |                |
6602 +=========+====================================================+================+
6603 | **200** | Input updated                                      | No Content     |
6604 +---------+----------------------------------------------------+----------------+
6605 | **400** | Invalid content / Missing content                  | No Content     |
6606 +---------+----------------------------------------------------+----------------+
6607 | **403** | Restricted operation                               | No Content     |
6608 +---------+----------------------------------------------------+----------------+
6609
6610 Consumes
6611 ~~~~~~~~
6612
6613 -  ``application/json``
6614
6615 Produces
6616 ~~~~~~~~
6617
6618 -  ``application/json``
6619
6620 Tags
6621 ~~~~
6622
6623 -  Input Catalog
6624
6625 Get component instance properties
6626 ---------------------------------
6627
6628 ::
6629
6630     GET /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/properties
6631
6632 Description
6633 ~~~~~~~~~~~
6634
6635 Returns component instance properties
6636
6637 Parameters
6638 ~~~~~~~~~~
6639
6640 +------------------+--------------------------+----------------------------------+
6641 | Type             | Name                     | Schema                           |
6642 +==================+==========================+==================================+
6643 | **Header**       | **USER\_ID**\ *optional* | string                           |
6644 +------------------+--------------------------+----------------------------------+
6645 | **Path**         | **componentInstanceUniqu | string                           |
6646 |                  | eId**\ *required*        |                                  |
6647 +------------------+--------------------------+----------------------------------+
6648 | **Path**         | **containerComponentId** | string                           |
6649 |                  | \ *required*             |                                  |
6650 +------------------+--------------------------+----------------------------------+
6651 | **Path**         | **containerComponentType | string                           |
6652 |                  | **\ *required*           |                                  |
6653 +------------------+--------------------------+----------------------------------+
6654
6655 Responses
6656 ~~~~~~~~~
6657
6658 +---------+----------------------------------------------------+----------------+
6659 | HTTP    | Description                                        | Schema         |
6660 | Code    |                                                    |                |
6661 +=========+====================================================+================+
6662 | **200** | Properties found                                   | No Content     |
6663 +---------+----------------------------------------------------+----------------+
6664 | **403** | Restricted operation                               | No Content     |
6665 +---------+----------------------------------------------------+----------------+
6666 | **404** | Component/Component Instance - not found           | No Content     |
6667 +---------+----------------------------------------------------+----------------+
6668
6669 Consumes
6670 ~~~~~~~~
6671
6672 -  ``application/json``
6673
6674 Produces
6675 ~~~~~~~~
6676
6677 -  ``application/json``
6678
6679 Tags
6680 ~~~~
6681
6682 -  Resource Instance Servlet
6683
6684 Create service proxy
6685 --------------------
6686
6687 ::
6688
6689     POST /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy
6690
6691 Description
6692 ~~~~~~~~~~~
6693
6694 Returns created service proxy
6695
6696 Parameters
6697 ~~~~~~~~~~
6698
6699 +----------+-------------+--------------------------------------+------------------+
6700 | Type     | Name        | Description                          | Schema           |
6701 +==========+=============+======================================+==================+
6702 | **Header | **USER\_ID* | USER\_ID of modifier user            | string           |
6703 | **       | *\ *require |                                      |                  |
6704 |          | d*          |                                      |                  |
6705 +----------+-------------+--------------------------------------+------------------+
6706 | **Path** | **container |                                      | string           |
6707 |          | ComponentId |                                      |                  |
6708 |          | **\ *requir |                                      |                  |
6709 |          | ed*         |                                      |                  |
6710 +----------+-------------+--------------------------------------+------------------+
6711 | **Path** | **container | valid values: resources / services   | enum (resources, |
6712 |          | ComponentTy |                                      | services)        |
6713 |          | pe**\ *requ |                                      |                  |
6714 |          | ired*       |                                      |                  |
6715 +----------+-------------+--------------------------------------+------------------+
6716 | **Body** | **body**\ * | RI object to be created              | string           |
6717 |          | required*   |                                      |                  |
6718 +----------+-------------+--------------------------------------+------------------+
6719
6720 Responses
6721 ~~~~~~~~~
6722
6723 +---------+----------------------------------------------------+----------------+
6724 | HTTP    | Description                                        | Schema         |
6725 | Code    |                                                    |                |
6726 +=========+====================================================+================+
6727 | **201** | Service proxy created                              | No Content     |
6728 +---------+----------------------------------------------------+----------------+
6729 | **400** | Invalid content / Missing content                  | No Content     |
6730 +---------+----------------------------------------------------+----------------+
6731 | **403** | Restricted operation                               | No Content     |
6732 +---------+----------------------------------------------------+----------------+
6733 | **409** | Service proxy already exist                        | No Content     |
6734 +---------+----------------------------------------------------+----------------+
6735
6736 Consumes
6737 ~~~~~~~~
6738
6739 -  ``application/json``
6740
6741 Produces
6742 ~~~~~~~~
6743
6744 -  ``application/json``
6745
6746 Tags
6747 ~~~~
6748
6749 -  Resource Instance Servlet
6750
6751 Delete service proxy
6752 --------------------
6753
6754 ::
6755
6756     DELETE /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}
6757
6758 Description
6759 ~~~~~~~~~~~
6760
6761 Returns delete service proxy
6762
6763 Parameters
6764 ~~~~~~~~~~
6765
6766 +----------+-------------+--------------------------------------+------------------+
6767 | Type     | Name        | Description                          | Schema           |
6768 +==========+=============+======================================+==================+
6769 | **Path** | **container |                                      | string           |
6770 |          | ComponentId |                                      |                  |
6771 |          | **\ *requir |                                      |                  |
6772 |          | ed*         |                                      |                  |
6773 +----------+-------------+--------------------------------------+------------------+
6774 | **Path** | **container | valid values: resources / services / | enum (resources, |
6775 |          | ComponentTy | products                             | services,        |
6776 |          | pe**\ *requ |                                      | products)        |
6777 |          | ired*       |                                      |                  |
6778 +----------+-------------+--------------------------------------+------------------+
6779 | **Path** | **servicePr |                                      | string           |
6780 |          | oxyId**\ *r |                                      |                  |
6781 |          | equired*    |                                      |                  |
6782 +----------+-------------+--------------------------------------+------------------+
6783
6784 Responses
6785 ~~~~~~~~~
6786
6787 +---------+----------------------------------------------------+----------------+
6788 | HTTP    | Description                                        | Schema         |
6789 | Code    |                                                    |                |
6790 +=========+====================================================+================+
6791 | **201** | Service proxy deleted                              | No Content     |
6792 +---------+----------------------------------------------------+----------------+
6793 | **400** | Invalid content / Missing content                  | No Content     |
6794 +---------+----------------------------------------------------+----------------+
6795 | **403** | Restricted operation                               | No Content     |
6796 +---------+----------------------------------------------------+----------------+
6797
6798 Consumes
6799 ~~~~~~~~
6800
6801 -  ``application/json``
6802
6803 Produces
6804 ~~~~~~~~
6805
6806 -  ``application/json``
6807
6808 Tags
6809 ~~~~
6810
6811 -  Resource Instance Servlet
6812
6813 Update service proxy with new version
6814 -------------------------------------
6815
6816 ::
6817
6818     POST /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}/changeVersion/{newServiceId}
6819
6820 Description
6821 ~~~~~~~~~~~
6822
6823 Returns updated service proxy
6824
6825 Parameters
6826 ~~~~~~~~~~
6827
6828 +----------+-------------+--------------------------------------+------------------+
6829 | Type     | Name        | Description                          | Schema           |
6830 +==========+=============+======================================+==================+
6831 | **Path** | **container |                                      | string           |
6832 |          | ComponentId |                                      |                  |
6833 |          | **\ *requir |                                      |                  |
6834 |          | ed*         |                                      |                  |
6835 +----------+-------------+--------------------------------------+------------------+
6836 | **Path** | **container | valid values: resources / services   | enum (resources, |
6837 |          | ComponentTy |                                      | services)        |
6838 |          | pe**\ *requ |                                      |                  |
6839 |          | ired*       |                                      |                  |
6840 +----------+-------------+--------------------------------------+------------------+
6841 | **Path** | **servicePr |                                      | string           |
6842 |          | oxyId**\ *r |                                      |                  |
6843 |          | equired*    |                                      |                  |
6844 +----------+-------------+--------------------------------------+------------------+
6845
6846 Responses
6847 ~~~~~~~~~
6848
6849 +---------+----------------------------------------------------+----------------+
6850 | HTTP    | Description                                        | Schema         |
6851 | Code    |                                                    |                |
6852 +=========+====================================================+================+
6853 | **201** | Service proxy created                              | No Content     |
6854 +---------+----------------------------------------------------+----------------+
6855 | **400** | Invalid content / Missing content                  | No Content     |
6856 +---------+----------------------------------------------------+----------------+
6857 | **403** | Restricted operation                               | No Content     |
6858 +---------+----------------------------------------------------+----------------+
6859
6860 Consumes
6861 ~~~~~~~~
6862
6863 -  ``application/json``
6864
6865 Produces
6866 ~~~~~~~~
6867
6868 -  ``application/json``
6869
6870 Tags
6871 ~~~~
6872
6873 -  Resource Instance Servlet
6874
6875 Update Group Instance Property Values
6876 -------------------------------------
6877
6878 ::
6879
6880     PUT /v1/catalog/{containerComponentType}/{serviceId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}
6881
6882 Description
6883 ~~~~~~~~~~~
6884
6885 Returns updated group instance
6886
6887 Parameters
6888 ~~~~~~~~~~
6889
6890 +----------+-------------+--------------------------------------+------------------+
6891 | Type     | Name        | Description                          | Schema           |
6892 +==========+=============+======================================+==================+
6893 | **Header | **USER\_ID* |                                      | string           |
6894 | **       | *\ *optiona |                                      |                  |
6895 |          | l*          |                                      |                  |
6896 +----------+-------------+--------------------------------------+------------------+
6897 | **Path** | **component |                                      | string           |
6898 |          | InstanceId* |                                      |                  |
6899 |          | *\ *require |                                      |                  |
6900 |          | d*          |                                      |                  |
6901 +----------+-------------+--------------------------------------+------------------+
6902 | **Path** | **groupInst |                                      | string           |
6903 |          | anceId**\ * |                                      |                  |
6904 |          | required*   |                                      |                  |
6905 +----------+-------------+--------------------------------------+------------------+
6906 | **Path** | **serviceId |                                      | string           |
6907 |          | **\ *requir |                                      |                  |
6908 |          | ed*         |                                      |                  |
6909 +----------+-------------+--------------------------------------+------------------+
6910 | **Body** | **body**\ * | Group instance object to be Updated  | string           |
6911 |          | required*   |                                      |                  |
6912 +----------+-------------+--------------------------------------+------------------+
6913
6914 Responses
6915 ~~~~~~~~~
6916
6917 +---------+----------------------------------------------------+----------------+
6918 | HTTP    | Description                                        | Schema         |
6919 | Code    |                                                    |                |
6920 +=========+====================================================+================+
6921 | **200** | Group Instance Property Values Updated             | No Content     |
6922 +---------+----------------------------------------------------+----------------+
6923 | **400** | Invalid content / Missing content                  | No Content     |
6924 +---------+----------------------------------------------------+----------------+
6925 | **403** | Restricted operation                               | No Content     |
6926 +---------+----------------------------------------------------+----------------+
6927
6928 Consumes
6929 ~~~~~~~~
6930
6931 -  ``application/json``
6932
6933 Produces
6934 ~~~~~~~~
6935
6936 -  ``application/json``
6937
6938 Tags
6939 ~~~~
6940
6941 -  Service Catalog
6942
6943 Retrieve the all resource, service and product categories
6944 ---------------------------------------------------------
6945
6946 ::
6947
6948     GET /v1/categories
6949
6950 Description
6951 ~~~~~~~~~~~
6952
6953 Retrieve the all resource, service and product categories
6954
6955 Parameters
6956 ~~~~~~~~~~
6957
6958 +------------------+--------------------------+----------------------------------+
6959 | Type             | Name                     | Schema                           |
6960 +==================+==========================+==================================+
6961 | **Header**       | **USER\_ID**\ *optional* | string                           |
6962 +------------------+--------------------------+----------------------------------+
6963
6964 Responses
6965 ~~~~~~~~~
6966
6967 +---------+----------------------------------------------------+----------------+
6968 | HTTP    | Description                                        | Schema         |
6969 | Code    |                                                    |                |
6970 +=========+====================================================+================+
6971 | **200** | Returns categories Ok                              | No Content     |
6972 +---------+----------------------------------------------------+----------------+
6973 | **403** | Missing information                                | No Content     |
6974 +---------+----------------------------------------------------+----------------+
6975 | **409** | Restricted operation                               | No Content     |
6976 +---------+----------------------------------------------------+----------------+
6977 | **500** | Internal Server Error                              | No Content     |
6978 +---------+----------------------------------------------------+----------------+
6979
6980 Consumes
6981 ~~~~~~~~
6982
6983 -  ``application/json``
6984
6985 Produces
6986 ~~~~~~~~
6987
6988 -  ``application/json``
6989
6990 Tags
6991 ~~~~
6992
6993 -  Element Servlet
6994
6995 Retrieve the list of all resource/service/product categories/sub-categories/groupings
6996 -------------------------------------------------------------------------------------
6997
6998 ::
6999
7000     GET /v1/categories/{componentType}
7001
7002 Description
7003 ~~~~~~~~~~~
7004
7005 Retrieve the list of all resource/service/product
7006 categories/sub-categories/groupings.
7007
7008 Parameters
7009 ~~~~~~~~~~
7010
7011 +----------+-------------+--------------------------------------+------------------+
7012 | Type     | Name        | Description                          | Schema           |
7013 +==========+=============+======================================+==================+
7014 | **Header | **USER\_ID* |                                      | string           |
7015 | **       | *\ *optiona |                                      |                  |
7016 |          | l*          |                                      |                  |
7017 +----------+-------------+--------------------------------------+------------------+
7018 | **Path** | **component | allowed values are resources /       | enum (resources, |
7019 |          | Type**\ *re | services/ products                   | services,        |
7020 |          | quired*     |                                      | products)        |
7021 +----------+-------------+--------------------------------------+------------------+
7022
7023 Responses
7024 ~~~~~~~~~
7025
7026 +---------+----------------------------------------------------+----------------+
7027 | HTTP    | Description                                        | Schema         |
7028 | Code    |                                                    |                |
7029 +=========+====================================================+================+
7030 | **200** | Returns categories Ok                              | No Content     |
7031 +---------+----------------------------------------------------+----------------+
7032 | **400** | Invalid component type                             | No Content     |
7033 +---------+----------------------------------------------------+----------------+
7034 | **403** | Missing information                                | No Content     |
7035 +---------+----------------------------------------------------+----------------+
7036 | **409** | Restricted operation                               | No Content     |
7037 +---------+----------------------------------------------------+----------------+
7038 | **500** | Internal Server Error                              | No Content     |
7039 +---------+----------------------------------------------------+----------------+
7040
7041 Consumes
7042 ~~~~~~~~
7043
7044 -  ``application/json``
7045
7046 Produces
7047 ~~~~~~~~
7048
7049 -  ``application/json``
7050
7051 Tags
7052 ~~~~
7053
7054 -  Element Servlet
7055
7056 Create new component category
7057 -----------------------------
7058
7059 ::
7060
7061     POST /v1/category/{componentType}
7062
7063 Description
7064 ~~~~~~~~~~~
7065
7066 Create new component category
7067
7068 Parameters
7069 ~~~~~~~~~~
7070
7071 +----------+-------------+--------------------------------------+------------------+
7072 | Type     | Name        | Description                          | Schema           |
7073 +==========+=============+======================================+==================+
7074 | **Header | **USER\_ID* |                                      | string           |
7075 | **       | *\ *optiona |                                      |                  |
7076 |          | l*          |                                      |                  |
7077 +----------+-------------+--------------------------------------+------------------+
7078 | **Path** | **component | allowed values are resources         | enum (resources, |
7079 |          | Type**\ *re | /services / products                 | services,        |
7080 |          | quired*     |                                      | products)        |
7081 +----------+-------------+--------------------------------------+------------------+
7082 | **Body** | **body**\ * | Category to be created               | string           |
7083 |          | required*   |                                      |                  |
7084 +----------+-------------+--------------------------------------+------------------+
7085
7086 Responses
7087 ~~~~~~~~~
7088
7089 +---------+----------------------------------------------------+----------------+
7090 | HTTP    | Description                                        | Schema         |
7091 | Code    |                                                    |                |
7092 +=========+====================================================+================+
7093 | **201** | Category created                                   | No Content     |
7094 +---------+----------------------------------------------------+----------------+
7095 | **400** | Invalid category data                              | No Content     |
7096 +---------+----------------------------------------------------+----------------+
7097 | **403** | USER\_ID header is missing                         | No Content     |
7098 +---------+----------------------------------------------------+----------------+
7099 | **409** | Category already exists / User not permitted to    | No Content     |
7100 |         | perform the action                                 |                |
7101 +---------+----------------------------------------------------+----------------+
7102 | **500** | General Error                                      | No Content     |
7103 +---------+----------------------------------------------------+----------------+
7104
7105 Consumes
7106 ~~~~~~~~
7107
7108 -  ``application/json``
7109
7110 Produces
7111 ~~~~~~~~
7112
7113 -  ``application/json``
7114
7115 Tags
7116 ~~~~
7117
7118 -  Element Servlet
7119
7120 Create new component sub-category
7121 ---------------------------------
7122
7123 ::
7124
7125     POST /v1/category/{componentType}/{categoryId}/subCategory
7126
7127 Description
7128 ~~~~~~~~~~~
7129
7130 Create new component sub-category for existing category
7131
7132 Parameters
7133 ~~~~~~~~~~
7134
7135 +----------+-------------+--------------------------------------+------------------+
7136 | Type     | Name        | Description                          | Schema           |
7137 +==========+=============+======================================+==================+
7138 | **Header | **USER\_ID* |                                      | string           |
7139 | **       | *\ *optiona |                                      |                  |
7140 |          | l*          |                                      |                  |
7141 +----------+-------------+--------------------------------------+------------------+
7142 | **Path** | **categoryI | Parent category unique ID            | string           |
7143 |          | d**\ *requi |                                      |                  |
7144 |          | red*        |                                      |                  |
7145 +----------+-------------+--------------------------------------+------------------+
7146 | **Path** | **component | allowed values are resources /       | enum (resources, |
7147 |          | Type**\ *re | products                             | products)        |
7148 |          | quired*     |                                      |                  |
7149 +----------+-------------+--------------------------------------+------------------+
7150 | **Body** | **body**\ * | Subcategory to be created. e.g.      | string           |
7151 |          | required*   | {"name":"Resource-subcat"}           |                  |
7152 +----------+-------------+--------------------------------------+------------------+
7153
7154 Responses
7155 ~~~~~~~~~
7156
7157 +---------+----------------------------------------------------+----------------+
7158 | HTTP    | Description                                        | Schema         |
7159 | Code    |                                                    |                |
7160 +=========+====================================================+================+
7161 | **201** | Subcategory created                                | No Content     |
7162 +---------+----------------------------------------------------+----------------+
7163 | **400** | Invalid subcategory data                           | No Content     |
7164 +---------+----------------------------------------------------+----------------+
7165 | **403** | USER\_ID header is missing                         | No Content     |
7166 +---------+----------------------------------------------------+----------------+
7167 | **404** | Parent category wasn’t found                       | No Content     |
7168 +---------+----------------------------------------------------+----------------+
7169 | **409** | Subcategory already exists / User not permitted to | No Content     |
7170 |         | perform the action                                 |                |
7171 +---------+----------------------------------------------------+----------------+
7172 | **500** | General Error                                      | No Content     |
7173 +---------+----------------------------------------------------+----------------+
7174
7175 Consumes
7176 ~~~~~~~~
7177
7178 -  ``application/json``
7179
7180 Produces
7181 ~~~~~~~~
7182
7183 -  ``application/json``
7184
7185 Tags
7186 ~~~~
7187
7188 -  Element Servlet
7189
7190 Create new component grouping
7191 -----------------------------
7192
7193 ::
7194
7195     POST /v1/category/{componentType}/{categoryId}/subCategory/{subCategoryId}/grouping
7196
7197 Description
7198 ~~~~~~~~~~~
7199
7200 Create new component grouping for existing sub-category
7201
7202 Parameters
7203 ~~~~~~~~~~
7204
7205 +----------+-------------+--------------------------------------+------------------+
7206 | Type     | Name        | Description                          | Schema           |
7207 +==========+=============+======================================+==================+
7208 | **Header | **USER\_ID* |                                      | string           |
7209 | **       | *\ *optiona |                                      |                  |
7210 |          | l*          |                                      |                  |
7211 +----------+-------------+--------------------------------------+------------------+
7212 | **Path** | **categoryI | Parent category unique ID            | string           |
7213 |          | d**\ *requi |                                      |                  |
7214 |          | red*        |                                      |                  |
7215 +----------+-------------+--------------------------------------+------------------+
7216 | **Path** | **component | allowed values are products          | enum (products)  |
7217 |          | Type**\ *re |                                      |                  |
7218 |          | quired*     |                                      |                  |
7219 +----------+-------------+--------------------------------------+------------------+
7220 | **Path** | **subCatego | Parent sub-category unique ID        | string           |
7221 |          | ryId**\ *re |                                      |                  |
7222 |          | quired*     |                                      |                  |
7223 +----------+-------------+--------------------------------------+------------------+
7224 | **Body** | **body**\ * | Subcategory to be created            | string           |
7225 |          | required*   |                                      |                  |
7226 +----------+-------------+--------------------------------------+------------------+
7227
7228 Responses
7229 ~~~~~~~~~
7230
7231 +---------+----------------------------------------------------+----------------+
7232 | HTTP    | Description                                        | Schema         |
7233 | Code    |                                                    |                |
7234 +=========+====================================================+================+
7235 | **201** | Grouping created                                   | No Content     |
7236 +---------+----------------------------------------------------+----------------+
7237 | **400** | Invalid grouping data                              | No Content     |
7238 +---------+----------------------------------------------------+----------------+
7239 | **403** | USER\_ID header is missing                         | No Content     |
7240 +---------+----------------------------------------------------+----------------+
7241 | **404** | Parent category or subcategory were not found      | No Content     |
7242 +---------+----------------------------------------------------+----------------+
7243 | **409** | Grouping already exists / User not permitted to    | No Content     |
7244 |         | perform the action                                 |                |
7245 +---------+----------------------------------------------------+----------------+
7246 | **500** | General Error                                      | No Content     |
7247 +---------+----------------------------------------------------+----------------+
7248
7249 Consumes
7250 ~~~~~~~~
7251
7252 -  ``application/json``
7253
7254 Produces
7255 ~~~~~~~~
7256
7257 -  ``application/json``
7258
7259 Tags
7260 ~~~~
7261
7262 -  Element Servlet
7263
7264 Delete component category
7265 -------------------------
7266
7267 ::
7268
7269     DELETE /v1/category/{componentType}/{categoryUniqueId}
7270
7271 Description
7272 ~~~~~~~~~~~
7273
7274 Delete component category
7275
7276 Parameters
7277 ~~~~~~~~~~
7278
7279 +------------------+--------------------------+----------------------------------+
7280 | Type             | Name                     | Schema                           |
7281 +==================+==========================+==================================+
7282 | **Header**       | **USER\_ID**\ *optional* | string                           |
7283 +------------------+--------------------------+----------------------------------+
7284 | **Path**         | **categoryUniqueId**\ *r | string                           |
7285 |                  | equired*                 |                                  |
7286 +------------------+--------------------------+----------------------------------+
7287 | **Path**         | **componentType**\ *requ | string                           |
7288 |                  | ired*                    |                                  |
7289 +------------------+--------------------------+----------------------------------+
7290
7291 Responses
7292 ~~~~~~~~~
7293
7294 +---------+----------------------------------------------------+----------------+
7295 | HTTP    | Description                                        | Schema         |
7296 | Code    |                                                    |                |
7297 +=========+====================================================+================+
7298 | **200** | successful operation                               | `Category <#_c |
7299 |         |                                                    | ategory>`__    |
7300 +---------+----------------------------------------------------+----------------+
7301 | **204** | Category deleted                                   | No Content     |
7302 +---------+----------------------------------------------------+----------------+
7303 | **403** | USER\_ID header is missing                         | No Content     |
7304 +---------+----------------------------------------------------+----------------+
7305 | **404** | Category not found                                 | No Content     |
7306 +---------+----------------------------------------------------+----------------+
7307 | **409** | User not permitted to perform the action           | No Content     |
7308 +---------+----------------------------------------------------+----------------+
7309 | **500** | General Error                                      | No Content     |
7310 +---------+----------------------------------------------------+----------------+
7311
7312 Consumes
7313 ~~~~~~~~
7314
7315 -  ``application/json``
7316
7317 Produces
7318 ~~~~~~~~
7319
7320 -  ``application/json``
7321
7322 Tags
7323 ~~~~
7324
7325 -  Element Servlet
7326
7327 Delete component category
7328 -------------------------
7329
7330 ::
7331
7332     DELETE /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}
7333
7334 Description
7335 ~~~~~~~~~~~
7336
7337 Delete component category
7338
7339 Parameters
7340 ~~~~~~~~~~
7341
7342 +------------------+--------------------------+----------------------------------+
7343 | Type             | Name                     | Schema                           |
7344 +==================+==========================+==================================+
7345 | **Header**       | **USER\_ID**\ *optional* | string                           |
7346 +------------------+--------------------------+----------------------------------+
7347 | **Path**         | **categoryUniqueId**\ *r | string                           |
7348 |                  | equired*                 |                                  |
7349 +------------------+--------------------------+----------------------------------+
7350 | **Path**         | **componentType**\ *requ | string                           |
7351 |                  | ired*                    |                                  |
7352 +------------------+--------------------------+----------------------------------+
7353 | **Path**         | **subCategoryUniqueId**\ | string                           |
7354 |                  |  *required*              |                                  |
7355 +------------------+--------------------------+----------------------------------+
7356
7357 Responses
7358 ~~~~~~~~~
7359
7360 +---------+----------------------------------------------------+----------------+
7361 | HTTP    | Description                                        | Schema         |
7362 | Code    |                                                    |                |
7363 +=========+====================================================+================+
7364 | **200** | successful operation                               | `Category <#_c |
7365 |         |                                                    | ategory>`__    |
7366 +---------+----------------------------------------------------+----------------+
7367 | **204** | Category deleted                                   | No Content     |
7368 +---------+----------------------------------------------------+----------------+
7369 | **403** | USER\_ID header is missing                         | No Content     |
7370 +---------+----------------------------------------------------+----------------+
7371 | **404** | Category not found                                 | No Content     |
7372 +---------+----------------------------------------------------+----------------+
7373 | **409** | User not permitted to perform the action           | No Content     |
7374 +---------+----------------------------------------------------+----------------+
7375 | **500** | General Error                                      | No Content     |
7376 +---------+----------------------------------------------------+----------------+
7377
7378 Consumes
7379 ~~~~~~~~
7380
7381 -  ``application/json``
7382
7383 Produces
7384 ~~~~~~~~
7385
7386 -  ``application/json``
7387
7388 Tags
7389 ~~~~
7390
7391 -  Element Servlet
7392
7393 Delete component category
7394 -------------------------
7395
7396 ::
7397
7398     DELETE /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}/grouping/{groupingUniqueId}
7399
7400 Description
7401 ~~~~~~~~~~~
7402
7403 Delete component category
7404
7405 Parameters
7406 ~~~~~~~~~~
7407
7408 +------------------+--------------------------+----------------------------------+
7409 | Type             | Name                     | Schema                           |
7410 +==================+==========================+==================================+
7411 | **Header**       | **USER\_ID**\ *optional* | string                           |
7412 +------------------+--------------------------+----------------------------------+
7413 | **Path**         | **categoryUniqueId**\ *r | string                           |
7414 |                  | equired*                 |                                  |
7415 +------------------+--------------------------+----------------------------------+
7416 | **Path**         | **componentType**\ *requ | string                           |
7417 |                  | ired*                    |                                  |
7418 +------------------+--------------------------+----------------------------------+
7419 | **Path**         | **groupingUniqueId**\ *r | string                           |
7420 |                  | equired*                 |                                  |
7421 +------------------+--------------------------+----------------------------------+
7422 | **Path**         | **subCategoryUniqueId**\ | string                           |
7423 |                  |  *required*              |                                  |
7424 +------------------+--------------------------+----------------------------------+
7425
7426 Responses
7427 ~~~~~~~~~
7428
7429 +---------+----------------------------------------------------+----------------+
7430 | HTTP    | Description                                        | Schema         |
7431 | Code    |                                                    |                |
7432 +=========+====================================================+================+
7433 | **200** | successful operation                               | `Category <#_c |
7434 |         |                                                    | ategory>`__    |
7435 +---------+----------------------------------------------------+----------------+
7436 | **204** | Category deleted                                   | No Content     |
7437 +---------+----------------------------------------------------+----------------+
7438 | **403** | USER\_ID header is missing                         | No Content     |
7439 +---------+----------------------------------------------------+----------------+
7440 | **404** | Category not found                                 | No Content     |
7441 +---------+----------------------------------------------------+----------------+
7442 | **409** | User not permitted to perform the action           | No Content     |
7443 +---------+----------------------------------------------------+----------------+
7444 | **500** | General Error                                      | No Content     |
7445 +---------+----------------------------------------------------+----------------+
7446
7447 Consumes
7448 ~~~~~~~~
7449
7450 -  ``application/json``
7451
7452 Produces
7453 ~~~~~~~~
7454
7455 -  ``application/json``
7456
7457 Tags
7458 ~~~~
7459
7460 -  Element Servlet
7461
7462 Retrieve all artifactTypes
7463 --------------------------
7464
7465 ::
7466
7467     GET /v1/configuration/ui
7468
7469 Description
7470 ~~~~~~~~~~~
7471
7472 Retrieve all artifactTypes
7473
7474 Parameters
7475 ~~~~~~~~~~
7476
7477 +------------------+--------------------------+----------------------------------+
7478 | Type             | Name                     | Schema                           |
7479 +==================+==========================+==================================+
7480 | **Header**       | **USER\_ID**\ *optional* | string                           |
7481 +------------------+--------------------------+----------------------------------+
7482
7483 Responses
7484 ~~~~~~~~~
7485
7486 +---------+----------------------------------------------------+----------------+
7487 | HTTP    | Description                                        | Schema         |
7488 | Code    |                                                    |                |
7489 +=========+====================================================+================+
7490 | **200** | Returns artifactTypes Ok                           | No Content     |
7491 +---------+----------------------------------------------------+----------------+
7492 | **404** | No artifactTypes were found                        | No Content     |
7493 +---------+----------------------------------------------------+----------------+
7494 | **500** | Internal Server Error                              | No Content     |
7495 +---------+----------------------------------------------------+----------------+
7496
7497 Consumes
7498 ~~~~~~~~
7499
7500 -  ``application/json``
7501
7502 Produces
7503 ~~~~~~~~
7504
7505 -  ``application/json``
7506
7507 Tags
7508 ~~~~
7509
7510 -  Element Servlet
7511
7512 Consumer credentials
7513 --------------------
7514
7515 ::
7516
7517     POST /v1/consumers
7518
7519 Description
7520 ~~~~~~~~~~~
7521
7522 Returns created ECOMP consumer credentials
7523
7524 Parameters
7525 ~~~~~~~~~~
7526
7527 +----------+-------------+--------------------------------------+------------------+
7528 | Type     | Name        | Description                          | Schema           |
7529 +==========+=============+======================================+==================+
7530 | **Header | **USER\_ID* |                                      | string           |
7531 | **       | *\ *optiona |                                      |                  |
7532 |          | l*          |                                      |                  |
7533 +----------+-------------+--------------------------------------+------------------+
7534 | **Body** | **body**\ * | Consumer Object to be created        | string           |
7535 |          | required*   |                                      |                  |
7536 +----------+-------------+--------------------------------------+------------------+
7537
7538 Responses
7539 ~~~~~~~~~
7540
7541 +---------+----------------------------------------------------+----------------+
7542 | HTTP    | Description                                        | Schema         |
7543 | Code    |                                                    |                |
7544 +=========+====================================================+================+
7545 | **201** | Consumer credentials created                       | No Content     |
7546 +---------+----------------------------------------------------+----------------+
7547 | **400** | Invalid content / Missing content                  | No Content     |
7548 +---------+----------------------------------------------------+----------------+
7549 | **403** | Restricted operation                               | No Content     |
7550 +---------+----------------------------------------------------+----------------+
7551
7552 Consumes
7553 ~~~~~~~~
7554
7555 -  ``application/json``
7556
7557 Produces
7558 ~~~~~~~~
7559
7560 -  ``application/json``
7561
7562 Tags
7563 ~~~~
7564
7565 -  Consumer Servlet
7566
7567 Retrieve Consumer
7568 -----------------
7569
7570 ::
7571
7572     GET /v1/consumers/{consumerId}
7573
7574 Description
7575 ~~~~~~~~~~~
7576
7577 Returns consumer according to ConsumerID
7578
7579 Parameters
7580 ~~~~~~~~~~
7581
7582 +------------------+--------------------------+----------------------------------+
7583 | Type             | Name                     | Schema                           |
7584 +==================+==========================+==================================+
7585 | **Header**       | **USER\_ID**\ *optional* | string                           |
7586 +------------------+--------------------------+----------------------------------+
7587 | **Path**         | **consumerId**\ *require | string                           |
7588 |                  | d*                       |                                  |
7589 +------------------+--------------------------+----------------------------------+
7590
7591 Responses
7592 ~~~~~~~~~
7593
7594 +---------+----------------------------------------------------+----------------+
7595 | HTTP    | Description                                        | Schema         |
7596 | Code    |                                                    |                |
7597 +=========+====================================================+================+
7598 | **200** | Consumer found                                     | No Content     |
7599 +---------+----------------------------------------------------+----------------+
7600 | **403** | Restricted operation                               | No Content     |
7601 +---------+----------------------------------------------------+----------------+
7602 | **404** | Consumer not found                                 | No Content     |
7603 +---------+----------------------------------------------------+----------------+
7604
7605 Consumes
7606 ~~~~~~~~
7607
7608 -  ``application/json``
7609
7610 Produces
7611 ~~~~~~~~
7612
7613 -  ``application/json``
7614
7615 Tags
7616 ~~~~
7617
7618 -  Consumer Servlet
7619
7620 Deletes Consumer
7621 ----------------
7622
7623 ::
7624
7625     DELETE /v1/consumers/{consumerId}
7626
7627 Description
7628 ~~~~~~~~~~~
7629
7630 Returns deleted consumer according to ConsumerID
7631
7632 Parameters
7633 ~~~~~~~~~~
7634
7635 +------------------+--------------------------+----------------------------------+
7636 | Type             | Name                     | Schema                           |
7637 +==================+==========================+==================================+
7638 | **Header**       | **USER\_ID**\ *optional* | string                           |
7639 +------------------+--------------------------+----------------------------------+
7640 | **Path**         | **consumerId**\ *require | string                           |
7641 |                  | d*                       |                                  |
7642 +------------------+--------------------------+----------------------------------+
7643
7644 Responses
7645 ~~~~~~~~~
7646
7647 +---------+----------------------------------------------------+----------------+
7648 | HTTP    | Description                                        | Schema         |
7649 | Code    |                                                    |                |
7650 +=========+====================================================+================+
7651 | **200** | successful operation                               | `ConsumerDefin |
7652 |         |                                                    | ition <#_consu |
7653 |         |                                                    | merdefinition> |
7654 |         |                                                    | `__            |
7655 +---------+----------------------------------------------------+----------------+
7656 | **204** | Consumer deleted                                   | No Content     |
7657 +---------+----------------------------------------------------+----------------+
7658 | **403** | Restricted operation                               | No Content     |
7659 +---------+----------------------------------------------------+----------------+
7660 | **404** | Consumer not found                                 | No Content     |
7661 +---------+----------------------------------------------------+----------------+
7662
7663 Consumes
7664 ~~~~~~~~
7665
7666 -  ``application/json``
7667
7668 Produces
7669 ~~~~~~~~
7670
7671 -  ``application/json``
7672
7673 Tags
7674 ~~~~
7675
7676 -  Consumer Servlet
7677
7678 Retrieve ecomp portal menu - MOC
7679 --------------------------------
7680
7681 ::
7682
7683     GET /v1/ecompPortalMenu
7684
7685 Description
7686 ~~~~~~~~~~~
7687
7688 Retrieve ecomp portal menu
7689
7690 Responses
7691 ~~~~~~~~~
7692
7693 +---------+----------------------------------------------------+----------------+
7694 | HTTP    | Description                                        | Schema         |
7695 | Code    |                                                    |                |
7696 +=========+====================================================+================+
7697 | **200** | Retrieve ecomp portal menu                         | No Content     |
7698 +---------+----------------------------------------------------+----------------+
7699
7700 Consumes
7701 ~~~~~~~~
7702
7703 -  ``application/json``
7704
7705 Produces
7706 ~~~~~~~~
7707
7708 -  ``application/json``
7709
7710 Tags
7711 ~~~~
7712
7713 -  Element Servlet
7714
7715 Retrieve all followed
7716 ---------------------
7717
7718 ::
7719
7720     GET /v1/followed
7721
7722 Description
7723 ~~~~~~~~~~~
7724
7725 Retrieve all followed
7726
7727 Parameters
7728 ~~~~~~~~~~
7729
7730 +------------------+--------------------------+----------------------------------+
7731 | Type             | Name                     | Schema                           |
7732 +==================+==========================+==================================+
7733 | **Header**       | **USER\_ID**\ *optional* | string                           |
7734 +------------------+--------------------------+----------------------------------+
7735
7736 Responses
7737 ~~~~~~~~~
7738
7739 +---------+----------------------------------------------------+----------------+
7740 | HTTP    | Description                                        | Schema         |
7741 | Code    |                                                    |                |
7742 +=========+====================================================+================+
7743 | **200** | Returns followed Ok                                | No Content     |
7744 +---------+----------------------------------------------------+----------------+
7745 | **404** | User not found                                     | No Content     |
7746 +---------+----------------------------------------------------+----------------+
7747 | **500** | Internal Server Error                              | No Content     |
7748 +---------+----------------------------------------------------+----------------+
7749
7750 Consumes
7751 ~~~~~~~~
7752
7753 -  ``application/json``
7754
7755 Produces
7756 ~~~~~~~~
7757
7758 -  ``application/json``
7759
7760 Tags
7761 ~~~~
7762
7763 -  Element Servlet
7764
7765 DELETE /v1/inactiveComponents/{componenttype}
7766 ---------------------------------------------
7767
7768 Parameters
7769 ~~~~~~~~~~
7770
7771 +------------------+--------------------------+----------------------------------+
7772 | Type             | Name                     | Schema                           |
7773 +==================+==========================+==================================+
7774 | **Path**         | **componentType**\ *requ | string                           |
7775 |                  | ired*                    |                                  |
7776 +------------------+--------------------------+----------------------------------+
7777
7778 Responses
7779 ~~~~~~~~~
7780
7781 +---------+----------------------------------------------------+----------------+
7782 | HTTP    | Description                                        | Schema         |
7783 | Code    |                                                    |                |
7784 +=========+====================================================+================+
7785 | **defau | successful operation                               | No Content     |
7786 | lt**    |                                                    |                |
7787 +---------+----------------------------------------------------+----------------+
7788
7789 Tags
7790 ~~~~
7791
7792 -  Element Servlet
7793
7794 Retrieve all propertyScopes
7795 ---------------------------
7796
7797 ::
7798
7799     GET /v1/propertyScopes
7800
7801 Description
7802 ~~~~~~~~~~~
7803
7804 Retrieve all propertyScopes
7805
7806 Parameters
7807 ~~~~~~~~~~
7808
7809 +------------------+--------------------------+----------------------------------+
7810 | Type             | Name                     | Schema                           |
7811 +==================+==========================+==================================+
7812 | **Header**       | **USER\_ID**\ *optional* | string                           |
7813 +------------------+--------------------------+----------------------------------+
7814
7815 Responses
7816 ~~~~~~~~~
7817
7818 +---------+----------------------------------------------------+----------------+
7819 | HTTP    | Description                                        | Schema         |
7820 | Code    |                                                    |                |
7821 +=========+====================================================+================+
7822 | **200** | Returns propertyScopes Ok                          | No Content     |
7823 +---------+----------------------------------------------------+----------------+
7824 | **404** | No propertyScopes were found                       | No Content     |
7825 +---------+----------------------------------------------------+----------------+
7826 | **500** | Internal Server Error                              | No Content     |
7827 +---------+----------------------------------------------------+----------------+
7828
7829 Consumes
7830 ~~~~~~~~
7831
7832 -  ``application/json``
7833
7834 Produces
7835 ~~~~~~~~
7836
7837 -  ``application/json``
7838
7839 Tags
7840 ~~~~
7841
7842 -  Element Servlet
7843
7844 Retrieve catalog resources and services
7845 ---------------------------------------
7846
7847 ::
7848
7849     GET /v1/screen
7850
7851 Description
7852 ~~~~~~~~~~~
7853
7854 Retrieve catalog resources and services
7855
7856 Parameters
7857 ~~~~~~~~~~
7858
7859 +------------------+--------------------------+----------------------------------+
7860 | Type             | Name                     | Schema                           |
7861 +==================+==========================+==================================+
7862 | **Header**       | **USER\_ID**\ *optional* | string                           |
7863 +------------------+--------------------------+----------------------------------+
7864 | **Query**        | **excludeTypes**\ *optio | < enum (PRODUCT, SERVICE, VF,    |
7865 |                  | nal*                     | VFC, CP, VL, VFCMT, CVFC, PNF) > |
7866 |                  |                          | array(multi)                     |
7867 +------------------+--------------------------+----------------------------------+
7868
7869 Responses
7870 ~~~~~~~~~
7871
7872 +---------+----------------------------------------------------+----------------+
7873 | HTTP    | Description                                        | Schema         |
7874 | Code    |                                                    |                |
7875 +=========+====================================================+================+
7876 | **200** | Returns resources and services Ok                  | No Content     |
7877 +---------+----------------------------------------------------+----------------+
7878 | **404** | User not found                                     | No Content     |
7879 +---------+----------------------------------------------------+----------------+
7880 | **500** | Internal Server Error                              | No Content     |
7881 +---------+----------------------------------------------------+----------------+
7882
7883 Consumes
7884 ~~~~~~~~
7885
7886 -  ``application/json``
7887
7888 Produces
7889 ~~~~~~~~
7890
7891 -  ``application/json``
7892
7893 Tags
7894 ~~~~
7895
7896 -  Element Servlet
7897
7898 Retrieve all tags
7899 -----------------
7900
7901 ::
7902
7903     GET /v1/tags
7904
7905 Description
7906 ~~~~~~~~~~~
7907
7908 Retrieve all tags
7909
7910 Parameters
7911 ~~~~~~~~~~
7912
7913 +------------------+--------------------------+----------------------------------+
7914 | Type             | Name                     | Schema                           |
7915 +==================+==========================+==================================+
7916 | **Header**       | **USER\_ID**\ *optional* | string                           |
7917 +------------------+--------------------------+----------------------------------+
7918
7919 Responses
7920 ~~~~~~~~~
7921
7922 +---------+----------------------------------------------------+----------------+
7923 | HTTP    | Description                                        | Schema         |
7924 | Code    |                                                    |                |
7925 +=========+====================================================+================+
7926 | **200** | Returns tags Ok                                    | No Content     |
7927 +---------+----------------------------------------------------+----------------+
7928 | **404** | No tags were found                                 | No Content     |
7929 +---------+----------------------------------------------------+----------------+
7930 | **500** | Internal Server Error                              | No Content     |
7931 +---------+----------------------------------------------------+----------------+
7932
7933 Consumes
7934 ~~~~~~~~
7935
7936 -  ``application/json``
7937
7938 Produces
7939 ~~~~~~~~
7940
7941 -  ``application/json``
7942
7943 Tags
7944 ~~~~
7945
7946 -  Element Servlet
7947
7948 add user
7949 --------
7950
7951 ::
7952
7953     POST /v1/user
7954
7955 Description
7956 ~~~~~~~~~~~
7957
7958 Provision new user
7959
7960 Parameters
7961 ~~~~~~~~~~
7962
7963 +----------+-------------+--------------------------------------+------------------+
7964 | Type     | Name        | Description                          | Schema           |
7965 +==========+=============+======================================+==================+
7966 | **Header | **USER\_ID* |                                      | string           |
7967 | **       | *\ *optiona |                                      |                  |
7968 |          | l*          |                                      |                  |
7969 +----------+-------------+--------------------------------------+------------------+
7970 | **Body** | **body**\ * | json describe the user               | string           |
7971 |          | required*   |                                      |                  |
7972 +----------+-------------+--------------------------------------+------------------+
7973
7974 Responses
7975 ~~~~~~~~~
7976
7977 +---------+----------------------------------------------------+----------------+
7978 | HTTP    | Description                                        | Schema         |
7979 | Code    |                                                    |                |
7980 +=========+====================================================+================+
7981 | **200** | successful operation                               | `User <#_user> |
7982 |         |                                                    | `__            |
7983 +---------+----------------------------------------------------+----------------+
7984 | **201** | New user created                                   | No Content     |
7985 +---------+----------------------------------------------------+----------------+
7986 | **400** | Invalid Content.                                   | No Content     |
7987 +---------+----------------------------------------------------+----------------+
7988 | **403** | Missing information                                | No Content     |
7989 +---------+----------------------------------------------------+----------------+
7990 | **405** | Method Not Allowed                                 | No Content     |
7991 +---------+----------------------------------------------------+----------------+
7992 | **409** | User already exists                                | No Content     |
7993 +---------+----------------------------------------------------+----------------+
7994 | **500** | Internal Server Error                              | No Content     |
7995 +---------+----------------------------------------------------+----------------+
7996
7997 Consumes
7998 ~~~~~~~~
7999
8000 -  ``application/json``
8001
8002 Produces
8003 ~~~~~~~~
8004
8005 -  ``application/json``
8006
8007 Tags
8008 ~~~~
8009
8010 -  User Administration
8011
8012 retrieve all administrators
8013 ---------------------------
8014
8015 ::
8016
8017     GET /v1/user/admins
8018
8019 Description
8020 ~~~~~~~~~~~
8021
8022 Returns all administrators
8023
8024 Parameters
8025 ~~~~~~~~~~
8026
8027 +------------------+--------------------------+----------------------------------+
8028 | Type             | Name                     | Schema                           |
8029 +==================+==========================+==================================+
8030 | **Path**         | **userId**\ *required*   | string                           |
8031 +------------------+--------------------------+----------------------------------+
8032
8033 Responses
8034 ~~~~~~~~~
8035
8036 +---------+----------------------------------------------------+----------------+
8037 | HTTP    | Description                                        | Schema         |
8038 | Code    |                                                    |                |
8039 +=========+====================================================+================+
8040 | **200** | Returns user Ok                                    | No Content     |
8041 +---------+----------------------------------------------------+----------------+
8042 | **405** | Method Not Allowed                                 | No Content     |
8043 +---------+----------------------------------------------------+----------------+
8044 | **500** | Internal Server Error                              | No Content     |
8045 +---------+----------------------------------------------------+----------------+
8046
8047 Consumes
8048 ~~~~~~~~
8049
8050 -  ``application/json``
8051
8052 Produces
8053 ~~~~~~~~
8054
8055 -  ``application/json``
8056
8057 Tags
8058 ~~~~
8059
8060 -  User Administration
8061
8062 authorize
8063 ---------
8064
8065 ::
8066
8067     GET /v1/user/authorize
8068
8069 Description
8070 ~~~~~~~~~~~
8071
8072 authorize user
8073
8074 Parameters
8075 ~~~~~~~~~~
8076
8077 +------------------+--------------------------+----------------------------------+
8078 | Type             | Name                     | Schema                           |
8079 +==================+==========================+==================================+
8080 | **Header**       | **HTTP\_CSP\_EMAIL**\ *o | string                           |
8081 |                  | ptional*                 |                                  |
8082 +------------------+--------------------------+----------------------------------+
8083 | **Header**       | **HTTP\_CSP\_FIRSTNAME** | string                           |
8084 |                  | \ *optional*             |                                  |
8085 +------------------+--------------------------+----------------------------------+
8086 | **Header**       | **HTTP\_CSP\_LASTNAME**\ | string                           |
8087 |                  |  *optional*              |                                  |
8088 +------------------+--------------------------+----------------------------------+
8089 | **Header**       | **USER\_ID**\ *optional* | string                           |
8090 +------------------+--------------------------+----------------------------------+
8091
8092 Responses
8093 ~~~~~~~~~
8094
8095 +---------+----------------------------------------------------+----------------+
8096 | HTTP    | Description                                        | Schema         |
8097 | Code    |                                                    |                |
8098 +=========+====================================================+================+
8099 | **200** | Returns user Ok                                    | No Content     |
8100 +---------+----------------------------------------------------+----------------+
8101 | **403** | Restricted Access                                  | No Content     |
8102 +---------+----------------------------------------------------+----------------+
8103 | **500** | Internal Server Error                              | No Content     |
8104 +---------+----------------------------------------------------+----------------+
8105
8106 Consumes
8107 ~~~~~~~~
8108
8109 -  ``application/json``
8110
8111 Produces
8112 ~~~~~~~~
8113
8114 -  ``application/json``
8115
8116 Tags
8117 ~~~~
8118
8119 -  User Administration
8120
8121 Retrieve the list of all active ASDC users or only group of users having specific roles.
8122 ----------------------------------------------------------------------------------------
8123
8124 ::
8125
8126     GET /v1/user/users
8127
8128 Description
8129 ~~~~~~~~~~~
8130
8131 Returns list of users with the specified roles, or all of users in the
8132 case of empty *roles* header
8133
8134 Parameters
8135 ~~~~~~~~~~
8136
8137 +----------+-------------+--------------------------------------+------------------+
8138 | Type     | Name        | Description                          | Schema           |
8139 +==========+=============+======================================+==================+
8140 | **Header | **USER\_ID* | Any active user’s USER\_ID           | string           |
8141 | **       | *\ *optiona |                                      |                  |
8142 |          | l*          |                                      |                  |
8143 +----------+-------------+--------------------------------------+------------------+
8144 | **Query* | **roles**\  | TESTER,DESIGNER,PRODUCT\_STRATEGIST, | string           |
8145 | *        | *optional*  | OPS,PRODUCT\_MANAGER,GOVERNOR,       |                  |
8146 |          |             | ADMIN OR all users by not typing     |                  |
8147 |          |             | anything                             |                  |
8148 +----------+-------------+--------------------------------------+------------------+
8149
8150 Responses
8151 ~~~~~~~~~
8152
8153 +---------+----------------------------------------------------+----------------+
8154 | HTTP    | Description                                        | Schema         |
8155 | Code    |                                                    |                |
8156 +=========+====================================================+================+
8157 | **200** | Returns users Ok                                   | No Content     |
8158 +---------+----------------------------------------------------+----------------+
8159 | **204** | No provisioned ASDC users of requested role        | No Content     |
8160 +---------+----------------------------------------------------+----------------+
8161 | **400** | Missing content                                    | No Content     |
8162 +---------+----------------------------------------------------+----------------+
8163 | **403** | Restricted Access                                  | No Content     |
8164 +---------+----------------------------------------------------+----------------+
8165 | **500** | Internal Server Error                              | No Content     |
8166 +---------+----------------------------------------------------+----------------+
8167
8168 Consumes
8169 ~~~~~~~~
8170
8171 -  ``application/json``
8172
8173 Produces
8174 ~~~~~~~~
8175
8176 -  ``application/json``
8177
8178 Tags
8179 ~~~~
8180
8181 -  User Administration
8182
8183 retrieve user details
8184 ---------------------
8185
8186 ::
8187
8188     GET /v1/user/{userId}
8189
8190 Description
8191 ~~~~~~~~~~~
8192
8193 Returns user details according to userId
8194
8195 Parameters
8196 ~~~~~~~~~~
8197
8198 +----------+-------------+--------------------------------------+------------------+
8199 | Type     | Name        | Description                          | Schema           |
8200 +==========+=============+======================================+==================+
8201 | **Path** | **userId**\ | userId of user to get                | string           |
8202 |          |  *required* |                                      |                  |
8203 +----------+-------------+--------------------------------------+------------------+
8204
8205 Responses
8206 ~~~~~~~~~
8207
8208 +---------+----------------------------------------------------+----------------+
8209 | HTTP    | Description                                        | Schema         |
8210 | Code    |                                                    |                |
8211 +=========+====================================================+================+
8212 | **200** | Returns user Ok                                    | No Content     |
8213 +---------+----------------------------------------------------+----------------+
8214 | **404** | User not found                                     | No Content     |
8215 +---------+----------------------------------------------------+----------------+
8216 | **405** | Method Not Allowed                                 | No Content     |
8217 +---------+----------------------------------------------------+----------------+
8218 | **500** | Internal Server Error                              | No Content     |
8219 +---------+----------------------------------------------------+----------------+
8220
8221 Consumes
8222 ~~~~~~~~
8223
8224 -  ``application/json``
8225
8226 Produces
8227 ~~~~~~~~
8228
8229 -  ``application/json``
8230
8231 Tags
8232 ~~~~
8233
8234 -  User Administration
8235
8236 delete user
8237 -----------
8238
8239 ::
8240
8241     DELETE /v1/user/{userId}
8242
8243 Description
8244 ~~~~~~~~~~~
8245
8246 Delete user
8247
8248 Parameters
8249 ~~~~~~~~~~
8250
8251 +----------+-------------+--------------------------------------+------------------+
8252 | Type     | Name        | Description                          | Schema           |
8253 +==========+=============+======================================+==================+
8254 | **Header | **USER\_ID* |                                      | string           |
8255 | **       | *\ *optiona |                                      |                  |
8256 |          | l*          |                                      |                  |
8257 +----------+-------------+--------------------------------------+------------------+
8258 | **Path** | **userId**\ | userId of user to get                | string           |
8259 |          |  *required* |                                      |                  |
8260 +----------+-------------+--------------------------------------+------------------+
8261
8262 Responses
8263 ~~~~~~~~~
8264
8265 +---------+----------------------------------------------------+----------------+
8266 | HTTP    | Description                                        | Schema         |
8267 | Code    |                                                    |                |
8268 +=========+====================================================+================+
8269 | **200** | Update deleted OK                                  | No Content     |
8270 +---------+----------------------------------------------------+----------------+
8271 | **400** | Invalid Content.                                   | No Content     |
8272 +---------+----------------------------------------------------+----------------+
8273 | **403** | Missing information                                | No Content     |
8274 +---------+----------------------------------------------------+----------------+
8275 | **404** | User not found                                     | No Content     |
8276 +---------+----------------------------------------------------+----------------+
8277 | **405** | Method Not Allowed                                 | No Content     |
8278 +---------+----------------------------------------------------+----------------+
8279 | **409** | Restricted operation                               | No Content     |
8280 +---------+----------------------------------------------------+----------------+
8281 | **500** | Internal Server Error                              | No Content     |
8282 +---------+----------------------------------------------------+----------------+
8283
8284 Consumes
8285 ~~~~~~~~
8286
8287 -  ``application/json``
8288
8289 Produces
8290 ~~~~~~~~
8291
8292 -  ``application/json``
8293
8294 Tags
8295 ~~~~
8296
8297 -  User Administration
8298
8299 update user role
8300 ----------------
8301
8302 ::
8303
8304     POST /v1/user/{userId}/role
8305
8306 Description
8307 ~~~~~~~~~~~
8308
8309 Update user role
8310
8311 Parameters
8312 ~~~~~~~~~~
8313
8314 +----------+-------------+--------------------------------------+------------------+
8315 | Type     | Name        | Description                          | Schema           |
8316 +==========+=============+======================================+==================+
8317 | **Header | **USER\_ID* |                                      | string           |
8318 | **       | *\ *optiona |                                      |                  |
8319 |          | l*          |                                      |                  |
8320 +----------+-------------+--------------------------------------+------------------+
8321 | **Path** | **userId**\ | userId of user to get                | string           |
8322 |          |  *required* |                                      |                  |
8323 +----------+-------------+--------------------------------------+------------------+
8324 | **Body** | **body**\ * | json describe the update role        | string           |
8325 |          | required*   |                                      |                  |
8326 +----------+-------------+--------------------------------------+------------------+
8327
8328 Responses
8329 ~~~~~~~~~
8330
8331 +---------+----------------------------------------------------+----------------+
8332 | HTTP    | Description                                        | Schema         |
8333 | Code    |                                                    |                |
8334 +=========+====================================================+================+
8335 | **200** | Update user OK                                     | No Content     |
8336 +---------+----------------------------------------------------+----------------+
8337 | **400** | Invalid Content.                                   | No Content     |
8338 +---------+----------------------------------------------------+----------------+
8339 | **403** | Missing information/Restricted operation           | No Content     |
8340 +---------+----------------------------------------------------+----------------+
8341 | **404** | User not found                                     | No Content     |
8342 +---------+----------------------------------------------------+----------------+
8343 | **405** | Method Not Allowed                                 | No Content     |
8344 +---------+----------------------------------------------------+----------------+
8345 | **409** | User already exists                                | No Content     |
8346 +---------+----------------------------------------------------+----------------+
8347 | **500** | Internal Server Error                              | No Content     |
8348 +---------+----------------------------------------------------+----------------+
8349
8350 Consumes
8351 ~~~~~~~~
8352
8353 -  ``application/json``
8354
8355 Produces
8356 ~~~~~~~~
8357
8358 -  ``application/json``
8359
8360 Tags
8361 ~~~~
8362
8363 -  User Administration
8364
8365 retrieve user role
8366 ------------------
8367
8368 ::
8369
8370     GET /v1/user/{userId}/role
8371
8372 Description
8373 ~~~~~~~~~~~
8374
8375 Returns user role according to userId
8376
8377 Parameters
8378 ~~~~~~~~~~
8379
8380 +----------+-------------+--------------------------------------+------------------+
8381 | Type     | Name        | Description                          | Schema           |
8382 +==========+=============+======================================+==================+
8383 | **Path** | **userId**\ | userId of user to get                | string           |
8384 |          |  *required* |                                      |                  |
8385 +----------+-------------+--------------------------------------+------------------+
8386
8387 Responses
8388 ~~~~~~~~~
8389
8390 +---------+----------------------------------------------------+----------------+
8391 | HTTP    | Description                                        | Schema         |
8392 | Code    |                                                    |                |
8393 +=========+====================================================+================+
8394 | **200** | Returns user role Ok                               | No Content     |
8395 +---------+----------------------------------------------------+----------------+
8396 | **404** | User not found                                     | No Content     |
8397 +---------+----------------------------------------------------+----------------+
8398 | **405** | Method Not Allowed                                 | No Content     |
8399 +---------+----------------------------------------------------+----------------+
8400 | **500** | Internal Server Error                              | No Content     |
8401 +---------+----------------------------------------------------+----------------+
8402
8403 Consumes
8404 ~~~~~~~~
8405
8406 -  ``application/json``
8407
8408 Produces
8409 ~~~~~~~~
8410
8411 -  ``application/json``
8412
8413 Tags
8414 ~~~~
8415
8416 -  User Administration
8417
8418 return the ASDC application version
8419 -----------------------------------
8420
8421 ::
8422
8423     GET /version
8424
8425 Description
8426 ~~~~~~~~~~~
8427
8428 return the ASDC application version
8429
8430 Responses
8431 ~~~~~~~~~
8432
8433 +---------+----------------------------------------------------+----------------+
8434 | HTTP    | Description                                        | Schema         |
8435 | Code    |                                                    |                |
8436 +=========+====================================================+================+
8437 | **200** | return ASDC version                                | No Content     |
8438 +---------+----------------------------------------------------+----------------+
8439 | **500** | Internal Error                                     | No Content     |
8440 +---------+----------------------------------------------------+----------------+
8441
8442 Consumes
8443 ~~~~~~~~
8444
8445 -  ``application/json``
8446
8447 Produces
8448 ~~~~~~~~
8449
8450 -  ``application/json``
8451
8452 Tags
8453 ~~~~
8454
8455 -  BE Monitoring
8456
8457 Definitions
8458 ===========
8459
8460 AdditionalInfoParameterInfo
8461 ---------------------------
8462
8463 +--------------------------------+-------------------------------------------+
8464 | Name                           | Schema                                    |
8465 +================================+===========================================+
8466 | **key**\ *optional*            | string                                    |
8467 +--------------------------------+-------------------------------------------+
8468 | **ownerId**\ *optional*        | string                                    |
8469 +--------------------------------+-------------------------------------------+
8470 | **uniqueId**\ *optional*       | string                                    |
8471 +--------------------------------+-------------------------------------------+
8472 | **value**\ *optional*          | string                                    |
8473 +--------------------------------+-------------------------------------------+
8474
8475 AdditionalInformationDefinition
8476 -------------------------------
8477
8478 +--------------------------------+-------------------------------------------+
8479 | Name                           | Schema                                    |
8480 +================================+===========================================+
8481 | **creationTime**\ *optional*   | integer (int64)                           |
8482 +--------------------------------+-------------------------------------------+
8483 | **lastCreatedCounter**\ *optio | integer (int32)                           |
8484 | nal*                           |                                           |
8485 +--------------------------------+-------------------------------------------+
8486 | **modificationTime**\ *optiona | integer (int64)                           |
8487 | l*                             |                                           |
8488 +--------------------------------+-------------------------------------------+
8489 | **ownerId**\ *optional*        | string                                    |
8490 +--------------------------------+-------------------------------------------+
8491 | **parameters**\ *optional*     | <                                         |
8492 |                                | `AdditionalInfoParameterInfo <#_additiona |
8493 |                                | linfoparameterinfo>`__                    |
8494 |                                | > array                                   |
8495 +--------------------------------+-------------------------------------------+
8496 | **parentUniqueId**\ *optional* | string                                    |
8497 +--------------------------------+-------------------------------------------+
8498 | **uniqueId**\ *optional*       | string                                    |
8499 +--------------------------------+-------------------------------------------+
8500
8501 ArtifactDataDefinition
8502 ----------------------
8503
8504 +--------------------------------+-------------------------------------------+
8505 | Name                           | Schema                                    |
8506 +================================+===========================================+
8507 | **apiUrl**\ *optional*         | string                                    |
8508 +--------------------------------+-------------------------------------------+
8509 | **artifactChecksum**\ *optiona | string                                    |
8510 | l*                             |                                           |
8511 +--------------------------------+-------------------------------------------+
8512 | **artifactCreator**\ *optional | string                                    |
8513 | *                              |                                           |
8514 +--------------------------------+-------------------------------------------+
8515 | **artifactDisplayName**\ *opti | string                                    |
8516 | onal*                          |                                           |
8517 +--------------------------------+-------------------------------------------+
8518 | **artifactGroupType**\ *option | enum (INFORMATIONAL, DEPLOYMENT,          |
8519 | al*                            | LIFE\_CYCLE, SERVICE\_API, TOSCA, OTHER)  |
8520 +--------------------------------+-------------------------------------------+
8521 | **artifactLabel**\ *optional*  | string                                    |
8522 +--------------------------------+-------------------------------------------+
8523 | **artifactName**\ *optional*   | string                                    |
8524 +--------------------------------+-------------------------------------------+
8525 | **artifactRef**\ *optional*    | string                                    |
8526 +--------------------------------+-------------------------------------------+
8527 | **artifactRepository**\ *optio | string                                    |
8528 | nal*                           |                                           |
8529 +--------------------------------+-------------------------------------------+
8530 | **artifactType**\ *optional*   | string                                    |
8531 +--------------------------------+-------------------------------------------+
8532 | **artifactUUID**\ *optional*   | string                                    |
8533 +--------------------------------+-------------------------------------------+
8534 | **artifactVersion**\ *optional | string                                    |
8535 | *                              |                                           |
8536 +--------------------------------+-------------------------------------------+
8537 | **creationDate**\ *optional*   | integer (int64)                           |
8538 +--------------------------------+-------------------------------------------+
8539 | **creatorFullName**\ *optional | string                                    |
8540 | *                              |                                           |
8541 +--------------------------------+-------------------------------------------+
8542 | **description**\ *optional*    | string                                    |
8543 +--------------------------------+-------------------------------------------+
8544 | **duplicated**\ *optional*     | boolean                                   |
8545 +--------------------------------+-------------------------------------------+
8546 | **esId**\ *optional*           | string                                    |
8547 +--------------------------------+-------------------------------------------+
8548 | **generated**\ *optional*      | boolean                                   |
8549 +--------------------------------+-------------------------------------------+
8550 | **generatedFromId**\ *optional | string                                    |
8551 | *                              |                                           |
8552 +--------------------------------+-------------------------------------------+
8553 | **heatParameters**\ *optional* | <                                         |
8554 |                                | `HeatParameterDataDefinition <#_heatparam |
8555 |                                | eterdatadefinition>`__                    |
8556 |                                | > array                                   |
8557 +--------------------------------+-------------------------------------------+
8558 | **heatParamsUpdateDate**\ *opt | integer (int64)                           |
8559 | ional*                         |                                           |
8560 +--------------------------------+-------------------------------------------+
8561 | **lastUpdateDate**\ *optional* | integer (int64)                           |
8562 +--------------------------------+-------------------------------------------+
8563 | **mandatory**\ *optional*      | boolean                                   |
8564 +--------------------------------+-------------------------------------------+
8565 | **ownerId**\ *optional*        | string                                    |
8566 +--------------------------------+-------------------------------------------+
8567 | **payloadUpdateDate**\ *option | integer (int64)                           |
8568 | al*                            |                                           |
8569 +--------------------------------+-------------------------------------------+
8570 | **requiredArtifacts**\ *option | < string > array                          |
8571 | al*                            |                                           |
8572 +--------------------------------+-------------------------------------------+
8573 | **serviceApi**\ *optional*     | boolean                                   |
8574 +--------------------------------+-------------------------------------------+
8575 | **timeout**\ *optional*        | integer (int32)                           |
8576 +--------------------------------+-------------------------------------------+
8577 | **uniqueId**\ *optional*       | string                                    |
8578 +--------------------------------+-------------------------------------------+
8579 | **updaterFullName**\ *optional | string                                    |
8580 | *                              |                                           |
8581 +--------------------------------+-------------------------------------------+
8582 | **userIdCreator**\ *optional*  | string                                    |
8583 +--------------------------------+-------------------------------------------+
8584 | **userIdLastUpdater**\ *option | string                                    |
8585 | al*                            |                                           |
8586 +--------------------------------+-------------------------------------------+
8587
8588 ArtifactDefinition
8589 ------------------
8590
8591 +--------------------------------+-------------------------------------------+
8592 | Name                           | Schema                                    |
8593 +================================+===========================================+
8594 | **apiUrl**\ *optional*         | string                                    |
8595 +--------------------------------+-------------------------------------------+
8596 | **artifactChecksum**\ *optiona | string                                    |
8597 | l*                             |                                           |
8598 +--------------------------------+-------------------------------------------+
8599 | **artifactCreator**\ *optional | string                                    |
8600 | *                              |                                           |
8601 +--------------------------------+-------------------------------------------+
8602 | **artifactDisplayName**\ *opti | string                                    |
8603 | onal*                          |                                           |
8604 +--------------------------------+-------------------------------------------+
8605 | **artifactGroupType**\ *option | enum (INFORMATIONAL, DEPLOYMENT,          |
8606 | al*                            | LIFE\_CYCLE, SERVICE\_API, TOSCA, OTHER)  |
8607 +--------------------------------+-------------------------------------------+
8608 | **artifactLabel**\ *optional*  | string                                    |
8609 +--------------------------------+-------------------------------------------+
8610 | **artifactName**\ *optional*   | string                                    |
8611 +--------------------------------+-------------------------------------------+
8612 | **artifactRef**\ *optional*    | string                                    |
8613 +--------------------------------+-------------------------------------------+
8614 | **artifactRepository**\ *optio | string                                    |
8615 | nal*                           |                                           |
8616 +--------------------------------+-------------------------------------------+
8617 | **artifactType**\ *optional*   | string                                    |
8618 +--------------------------------+-------------------------------------------+
8619 | **artifactUUID**\ *optional*   | string                                    |
8620 +--------------------------------+-------------------------------------------+
8621 | **artifactVersion**\ *optional | string                                    |
8622 | *                              |                                           |
8623 +--------------------------------+-------------------------------------------+
8624 | **creationDate**\ *optional*   | integer (int64)                           |
8625 +--------------------------------+-------------------------------------------+
8626 | **creatorFullName**\ *optional | string                                    |
8627 | *                              |                                           |
8628 +--------------------------------+-------------------------------------------+
8629 | **description**\ *optional*    | string                                    |
8630 +--------------------------------+-------------------------------------------+
8631 | **duplicated**\ *optional*     | boolean                                   |
8632 +--------------------------------+-------------------------------------------+
8633 | **esId**\ *optional*           | string                                    |
8634 +--------------------------------+-------------------------------------------+
8635 | **generated**\ *optional*      | boolean                                   |
8636 +--------------------------------+-------------------------------------------+
8637 | **generatedFromId**\ *optional | string                                    |
8638 | *                              |                                           |
8639 +--------------------------------+-------------------------------------------+
8640 | **heatParameters**\ *optional* | <                                         |
8641 |                                | `HeatParameterDataDefinition <#_heatparam |
8642 |                                | eterdatadefinition>`__                    |
8643 |                                | > array                                   |
8644 +--------------------------------+-------------------------------------------+
8645 | **heatParamsUpdateDate**\ *opt | integer (int64)                           |
8646 | ional*                         |                                           |
8647 +--------------------------------+-------------------------------------------+
8648 | **lastUpdateDate**\ *optional* | integer (int64)                           |
8649 +--------------------------------+-------------------------------------------+
8650 | **listHeatParameters**\ *optio | <                                         |
8651 | nal*                           | `HeatParameterDefinition <#_heatparameter |
8652 |                                | definition>`__                            |
8653 |                                | > array                                   |
8654 +--------------------------------+-------------------------------------------+
8655 | **mandatory**\ *optional*      | boolean                                   |
8656 +--------------------------------+-------------------------------------------+
8657 | **ownerId**\ *optional*        | string                                    |
8658 +--------------------------------+-------------------------------------------+
8659 | **payloadData**\ *optional*    | < string (byte) > array                   |
8660 +--------------------------------+-------------------------------------------+
8661 | **payloadUpdateDate**\ *option | integer (int64)                           |
8662 | al*                            |                                           |
8663 +--------------------------------+-------------------------------------------+
8664 | **requiredArtifacts**\ *option | < string > array                          |
8665 | al*                            |                                           |
8666 +--------------------------------+-------------------------------------------+
8667 | **serviceApi**\ *optional*     | boolean                                   |
8668 +--------------------------------+-------------------------------------------+
8669 | **timeout**\ *optional*        | integer (int32)                           |
8670 +--------------------------------+-------------------------------------------+
8671 | **uniqueId**\ *optional*       | string                                    |
8672 +--------------------------------+-------------------------------------------+
8673 | **updaterFullName**\ *optional | string                                    |
8674 | *                              |                                           |
8675 +--------------------------------+-------------------------------------------+
8676 | **userIdCreator**\ *optional*  | string                                    |
8677 +--------------------------------+-------------------------------------------+
8678 | **userIdLastUpdater**\ *option | string                                    |
8679 | al*                            |                                           |
8680 +--------------------------------+-------------------------------------------+
8681
8682 CapabilityDefinition
8683 --------------------
8684
8685 +--------------------------------+-------------------------------------------+
8686 | Name                           | Schema                                    |
8687 +================================+===========================================+
8688 | **capabilitySources**\ *option | < string > array                          |
8689 | al*                            |                                           |
8690 +--------------------------------+-------------------------------------------+
8691 | **description**\ *optional*    | string                                    |
8692 +--------------------------------+-------------------------------------------+
8693 | **leftOccurrences**\ *optional | string                                    |
8694 | *                              |                                           |
8695 +--------------------------------+-------------------------------------------+
8696 | **maxOccurrences**\ *optional* | string                                    |
8697 +--------------------------------+-------------------------------------------+
8698 | **minOccurrences**\ *optional* | string                                    |
8699 +--------------------------------+-------------------------------------------+
8700 | **name**\ *optional*           | string                                    |
8701 +--------------------------------+-------------------------------------------+
8702 | **ownerId**\ *optional*        | string                                    |
8703 +--------------------------------+-------------------------------------------+
8704 | **ownerName**\ *optional*      | string                                    |
8705 +--------------------------------+-------------------------------------------+
8706 | **parentName**\ *optional*     | string                                    |
8707 +--------------------------------+-------------------------------------------+
8708 | **path**\ *optional*           | < string > array                          |
8709 +--------------------------------+-------------------------------------------+
8710 | **properties**\ *optional*     | <                                         |
8711 |                                | `ComponentInstanceProperty <#_componentin |
8712 |                                | stanceproperty>`__                        |
8713 |                                | > array                                   |
8714 +--------------------------------+-------------------------------------------+
8715 | **source**\ *optional*         | string                                    |
8716 +--------------------------------+-------------------------------------------+
8717 | **type**\ *optional*           | string                                    |
8718 +--------------------------------+-------------------------------------------+
8719 | **uniqueId**\ *optional*       | string                                    |
8720 +--------------------------------+-------------------------------------------+
8721 | **validSourceTypes**\ *optiona | < string > array                          |
8722 | l*                             |                                           |
8723 +--------------------------------+-------------------------------------------+
8724
8725 Category
8726 --------
8727
8728 +--------------------------------+-------------------------------------------+
8729 | Name                           | Schema                                    |
8730 +================================+===========================================+
8731 | **name**\ *optional*           | string                                    |
8732 +--------------------------------+-------------------------------------------+
8733
8734 CategoryDefinition
8735 ------------------
8736
8737 +--------------------------------+-------------------------------------------+
8738 | Name                           | Schema                                    |
8739 +================================+===========================================+
8740 | **icons**\ *optional*          | < string > array                          |
8741 +--------------------------------+-------------------------------------------+
8742 | **name**\ *optional*           | string                                    |
8743 +--------------------------------+-------------------------------------------+
8744 | **normalizedName**\ *optional* | string                                    |
8745 +--------------------------------+-------------------------------------------+
8746 | **ownerId**\ *optional*        | string                                    |
8747 +--------------------------------+-------------------------------------------+
8748 | **subcategories**\ *optional*  | <                                         |
8749 |                                | `SubCategoryDefinition <#_subcategorydefi |
8750 |                                | nition>`__                                |
8751 |                                | > array                                   |
8752 +--------------------------------+-------------------------------------------+
8753 | **uniqueId**\ *optional*       | string                                    |
8754 +--------------------------------+-------------------------------------------+
8755
8756 ComponentInstance
8757 -----------------
8758
8759 +--------------------------------+-------------------------------------------+
8760 | Name                           | Schema                                    |
8761 +================================+===========================================+
8762 | **artifacts**\ *optional*      | < string,                                 |
8763 |                                | `ArtifactDefinition <#_artifactdefinition |
8764 |                                | >`__                                      |
8765 |                                | > map                                     |
8766 +--------------------------------+-------------------------------------------+
8767 | **attributeValueCounter**\ *op | integer (int32)                           |
8768 | tional*                        |                                           |
8769 +--------------------------------+-------------------------------------------+
8770 | **capabilities**\ *optional*   | < string, <                               |
8771 |                                | `CapabilityDefinition <#_capabilitydefini |
8772 |                                | tion>`__                                  |
8773 |                                | > array > map                             |
8774 +--------------------------------+-------------------------------------------+
8775 | **componentName**\ *optional*  | string                                    |
8776 +--------------------------------+-------------------------------------------+
8777 | **componentUid**\ *optional*   | string                                    |
8778 +--------------------------------+-------------------------------------------+
8779 | **componentVersion**\ *optiona | string                                    |
8780 | l*                             |                                           |
8781 +--------------------------------+-------------------------------------------+
8782 | **creationTime**\ *optional*   | integer (int64)                           |
8783 +--------------------------------+-------------------------------------------+
8784 | **customizationUUID**\ *option | string                                    |
8785 | al*                            |                                           |
8786 +--------------------------------+-------------------------------------------+
8787 | **deploymentArtifacts**\ *opti | < string,                                 |
8788 | onal*                          | `ArtifactDefinition <#_artifactdefinition |
8789 |                                | >`__                                      |
8790 |                                | > map                                     |
8791 +--------------------------------+-------------------------------------------+
8792 | **description**\ *optional*    | string                                    |
8793 +--------------------------------+-------------------------------------------+
8794 | **groupInstances**\ *optional* | < `GroupInstance <#_groupinstance>`__ >   |
8795 |                                | array                                     |
8796 +--------------------------------+-------------------------------------------+
8797 | **icon**\ *optional*           | string                                    |
8798 +--------------------------------+-------------------------------------------+
8799 | **inputValueCounter**\ *option | integer (int32)                           |
8800 | al*                            |                                           |
8801 +--------------------------------+-------------------------------------------+
8802 | **invariantName**\ *optional*  | string                                    |
8803 +--------------------------------+-------------------------------------------+
8804 | **modificationTime**\ *optiona | integer (int64)                           |
8805 | l*                             |                                           |
8806 +--------------------------------+-------------------------------------------+
8807 | **name**\ *optional*           | string                                    |
8808 +--------------------------------+-------------------------------------------+
8809 | **normalizedName**\ *optional* | string                                    |
8810 +--------------------------------+-------------------------------------------+
8811 | **originType**\ *optional*     | enum (PRODUCT, SERVICE, VF, VFC, CP, VL,  |
8812 |                                | VFCMT, CVFC, PNF)                         |
8813 +--------------------------------+-------------------------------------------+
8814 | **ownerId**\ *optional*        | string                                    |
8815 +--------------------------------+-------------------------------------------+
8816 | **posX**\ *optional*           | string                                    |
8817 +--------------------------------+-------------------------------------------+
8818 | **posY**\ *optional*           | string                                    |
8819 +--------------------------------+-------------------------------------------+
8820 | **propertyValueCounter**\ *opt | integer (int32)                           |
8821 | ional*                         |                                           |
8822 +--------------------------------+-------------------------------------------+
8823 | **requirements**\ *optional*   | < string, <                               |
8824 |                                | `RequirementDefinition <#_requirementdefi |
8825 |                                | nition>`__                                |
8826 |                                | > array > map                             |
8827 +--------------------------------+-------------------------------------------+
8828 | **toscaComponentName**\ *optio | string                                    |
8829 | nal*                           |                                           |
8830 +--------------------------------+-------------------------------------------+
8831 | **uniqueId**\ *optional*       | string                                    |
8832 +--------------------------------+-------------------------------------------+
8833
8834 ComponentInstanceInput
8835 ----------------------
8836
8837 +--------------------------------+-------------------------------------------+
8838 | Name                           | Schema                                    |
8839 +================================+===========================================+
8840 | **componentInstanceId**\ *opti | string                                    |
8841 | onal*                          |                                           |
8842 +--------------------------------+-------------------------------------------+
8843 | **componentInstanceName**\ *op | string                                    |
8844 | tional*                        |                                           |
8845 +--------------------------------+-------------------------------------------+
8846 | **constraints**\ *optional*    | <                                         |
8847 |                                | `PropertyConstraint <#_propertyconstraint |
8848 |                                | >`__                                      |
8849 |                                | > array                                   |
8850 +--------------------------------+-------------------------------------------+
8851 | **defaultValue**\ *optional*   | string                                    |
8852 +--------------------------------+-------------------------------------------+
8853 | **definition**\ *optional*     | boolean                                   |
8854 +--------------------------------+-------------------------------------------+
8855 | **description**\ *optional*    | string                                    |
8856 +--------------------------------+-------------------------------------------+
8857 | **getInputValues**\ *optional* | <                                         |
8858 |                                | `GetInputValueDataDefinition <#_getinputv |
8859 |                                | aluedatadefinition>`__                    |
8860 |                                | > array                                   |
8861 +--------------------------------+-------------------------------------------+
8862 | **hidden**\ *optional*         | boolean                                   |
8863 +--------------------------------+-------------------------------------------+
8864 | **immutable**\ *optional*      | boolean                                   |
8865 +--------------------------------+-------------------------------------------+
8866 | **inputId**\ *optional*        | string                                    |
8867 +--------------------------------+-------------------------------------------+
8868 | **inputPath**\ *optional*      | string                                    |
8869 +--------------------------------+-------------------------------------------+
8870 | **inputs**\ *optional*         | <                                         |
8871 |                                | `ComponentInstanceInput <#_componentinsta |
8872 |                                | nceinput>`__                              |
8873 |                                | > array                                   |
8874 +--------------------------------+-------------------------------------------+
8875 | **instanceUniqueId**\ *optiona | string                                    |
8876 | l*                             |                                           |
8877 +--------------------------------+-------------------------------------------+
8878 | **label**\ *optional*          | string                                    |
8879 +--------------------------------+-------------------------------------------+
8880 | **name**\ *optional*           | string                                    |
8881 +--------------------------------+-------------------------------------------+
8882 | **ownerId**\ *optional*        | string                                    |
8883 +--------------------------------+-------------------------------------------+
8884 | **parentUniqueId**\ *optional* | string                                    |
8885 +--------------------------------+-------------------------------------------+
8886 | **password**\ *optional*       | boolean                                   |
8887 +--------------------------------+-------------------------------------------+
8888 | **path**\ *optional*           | < string > array                          |
8889 +--------------------------------+-------------------------------------------+
8890 | **properties**\ *optional*     | <                                         |
8891 |                                | `ComponentInstanceProperty <#_componentin |
8892 |                                | stanceproperty>`__                        |
8893 |                                | > array                                   |
8894 +--------------------------------+-------------------------------------------+
8895 | **propertyId**\ *optional*     | string                                    |
8896 +--------------------------------+-------------------------------------------+
8897 | **required**\ *optional*       | boolean                                   |
8898 +--------------------------------+-------------------------------------------+
8899 | **rules**\ *optional*          | < `PropertyRule <#_propertyrule>`__ >     |
8900 |                                | array                                     |
8901 +--------------------------------+-------------------------------------------+
8902 | **schema**\ *optional*         | `SchemaDefinition <#_schemadefinition>`__ |
8903 +--------------------------------+-------------------------------------------+
8904 | **status**\ *optional*         | string                                    |
8905 +--------------------------------+-------------------------------------------+
8906 | **type**\ *optional*           | string                                    |
8907 +--------------------------------+-------------------------------------------+
8908 | **uniqueId**\ *optional*       | string                                    |
8909 +--------------------------------+-------------------------------------------+
8910 | **value**\ *optional*          | string                                    |
8911 +--------------------------------+-------------------------------------------+
8912 | **valueUniqueUid**\ *optional* | string                                    |
8913 +--------------------------------+-------------------------------------------+
8914
8915 ComponentInstanceProperty
8916 -------------------------
8917
8918 +--------------------------------+-------------------------------------------+
8919 | Name                           | Schema                                    |
8920 +================================+===========================================+
8921 | **componentInstanceId**\ *opti | string                                    |
8922 | onal*                          |                                           |
8923 +--------------------------------+-------------------------------------------+
8924 | **componentInstanceName**\ *op | string                                    |
8925 | tional*                        |                                           |
8926 +--------------------------------+-------------------------------------------+
8927 | **constraints**\ *optional*    | <                                         |
8928 |                                | `PropertyConstraint <#_propertyconstraint |
8929 |                                | >`__                                      |
8930 |                                | > array                                   |
8931 +--------------------------------+-------------------------------------------+
8932 | **defaultValue**\ *optional*   | string                                    |
8933 +--------------------------------+-------------------------------------------+
8934 | **definition**\ *optional*     | boolean                                   |
8935 +--------------------------------+-------------------------------------------+
8936 | **description**\ *optional*    | string                                    |
8937 +--------------------------------+-------------------------------------------+
8938 | **getInputValues**\ *optional* | <                                         |
8939 |                                | `GetInputValueDataDefinition <#_getinputv |
8940 |                                | aluedatadefinition>`__                    |
8941 |                                | > array                                   |
8942 +--------------------------------+-------------------------------------------+
8943 | **hidden**\ *optional*         | boolean                                   |
8944 +--------------------------------+-------------------------------------------+
8945 | **immutable**\ *optional*      | boolean                                   |
8946 +--------------------------------+-------------------------------------------+
8947 | **inputId**\ *optional*        | string                                    |
8948 +--------------------------------+-------------------------------------------+
8949 | **inputPath**\ *optional*      | string                                    |
8950 +--------------------------------+-------------------------------------------+
8951 | **instanceUniqueId**\ *optiona | string                                    |
8952 | l*                             |                                           |
8953 +--------------------------------+-------------------------------------------+
8954 | **label**\ *optional*          | string                                    |
8955 +--------------------------------+-------------------------------------------+
8956 | **name**\ *optional*           | string                                    |
8957 +--------------------------------+-------------------------------------------+
8958 | **ownerId**\ *optional*        | string                                    |
8959 +--------------------------------+-------------------------------------------+
8960 | **parentUniqueId**\ *optional* | string                                    |
8961 +--------------------------------+-------------------------------------------+
8962 | **password**\ *optional*       | boolean                                   |
8963 +--------------------------------+-------------------------------------------+
8964 | **path**\ *optional*           | < string > array                          |
8965 +--------------------------------+-------------------------------------------+
8966 | **propertyId**\ *optional*     | string                                    |
8967 +--------------------------------+-------------------------------------------+
8968 | **required**\ *optional*       | boolean                                   |
8969 +--------------------------------+-------------------------------------------+
8970 | **rules**\ *optional*          | < `PropertyRule <#_propertyrule>`__ >     |
8971 |                                | array                                     |
8972 +--------------------------------+-------------------------------------------+
8973 | **schema**\ *optional*         | `SchemaDefinition <#_schemadefinition>`__ |
8974 +--------------------------------+-------------------------------------------+
8975 | **status**\ *optional*         | string                                    |
8976 +--------------------------------+-------------------------------------------+
8977 | **type**\ *optional*           | string                                    |
8978 +--------------------------------+-------------------------------------------+
8979 | **uniqueId**\ *optional*       | string                                    |
8980 +--------------------------------+-------------------------------------------+
8981 | **value**\ *optional*          | string                                    |
8982 +--------------------------------+-------------------------------------------+
8983 | **valueUniqueUid**\ *optional* | string                                    |
8984 +--------------------------------+-------------------------------------------+
8985
8986 ComponentMetadataDataDefinition
8987 -------------------------------
8988
8989 +--------------------------------+-------------------------------------------+
8990 | Name                           | Schema                                    |
8991 +================================+===========================================+
8992 | **allVersions**\ *optional*    | < string, string > map                    |
8993 +--------------------------------+-------------------------------------------+
8994 | **componentType**\ *optional*  | enum (RESOURCE, SERVICE,                  |
8995 |                                | RESOURCE\_INSTANCE, PRODUCT,              |
8996 |                                | SERVICE\_INSTANCE)                        |
8997 +--------------------------------+-------------------------------------------+
8998 | **conformanceLevel**\ *optiona | string                                    |
8999 | l*                             |                                           |
9000 +--------------------------------+-------------------------------------------+
9001 | **contactId**\ *optional*      | string                                    |
9002 +--------------------------------+-------------------------------------------+
9003 | **creationDate**\ *optional*   | integer (int64)                           |
9004 +--------------------------------+-------------------------------------------+
9005 | **creatorFullName**\ *optional | string                                    |
9006 | *                              |                                           |
9007 +--------------------------------+-------------------------------------------+
9008 | **creatorUserId**\ *optional*  | string                                    |
9009 +--------------------------------+-------------------------------------------+
9010 | **csarUUID**\ *optional*       | string                                    |
9011 +--------------------------------+-------------------------------------------+
9012 | **csarVersion**\ *optional*    | string                                    |
9013 +--------------------------------+-------------------------------------------+
9014 | **deleted**\ *optional*        | boolean                                   |
9015 +--------------------------------+-------------------------------------------+
9016 | **description**\ *optional*    | string                                    |
9017 +--------------------------------+-------------------------------------------+
9018 | **highestVersion**\ *optional* | boolean                                   |
9019 +--------------------------------+-------------------------------------------+
9020 | **icon**\ *optional*           | string                                    |
9021 +--------------------------------+-------------------------------------------+
9022 | **importedToscaChecksum**\ *op | string                                    |
9023 | tional*                        |                                           |
9024 +--------------------------------+-------------------------------------------+
9025 | **invariantUUID**\ *optional*  | string                                    |
9026 +--------------------------------+-------------------------------------------+
9027 | **isDeleted**\ *optional*      | boolean                                   |
9028 +--------------------------------+-------------------------------------------+
9029 | **isHighestVersion**\ *optiona | boolean                                   |
9030 | l*                             |                                           |
9031 +--------------------------------+-------------------------------------------+
9032 | **lastUpdateDate**\ *optional* | integer (int64)                           |
9033 +--------------------------------+-------------------------------------------+
9034 | **lastUpdaterFullName**\ *opti | string                                    |
9035 | onal*                          |                                           |
9036 +--------------------------------+-------------------------------------------+
9037 | **lastUpdaterUserId**\ *option | string                                    |
9038 | al*                            |                                           |
9039 +--------------------------------+-------------------------------------------+
9040 | **lifecycleState**\ *optional* | string                                    |
9041 +--------------------------------+-------------------------------------------+
9042 | **name**\ *optional*           | string                                    |
9043 +--------------------------------+-------------------------------------------+
9044 | **normalizedName**\ *optional* | string                                    |
9045 +--------------------------------+-------------------------------------------+
9046 | **ownerId**\ *optional*        | string                                    |
9047 +--------------------------------+-------------------------------------------+
9048 | **projectCode**\ *optional*    | string                                    |
9049 +--------------------------------+-------------------------------------------+
9050 | **state**\ *optional*          | string                                    |
9051 +--------------------------------+-------------------------------------------+
9052 | **systemName**\ *optional*     | string                                    |
9053 +--------------------------------+-------------------------------------------+
9054 | **tags**\ *optional*           | < string > array                          |
9055 +--------------------------------+-------------------------------------------+
9056 | **uniqueId**\ *optional*       | string                                    |
9057 +--------------------------------+-------------------------------------------+
9058 | **uuid**\ *optional*           | string                                    |
9059 +--------------------------------+-------------------------------------------+
9060 | **version**\ *optional*        | string                                    |
9061 +--------------------------------+-------------------------------------------+
9062
9063 ComponentMetadataDefinition
9064 ---------------------------
9065
9066 +--------------------------------+-------------------------------------------+
9067 | Name                           | Schema                                    |
9068 +================================+===========================================+
9069 | **metadataDataDefinition**\ *o | `ComponentMetadataDataDefinition <#_compo |
9070 | ptional*                       | nentmetadatadatadefinition>`__            |
9071 +--------------------------------+-------------------------------------------+
9072
9073 ConsumerDefinition
9074 ------------------
9075
9076 +--------------------------------+-------------------------------------------+
9077 | Name                           | Schema                                    |
9078 +================================+===========================================+
9079 | **consumerDetailsLastupdatedti | integer (int64)                           |
9080 | me**\ *optional*               |                                           |
9081 +--------------------------------+-------------------------------------------+
9082 | **consumerLastAuthenticationTi | integer (int64)                           |
9083 | me**\ *optional*               |                                           |
9084 +--------------------------------+-------------------------------------------+
9085 | **consumerName**\ *optional*   | string                                    |
9086 +--------------------------------+-------------------------------------------+
9087 | **consumerPassword**\ *optiona | string                                    |
9088 | l*                             |                                           |
9089 +--------------------------------+-------------------------------------------+
9090 | **consumerSalt**\ *optional*   | string                                    |
9091 +--------------------------------+-------------------------------------------+
9092 | **lastModfierAtuid**\ *optiona | string                                    |
9093 | l*                             |                                           |
9094 +--------------------------------+-------------------------------------------+
9095 | **ownerId**\ *optional*        | string                                    |
9096 +--------------------------------+-------------------------------------------+
9097
9098 DistributionStatusInfo
9099 ----------------------
9100
9101 +--------------------------------+-------------------------------------------+
9102 | Name                           | Schema                                    |
9103 +================================+===========================================+
9104 | **errorReason**\ *optional*    | string                                    |
9105 +--------------------------------+-------------------------------------------+
9106 | **omfComponentID**\ *optional* | string                                    |
9107 +--------------------------------+-------------------------------------------+
9108 | **status**\ *optional*         | string                                    |
9109 +--------------------------------+-------------------------------------------+
9110 | **timestamp**\ *optional*      | string                                    |
9111 +--------------------------------+-------------------------------------------+
9112 | **url**\ *optional*            | string                                    |
9113 +--------------------------------+-------------------------------------------+
9114
9115 DistributionStatusListResponse
9116 ------------------------------
9117
9118 +--------------------------------+-------------------------------------------+
9119 | Name                           | Schema                                    |
9120 +================================+===========================================+
9121 | **distributionStatusList**\ *o | <                                         |
9122 | ptional*                       | `DistributionStatusInfo <#_distributionst |
9123 |                                | atusinfo>`__                              |
9124 |                                | > array                                   |
9125 +--------------------------------+-------------------------------------------+
9126
9127 GetInputValueDataDefinition
9128 ---------------------------
9129
9130 +--------------------------------+-------------------------------------------+
9131 | Name                           | Schema                                    |
9132 +================================+===========================================+
9133 | **getInputIndex**\ *optional*  | `GetInputValueDataDefinition <#_getinputv |
9134 |                                | aluedatadefinition>`__                    |
9135 +--------------------------------+-------------------------------------------+
9136 | **indexValue**\ *optional*     | integer (int32)                           |
9137 +--------------------------------+-------------------------------------------+
9138 | **inputId**\ *optional*        | string                                    |
9139 +--------------------------------+-------------------------------------------+
9140 | **inputName**\ *optional*      | string                                    |
9141 +--------------------------------+-------------------------------------------+
9142 | **list**\ *optional*           | boolean                                   |
9143 +--------------------------------+-------------------------------------------+
9144 | **ownerId**\ *optional*        | string                                    |
9145 +--------------------------------+-------------------------------------------+
9146 | **propName**\ *optional*       | string                                    |
9147 +--------------------------------+-------------------------------------------+
9148
9149 GroupDefinition
9150 ---------------
9151
9152 +--------------------------------+-------------------------------------------+
9153 | Name                           | Schema                                    |
9154 +================================+===========================================+
9155 | **artifacts**\ *optional*      | < string > array                          |
9156 +--------------------------------+-------------------------------------------+
9157 | **artifactsUuid**\ *optional*  | < string > array                          |
9158 +--------------------------------+-------------------------------------------+
9159 | **description**\ *optional*    | string                                    |
9160 +--------------------------------+-------------------------------------------+
9161 | **groupUUID**\ *optional*      | string                                    |
9162 +--------------------------------+-------------------------------------------+
9163 | **invariantUUID**\ *optional*  | string                                    |
9164 +--------------------------------+-------------------------------------------+
9165 | **members**\ *optional*        | < string, string > map                    |
9166 +--------------------------------+-------------------------------------------+
9167 | **name**\ *optional*           | string                                    |
9168 +--------------------------------+-------------------------------------------+
9169 | **ownerId**\ *optional*        | string                                    |
9170 +--------------------------------+-------------------------------------------+
9171 | **properties**\ *optional*     | <                                         |
9172 |                                | `PropertyDataDefinition <#_propertydatade |
9173 |                                | finition>`__                              |
9174 |                                | > array                                   |
9175 +--------------------------------+-------------------------------------------+
9176 | **propertyValueCounter**\ *opt | integer (int32)                           |
9177 | ional*                         |                                           |
9178 +--------------------------------+-------------------------------------------+
9179 | **type**\ *optional*           | string                                    |
9180 +--------------------------------+-------------------------------------------+
9181 | **typeUid**\ *optional*        | string                                    |
9182 +--------------------------------+-------------------------------------------+
9183 | **uniqueId**\ *optional*       | string                                    |
9184 +--------------------------------+-------------------------------------------+
9185 | **version**\ *optional*        | string                                    |
9186 +--------------------------------+-------------------------------------------+
9187
9188 GroupInstance
9189 -------------
9190
9191 +--------------------------------+-------------------------------------------+
9192 | Name                           | Schema                                    |
9193 +================================+===========================================+
9194 | **artifacts**\ *optional*      | < string > array                          |
9195 +--------------------------------+-------------------------------------------+
9196 | **artifactsUuid**\ *optional*  | < string > array                          |
9197 +--------------------------------+-------------------------------------------+
9198 | **creationTime**\ *optional*   | integer (int64)                           |
9199 +--------------------------------+-------------------------------------------+
9200 | **customizationUUID**\ *option | string                                    |
9201 | al*                            |                                           |
9202 +--------------------------------+-------------------------------------------+
9203 | **description**\ *optional*    | string                                    |
9204 +--------------------------------+-------------------------------------------+
9205 | **groupInstanceArtifacts**\ *o | < string > array                          |
9206 | ptional*                       |                                           |
9207 +--------------------------------+-------------------------------------------+
9208 | **groupInstanceArtifactsUuid** | < string > array                          |
9209 | \ *optional*                   |                                           |
9210 +--------------------------------+-------------------------------------------+
9211 | **groupName**\ *optional*      | string                                    |
9212 +--------------------------------+-------------------------------------------+
9213 | **groupUUID**\ *optional*      | string                                    |
9214 +--------------------------------+-------------------------------------------+
9215 | **groupUid**\ *optional*       | string                                    |
9216 +--------------------------------+-------------------------------------------+
9217 | **invariantUUID**\ *optional*  | string                                    |
9218 +--------------------------------+-------------------------------------------+
9219 | **modificationTime**\ *optiona | integer (int64)                           |
9220 | l*                             |                                           |
9221 +--------------------------------+-------------------------------------------+
9222 | **name**\ *optional*           | string                                    |
9223 +--------------------------------+-------------------------------------------+
9224 | **normalizedName**\ *optional* | string                                    |
9225 +--------------------------------+-------------------------------------------+
9226 | **ownerId**\ *optional*        | string                                    |
9227 +--------------------------------+-------------------------------------------+
9228 | **posX**\ *optional*           | string                                    |
9229 +--------------------------------+-------------------------------------------+
9230 | **posY**\ *optional*           | string                                    |
9231 +--------------------------------+-------------------------------------------+
9232 | **properties**\ *optional*     | <                                         |
9233 |                                | `PropertyDataDefinition <#_propertydatade |
9234 |                                | finition>`__                              |
9235 |                                | > array                                   |
9236 +--------------------------------+-------------------------------------------+
9237 | **propertyValueCounter**\ *opt | integer (int32)                           |
9238 | ional*                         |                                           |
9239 +--------------------------------+-------------------------------------------+
9240 | **type**\ *optional*           | string                                    |
9241 +--------------------------------+-------------------------------------------+
9242 | **uniqueId**\ *optional*       | string                                    |
9243 +--------------------------------+-------------------------------------------+
9244 | **version**\ *optional*        | string                                    |
9245 +--------------------------------+-------------------------------------------+
9246
9247 GroupingDefinition
9248 ------------------
9249
9250 +--------------------------------+-------------------------------------------+
9251 | Name                           | Schema                                    |
9252 +================================+===========================================+
9253 | **name**\ *optional*           | string                                    |
9254 +--------------------------------+-------------------------------------------+
9255 | **normalizedName**\ *optional* | string                                    |
9256 +--------------------------------+-------------------------------------------+
9257 | **ownerId**\ *optional*        | string                                    |
9258 +--------------------------------+-------------------------------------------+
9259 | **uniqueId**\ *optional*       | string                                    |
9260 +--------------------------------+-------------------------------------------+
9261
9262 HeatParameterDataDefinition
9263 ---------------------------
9264
9265 +--------------------------------+-------------------------------------------+
9266 | Name                           | Schema                                    |
9267 +================================+===========================================+
9268 | **currentValue**\ *optional*   | string                                    |
9269 +--------------------------------+-------------------------------------------+
9270 | **defaultValue**\ *optional*   | string                                    |
9271 +--------------------------------+-------------------------------------------+
9272 | **description**\ *optional*    | string                                    |
9273 +--------------------------------+-------------------------------------------+
9274 | **name**\ *optional*           | string                                    |
9275 +--------------------------------+-------------------------------------------+
9276 | **ownerId**\ *optional*        | string                                    |
9277 +--------------------------------+-------------------------------------------+
9278 | **type**\ *optional*           | string                                    |
9279 +--------------------------------+-------------------------------------------+
9280 | **uniqueId**\ *optional*       | string                                    |
9281 +--------------------------------+-------------------------------------------+
9282
9283 HeatParameterDefinition
9284 -----------------------
9285
9286 +--------------------------------+-------------------------------------------+
9287 | Name                           | Schema                                    |
9288 +================================+===========================================+
9289 | **currentValue**\ *optional*   | string                                    |
9290 +--------------------------------+-------------------------------------------+
9291 | **defaultValue**\ *optional*   | string                                    |
9292 +--------------------------------+-------------------------------------------+
9293 | **description**\ *optional*    | string                                    |
9294 +--------------------------------+-------------------------------------------+
9295 | **name**\ *optional*           | string                                    |
9296 +--------------------------------+-------------------------------------------+
9297 | **ownerId**\ *optional*        | string                                    |
9298 +--------------------------------+-------------------------------------------+
9299 | **type**\ *optional*           | string                                    |
9300 +--------------------------------+-------------------------------------------+
9301 | **uniqueId**\ *optional*       | string                                    |
9302 +--------------------------------+-------------------------------------------+
9303
9304 InputDefinition
9305 ---------------
9306
9307 +--------------------------------+-------------------------------------------+
9308 | Name                           | Schema                                    |
9309 +================================+===========================================+
9310 | **constraints**\ *optional*    | <                                         |
9311 |                                | `PropertyConstraint <#_propertyconstraint |
9312 |                                | >`__                                      |
9313 |                                | > array                                   |
9314 +--------------------------------+-------------------------------------------+
9315 | **defaultValue**\ *optional*   | string                                    |
9316 +--------------------------------+-------------------------------------------+
9317 | **definition**\ *optional*     | boolean                                   |
9318 +--------------------------------+-------------------------------------------+
9319 | **description**\ *optional*    | string                                    |
9320 +--------------------------------+-------------------------------------------+
9321 | **getInputValues**\ *optional* | <                                         |
9322 |                                | `GetInputValueDataDefinition <#_getinputv |
9323 |                                | aluedatadefinition>`__                    |
9324 |                                | > array                                   |
9325 +--------------------------------+-------------------------------------------+
9326 | **hidden**\ *optional*         | boolean                                   |
9327 +--------------------------------+-------------------------------------------+
9328 | **immutable**\ *optional*      | boolean                                   |
9329 +--------------------------------+-------------------------------------------+
9330 | **inputId**\ *optional*        | string                                    |
9331 +--------------------------------+-------------------------------------------+
9332 | **inputPath**\ *optional*      | string                                    |
9333 +--------------------------------+-------------------------------------------+
9334 | **inputs**\ *optional*         | <                                         |
9335 |                                | `ComponentInstanceInput <#_componentinsta |
9336 |                                | nceinput>`__                              |
9337 |                                | > array                                   |
9338 +--------------------------------+-------------------------------------------+
9339 | **instanceUniqueId**\ *optiona | string                                    |
9340 | l*                             |                                           |
9341 +--------------------------------+-------------------------------------------+
9342 | **label**\ *optional*          | string                                    |
9343 +--------------------------------+-------------------------------------------+
9344 | **name**\ *optional*           | string                                    |
9345 +--------------------------------+-------------------------------------------+
9346 | **ownerId**\ *optional*        | string                                    |
9347 +--------------------------------+-------------------------------------------+
9348 | **parentUniqueId**\ *optional* | string                                    |
9349 +--------------------------------+-------------------------------------------+
9350 | **password**\ *optional*       | boolean                                   |
9351 +--------------------------------+-------------------------------------------+
9352 | **properties**\ *optional*     | <                                         |
9353 |                                | `ComponentInstanceProperty <#_componentin |
9354 |                                | stanceproperty>`__                        |
9355 |                                | > array                                   |
9356 +--------------------------------+-------------------------------------------+
9357 | **propertyId**\ *optional*     | string                                    |
9358 +--------------------------------+-------------------------------------------+
9359 | **required**\ *optional*       | boolean                                   |
9360 +--------------------------------+-------------------------------------------+
9361 | **schema**\ *optional*         | `SchemaDefinition <#_schemadefinition>`__ |
9362 +--------------------------------+-------------------------------------------+
9363 | **status**\ *optional*         | string                                    |
9364 +--------------------------------+-------------------------------------------+
9365 | **type**\ *optional*           | string                                    |
9366 +--------------------------------+-------------------------------------------+
9367 | **uniqueId**\ *optional*       | string                                    |
9368 +--------------------------------+-------------------------------------------+
9369 | **value**\ *optional*          | string                                    |
9370 +--------------------------------+-------------------------------------------+
9371
9372 InterfaceDefinition
9373 -------------------
9374
9375 +--------------------------------+-------------------------------------------+
9376 | Name                           | Schema                                    |
9377 +================================+===========================================+
9378 | **creationDate**\ *optional*   | integer (int64)                           |
9379 +--------------------------------+-------------------------------------------+
9380 | **definition**\ *optional*     | boolean                                   |
9381 +--------------------------------+-------------------------------------------+
9382 | **description**\ *optional*    | string                                    |
9383 +--------------------------------+-------------------------------------------+
9384 | **lastUpdateDate**\ *optional* | integer (int64)                           |
9385 +--------------------------------+-------------------------------------------+
9386 | **operations**\ *optional*     | < string,                                 |
9387 |                                | `OperationDataDefinition <#_operationdata |
9388 |                                | definition>`__                            |
9389 |                                | > map                                     |
9390 +--------------------------------+-------------------------------------------+
9391 | **operationsMap**\ *optional*  | < string, `Operation <#_operation>`__ >   |
9392 |                                | map                                       |
9393 +--------------------------------+-------------------------------------------+
9394 | **ownerId**\ *optional*        | string                                    |
9395 +--------------------------------+-------------------------------------------+
9396 | **type**\ *optional*           | string                                    |
9397 +--------------------------------+-------------------------------------------+
9398 | **uniqueId**\ *optional*       | string                                    |
9399 +--------------------------------+-------------------------------------------+
9400
9401 LifecycleChangeInfoWithAction
9402 -----------------------------
9403
9404 +--------------------------------+-------------------------------------------+
9405 | Name                           | Schema                                    |
9406 +================================+===========================================+
9407 | **action**\ *optional*         | enum (CREATE\_FROM\_CSAR,                 |
9408 |                                | UPDATE\_FROM\_EXTERNAL\_API)              |
9409 +--------------------------------+-------------------------------------------+
9410 | **userRemarks**\ *optional*    | string                                    |
9411 +--------------------------------+-------------------------------------------+
9412
9413 Operation
9414 ---------
9415
9416 +--------------------------------+-------------------------------------------+
9417 | Name                           | Schema                                    |
9418 +================================+===========================================+
9419 | **creationDate**\ *optional*   | integer (int64)                           |
9420 +--------------------------------+-------------------------------------------+
9421 | **definition**\ *optional*     | boolean                                   |
9422 +--------------------------------+-------------------------------------------+
9423 | **description**\ *optional*    | string                                    |
9424 +--------------------------------+-------------------------------------------+
9425 | **implementation**\ *optional* | `ArtifactDataDefinition <#_artifactdatade |
9426 |                                | finition>`__                              |
9427 +--------------------------------+-------------------------------------------+
9428 | **implementationArtifact**\ *o | `ArtifactDefinition <#_artifactdefinition |
9429 | ptional*                       | >`__                                      |
9430 +--------------------------------+-------------------------------------------+
9431 | **inputs**\ *optional*         | < string,                                 |
9432 |                                | `PropertyDataDefinition <#_propertydatade |
9433 |                                | finition>`__                              |
9434 |                                | > map                                     |
9435 +--------------------------------+-------------------------------------------+
9436 | **lastUpdateDate**\ *optional* | integer (int64)                           |
9437 +--------------------------------+-------------------------------------------+
9438 | **ownerId**\ *optional*        | string                                    |
9439 +--------------------------------+-------------------------------------------+
9440 | **uniqueId**\ *optional*       | string                                    |
9441 +--------------------------------+-------------------------------------------+
9442
9443 OperationDataDefinition
9444 -----------------------
9445
9446 +--------------------------------+-------------------------------------------+
9447 | Name                           | Schema                                    |
9448 +================================+===========================================+
9449 | **creationDate**\ *optional*   | integer (int64)                           |
9450 +--------------------------------+-------------------------------------------+
9451 | **description**\ *optional*    | string                                    |
9452 +--------------------------------+-------------------------------------------+
9453 | **implementation**\ *optional* | `ArtifactDataDefinition <#_artifactdatade |
9454 |                                | finition>`__                              |
9455 +--------------------------------+-------------------------------------------+
9456 | **inputs**\ *optional*         | < string,                                 |
9457 |                                | `PropertyDataDefinition <#_propertydatade |
9458 |                                | finition>`__                              |
9459 |                                | > map                                     |
9460 +--------------------------------+-------------------------------------------+
9461 | **lastUpdateDate**\ *optional* | integer (int64)                           |
9462 +--------------------------------+-------------------------------------------+
9463 | **ownerId**\ *optional*        | string                                    |
9464 +--------------------------------+-------------------------------------------+
9465 | **uniqueId**\ *optional*       | string                                    |
9466 +--------------------------------+-------------------------------------------+
9467
9468 Product
9469 -------
9470
9471 +--------------------------------+-------------------------------------------+
9472 | Name                           | Schema                                    |
9473 +================================+===========================================+
9474 | **additionalInformation**\ *op | <                                         |
9475 | tional*                        | `AdditionalInformationDefinition <#_addit |
9476 |                                | ionalinformationdefinition>`__            |
9477 |                                | > array                                   |
9478 +--------------------------------+-------------------------------------------+
9479 | **allArtifacts**\ *optional*   | < string,                                 |
9480 |                                | `ArtifactDefinition <#_artifactdefinition |
9481 |                                | >`__                                      |
9482 |                                | > map                                     |
9483 +--------------------------------+-------------------------------------------+
9484 | **allVersions**\ *optional*    | < string, string > map                    |
9485 +--------------------------------+-------------------------------------------+
9486 | **artifacts**\ *optional*      | < string,                                 |
9487 |                                | `ArtifactDefinition <#_artifactdefinition |
9488 |                                | >`__                                      |
9489 |                                | > map                                     |
9490 +--------------------------------+-------------------------------------------+
9491 | **capabilities**\ *optional*   | < string, <                               |
9492 |                                | `CapabilityDefinition <#_capabilitydefini |
9493 |                                | tion>`__                                  |
9494 |                                | > array > map                             |
9495 +--------------------------------+-------------------------------------------+
9496 | **categories**\ *optional*     | <                                         |
9497 |                                | `CategoryDefinition <#_categorydefinition |
9498 |                                | >`__                                      |
9499 |                                | > array                                   |
9500 +--------------------------------+-------------------------------------------+
9501 | **componentInstances**\ *optio | <                                         |
9502 | nal*                           | `ComponentInstance <#_componentinstance>` |
9503 |                                | __                                        |
9504 |                                | > array                                   |
9505 +--------------------------------+-------------------------------------------+
9506 | **componentInstancesAttributes | < string, <                               |
9507 | **\ *optional*                 | `ComponentInstanceProperty <#_componentin |
9508 |                                | stanceproperty>`__                        |
9509 |                                | > array > map                             |
9510 +--------------------------------+-------------------------------------------+
9511 | **componentInstancesInputs**\  | < string, <                               |
9512 | *optional*                     | `ComponentInstanceInput <#_componentinsta |
9513 |                                | nceinput>`__                              |
9514 |                                | > array > map                             |
9515 +--------------------------------+-------------------------------------------+
9516 | **componentInstancesProperties | < string, <                               |
9517 | **\ *optional*                 | `ComponentInstanceProperty <#_componentin |
9518 |                                | stanceproperty>`__                        |
9519 |                                | > array > map                             |
9520 +--------------------------------+-------------------------------------------+
9521 | **componentInstancesRelations* | <                                         |
9522 | *\ *optional*                  | `RequirementCapabilityRelDef <#_requireme |
9523 |                                | ntcapabilityreldef>`__                    |
9524 |                                | > array                                   |
9525 +--------------------------------+-------------------------------------------+
9526 | **componentMetadataDefinition* | `ComponentMetadataDefinition <#_component |
9527 | *\ *optional*                  | metadatadefinition>`__                    |
9528 +--------------------------------+-------------------------------------------+
9529 | **componentType**\ *optional*  | enum (RESOURCE, SERVICE,                  |
9530 |                                | RESOURCE\_INSTANCE, PRODUCT,              |
9531 |                                | SERVICE\_INSTANCE)                        |
9532 +--------------------------------+-------------------------------------------+
9533 | **conformanceLevel**\ *optiona | string                                    |
9534 | l*                             |                                           |
9535 +--------------------------------+-------------------------------------------+
9536 | **contactId**\ *optional*      | string                                    |
9537 +--------------------------------+-------------------------------------------+
9538 | **contacts**\ *optional*       | < string > array                          |
9539 +--------------------------------+-------------------------------------------+
9540 | **creationDate**\ *optional*   | integer (int64)                           |
9541 +--------------------------------+-------------------------------------------+
9542 | **creatorFullName**\ *optional | string                                    |
9543 | *                              |                                           |
9544 +--------------------------------+-------------------------------------------+
9545 | **creatorUserId**\ *optional*  | string                                    |
9546 +--------------------------------+-------------------------------------------+
9547 | **csarUUID**\ *optional*       | string                                    |
9548 +--------------------------------+-------------------------------------------+
9549 | **csarVersion**\ *optional*    | string                                    |
9550 +--------------------------------+-------------------------------------------+
9551 | **deploymentArtifacts**\ *opti | < string,                                 |
9552 | onal*                          | `ArtifactDefinition <#_artifactdefinition |
9553 |                                | >`__                                      |
9554 |                                | > map                                     |
9555 +--------------------------------+-------------------------------------------+
9556 | **derivedFromGenericType**\ *o | string                                    |
9557 | ptional*                       |                                           |
9558 +--------------------------------+-------------------------------------------+
9559 | **derivedFromGenericVersion**\ | string                                    |
9560 |  *optional*                    |                                           |
9561 +--------------------------------+-------------------------------------------+
9562 | **description**\ *optional*    | string                                    |
9563 +--------------------------------+-------------------------------------------+
9564 | **fullName**\ *optional*       | string                                    |
9565 +--------------------------------+-------------------------------------------+
9566 | **groups**\ *optional*         | < `GroupDefinition <#_groupdefinition>`__ |
9567 |                                | > array                                   |
9568 +--------------------------------+-------------------------------------------+
9569 | **highestVersion**\ *optional* | boolean                                   |
9570 +--------------------------------+-------------------------------------------+
9571 | **icon**\ *optional*           | string                                    |
9572 +--------------------------------+-------------------------------------------+
9573 | **importedToscaChecksum**\ *op | string                                    |
9574 | tional*                        |                                           |
9575 +--------------------------------+-------------------------------------------+
9576 | **inputs**\ *optional*         | < `InputDefinition <#_inputdefinition>`__ |
9577 |                                | > array                                   |
9578 +--------------------------------+-------------------------------------------+
9579 | **invariantUUID**\ *optional*  | string                                    |
9580 +--------------------------------+-------------------------------------------+
9581 | **isActive**\ *optional*       | boolean                                   |
9582 +--------------------------------+-------------------------------------------+
9583 | **isDeleted**\ *optional*      | boolean                                   |
9584 +--------------------------------+-------------------------------------------+
9585 | **lastUpdateDate**\ *optional* | integer (int64)                           |
9586 +--------------------------------+-------------------------------------------+
9587 | **lastUpdaterFullName**\ *opti | string                                    |
9588 | onal*                          |                                           |
9589 +--------------------------------+-------------------------------------------+
9590 | **lastUpdaterUserId**\ *option | string                                    |
9591 | al*                            |                                           |
9592 +--------------------------------+-------------------------------------------+
9593 | **lifecycleState**\ *optional* | enum (READY\_FOR\_CERTIFICATION,          |
9594 |                                | CERTIFICATION\_IN\_PROGRESS, CERTIFIED,   |
9595 |                                | NOT\_CERTIFIED\_CHECKIN,                  |
9596 |                                | NOT\_CERTIFIED\_CHECKOUT)                 |
9597 +--------------------------------+-------------------------------------------+
9598 | **name**\ *optional*           | string                                    |
9599 +--------------------------------+-------------------------------------------+
9600 | **normalizedName**\ *optional* | string                                    |
9601 +--------------------------------+-------------------------------------------+
9602 | **projectCode**\ *optional*    | string                                    |
9603 +--------------------------------+-------------------------------------------+
9604 | **requirements**\ *optional*   | < string, <                               |
9605 |                                | `RequirementDefinition <#_requirementdefi |
9606 |                                | nition>`__                                |
9607 |                                | > array > map                             |
9608 +--------------------------------+-------------------------------------------+
9609 | **systemName**\ *optional*     | string                                    |
9610 +--------------------------------+-------------------------------------------+
9611 | **tags**\ *optional*           | < string > array                          |
9612 +--------------------------------+-------------------------------------------+
9613 | **toscaArtifacts**\ *optional* | < string,                                 |
9614 |                                | `ArtifactDefinition <#_artifactdefinition |
9615 |                                | >`__                                      |
9616 |                                | > map                                     |
9617 +--------------------------------+-------------------------------------------+
9618 | **toscaType**\ *optional*      | string                                    |
9619 +--------------------------------+-------------------------------------------+
9620 | **uniqueId**\ *optional*       | string                                    |
9621 +--------------------------------+-------------------------------------------+
9622 | **uuid**\ *optional*           | string                                    |
9623 +--------------------------------+-------------------------------------------+
9624 | **version**\ *optional*        | string                                    |
9625 +--------------------------------+-------------------------------------------+
9626
9627 PropertyConstraint
9628 ------------------
9629
9630 *Type* : object
9631
9632 PropertyDataDefinition
9633 ----------------------
9634
9635 +--------------------------------+-------------------------------------------+
9636 | Name                           | Schema                                    |
9637 +================================+===========================================+
9638 | **defaultValue**\ *optional*   | string                                    |
9639 +--------------------------------+-------------------------------------------+
9640 | **definition**\ *optional*     | boolean                                   |
9641 +--------------------------------+-------------------------------------------+
9642 | **description**\ *optional*    | string                                    |
9643 +--------------------------------+-------------------------------------------+
9644 | **getInputValues**\ *optional* | <                                         |
9645 |                                | `GetInputValueDataDefinition <#_getinputv |
9646 |                                | aluedatadefinition>`__                    |
9647 |                                | > array                                   |
9648 +--------------------------------+-------------------------------------------+
9649 | **hidden**\ *optional*         | boolean                                   |
9650 +--------------------------------+-------------------------------------------+
9651 | **immutable**\ *optional*      | boolean                                   |
9652 +--------------------------------+-------------------------------------------+
9653 | **inputId**\ *optional*        | string                                    |
9654 +--------------------------------+-------------------------------------------+
9655 | **inputPath**\ *optional*      | string                                    |
9656 +--------------------------------+-------------------------------------------+
9657 | **instanceUniqueId**\ *optiona | string                                    |
9658 | l*                             |                                           |
9659 +--------------------------------+-------------------------------------------+
9660 | **label**\ *optional*          | string                                    |
9661 +--------------------------------+-------------------------------------------+
9662 | **name**\ *optional*           | string                                    |
9663 +--------------------------------+-------------------------------------------+
9664 | **ownerId**\ *optional*        | string                                    |
9665 +--------------------------------+-------------------------------------------+
9666 | **parentUniqueId**\ *optional* | string                                    |
9667 +--------------------------------+-------------------------------------------+
9668 | **password**\ *optional*       | boolean                                   |
9669 +--------------------------------+-------------------------------------------+
9670 | **propertyId**\ *optional*     | string                                    |
9671 +--------------------------------+-------------------------------------------+
9672 | **required**\ *optional*       | boolean                                   |
9673 +--------------------------------+-------------------------------------------+
9674 | **schema**\ *optional*         | `SchemaDefinition <#_schemadefinition>`__ |
9675 +--------------------------------+-------------------------------------------+
9676 | **status**\ *optional*         | string                                    |
9677 +--------------------------------+-------------------------------------------+
9678 | **type**\ *optional*           | string                                    |
9679 +--------------------------------+-------------------------------------------+
9680 | **uniqueId**\ *optional*       | string                                    |
9681 +--------------------------------+-------------------------------------------+
9682 | **value**\ *optional*          | string                                    |
9683 +--------------------------------+-------------------------------------------+
9684
9685 PropertyDefinition
9686 ------------------
9687
9688 +--------------------------------+-------------------------------------------+
9689 | Name                           | Schema                                    |
9690 +================================+===========================================+
9691 | **constraints**\ *optional*    | <                                         |
9692 |                                | `PropertyConstraint <#_propertyconstraint |
9693 |                                | >`__                                      |
9694 |                                | > array                                   |
9695 +--------------------------------+-------------------------------------------+
9696 | **defaultValue**\ *optional*   | string                                    |
9697 +--------------------------------+-------------------------------------------+
9698 | **definition**\ *optional*     | boolean                                   |
9699 +--------------------------------+-------------------------------------------+
9700 | **description**\ *optional*    | string                                    |
9701 +--------------------------------+-------------------------------------------+
9702 | **getInputValues**\ *optional* | <                                         |
9703 |                                | `GetInputValueDataDefinition <#_getinputv |
9704 |                                | aluedatadefinition>`__                    |
9705 |                                | > array                                   |
9706 +--------------------------------+-------------------------------------------+
9707 | **hidden**\ *optional*         | boolean                                   |
9708 +--------------------------------+-------------------------------------------+
9709 | **immutable**\ *optional*      | boolean                                   |
9710 +--------------------------------+-------------------------------------------+
9711 | **inputId**\ *optional*        | string                                    |
9712 +--------------------------------+-------------------------------------------+
9713 | **inputPath**\ *optional*      | string                                    |
9714 +--------------------------------+-------------------------------------------+
9715 | **instanceUniqueId**\ *optiona | string                                    |
9716 | l*                             |                                           |
9717 +--------------------------------+-------------------------------------------+
9718 | **label**\ *optional*          | string                                    |
9719 +--------------------------------+-------------------------------------------+
9720 | **name**\ *optional*           | string                                    |
9721 +--------------------------------+-------------------------------------------+
9722 | **ownerId**\ *optional*        | string                                    |
9723 +--------------------------------+-------------------------------------------+
9724 | **parentUniqueId**\ *optional* | string                                    |
9725 +--------------------------------+-------------------------------------------+
9726 | **password**\ *optional*       | boolean                                   |
9727 +--------------------------------+-------------------------------------------+
9728 | **propertyId**\ *optional*     | string                                    |
9729 +--------------------------------+-------------------------------------------+
9730 | **required**\ *optional*       | boolean                                   |
9731 +--------------------------------+-------------------------------------------+
9732 | **schema**\ *optional*         | `SchemaDefinition <#_schemadefinition>`__ |
9733 +--------------------------------+-------------------------------------------+
9734 | **status**\ *optional*         | string                                    |
9735 +--------------------------------+-------------------------------------------+
9736 | **type**\ *optional*           | string                                    |
9737 +--------------------------------+-------------------------------------------+
9738 | **uniqueId**\ *optional*       | string                                    |
9739 +--------------------------------+-------------------------------------------+
9740 | **value**\ *optional*          | string                                    |
9741 +--------------------------------+-------------------------------------------+
9742
9743 PropertyRule
9744 ------------
9745
9746 +--------------------------------+-------------------------------------------+
9747 | Name                           | Schema                                    |
9748 +================================+===========================================+
9749 | **firstToken**\ *optional*     | string                                    |
9750 +--------------------------------+-------------------------------------------+
9751 | **ownerId**\ *optional*        | string                                    |
9752 +--------------------------------+-------------------------------------------+
9753 | **rule**\ *optional*           | < string > array                          |
9754 +--------------------------------+-------------------------------------------+
9755 | **ruleSize**\ *optional*       | integer (int32)                           |
9756 +--------------------------------+-------------------------------------------+
9757 | **value**\ *optional*          | string                                    |
9758 +--------------------------------+-------------------------------------------+
9759
9760 RelationshipImpl
9761 ----------------
9762
9763 +--------------------------------+-------------------------------------------+
9764 | Name                           | Schema                                    |
9765 +================================+===========================================+
9766 | **type**\ *optional*           | string                                    |
9767 +--------------------------------+-------------------------------------------+
9768
9769 RequirementAndRelationshipPair
9770 ------------------------------
9771
9772 +--------------------------------+-------------------------------------------+
9773 | Name                           | Schema                                    |
9774 +================================+===========================================+
9775 | **capability**\ *optional*     | string                                    |
9776 +--------------------------------+-------------------------------------------+
9777 | **capabilityOwnerId**\ *option | string                                    |
9778 | al*                            |                                           |
9779 +--------------------------------+-------------------------------------------+
9780 | **capabilityUid**\ *optional*  | string                                    |
9781 +--------------------------------+-------------------------------------------+
9782 | **id**\ *optional*             | string                                    |
9783 +--------------------------------+-------------------------------------------+
9784 | **relationship**\ *optional*   | `RelationshipImpl <#_relationshipimpl>`__ |
9785 +--------------------------------+-------------------------------------------+
9786 | **requirement**\ *optional*    | string                                    |
9787 +--------------------------------+-------------------------------------------+
9788 | **requirementOwnerId**\ *optio | string                                    |
9789 | nal*                           |                                           |
9790 +--------------------------------+-------------------------------------------+
9791 | **requirementUid**\ *optional* | string                                    |
9792 +--------------------------------+-------------------------------------------+
9793
9794 RequirementCapabilityRelDef
9795 ---------------------------
9796
9797 +--------------------------------+-------------------------------------------+
9798 | Name                           | Schema                                    |
9799 +================================+===========================================+
9800 | **fromNode**\ *optional*       | string                                    |
9801 +--------------------------------+-------------------------------------------+
9802 | **relationships**\ *optional*  | <                                         |
9803 |                                | `RequirementAndRelationshipPair <#_requir |
9804 |                                | ementandrelationshippair>`__              |
9805 |                                | > array                                   |
9806 +--------------------------------+-------------------------------------------+
9807 | **toNode**\ *optional*         | string                                    |
9808 +--------------------------------+-------------------------------------------+
9809 | **uid**\ *optional*            | string                                    |
9810 +--------------------------------+-------------------------------------------+
9811
9812 RequirementDefinition
9813 ---------------------
9814
9815 +--------------------------------+-------------------------------------------+
9816 | Name                           | Schema                                    |
9817 +================================+===========================================+
9818 | **capability**\ *optional*     | string                                    |
9819 +--------------------------------+-------------------------------------------+
9820 | **leftOccurrences**\ *optional | string                                    |
9821 | *                              |                                           |
9822 +--------------------------------+-------------------------------------------+
9823 | **maxOccurrences**\ *optional* | string                                    |
9824 +--------------------------------+-------------------------------------------+
9825 | **minOccurrences**\ *optional* | string                                    |
9826 +--------------------------------+-------------------------------------------+
9827 | **name**\ *optional*           | string                                    |
9828 +--------------------------------+-------------------------------------------+
9829 | **node**\ *optional*           | string                                    |
9830 +--------------------------------+-------------------------------------------+
9831 | **ownerId**\ *optional*        | string                                    |
9832 +--------------------------------+-------------------------------------------+
9833 | **ownerName**\ *optional*      | string                                    |
9834 +--------------------------------+-------------------------------------------+
9835 | **parentName**\ *optional*     | string                                    |
9836 +--------------------------------+-------------------------------------------+
9837 | **path**\ *optional*           | < string > array                          |
9838 +--------------------------------+-------------------------------------------+
9839 | **relationship**\ *optional*   | string                                    |
9840 +--------------------------------+-------------------------------------------+
9841 | **source**\ *optional*         | string                                    |
9842 +--------------------------------+-------------------------------------------+
9843 | **uniqueId**\ *optional*       | string                                    |
9844 +--------------------------------+-------------------------------------------+
9845
9846 Resource
9847 --------
9848
9849 +--------------------------------+-------------------------------------------+
9850 | Name                           | Schema                                    |
9851 +================================+===========================================+
9852 | **abstract**\ *optional*       | boolean                                   |
9853 +--------------------------------+-------------------------------------------+
9854 | **additionalInformation**\ *op | <                                         |
9855 | tional*                        | `AdditionalInformationDefinition <#_addit |
9856 |                                | ionalinformationdefinition>`__            |
9857 |                                | > array                                   |
9858 +--------------------------------+-------------------------------------------+
9859 | **allArtifacts**\ *optional*   | < string,                                 |
9860 |                                | `ArtifactDefinition <#_artifactdefinition |
9861 |                                | >`__                                      |
9862 |                                | > map                                     |
9863 +--------------------------------+-------------------------------------------+
9864 | **allVersions**\ *optional*    | < string, string > map                    |
9865 +--------------------------------+-------------------------------------------+
9866 | **artifacts**\ *optional*      | < string,                                 |
9867 |                                | `ArtifactDefinition <#_artifactdefinition |
9868 |                                | >`__                                      |
9869 |                                | > map                                     |
9870 +--------------------------------+-------------------------------------------+
9871 | **attributes**\ *optional*     | <                                         |
9872 |                                | `PropertyDefinition <#_propertydefinition |
9873 |                                | >`__                                      |
9874 |                                | > array                                   |
9875 +--------------------------------+-------------------------------------------+
9876 | **capabilities**\ *optional*   | < string, <                               |
9877 |                                | `CapabilityDefinition <#_capabilitydefini |
9878 |                                | tion>`__                                  |
9879 |                                | > array > map                             |
9880 +--------------------------------+-------------------------------------------+
9881 | **categories**\ *optional*     | <                                         |
9882 |                                | `CategoryDefinition <#_categorydefinition |
9883 |                                | >`__                                      |
9884 |                                | > array                                   |
9885 +--------------------------------+-------------------------------------------+
9886 | **componentInstances**\ *optio | <                                         |
9887 | nal*                           | `ComponentInstance <#_componentinstance>` |
9888 |                                | __                                        |
9889 |                                | > array                                   |
9890 +--------------------------------+-------------------------------------------+
9891 | **componentInstancesAttributes | < string, <                               |
9892 | **\ *optional*                 | `ComponentInstanceProperty <#_componentin |
9893 |                                | stanceproperty>`__                        |
9894 |                                | > array > map                             |
9895 +--------------------------------+-------------------------------------------+
9896 | **componentInstancesInputs**\  | < string, <                               |
9897 | *optional*                     | `ComponentInstanceInput <#_componentinsta |
9898 |                                | nceinput>`__                              |
9899 |                                | > array > map                             |
9900 +--------------------------------+-------------------------------------------+
9901 | **componentInstancesProperties | < string, <                               |
9902 | **\ *optional*                 | `ComponentInstanceProperty <#_componentin |
9903 |                                | stanceproperty>`__                        |
9904 |                                | > array > map                             |
9905 +--------------------------------+-------------------------------------------+
9906 | **componentInstancesRelations* | <                                         |
9907 | *\ *optional*                  | `RequirementCapabilityRelDef <#_requireme |
9908 |                                | ntcapabilityreldef>`__                    |
9909 |                                | > array                                   |
9910 +--------------------------------+-------------------------------------------+
9911 | **componentMetadataDefinition* | `ComponentMetadataDefinition <#_component |
9912 | *\ *optional*                  | metadatadefinition>`__                    |
9913 +--------------------------------+-------------------------------------------+
9914 | **componentType**\ *optional*  | enum (RESOURCE, SERVICE,                  |
9915 |                                | RESOURCE\_INSTANCE, PRODUCT,              |
9916 |                                | SERVICE\_INSTANCE)                        |
9917 +--------------------------------+-------------------------------------------+
9918 | **conformanceLevel**\ *optiona | string                                    |
9919 | l*                             |                                           |
9920 +--------------------------------+-------------------------------------------+
9921 | **contactId**\ *optional*      | string                                    |
9922 +--------------------------------+-------------------------------------------+
9923 | **cost**\ *optional*           | string                                    |
9924 +--------------------------------+-------------------------------------------+
9925 | **creationDate**\ *optional*   | integer (int64)                           |
9926 +--------------------------------+-------------------------------------------+
9927 | **creatorFullName**\ *optional | string                                    |
9928 | *                              |                                           |
9929 +--------------------------------+-------------------------------------------+
9930 | **creatorUserId**\ *optional*  | string                                    |
9931 +--------------------------------+-------------------------------------------+
9932 | **csarUUID**\ *optional*       | string                                    |
9933 +--------------------------------+-------------------------------------------+
9934 | **csarVersion**\ *optional*    | string                                    |
9935 +--------------------------------+-------------------------------------------+
9936 | **defaultCapabilities**\ *opti | < string > array                          |
9937 | onal*                          |                                           |
9938 +--------------------------------+-------------------------------------------+
9939 | **deploymentArtifacts**\ *opti | < string,                                 |
9940 | onal*                          | `ArtifactDefinition <#_artifactdefinition |
9941 |                                | >`__                                      |
9942 |                                | > map                                     |
9943 +--------------------------------+-------------------------------------------+
9944 | **derivedFrom**\ *optional*    | < string > array                          |
9945 +--------------------------------+-------------------------------------------+
9946 | **derivedFromGenericType**\ *o | string                                    |
9947 | ptional*                       |                                           |
9948 +--------------------------------+-------------------------------------------+
9949 | **derivedFromGenericVersion**\ | string                                    |
9950 |  *optional*                    |                                           |
9951 +--------------------------------+-------------------------------------------+
9952 | **derivedList**\ *optional*    | < string > array                          |
9953 +--------------------------------+-------------------------------------------+
9954 | **description**\ *optional*    | string                                    |
9955 +--------------------------------+-------------------------------------------+
9956 | **groups**\ *optional*         | < `GroupDefinition <#_groupdefinition>`__ |
9957 |                                | > array                                   |
9958 +--------------------------------+-------------------------------------------+
9959 | **highestVersion**\ *optional* | boolean                                   |
9960 +--------------------------------+-------------------------------------------+
9961 | **icon**\ *optional*           | string                                    |
9962 +--------------------------------+-------------------------------------------+
9963 | **importedToscaChecksum**\ *op | string                                    |
9964 | tional*                        |                                           |
9965 +--------------------------------+-------------------------------------------+
9966 | **inputs**\ *optional*         | < `InputDefinition <#_inputdefinition>`__ |
9967 |                                | > array                                   |
9968 +--------------------------------+-------------------------------------------+
9969 | **interfaces**\ *optional*     | < string,                                 |
9970 |                                | `InterfaceDefinition <#_interfacedefiniti |
9971 |                                | on>`__                                    |
9972 |                                | > map                                     |
9973 +--------------------------------+-------------------------------------------+
9974 | **invariantUUID**\ *optional*  | string                                    |
9975 +--------------------------------+-------------------------------------------+
9976 | **isDeleted**\ *optional*      | boolean                                   |
9977 +--------------------------------+-------------------------------------------+
9978 | **lastUpdateDate**\ *optional* | integer (int64)                           |
9979 +--------------------------------+-------------------------------------------+
9980 | **lastUpdaterFullName**\ *opti | string                                    |
9981 | onal*                          |                                           |
9982 +--------------------------------+-------------------------------------------+
9983 | **lastUpdaterUserId**\ *option | string                                    |
9984 | al*                            |                                           |
9985 +--------------------------------+-------------------------------------------+
9986 | **licenseType**\ *optional*    | string                                    |
9987 +--------------------------------+-------------------------------------------+
9988 | **lifecycleState**\ *optional* | enum (READY\_FOR\_CERTIFICATION,          |
9989 |                                | CERTIFICATION\_IN\_PROGRESS, CERTIFIED,   |
9990 |                                | NOT\_CERTIFIED\_CHECKIN,                  |
9991 |                                | NOT\_CERTIFIED\_CHECKOUT)                 |
9992 +--------------------------------+-------------------------------------------+
9993 | **name**\ *optional*           | string                                    |
9994 +--------------------------------+-------------------------------------------+
9995 | **normalizedName**\ *optional* | string                                    |
9996 +--------------------------------+-------------------------------------------+
9997 | **projectCode**\ *optional*    | string                                    |
9998 +--------------------------------+-------------------------------------------+
9999 | **properties**\ *optional*     | <                                         |
10000 |                                | `PropertyDefinition <#_propertydefinition |
10001 |                                | >`__                                      |
10002 |                                | > array                                   |
10003 +--------------------------------+-------------------------------------------+
10004 | **requirements**\ *optional*   | < string, <                               |
10005 |                                | `RequirementDefinition <#_requirementdefi |
10006 |                                | nition>`__                                |
10007 |                                | > array > map                             |
10008 +--------------------------------+-------------------------------------------+
10009 | **resourceType**\ *optional*   | enum (VFC, VF, CP, PNF, CVFC, VL, VFCMT,  |
10010 |                                | ABSTRACT)                                 |
10011 +--------------------------------+-------------------------------------------+
10012 | **resourceVendorModelNumber**\ | string                                    |
10013 |  *optional*                    |                                           |
10014 +--------------------------------+-------------------------------------------+
10015 | **systemName**\ *optional*     | string                                    |
10016 +--------------------------------+-------------------------------------------+
10017 | **tags**\ *optional*           | < string > array                          |
10018 +--------------------------------+-------------------------------------------+
10019 | **toscaArtifacts**\ *optional* | < string,                                 |
10020 |                                | `ArtifactDefinition <#_artifactdefinition |
10021 |                                | >`__                                      |
10022 |                                | > map                                     |
10023 +--------------------------------+-------------------------------------------+
10024 | **toscaResourceName**\ *option | string                                    |
10025 | al*                            |                                           |
10026 +--------------------------------+-------------------------------------------+
10027 | **toscaType**\ *optional*      | string                                    |
10028 +--------------------------------+-------------------------------------------+
10029 | **uniqueId**\ *optional*       | string                                    |
10030 +--------------------------------+-------------------------------------------+
10031 | **uuid**\ *optional*           | string                                    |
10032 +--------------------------------+-------------------------------------------+
10033 | **vendorName**\ *optional*     | string                                    |
10034 +--------------------------------+-------------------------------------------+
10035 | **vendorRelease**\ *optional*  | string                                    |
10036 +--------------------------------+-------------------------------------------+
10037 | **version**\ *optional*        | string                                    |
10038 +--------------------------------+-------------------------------------------+
10039
10040 SchemaDefinition
10041 ----------------
10042
10043 +--------------------------------+-------------------------------------------+
10044 | Name                           | Schema                                    |
10045 +================================+===========================================+
10046 | **constraints**\ *optional*    | < string > array                          |
10047 +--------------------------------+-------------------------------------------+
10048 | **derivedFrom**\ *optional*    | string                                    |
10049 +--------------------------------+-------------------------------------------+
10050 | **ownerId**\ *optional*        | string                                    |
10051 +--------------------------------+-------------------------------------------+
10052 | **properties**\ *optional*     | < string,                                 |
10053 |                                | `PropertyDataDefinition <#_propertydatade |
10054 |                                | finition>`__                              |
10055 |                                | > map                                     |
10056 +--------------------------------+-------------------------------------------+
10057 | **property**\ *optional*       | `PropertyDataDefinition <#_propertydatade |
10058 |                                | finition>`__                              |
10059 +--------------------------------+-------------------------------------------+
10060
10061 Service
10062 -------
10063
10064 +--------------------------------+-------------------------------------------+
10065 | Name                           | Schema                                    |
10066 +================================+===========================================+
10067 | **additionalInformation**\ *op | <                                         |
10068 | tional*                        | `AdditionalInformationDefinition <#_addit |
10069 |                                | ionalinformationdefinition>`__            |
10070 |                                | > array                                   |
10071 +--------------------------------+-------------------------------------------+
10072 | **allArtifacts**\ *optional*   | < string,                                 |
10073 |                                | `ArtifactDefinition <#_artifactdefinition |
10074 |                                | >`__                                      |
10075 |                                | > map                                     |
10076 +--------------------------------+-------------------------------------------+
10077 | **allVersions**\ *optional*    | < string, string > map                    |
10078 +--------------------------------+-------------------------------------------+
10079 | **artifacts**\ *optional*      | < string,                                 |
10080 |                                | `ArtifactDefinition <#_artifactdefinition |
10081 |                                | >`__                                      |
10082 |                                | > map                                     |
10083 +--------------------------------+-------------------------------------------+
10084 | **capabilities**\ *optional*   | < string, <                               |
10085 |                                | `CapabilityDefinition <#_capabilitydefini |
10086 |                                | tion>`__                                  |
10087 |                                | > array > map                             |
10088 +--------------------------------+-------------------------------------------+
10089 | **categories**\ *optional*     | <                                         |
10090 |                                | `CategoryDefinition <#_categorydefinition |
10091 |                                | >`__                                      |
10092 |                                | > array                                   |
10093 +--------------------------------+-------------------------------------------+
10094 | **componentInstances**\ *optio | <                                         |
10095 | nal*                           | `ComponentInstance <#_componentinstance>` |
10096 |                                | __                                        |
10097 |                                | > array                                   |
10098 +--------------------------------+-------------------------------------------+
10099 | **componentInstancesAttributes | < string, <                               |
10100 | **\ *optional*                 | `ComponentInstanceProperty <#_componentin |
10101 |                                | stanceproperty>`__                        |
10102 |                                | > array > map                             |
10103 +--------------------------------+-------------------------------------------+
10104 | **componentInstancesInputs**\  | < string, <                               |
10105 | *optional*                     | `ComponentInstanceInput <#_componentinsta |
10106 |                                | nceinput>`__                              |
10107 |                                | > array > map                             |
10108 +--------------------------------+-------------------------------------------+
10109 | **componentInstancesProperties | < string, <                               |
10110 | **\ *optional*                 | `ComponentInstanceProperty <#_componentin |
10111 |                                | stanceproperty>`__                        |
10112 |                                | > array > map                             |
10113 +--------------------------------+-------------------------------------------+
10114 | **componentInstancesRelations* | <                                         |
10115 | *\ *optional*                  | `RequirementCapabilityRelDef <#_requireme |
10116 |                                | ntcapabilityreldef>`__                    |
10117 |                                | > array                                   |
10118 +--------------------------------+-------------------------------------------+
10119 | **componentMetadataDefinition* | `ComponentMetadataDefinition <#_component |
10120 | *\ *optional*                  | metadatadefinition>`__                    |
10121 +--------------------------------+-------------------------------------------+
10122 | **componentType**\ *optional*  | enum (RESOURCE, SERVICE,                  |
10123 |                                | RESOURCE\_INSTANCE, PRODUCT,              |
10124 |                                | SERVICE\_INSTANCE)                        |
10125 +--------------------------------+-------------------------------------------+
10126 | **conformanceLevel**\ *optiona | string                                    |
10127 | l*                             |                                           |
10128 +--------------------------------+-------------------------------------------+
10129 | **contactId**\ *optional*      | string                                    |
10130 +--------------------------------+-------------------------------------------+
10131 | **creationDate**\ *optional*   | integer (int64)                           |
10132 +--------------------------------+-------------------------------------------+
10133 | **creatorFullName**\ *optional | string                                    |
10134 | *                              |                                           |
10135 +--------------------------------+-------------------------------------------+
10136 | **creatorUserId**\ *optional*  | string                                    |
10137 +--------------------------------+-------------------------------------------+
10138 | **csarUUID**\ *optional*       | string                                    |
10139 +--------------------------------+-------------------------------------------+
10140 | **csarVersion**\ *optional*    | string                                    |
10141 +--------------------------------+-------------------------------------------+
10142 | **deploymentArtifacts**\ *opti | < string,                                 |
10143 | onal*                          | `ArtifactDefinition <#_artifactdefinition |
10144 |                                | >`__                                      |
10145 |                                | > map                                     |
10146 +--------------------------------+-------------------------------------------+
10147 | **derivedFromGenericType**\ *o | string                                    |
10148 | ptional*                       |                                           |
10149 +--------------------------------+-------------------------------------------+
10150 | **derivedFromGenericVersion**\ | string                                    |
10151 |  *optional*                    |                                           |
10152 +--------------------------------+-------------------------------------------+
10153 | **description**\ *optional*    | string                                    |
10154 +--------------------------------+-------------------------------------------+
10155 | **distributionStatus**\ *optio | enum (DISTRIBUTION\_NOT\_APPROVED,        |
10156 | nal*                           | DISTRIBUTION\_APPROVED, DISTRIBUTED,      |
10157 |                                | DISTRIBUTION\_REJECTED)                   |
10158 +--------------------------------+-------------------------------------------+
10159 | **ecompGeneratedNaming**\ *opt | boolean                                   |
10160 | ional*                         |                                           |
10161 +--------------------------------+-------------------------------------------+
10162 | **groups**\ *optional*         | < `GroupDefinition <#_groupdefinition>`__ |
10163 |                                | > array                                   |
10164 +--------------------------------+-------------------------------------------+
10165 | **highestVersion**\ *optional* | boolean                                   |
10166 +--------------------------------+-------------------------------------------+
10167 | **icon**\ *optional*           | string                                    |
10168 +--------------------------------+-------------------------------------------+
10169 | **importedToscaChecksum**\ *op | string                                    |
10170 | tional*                        |                                           |
10171 +--------------------------------+-------------------------------------------+
10172 | **inputs**\ *optional*         | < `InputDefinition <#_inputdefinition>`__ |
10173 |                                | > array                                   |
10174 +--------------------------------+-------------------------------------------+
10175 | **invariantUUID**\ *optional*  | string                                    |
10176 +--------------------------------+-------------------------------------------+
10177 | **isDeleted**\ *optional*      | boolean                                   |
10178 +--------------------------------+-------------------------------------------+
10179 | **lastUpdateDate**\ *optional* | integer (int64)                           |
10180 +--------------------------------+-------------------------------------------+
10181 | **lastUpdaterFullName**\ *opti | string                                    |
10182 | onal*                          |                                           |
10183 +--------------------------------+-------------------------------------------+
10184 | **lastUpdaterUserId**\ *option | string                                    |
10185 | al*                            |                                           |
10186 +--------------------------------+-------------------------------------------+
10187 | **lifecycleState**\ *optional* | enum (READY\_FOR\_CERTIFICATION,          |
10188 |                                | CERTIFICATION\_IN\_PROGRESS, CERTIFIED,   |
10189 |                                | NOT\_CERTIFIED\_CHECKIN,                  |
10190 |                                | NOT\_CERTIFIED\_CHECKOUT)                 |
10191 +--------------------------------+-------------------------------------------+
10192 | **name**\ *optional*           | string                                    |
10193 +--------------------------------+-------------------------------------------+
10194 | **namingPolicy**\ *optional*   | string                                    |
10195 +--------------------------------+-------------------------------------------+
10196 | **normalizedName**\ *optional* | string                                    |
10197 +--------------------------------+-------------------------------------------+
10198 | **projectCode**\ *optional*    | string                                    |
10199 +--------------------------------+-------------------------------------------+
10200 | **requirements**\ *optional*   | < string, <                               |
10201 |                                | `RequirementDefinition <#_requirementdefi |
10202 |                                | nition>`__                                |
10203 |                                | > array > map                             |
10204 +--------------------------------+-------------------------------------------+
10205 | **serviceApiArtifacts**\ *opti | < string,                                 |
10206 | onal*                          | `ArtifactDefinition <#_artifactdefinition |
10207 |                                | >`__                                      |
10208 |                                | > map                                     |
10209 +--------------------------------+-------------------------------------------+
10210 | **serviceRole**\ *optional*    | string                                    |
10211 +--------------------------------+-------------------------------------------+
10212 | **serviceType**\ *optional*    | string                                    |
10213 +--------------------------------+-------------------------------------------+
10214 | **systemName**\ *optional*     | string                                    |
10215 +--------------------------------+-------------------------------------------+
10216 | **tags**\ *optional*           | < string > array                          |
10217 +--------------------------------+-------------------------------------------+
10218 | **toscaArtifacts**\ *optional* | < string,                                 |
10219 |                                | `ArtifactDefinition <#_artifactdefinition |
10220 |                                | >`__                                      |
10221 |                                | > map                                     |
10222 +--------------------------------+-------------------------------------------+
10223 | **toscaType**\ *optional*      | string                                    |
10224 +--------------------------------+-------------------------------------------+
10225 | **uniqueId**\ *optional*       | string                                    |
10226 +--------------------------------+-------------------------------------------+
10227 | **uuid**\ *optional*           | string                                    |
10228 +--------------------------------+-------------------------------------------+
10229 | **version**\ *optional*        | string                                    |
10230 +--------------------------------+-------------------------------------------+
10231
10232 SubCategoryDefinition
10233 ---------------------
10234
10235 +--------------------------------+-------------------------------------------+
10236 | Name                           | Schema                                    |
10237 +================================+===========================================+
10238 | **groupings**\ *optional*      | <                                         |
10239 |                                | `GroupingDefinition <#_groupingdefinition |
10240 |                                | >`__                                      |
10241 |                                | > array                                   |
10242 +--------------------------------+-------------------------------------------+
10243 | **icons**\ *optional*          | < string > array                          |
10244 +--------------------------------+-------------------------------------------+
10245 | **name**\ *optional*           | string                                    |
10246 +--------------------------------+-------------------------------------------+
10247 | **normalizedName**\ *optional* | string                                    |
10248 +--------------------------------+-------------------------------------------+
10249 | **ownerId**\ *optional*        | string                                    |
10250 +--------------------------------+-------------------------------------------+
10251 | **uniqueId**\ *optional*       | string                                    |
10252 +--------------------------------+-------------------------------------------+
10253
10254 User
10255 ----
10256
10257 +--------------------------------+-------------------------------------------+
10258 | Name                           | Schema                                    |
10259 +================================+===========================================+
10260 | **email**\ *optional*          | string                                    |
10261 +--------------------------------+-------------------------------------------+
10262 | **firstName**\ *optional*      | string                                    |
10263 +--------------------------------+-------------------------------------------+
10264 | **fullName**\ *optional*       | string                                    |
10265 +--------------------------------+-------------------------------------------+
10266 | **lastLoginTime**\ *optional*  | integer (int64)                           |
10267 +--------------------------------+-------------------------------------------+
10268 | **lastName**\ *optional*       | string                                    |
10269 +--------------------------------+-------------------------------------------+
10270 | **role**\ *optional*           | string                                    |
10271 +--------------------------------+-------------------------------------------+
10272 | **status**\ *optional*         | enum (ACTIVE, INACTIVE)                   |
10273 +--------------------------------+-------------------------------------------+
10274 | **userId**\ *optional*         | string                                    |
10275 +--------------------------------+-------------------------------------------+