Rich Bennett | 4b00193 | 2017-10-16 09:25:01 -0400 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | .. http://creativecommons.org/licenses/by/4.0 |
| 3 | |
Idan Amit | fc411f0 | 2017-10-23 12:36:06 +0300 | [diff] [blame] | 4 | ============= |
Idan Amit | 248b9b7 | 2017-11-05 11:56:11 +0200 | [diff] [blame] | 5 | Offered APIs |
Idan Amit | fc411f0 | 2017-10-23 12:36:06 +0300 | [diff] [blame] | 6 | ============= |
Rich Bennett | 4b00193 | 2017-10-16 09:25:01 -0400 | [diff] [blame] | 7 | |
Idan Amit | fc411f0 | 2017-10-23 12:36:06 +0300 | [diff] [blame] | 8 | :Date: 2017-10-23 |
Rich Bennett | 4b00193 | 2017-10-16 09:25:01 -0400 | [diff] [blame] | 9 | |
Idan Amit | 6e30a1b | 2017-10-18 09:51:10 +0300 | [diff] [blame] | 10 | .. contents:: |
Idan Amit | 248b9b7 | 2017-11-05 11:56:11 +0200 | [diff] [blame] | 11 | :depth: 3 |
Idan Amit | 6e30a1b | 2017-10-18 09:51:10 +0300 | [diff] [blame] | 12 | .. |
| 13 | |
| 14 | Overview |
| 15 | ======== |
| 16 | |
| 17 | Version information |
| 18 | ------------------- |
| 19 | |
Idan Amit | dbfbc63 | 2017-10-29 17:03:42 +0200 | [diff] [blame] | 20 | *Version* : 1.1.0 |
Idan Amit | 6e30a1b | 2017-10-18 09:51:10 +0300 | [diff] [blame] | 21 | |
| 22 | URI scheme |
| 23 | ---------- |
| 24 | |
| 25 | *Host* : localhost:8080 *BasePath* : /sdc2/rest *Schemes* : HTTP |
| 26 | |
| 27 | Tags |
| 28 | ---- |
| 29 | |
| 30 | - Additional Information Servlet |
| 31 | |
| 32 | - BE Monitoring |
| 33 | |
| 34 | - Catalog Types Upload |
| 35 | |
| 36 | - Component Servlet |
| 37 | |
| 38 | - Consumer Servlet |
| 39 | |
| 40 | - Distribution Service Servlet |
| 41 | |
| 42 | - Element Servlet |
| 43 | |
| 44 | - Input Catalog |
| 45 | |
| 46 | - Lifecycle Actions Servlet |
| 47 | |
| 48 | - Product Catalog |
| 49 | |
| 50 | - Resource Artifact Servlet |
| 51 | |
| 52 | - Resource Attribute Servlet |
| 53 | |
| 54 | - Resource Group Servlet |
| 55 | |
| 56 | - Resource Instance Servlet |
| 57 | |
| 58 | - Resource Property Servlet |
| 59 | |
| 60 | - Resources Catalog |
| 61 | |
| 62 | - Resources Catalog Upload |
| 63 | |
| 64 | - Service Catalog |
| 65 | |
| 66 | - Types Fetch Servlet |
| 67 | |
| 68 | - User Administration |
| 69 | |
| 70 | Paths |
| 71 | ===== |
| 72 | |
| 73 | return aggregate BE health check of Titan, ES and BE |
| 74 | ---------------------------------------------------- |
| 75 | |
| 76 | :: |
| 77 | |
| 78 | GET /healthCheck |
| 79 | |
| 80 | Description |
| 81 | ~~~~~~~~~~~ |
| 82 | |
| 83 | return BE health check |
| 84 | |
| 85 | Responses |
| 86 | ~~~~~~~~~ |
| 87 | |
| 88 | +---------+----------------------------------------------------+----------------+ |
| 89 | | HTTP | Description | Schema | |
| 90 | | Code | | | |
| 91 | +=========+====================================================+================+ |
| 92 | | **200** | Titan, ES and BE are all up | No Content | |
| 93 | +---------+----------------------------------------------------+----------------+ |
| 94 | | **500** | One or more BE components (Titan, ES, BE) are down | No Content | |
| 95 | +---------+----------------------------------------------------+----------------+ |
| 96 | |
| 97 | Consumes |
| 98 | ~~~~~~~~ |
| 99 | |
| 100 | - ``application/json`` |
| 101 | |
| 102 | Produces |
| 103 | ~~~~~~~~ |
| 104 | |
| 105 | - ``application/json`` |
| 106 | |
| 107 | Tags |
| 108 | ~~~~ |
| 109 | |
| 110 | - BE Monitoring |
| 111 | |
| 112 | POST /monitoring |
| 113 | ---------------- |
| 114 | |
| 115 | Parameters |
| 116 | ~~~~~~~~~~ |
| 117 | |
| 118 | +------------------+--------------------------+----------------------------------+ |
| 119 | | Type | Name | Schema | |
| 120 | +==================+==========================+==================================+ |
| 121 | | **Body** | **body**\ *optional* | string | |
| 122 | +------------------+--------------------------+----------------------------------+ |
| 123 | |
| 124 | Responses |
| 125 | ~~~~~~~~~ |
| 126 | |
| 127 | +---------+----------------------------------------------------+----------------+ |
| 128 | | HTTP | Description | Schema | |
| 129 | | Code | | | |
| 130 | +=========+====================================================+================+ |
| 131 | | **defau | successful operation | No Content | |
| 132 | | lt** | | | |
| 133 | +---------+----------------------------------------------------+----------------+ |
| 134 | |
| 135 | Consumes |
| 136 | ~~~~~~~~ |
| 137 | |
| 138 | - ``application/json`` |
| 139 | |
| 140 | Produces |
| 141 | ~~~~~~~~ |
| 142 | |
| 143 | - ``application/json`` |
| 144 | |
| 145 | Tags |
| 146 | ~~~~ |
| 147 | |
| 148 | - BE Monitoring |
| 149 | |
| 150 | Retrieve all artifactTypes |
| 151 | -------------------------- |
| 152 | |
| 153 | :: |
| 154 | |
| 155 | GET /v1/artifactTypes |
| 156 | |
| 157 | Description |
| 158 | ~~~~~~~~~~~ |
| 159 | |
| 160 | Retrieve all artifactTypes |
| 161 | |
| 162 | Parameters |
| 163 | ~~~~~~~~~~ |
| 164 | |
| 165 | +------------------+--------------------------+----------------------------------+ |
| 166 | | Type | Name | Schema | |
| 167 | +==================+==========================+==================================+ |
| 168 | | **Header** | **USER\_ID**\ *optional* | string | |
| 169 | +------------------+--------------------------+----------------------------------+ |
| 170 | |
| 171 | Responses |
| 172 | ~~~~~~~~~ |
| 173 | |
| 174 | +---------+----------------------------------------------------+----------------+ |
| 175 | | HTTP | Description | Schema | |
| 176 | | Code | | | |
| 177 | +=========+====================================================+================+ |
| 178 | | **200** | Returns artifactTypes Ok | No Content | |
| 179 | +---------+----------------------------------------------------+----------------+ |
| 180 | | **404** | No artifactTypes were found | No Content | |
| 181 | +---------+----------------------------------------------------+----------------+ |
| 182 | | **500** | Internal Server Error | No Content | |
| 183 | +---------+----------------------------------------------------+----------------+ |
| 184 | |
| 185 | Consumes |
| 186 | ~~~~~~~~ |
| 187 | |
| 188 | - ``application/json`` |
| 189 | |
| 190 | Produces |
| 191 | ~~~~~~~~ |
| 192 | |
| 193 | - ``application/json`` |
| 194 | |
| 195 | Tags |
| 196 | ~~~~ |
| 197 | |
| 198 | - Element Servlet |
| 199 | |
| 200 | get component audit records |
| 201 | --------------------------- |
| 202 | |
| 203 | :: |
| 204 | |
| 205 | GET /v1/catalog/audit-records/{componentType}/{componentUniqueId} |
| 206 | |
| 207 | Description |
| 208 | ~~~~~~~~~~~ |
| 209 | |
| 210 | get audit records for a service or a resource |
| 211 | |
| 212 | Parameters |
| 213 | ~~~~~~~~~~ |
| 214 | |
| 215 | +------------------+--------------------------+----------------------------------+ |
| 216 | | Type | Name | Schema | |
| 217 | +==================+==========================+==================================+ |
| 218 | | **Header** | **USER\_ID**\ *optional* | string | |
| 219 | +------------------+--------------------------+----------------------------------+ |
| 220 | | **Path** | **componentType**\ *requ | string | |
| 221 | | | ired* | | |
| 222 | +------------------+--------------------------+----------------------------------+ |
| 223 | | **Path** | **componentUniqueId**\ * | string | |
| 224 | | | required* | | |
| 225 | +------------------+--------------------------+----------------------------------+ |
| 226 | |
| 227 | Responses |
| 228 | ~~~~~~~~~ |
| 229 | |
| 230 | +---------+----------------------------------------------------+----------------+ |
| 231 | | HTTP | Description | Schema | |
| 232 | | Code | | | |
| 233 | +=========+====================================================+================+ |
| 234 | | **200** | Service found | No Content | |
| 235 | +---------+----------------------------------------------------+----------------+ |
| 236 | | **403** | Restricted operation | No Content | |
| 237 | +---------+----------------------------------------------------+----------------+ |
| 238 | |
| 239 | Consumes |
| 240 | ~~~~~~~~ |
| 241 | |
| 242 | - ``application/json`` |
| 243 | |
| 244 | Produces |
| 245 | ~~~~~~~~ |
| 246 | |
| 247 | - ``application/json`` |
| 248 | |
| 249 | Tags |
| 250 | ~~~~ |
| 251 | |
| 252 | - Service Catalog |
| 253 | |
| 254 | Get data types |
| 255 | -------------- |
| 256 | |
| 257 | :: |
| 258 | |
| 259 | GET /v1/catalog/dataTypes |
| 260 | |
| 261 | Description |
| 262 | ~~~~~~~~~~~ |
| 263 | |
| 264 | Returns data types |
| 265 | |
| 266 | Parameters |
| 267 | ~~~~~~~~~~ |
| 268 | |
| 269 | +------------------+--------------------------+----------------------------------+ |
| 270 | | Type | Name | Schema | |
| 271 | +==================+==========================+==================================+ |
| 272 | | **Header** | **USER\_ID**\ *optional* | string | |
| 273 | +------------------+--------------------------+----------------------------------+ |
| 274 | |
| 275 | Responses |
| 276 | ~~~~~~~~~ |
| 277 | |
| 278 | +---------+----------------------------------------------------+----------------+ |
| 279 | | HTTP | Description | Schema | |
| 280 | | Code | | | |
| 281 | +=========+====================================================+================+ |
| 282 | | **200** | datatypes | No Content | |
| 283 | +---------+----------------------------------------------------+----------------+ |
| 284 | | **400** | Invalid content / Missing content | No Content | |
| 285 | +---------+----------------------------------------------------+----------------+ |
| 286 | | **403** | Restricted operation | No Content | |
| 287 | +---------+----------------------------------------------------+----------------+ |
| 288 | | **404** | Data types not found | No Content | |
| 289 | +---------+----------------------------------------------------+----------------+ |
| 290 | |
| 291 | Consumes |
| 292 | ~~~~~~~~ |
| 293 | |
| 294 | - ``application/json`` |
| 295 | |
| 296 | Produces |
| 297 | ~~~~~~~~ |
| 298 | |
| 299 | - ``application/json`` |
| 300 | |
| 301 | Tags |
| 302 | ~~~~ |
| 303 | |
| 304 | - Types Fetch Servlet |
| 305 | |
| 306 | Create product |
| 307 | -------------- |
| 308 | |
| 309 | :: |
| 310 | |
| 311 | POST /v1/catalog/products |
| 312 | |
| 313 | Description |
| 314 | ~~~~~~~~~~~ |
| 315 | |
| 316 | Returns created product |
| 317 | |
| 318 | Parameters |
| 319 | ~~~~~~~~~~ |
| 320 | |
| 321 | +----------+-------------+--------------------------------------+------------------+ |
| 322 | | Type | Name | Description | Schema | |
| 323 | +==========+=============+======================================+==================+ |
| 324 | | **Header | **USER\_ID* | USER\_ID of product strategist user | string | |
| 325 | | ** | *\ *require | | | |
| 326 | | | d* | | | |
| 327 | +----------+-------------+--------------------------------------+------------------+ |
| 328 | | **Body** | **body**\ * | Product object to be created | string | |
| 329 | | | required* | | | |
| 330 | +----------+-------------+--------------------------------------+------------------+ |
| 331 | |
| 332 | Responses |
| 333 | ~~~~~~~~~ |
| 334 | |
| 335 | +---------+----------------------------------------------------+----------------+ |
| 336 | | HTTP | Description | Schema | |
| 337 | | Code | | | |
| 338 | +=========+====================================================+================+ |
| 339 | | **200** | successful operation | `Product <#_pr | |
| 340 | | | | oduct>`__ | |
| 341 | +---------+----------------------------------------------------+----------------+ |
| 342 | | **201** | Product created | No Content | |
| 343 | +---------+----------------------------------------------------+----------------+ |
| 344 | | **400** | Invalid/missing content | No Content | |
| 345 | +---------+----------------------------------------------------+----------------+ |
| 346 | | **403** | Restricted operation / Empty USER\_ID header | No Content | |
| 347 | +---------+----------------------------------------------------+----------------+ |
| 348 | | **409** | Product already exists / User not found / Wrong | No Content | |
| 349 | | | user role | | |
| 350 | +---------+----------------------------------------------------+----------------+ |
| 351 | |
| 352 | Consumes |
| 353 | ~~~~~~~~ |
| 354 | |
| 355 | - ``application/json`` |
| 356 | |
| 357 | Produces |
| 358 | ~~~~~~~~ |
| 359 | |
| 360 | - ``application/json`` |
| 361 | |
| 362 | Tags |
| 363 | ~~~~ |
| 364 | |
| 365 | - Product Catalog |
| 366 | |
| 367 | Retrieve Service |
| 368 | ---------------- |
| 369 | |
| 370 | :: |
| 371 | |
| 372 | GET /v1/catalog/products/productName/{productName}/productVersion/{productVersion} |
| 373 | |
| 374 | Description |
| 375 | ~~~~~~~~~~~ |
| 376 | |
| 377 | Returns product according to name and version |
| 378 | |
| 379 | Parameters |
| 380 | ~~~~~~~~~~ |
| 381 | |
| 382 | +------------------+--------------------------+----------------------------------+ |
| 383 | | Type | Name | Schema | |
| 384 | +==================+==========================+==================================+ |
| 385 | | **Header** | **USER\_ID**\ *optional* | string | |
| 386 | +------------------+--------------------------+----------------------------------+ |
| 387 | | **Path** | **productName**\ *requir | string | |
| 388 | | | ed* | | |
| 389 | +------------------+--------------------------+----------------------------------+ |
| 390 | | **Path** | **productVersion**\ *req | string | |
| 391 | | | uired* | | |
| 392 | +------------------+--------------------------+----------------------------------+ |
| 393 | |
| 394 | Responses |
| 395 | ~~~~~~~~~ |
| 396 | |
| 397 | +---------+----------------------------------------------------+----------------+ |
| 398 | | HTTP | Description | Schema | |
| 399 | | Code | | | |
| 400 | +=========+====================================================+================+ |
| 401 | | **200** | Product found | No Content | |
| 402 | +---------+----------------------------------------------------+----------------+ |
| 403 | | **403** | Restricted operation | No Content | |
| 404 | +---------+----------------------------------------------------+----------------+ |
| 405 | | **404** | Product not found | No Content | |
| 406 | +---------+----------------------------------------------------+----------------+ |
| 407 | |
| 408 | Consumes |
| 409 | ~~~~~~~~ |
| 410 | |
| 411 | - ``application/json`` |
| 412 | |
| 413 | Produces |
| 414 | ~~~~~~~~ |
| 415 | |
| 416 | - ``application/json`` |
| 417 | |
| 418 | Tags |
| 419 | ~~~~ |
| 420 | |
| 421 | - Product Catalog |
| 422 | |
| 423 | validate product name |
| 424 | --------------------- |
| 425 | |
| 426 | :: |
| 427 | |
| 428 | GET /v1/catalog/products/validate-name/{productName} |
| 429 | |
| 430 | Description |
| 431 | ~~~~~~~~~~~ |
| 432 | |
| 433 | checks if the chosen product name is available |
| 434 | |
| 435 | Parameters |
| 436 | ~~~~~~~~~~ |
| 437 | |
| 438 | +------------------+--------------------------+----------------------------------+ |
| 439 | | Type | Name | Schema | |
| 440 | +==================+==========================+==================================+ |
| 441 | | **Header** | **USER\_ID**\ *optional* | string | |
| 442 | +------------------+--------------------------+----------------------------------+ |
| 443 | | **Path** | **productName**\ *requir | string | |
| 444 | | | ed* | | |
| 445 | +------------------+--------------------------+----------------------------------+ |
| 446 | |
| 447 | Responses |
| 448 | ~~~~~~~~~ |
| 449 | |
| 450 | +---------+----------------------------------------------------+----------------+ |
| 451 | | HTTP | Description | Schema | |
| 452 | | Code | | | |
| 453 | +=========+====================================================+================+ |
| 454 | | **200** | Service found | No Content | |
| 455 | +---------+----------------------------------------------------+----------------+ |
| 456 | | **403** | Restricted operation | No Content | |
| 457 | +---------+----------------------------------------------------+----------------+ |
| 458 | |
| 459 | Consumes |
| 460 | ~~~~~~~~ |
| 461 | |
| 462 | - ``application/json`` |
| 463 | |
| 464 | Produces |
| 465 | ~~~~~~~~ |
| 466 | |
| 467 | - ``application/json`` |
| 468 | |
| 469 | Tags |
| 470 | ~~~~ |
| 471 | |
| 472 | - Product Catalog |
| 473 | |
| 474 | Retrieve product |
| 475 | ---------------- |
| 476 | |
| 477 | :: |
| 478 | |
| 479 | GET /v1/catalog/products/{productId} |
| 480 | |
| 481 | Description |
| 482 | ~~~~~~~~~~~ |
| 483 | |
| 484 | Returns product according to productId |
| 485 | |
| 486 | Parameters |
| 487 | ~~~~~~~~~~ |
| 488 | |
| 489 | +------------------+--------------------------+----------------------------------+ |
| 490 | | Type | Name | Schema | |
| 491 | +==================+==========================+==================================+ |
| 492 | | **Header** | **USER\_ID**\ *optional* | string | |
| 493 | +------------------+--------------------------+----------------------------------+ |
| 494 | | **Path** | **productId**\ *required | string | |
| 495 | | | * | | |
| 496 | +------------------+--------------------------+----------------------------------+ |
| 497 | |
| 498 | Responses |
| 499 | ~~~~~~~~~ |
| 500 | |
| 501 | +---------+----------------------------------------------------+----------------+ |
| 502 | | HTTP | Description | Schema | |
| 503 | | Code | | | |
| 504 | +=========+====================================================+================+ |
| 505 | | **200** | Product found | No Content | |
| 506 | +---------+----------------------------------------------------+----------------+ |
| 507 | | **403** | Missing information | No Content | |
| 508 | +---------+----------------------------------------------------+----------------+ |
| 509 | | **404** | Product not found | No Content | |
| 510 | +---------+----------------------------------------------------+----------------+ |
| 511 | | **409** | Restricted operation | No Content | |
| 512 | +---------+----------------------------------------------------+----------------+ |
| 513 | | **500** | Internal Server Error | No Content | |
| 514 | +---------+----------------------------------------------------+----------------+ |
| 515 | |
| 516 | Consumes |
| 517 | ~~~~~~~~ |
| 518 | |
| 519 | - ``application/json`` |
| 520 | |
| 521 | Produces |
| 522 | ~~~~~~~~ |
| 523 | |
| 524 | - ``application/json`` |
| 525 | |
| 526 | Tags |
| 527 | ~~~~ |
| 528 | |
| 529 | - Product Catalog |
| 530 | |
| 531 | DELETE /v1/catalog/products/{productid} |
| 532 | --------------------------------------- |
| 533 | |
| 534 | Parameters |
| 535 | ~~~~~~~~~~ |
| 536 | |
| 537 | +------------------+--------------------------+----------------------------------+ |
| 538 | | Type | Name | Schema | |
| 539 | +==================+==========================+==================================+ |
| 540 | | **Path** | **productId**\ *required | string | |
| 541 | | | * | | |
| 542 | +------------------+--------------------------+----------------------------------+ |
| 543 | |
| 544 | Responses |
| 545 | ~~~~~~~~~ |
| 546 | |
| 547 | +---------+----------------------------------------------------+----------------+ |
| 548 | | HTTP | Description | Schema | |
| 549 | | Code | | | |
| 550 | +=========+====================================================+================+ |
| 551 | | **defau | successful operation | No Content | |
| 552 | | lt** | | | |
| 553 | +---------+----------------------------------------------------+----------------+ |
| 554 | |
| 555 | Tags |
| 556 | ~~~~ |
| 557 | |
| 558 | - Product Catalog |
| 559 | |
| 560 | Update Product Metadata |
| 561 | ----------------------- |
| 562 | |
| 563 | :: |
| 564 | |
| 565 | PUT /v1/catalog/products/{productId}/metadata |
| 566 | |
| 567 | Description |
| 568 | ~~~~~~~~~~~ |
| 569 | |
| 570 | Returns updated product |
| 571 | |
| 572 | Parameters |
| 573 | ~~~~~~~~~~ |
| 574 | |
| 575 | +----------+-------------+--------------------------------------+------------------+ |
| 576 | | Type | Name | Description | Schema | |
| 577 | +==========+=============+======================================+==================+ |
| 578 | | **Header | **USER\_ID* | | string | |
| 579 | | ** | *\ *optiona | | | |
| 580 | | | l* | | | |
| 581 | +----------+-------------+--------------------------------------+------------------+ |
| 582 | | **Path** | **productId | | string | |
| 583 | | | **\ *requir | | | |
| 584 | | | ed* | | | |
| 585 | +----------+-------------+--------------------------------------+------------------+ |
| 586 | | **Body** | **body**\ * | Product object to be Updated | string | |
| 587 | | | required* | | | |
| 588 | +----------+-------------+--------------------------------------+------------------+ |
| 589 | |
| 590 | Responses |
| 591 | ~~~~~~~~~ |
| 592 | |
| 593 | +---------+----------------------------------------------------+----------------+ |
| 594 | | HTTP | Description | Schema | |
| 595 | | Code | | | |
| 596 | +=========+====================================================+================+ |
| 597 | | **200** | Product Updated | No Content | |
| 598 | +---------+----------------------------------------------------+----------------+ |
| 599 | | **400** | Invalid content / Missing content | No Content | |
| 600 | +---------+----------------------------------------------------+----------------+ |
| 601 | | **403** | Restricted operation | No Content | |
| 602 | +---------+----------------------------------------------------+----------------+ |
| 603 | |
| 604 | Consumes |
| 605 | ~~~~~~~~ |
| 606 | |
| 607 | - ``application/json`` |
| 608 | |
| 609 | Produces |
| 610 | ~~~~~~~~ |
| 611 | |
| 612 | - ``application/json`` |
| 613 | |
| 614 | Tags |
| 615 | ~~~~ |
| 616 | |
| 617 | - Product Catalog |
| 618 | |
| 619 | Create Resource |
| 620 | --------------- |
| 621 | |
| 622 | :: |
| 623 | |
| 624 | POST /v1/catalog/resources |
| 625 | |
| 626 | Description |
| 627 | ~~~~~~~~~~~ |
| 628 | |
| 629 | Returns created resource |
| 630 | |
| 631 | Parameters |
| 632 | ~~~~~~~~~~ |
| 633 | |
| 634 | +----------+-------------+--------------------------------------+------------------+ |
| 635 | | Type | Name | Description | Schema | |
| 636 | +==========+=============+======================================+==================+ |
| 637 | | **Header | **USER\_ID* | | string | |
| 638 | | ** | *\ *optiona | | | |
| 639 | | | l* | | | |
| 640 | +----------+-------------+--------------------------------------+------------------+ |
| 641 | | **Body** | **body**\ * | Resource object to be created | string | |
| 642 | | | required* | | | |
| 643 | +----------+-------------+--------------------------------------+------------------+ |
| 644 | |
| 645 | Responses |
| 646 | ~~~~~~~~~ |
| 647 | |
| 648 | +---------+----------------------------------------------------+----------------+ |
| 649 | | HTTP | Description | Schema | |
| 650 | | Code | | | |
| 651 | +=========+====================================================+================+ |
| 652 | | **200** | successful operation | `Resource <#_r | |
| 653 | | | | esource>`__ | |
| 654 | +---------+----------------------------------------------------+----------------+ |
| 655 | | **201** | Resource created | No Content | |
| 656 | +---------+----------------------------------------------------+----------------+ |
| 657 | | **400** | Invalid content / Missing content | No Content | |
| 658 | +---------+----------------------------------------------------+----------------+ |
| 659 | | **403** | Restricted operation | No Content | |
| 660 | +---------+----------------------------------------------------+----------------+ |
| 661 | | **409** | Resource already exist | No Content | |
| 662 | +---------+----------------------------------------------------+----------------+ |
| 663 | |
| 664 | Consumes |
| 665 | ~~~~~~~~ |
| 666 | |
| 667 | - ``application/json`` |
| 668 | |
| 669 | Produces |
| 670 | ~~~~~~~~ |
| 671 | |
| 672 | - ``application/json`` |
| 673 | |
| 674 | Tags |
| 675 | ~~~~ |
| 676 | |
| 677 | - Resources Catalog |
| 678 | |
| 679 | GET /v1/catalog/resources/certified/abstract |
| 680 | -------------------------------------------- |
| 681 | |
| 682 | Parameters |
| 683 | ~~~~~~~~~~ |
| 684 | |
| 685 | +------------------+--------------------------+----------------------------------+ |
| 686 | | Type | Name | Schema | |
| 687 | +==================+==========================+==================================+ |
| 688 | | **Header** | **USER\_ID**\ *optional* | string | |
| 689 | +------------------+--------------------------+----------------------------------+ |
| 690 | |
| 691 | Responses |
| 692 | ~~~~~~~~~ |
| 693 | |
| 694 | +---------+----------------------------------------------------+----------------+ |
| 695 | | HTTP | Description | Schema | |
| 696 | | Code | | | |
| 697 | +=========+====================================================+================+ |
| 698 | | **defau | successful operation | No Content | |
| 699 | | lt** | | | |
| 700 | +---------+----------------------------------------------------+----------------+ |
| 701 | |
| 702 | Consumes |
| 703 | ~~~~~~~~ |
| 704 | |
| 705 | - ``application/json`` |
| 706 | |
| 707 | Produces |
| 708 | ~~~~~~~~ |
| 709 | |
| 710 | - ``application/json`` |
| 711 | |
| 712 | Tags |
| 713 | ~~~~ |
| 714 | |
| 715 | - Resources Catalog |
| 716 | |
| 717 | GET /v1/catalog/resources/certified/notabstract |
| 718 | ----------------------------------------------- |
| 719 | |
| 720 | Parameters |
| 721 | ~~~~~~~~~~ |
| 722 | |
| 723 | +------------------+--------------------------+----------------------------------+ |
| 724 | | Type | Name | Schema | |
| 725 | +==================+==========================+==================================+ |
| 726 | | **Header** | **USER\_ID**\ *optional* | string | |
| 727 | +------------------+--------------------------+----------------------------------+ |
| 728 | |
| 729 | Responses |
| 730 | ~~~~~~~~~ |
| 731 | |
| 732 | +---------+----------------------------------------------------+----------------+ |
| 733 | | HTTP | Description | Schema | |
| 734 | | Code | | | |
| 735 | +=========+====================================================+================+ |
| 736 | | **defau | successful operation | No Content | |
| 737 | | lt** | | | |
| 738 | +---------+----------------------------------------------------+----------------+ |
| 739 | |
| 740 | Consumes |
| 741 | ~~~~~~~~ |
| 742 | |
| 743 | - ``application/json`` |
| 744 | |
| 745 | Produces |
| 746 | ~~~~~~~~ |
| 747 | |
| 748 | - ``application/json`` |
| 749 | |
| 750 | Tags |
| 751 | ~~~~ |
| 752 | |
| 753 | - Resources Catalog |
| 754 | |
| 755 | Create Resource |
| 756 | --------------- |
| 757 | |
| 758 | :: |
| 759 | |
| 760 | POST /v1/catalog/resources/csar/{csaruuid} |
| 761 | |
| 762 | Description |
| 763 | ~~~~~~~~~~~ |
| 764 | |
| 765 | Returns resource created from csar uuid |
| 766 | |
| 767 | Parameters |
| 768 | ~~~~~~~~~~ |
| 769 | |
| 770 | +------------------+--------------------------+----------------------------------+ |
| 771 | | Type | Name | Schema | |
| 772 | +==================+==========================+==================================+ |
| 773 | | **Header** | **USER\_ID**\ *optional* | string | |
| 774 | +------------------+--------------------------+----------------------------------+ |
| 775 | | **Path** | **csaruuid**\ *required* | string | |
| 776 | +------------------+--------------------------+----------------------------------+ |
| 777 | |
| 778 | Responses |
| 779 | ~~~~~~~~~ |
| 780 | |
| 781 | +---------+----------------------------------------------------+----------------+ |
| 782 | | HTTP | Description | Schema | |
| 783 | | Code | | | |
| 784 | +=========+====================================================+================+ |
| 785 | | **200** | successful operation | `Resource <#_r | |
| 786 | | | | esource>`__ | |
| 787 | +---------+----------------------------------------------------+----------------+ |
| 788 | | **201** | Resource retrieced | No Content | |
| 789 | +---------+----------------------------------------------------+----------------+ |
| 790 | | **400** | Invalid content / Missing content | No Content | |
| 791 | +---------+----------------------------------------------------+----------------+ |
| 792 | | **403** | Restricted operation | No Content | |
| 793 | +---------+----------------------------------------------------+----------------+ |
| 794 | |
| 795 | Consumes |
| 796 | ~~~~~~~~ |
| 797 | |
| 798 | - ``application/json`` |
| 799 | |
| 800 | Produces |
| 801 | ~~~~~~~~ |
| 802 | |
| 803 | - ``application/json`` |
| 804 | |
| 805 | Tags |
| 806 | ~~~~ |
| 807 | |
| 808 | - Resources Catalog |
| 809 | |
| 810 | Retrieve Resource by name and version |
| 811 | ------------------------------------- |
| 812 | |
| 813 | :: |
| 814 | |
| 815 | GET /v1/catalog/resources/resourceName/{resourceName}/resourceVersion/{resourceVersion} |
| 816 | |
| 817 | Description |
| 818 | ~~~~~~~~~~~ |
| 819 | |
| 820 | Returns resource according to resourceId |
| 821 | |
| 822 | Parameters |
| 823 | ~~~~~~~~~~ |
| 824 | |
| 825 | +------------------+--------------------------+----------------------------------+ |
| 826 | | Type | Name | Schema | |
| 827 | +==================+==========================+==================================+ |
| 828 | | **Header** | **USER\_ID**\ *optional* | string | |
| 829 | +------------------+--------------------------+----------------------------------+ |
| 830 | | **Path** | **resourceName**\ *requi | string | |
| 831 | | | red* | | |
| 832 | +------------------+--------------------------+----------------------------------+ |
| 833 | | **Path** | **resourceVersion**\ *re | string | |
| 834 | | | quired* | | |
| 835 | +------------------+--------------------------+----------------------------------+ |
| 836 | |
| 837 | Responses |
| 838 | ~~~~~~~~~ |
| 839 | |
| 840 | +---------+----------------------------------------------------+----------------+ |
| 841 | | HTTP | Description | Schema | |
| 842 | | Code | | | |
| 843 | +=========+====================================================+================+ |
| 844 | | **200** | Resource found | No Content | |
| 845 | +---------+----------------------------------------------------+----------------+ |
| 846 | | **403** | Restricted operation | No Content | |
| 847 | +---------+----------------------------------------------------+----------------+ |
| 848 | | **404** | Resource not found | No Content | |
| 849 | +---------+----------------------------------------------------+----------------+ |
| 850 | |
| 851 | Consumes |
| 852 | ~~~~~~~~ |
| 853 | |
| 854 | - ``application/json`` |
| 855 | |
| 856 | Produces |
| 857 | ~~~~~~~~ |
| 858 | |
| 859 | - ``application/json`` |
| 860 | |
| 861 | Tags |
| 862 | ~~~~ |
| 863 | |
| 864 | - Resources Catalog |
| 865 | |
| 866 | validate resource name |
| 867 | ---------------------- |
| 868 | |
| 869 | :: |
| 870 | |
| 871 | GET /v1/catalog/resources/validate-name/{resourceName} |
| 872 | |
| 873 | Description |
| 874 | ~~~~~~~~~~~ |
| 875 | |
| 876 | checks if the chosen resource name is available |
| 877 | |
| 878 | Parameters |
| 879 | ~~~~~~~~~~ |
| 880 | |
| 881 | +------------------+--------------------------+----------------------------------+ |
| 882 | | Type | Name | Schema | |
| 883 | +==================+==========================+==================================+ |
| 884 | | **Header** | **USER\_ID**\ *optional* | string | |
| 885 | +------------------+--------------------------+----------------------------------+ |
| 886 | | **Path** | **resourceName**\ *requi | string | |
| 887 | | | red* | | |
| 888 | +------------------+--------------------------+----------------------------------+ |
| 889 | | **Query** | **subtype**\ *optional* | string | |
| 890 | +------------------+--------------------------+----------------------------------+ |
| 891 | |
| 892 | Responses |
| 893 | ~~~~~~~~~ |
| 894 | |
| 895 | +---------+----------------------------------------------------+----------------+ |
| 896 | | HTTP | Description | Schema | |
| 897 | | Code | | | |
| 898 | +=========+====================================================+================+ |
| 899 | | **200** | Resource found | No Content | |
| 900 | +---------+----------------------------------------------------+----------------+ |
| 901 | | **403** | Restricted operation | No Content | |
| 902 | +---------+----------------------------------------------------+----------------+ |
| 903 | |
| 904 | Consumes |
| 905 | ~~~~~~~~ |
| 906 | |
| 907 | - ``application/json`` |
| 908 | |
| 909 | Produces |
| 910 | ~~~~~~~~ |
| 911 | |
| 912 | - ``application/json`` |
| 913 | |
| 914 | Tags |
| 915 | ~~~~ |
| 916 | |
| 917 | - Resources Catalog |
| 918 | |
| 919 | Retrieve Resource |
| 920 | ----------------- |
| 921 | |
| 922 | :: |
| 923 | |
| 924 | GET /v1/catalog/resources/{resourceId} |
| 925 | |
| 926 | Description |
| 927 | ~~~~~~~~~~~ |
| 928 | |
| 929 | Returns resource according to resourceId |
| 930 | |
| 931 | Parameters |
| 932 | ~~~~~~~~~~ |
| 933 | |
| 934 | +------------------+--------------------------+----------------------------------+ |
| 935 | | Type | Name | Schema | |
| 936 | +==================+==========================+==================================+ |
| 937 | | **Header** | **USER\_ID**\ *optional* | string | |
| 938 | +------------------+--------------------------+----------------------------------+ |
| 939 | | **Path** | **resourceId**\ *require | string | |
| 940 | | | d* | | |
| 941 | +------------------+--------------------------+----------------------------------+ |
| 942 | |
| 943 | Responses |
| 944 | ~~~~~~~~~ |
| 945 | |
| 946 | +---------+----------------------------------------------------+----------------+ |
| 947 | | HTTP | Description | Schema | |
| 948 | | Code | | | |
| 949 | +=========+====================================================+================+ |
| 950 | | **200** | Resource found | No Content | |
| 951 | +---------+----------------------------------------------------+----------------+ |
| 952 | | **403** | Restricted operation | No Content | |
| 953 | +---------+----------------------------------------------------+----------------+ |
| 954 | | **404** | Resource not found | No Content | |
| 955 | +---------+----------------------------------------------------+----------------+ |
| 956 | |
| 957 | Consumes |
| 958 | ~~~~~~~~ |
| 959 | |
| 960 | - ``application/json`` |
| 961 | |
| 962 | Produces |
| 963 | ~~~~~~~~ |
| 964 | |
| 965 | - ``application/json`` |
| 966 | |
| 967 | Tags |
| 968 | ~~~~ |
| 969 | |
| 970 | - Resources Catalog |
| 971 | |
| 972 | Update Resource |
| 973 | --------------- |
| 974 | |
| 975 | :: |
| 976 | |
| 977 | PUT /v1/catalog/resources/{resourceId} |
| 978 | |
| 979 | Description |
| 980 | ~~~~~~~~~~~ |
| 981 | |
| 982 | Returns updated resource |
| 983 | |
| 984 | Parameters |
| 985 | ~~~~~~~~~~ |
| 986 | |
| 987 | +----------+-------------+--------------------------------------+------------------+ |
| 988 | | Type | Name | Description | Schema | |
| 989 | +==========+=============+======================================+==================+ |
| 990 | | **Header | **USER\_ID* | | string | |
| 991 | | ** | *\ *optiona | | | |
| 992 | | | l* | | | |
| 993 | +----------+-------------+--------------------------------------+------------------+ |
| 994 | | **Path** | **resourceI | | string | |
| 995 | | | d**\ *requi | | | |
| 996 | | | red* | | | |
| 997 | +----------+-------------+--------------------------------------+------------------+ |
| 998 | | **Body** | **body**\ * | Resource object to be updated | string | |
| 999 | | | required* | | | |
| 1000 | +----------+-------------+--------------------------------------+------------------+ |
| 1001 | |
| 1002 | Responses |
| 1003 | ~~~~~~~~~ |
| 1004 | |
| 1005 | +---------+----------------------------------------------------+----------------+ |
| 1006 | | HTTP | Description | Schema | |
| 1007 | | Code | | | |
| 1008 | +=========+====================================================+================+ |
| 1009 | | **200** | Resource updated | No Content | |
| 1010 | +---------+----------------------------------------------------+----------------+ |
| 1011 | | **400** | Invalid content / Missing content | No Content | |
| 1012 | +---------+----------------------------------------------------+----------------+ |
| 1013 | | **403** | Restricted operation | No Content | |
| 1014 | +---------+----------------------------------------------------+----------------+ |
| 1015 | | **409** | Resource already exist | No Content | |
| 1016 | +---------+----------------------------------------------------+----------------+ |
| 1017 | |
| 1018 | Consumes |
| 1019 | ~~~~~~~~ |
| 1020 | |
| 1021 | - ``application/json`` |
| 1022 | |
| 1023 | Produces |
| 1024 | ~~~~~~~~ |
| 1025 | |
| 1026 | - ``application/json`` |
| 1027 | |
| 1028 | Tags |
| 1029 | ~~~~ |
| 1030 | |
| 1031 | - Resources Catalog |
| 1032 | |
| 1033 | DELETE /v1/catalog/resources/{resourceid} |
| 1034 | ----------------------------------------- |
| 1035 | |
| 1036 | Parameters |
| 1037 | ~~~~~~~~~~ |
| 1038 | |
| 1039 | +------------------+--------------------------+----------------------------------+ |
| 1040 | | Type | Name | Schema | |
| 1041 | +==================+==========================+==================================+ |
| 1042 | | **Path** | **resourceId**\ *require | string | |
| 1043 | | | d* | | |
| 1044 | +------------------+--------------------------+----------------------------------+ |
| 1045 | |
| 1046 | Responses |
| 1047 | ~~~~~~~~~ |
| 1048 | |
| 1049 | +---------+----------------------------------------------------+----------------+ |
| 1050 | | HTTP | Description | Schema | |
| 1051 | | Code | | | |
| 1052 | +=========+====================================================+================+ |
| 1053 | | **defau | successful operation | No Content | |
| 1054 | | lt** | | | |
| 1055 | +---------+----------------------------------------------------+----------------+ |
| 1056 | |
| 1057 | Tags |
| 1058 | ~~~~ |
| 1059 | |
| 1060 | - Resources Catalog |
| 1061 | |
| 1062 | Create Additional Information Label and Value |
| 1063 | --------------------------------------------- |
| 1064 | |
| 1065 | :: |
| 1066 | |
| 1067 | POST /v1/catalog/resources/{resourceId}/additionalinfo |
| 1068 | |
| 1069 | Description |
| 1070 | ~~~~~~~~~~~ |
| 1071 | |
| 1072 | Returns created Additional Inforamtion property |
| 1073 | |
| 1074 | Parameters |
| 1075 | ~~~~~~~~~~ |
| 1076 | |
| 1077 | +----------+-------------+--------------------------------------+------------------+ |
| 1078 | | Type | Name | Description | Schema | |
| 1079 | +==========+=============+======================================+==================+ |
| 1080 | | **Header | **USER\_ID* | | string | |
| 1081 | | ** | *\ *optiona | | | |
| 1082 | | | l* | | | |
| 1083 | +----------+-------------+--------------------------------------+------------------+ |
| 1084 | | **Path** | **resourceI | resource id to update with new | string | |
| 1085 | | | d**\ *requi | property | | |
| 1086 | | | red* | | | |
| 1087 | +----------+-------------+--------------------------------------+------------------+ |
| 1088 | | **Body** | **body**\ * | Additional information key value to | string | |
| 1089 | | | required* | be created | | |
| 1090 | +----------+-------------+--------------------------------------+------------------+ |
| 1091 | |
| 1092 | Responses |
| 1093 | ~~~~~~~~~ |
| 1094 | |
| 1095 | +---------+----------------------------------------------------+----------------+ |
| 1096 | | HTTP | Description | Schema | |
| 1097 | | Code | | | |
| 1098 | +=========+====================================================+================+ |
| 1099 | | **201** | Additional information created | No Content | |
| 1100 | +---------+----------------------------------------------------+----------------+ |
| 1101 | | **400** | Invalid content / Missing content | No Content | |
| 1102 | +---------+----------------------------------------------------+----------------+ |
| 1103 | | **403** | Restricted operation | No Content | |
| 1104 | +---------+----------------------------------------------------+----------------+ |
| 1105 | | **409** | Additional information key already exist | No Content | |
| 1106 | +---------+----------------------------------------------------+----------------+ |
| 1107 | |
| 1108 | Consumes |
| 1109 | ~~~~~~~~ |
| 1110 | |
| 1111 | - ``application/json`` |
| 1112 | |
| 1113 | Produces |
| 1114 | ~~~~~~~~ |
| 1115 | |
| 1116 | - ``application/json`` |
| 1117 | |
| 1118 | Tags |
| 1119 | ~~~~ |
| 1120 | |
| 1121 | - Additional Information Servlet |
| 1122 | |
| 1123 | Get all Additional Information under resource |
| 1124 | --------------------------------------------- |
| 1125 | |
| 1126 | :: |
| 1127 | |
| 1128 | GET /v1/catalog/resources/{resourceId}/additionalinfo |
| 1129 | |
| 1130 | Description |
| 1131 | ~~~~~~~~~~~ |
| 1132 | |
| 1133 | Returns Additional Inforamtion property |
| 1134 | |
| 1135 | Parameters |
| 1136 | ~~~~~~~~~~ |
| 1137 | |
| 1138 | +----------+-------------+--------------------------------------+------------------+ |
| 1139 | | Type | Name | Description | Schema | |
| 1140 | +==========+=============+======================================+==================+ |
| 1141 | | **Header | **USER\_ID* | | string | |
| 1142 | | ** | *\ *optiona | | | |
| 1143 | | | l* | | | |
| 1144 | +----------+-------------+--------------------------------------+------------------+ |
| 1145 | | **Path** | **resourceI | resource id to update with new | string | |
| 1146 | | | d**\ *requi | property | | |
| 1147 | | | red* | | | |
| 1148 | +----------+-------------+--------------------------------------+------------------+ |
| 1149 | |
| 1150 | Responses |
| 1151 | ~~~~~~~~~ |
| 1152 | |
| 1153 | +---------+----------------------------------------------------+----------------+ |
| 1154 | | HTTP | Description | Schema | |
| 1155 | | Code | | | |
| 1156 | +=========+====================================================+================+ |
| 1157 | | **200** | list of additional information | No Content | |
| 1158 | +---------+----------------------------------------------------+----------------+ |
| 1159 | | **400** | Invalid content / Missing content | No Content | |
| 1160 | +---------+----------------------------------------------------+----------------+ |
| 1161 | | **403** | Restricted operation | No Content | |
| 1162 | +---------+----------------------------------------------------+----------------+ |
| 1163 | | **409** | Additional information key already exist | No Content | |
| 1164 | +---------+----------------------------------------------------+----------------+ |
| 1165 | |
| 1166 | Consumes |
| 1167 | ~~~~~~~~ |
| 1168 | |
| 1169 | - ``application/json`` |
| 1170 | |
| 1171 | Produces |
| 1172 | ~~~~~~~~ |
| 1173 | |
| 1174 | - ``application/json`` |
| 1175 | |
| 1176 | Tags |
| 1177 | ~~~~ |
| 1178 | |
| 1179 | - Additional Information Servlet |
| 1180 | |
| 1181 | Get Additional Information by id |
| 1182 | -------------------------------- |
| 1183 | |
| 1184 | :: |
| 1185 | |
| 1186 | GET /v1/catalog/resources/{resourceId}/additionalinfo/{labelId} |
| 1187 | |
| 1188 | Description |
| 1189 | ~~~~~~~~~~~ |
| 1190 | |
| 1191 | Returns Additional Inforamtion property |
| 1192 | |
| 1193 | Parameters |
| 1194 | ~~~~~~~~~~ |
| 1195 | |
| 1196 | +----------+-------------+--------------------------------------+------------------+ |
| 1197 | | Type | Name | Description | Schema | |
| 1198 | +==========+=============+======================================+==================+ |
| 1199 | | **Header | **USER\_ID* | | string | |
| 1200 | | ** | *\ *optiona | | | |
| 1201 | | | l* | | | |
| 1202 | +----------+-------------+--------------------------------------+------------------+ |
| 1203 | | **Path** | **labelId** | label id | string | |
| 1204 | | | \ *required | | | |
| 1205 | | | * | | | |
| 1206 | +----------+-------------+--------------------------------------+------------------+ |
| 1207 | | **Path** | **resourceI | resource id to update with new | string | |
| 1208 | | | d**\ *requi | property | | |
| 1209 | | | red* | | | |
| 1210 | +----------+-------------+--------------------------------------+------------------+ |
| 1211 | |
| 1212 | Responses |
| 1213 | ~~~~~~~~~ |
| 1214 | |
| 1215 | +---------+----------------------------------------------------+----------------+ |
| 1216 | | HTTP | Description | Schema | |
| 1217 | | Code | | | |
| 1218 | +=========+====================================================+================+ |
| 1219 | | **200** | fetched additional information | No Content | |
| 1220 | +---------+----------------------------------------------------+----------------+ |
| 1221 | | **400** | Invalid content / Missing content | No Content | |
| 1222 | +---------+----------------------------------------------------+----------------+ |
| 1223 | | **403** | Restricted operation | No Content | |
| 1224 | +---------+----------------------------------------------------+----------------+ |
| 1225 | | **409** | Additional information key already exist | No Content | |
| 1226 | +---------+----------------------------------------------------+----------------+ |
| 1227 | |
| 1228 | Consumes |
| 1229 | ~~~~~~~~ |
| 1230 | |
| 1231 | - ``application/json`` |
| 1232 | |
| 1233 | Produces |
| 1234 | ~~~~~~~~ |
| 1235 | |
| 1236 | - ``application/json`` |
| 1237 | |
| 1238 | Tags |
| 1239 | ~~~~ |
| 1240 | |
| 1241 | - Additional Information Servlet |
| 1242 | |
| 1243 | Update Additional Information Label and Value |
| 1244 | --------------------------------------------- |
| 1245 | |
| 1246 | :: |
| 1247 | |
| 1248 | PUT /v1/catalog/resources/{resourceId}/additionalinfo/{labelId} |
| 1249 | |
| 1250 | Description |
| 1251 | ~~~~~~~~~~~ |
| 1252 | |
| 1253 | Returns updated Additional Inforamtion property |
| 1254 | |
| 1255 | Parameters |
| 1256 | ~~~~~~~~~~ |
| 1257 | |
| 1258 | +----------+-------------+--------------------------------------+------------------+ |
| 1259 | | Type | Name | Description | Schema | |
| 1260 | +==========+=============+======================================+==================+ |
| 1261 | | **Header | **USER\_ID* | | string | |
| 1262 | | ** | *\ *optiona | | | |
| 1263 | | | l* | | | |
| 1264 | +----------+-------------+--------------------------------------+------------------+ |
| 1265 | | **Path** | **labelId** | label id | string | |
| 1266 | | | \ *required | | | |
| 1267 | | | * | | | |
| 1268 | +----------+-------------+--------------------------------------+------------------+ |
| 1269 | | **Path** | **resourceI | resource id to update with new | string | |
| 1270 | | | d**\ *requi | property | | |
| 1271 | | | red* | | | |
| 1272 | +----------+-------------+--------------------------------------+------------------+ |
| 1273 | | **Body** | **body**\ * | Additional information key value to | string | |
| 1274 | | | required* | be created | | |
| 1275 | +----------+-------------+--------------------------------------+------------------+ |
| 1276 | |
| 1277 | Responses |
| 1278 | ~~~~~~~~~ |
| 1279 | |
| 1280 | +---------+----------------------------------------------------+----------------+ |
| 1281 | | HTTP | Description | Schema | |
| 1282 | | Code | | | |
| 1283 | +=========+====================================================+================+ |
| 1284 | | **200** | Additional information updated | No Content | |
| 1285 | +---------+----------------------------------------------------+----------------+ |
| 1286 | | **400** | Invalid content / Missing content | No Content | |
| 1287 | +---------+----------------------------------------------------+----------------+ |
| 1288 | | **403** | Restricted operation | No Content | |
| 1289 | +---------+----------------------------------------------------+----------------+ |
| 1290 | | **409** | Additional information key already exist | No Content | |
| 1291 | +---------+----------------------------------------------------+----------------+ |
| 1292 | |
| 1293 | Consumes |
| 1294 | ~~~~~~~~ |
| 1295 | |
| 1296 | - ``application/json`` |
| 1297 | |
| 1298 | Produces |
| 1299 | ~~~~~~~~ |
| 1300 | |
| 1301 | - ``application/json`` |
| 1302 | |
| 1303 | Tags |
| 1304 | ~~~~ |
| 1305 | |
| 1306 | - Additional Information Servlet |
| 1307 | |
| 1308 | Create Additional Information Label and Value |
| 1309 | --------------------------------------------- |
| 1310 | |
| 1311 | :: |
| 1312 | |
| 1313 | DELETE /v1/catalog/resources/{resourceId}/additionalinfo/{labelId} |
| 1314 | |
| 1315 | Description |
| 1316 | ~~~~~~~~~~~ |
| 1317 | |
| 1318 | Returns deleted Additional Inforamtion property |
| 1319 | |
| 1320 | Parameters |
| 1321 | ~~~~~~~~~~ |
| 1322 | |
| 1323 | +----------+-------------+--------------------------------------+------------------+ |
| 1324 | | Type | Name | Description | Schema | |
| 1325 | +==========+=============+======================================+==================+ |
| 1326 | | **Header | **USER\_ID* | | string | |
| 1327 | | ** | *\ *optiona | | | |
| 1328 | | | l* | | | |
| 1329 | +----------+-------------+--------------------------------------+------------------+ |
| 1330 | | **Path** | **labelId** | label id | string | |
| 1331 | | | \ *required | | | |
| 1332 | | | * | | | |
| 1333 | +----------+-------------+--------------------------------------+------------------+ |
| 1334 | | **Path** | **resourceI | resource id to update with new | string | |
| 1335 | | | d**\ *requi | property | | |
| 1336 | | | red* | | | |
| 1337 | +----------+-------------+--------------------------------------+------------------+ |
| 1338 | |
| 1339 | Responses |
| 1340 | ~~~~~~~~~ |
| 1341 | |
| 1342 | +---------+----------------------------------------------------+----------------+ |
| 1343 | | HTTP | Description | Schema | |
| 1344 | | Code | | | |
| 1345 | +=========+====================================================+================+ |
| 1346 | | **200** | Additional information deleted | No Content | |
| 1347 | +---------+----------------------------------------------------+----------------+ |
| 1348 | | **400** | Invalid content / Missing content | No Content | |
| 1349 | +---------+----------------------------------------------------+----------------+ |
| 1350 | | **403** | Restricted operation | No Content | |
| 1351 | +---------+----------------------------------------------------+----------------+ |
| 1352 | | **409** | Additional information key already exist | No Content | |
| 1353 | +---------+----------------------------------------------------+----------------+ |
| 1354 | |
| 1355 | Consumes |
| 1356 | ~~~~~~~~ |
| 1357 | |
| 1358 | - ``application/json`` |
| 1359 | |
| 1360 | Produces |
| 1361 | ~~~~~~~~ |
| 1362 | |
| 1363 | - ``application/json`` |
| 1364 | |
| 1365 | Tags |
| 1366 | ~~~~ |
| 1367 | |
| 1368 | - Additional Information Servlet |
| 1369 | |
| 1370 | Create Artifact |
| 1371 | --------------- |
| 1372 | |
| 1373 | :: |
| 1374 | |
| 1375 | POST /v1/catalog/resources/{resourceId}/artifacts |
| 1376 | |
| 1377 | Description |
| 1378 | ~~~~~~~~~~~ |
| 1379 | |
| 1380 | Returns created ArtifactDefinition |
| 1381 | |
| 1382 | Parameters |
| 1383 | ~~~~~~~~~~ |
| 1384 | |
| 1385 | +----------+-------------+--------------------------------------+------------------+ |
| 1386 | | Type | Name | Description | Schema | |
| 1387 | +==========+=============+======================================+==================+ |
| 1388 | | **Path** | **resourceI | | string | |
| 1389 | | | d**\ *requi | | | |
| 1390 | | | red* | | | |
| 1391 | +----------+-------------+--------------------------------------+------------------+ |
| 1392 | | **Body** | **body**\ * | json describe the artifact | string | |
| 1393 | | | required* | | | |
| 1394 | +----------+-------------+--------------------------------------+------------------+ |
| 1395 | |
| 1396 | Responses |
| 1397 | ~~~~~~~~~ |
| 1398 | |
| 1399 | +---------+----------------------------------------------------+----------------+ |
| 1400 | | HTTP | Description | Schema | |
| 1401 | | Code | | | |
| 1402 | +=========+====================================================+================+ |
| 1403 | | **201** | Resource created | No Content | |
| 1404 | +---------+----------------------------------------------------+----------------+ |
| 1405 | | **400** | Invalid content / Missing content | No Content | |
| 1406 | +---------+----------------------------------------------------+----------------+ |
| 1407 | | **403** | Restricted operation | No Content | |
| 1408 | +---------+----------------------------------------------------+----------------+ |
| 1409 | | **409** | Artifact already exist | No Content | |
| 1410 | +---------+----------------------------------------------------+----------------+ |
| 1411 | |
| 1412 | Consumes |
| 1413 | ~~~~~~~~ |
| 1414 | |
| 1415 | - ``application/json`` |
| 1416 | |
| 1417 | Produces |
| 1418 | ~~~~~~~~ |
| 1419 | |
| 1420 | - ``application/json`` |
| 1421 | |
| 1422 | Tags |
| 1423 | ~~~~ |
| 1424 | |
| 1425 | - Resource Artifact Servlet |
| 1426 | |
| 1427 | Update Artifact |
| 1428 | --------------- |
| 1429 | |
| 1430 | :: |
| 1431 | |
| 1432 | POST /v1/catalog/resources/{resourceId}/artifacts/{artifactId} |
| 1433 | |
| 1434 | Description |
| 1435 | ~~~~~~~~~~~ |
| 1436 | |
| 1437 | Returns updated artifact |
| 1438 | |
| 1439 | Parameters |
| 1440 | ~~~~~~~~~~ |
| 1441 | |
| 1442 | +----------+-------------+--------------------------------------+------------------+ |
| 1443 | | Type | Name | Description | Schema | |
| 1444 | +==========+=============+======================================+==================+ |
| 1445 | | **Path** | **artifactI | | string | |
| 1446 | | | d**\ *requi | | | |
| 1447 | | | red* | | | |
| 1448 | +----------+-------------+--------------------------------------+------------------+ |
| 1449 | | **Path** | **resourceI | | string | |
| 1450 | | | d**\ *requi | | | |
| 1451 | | | red* | | | |
| 1452 | +----------+-------------+--------------------------------------+------------------+ |
| 1453 | | **Body** | **body**\ * | json describe the artifact | string | |
| 1454 | | | required* | | | |
| 1455 | +----------+-------------+--------------------------------------+------------------+ |
| 1456 | |
| 1457 | Responses |
| 1458 | ~~~~~~~~~ |
| 1459 | |
| 1460 | +---------+----------------------------------------------------+----------------+ |
| 1461 | | HTTP | Description | Schema | |
| 1462 | | Code | | | |
| 1463 | +=========+====================================================+================+ |
| 1464 | | **201** | Resource created | No Content | |
| 1465 | +---------+----------------------------------------------------+----------------+ |
| 1466 | | **400** | Invalid content / Missing content | No Content | |
| 1467 | +---------+----------------------------------------------------+----------------+ |
| 1468 | | **403** | Restricted operation | No Content | |
| 1469 | +---------+----------------------------------------------------+----------------+ |
| 1470 | |
| 1471 | Consumes |
| 1472 | ~~~~~~~~ |
| 1473 | |
| 1474 | - ``application/json`` |
| 1475 | |
| 1476 | Produces |
| 1477 | ~~~~~~~~ |
| 1478 | |
| 1479 | - ``application/json`` |
| 1480 | |
| 1481 | Tags |
| 1482 | ~~~~ |
| 1483 | |
| 1484 | - Resource Artifact Servlet |
| 1485 | |
| 1486 | Download resource Artifact in Base64 |
| 1487 | ------------------------------------ |
| 1488 | |
| 1489 | :: |
| 1490 | |
| 1491 | GET /v1/catalog/resources/{resourceId}/artifacts/{artifactId} |
| 1492 | |
| 1493 | Description |
| 1494 | ~~~~~~~~~~~ |
| 1495 | |
| 1496 | Returns downloaded artifact |
| 1497 | |
| 1498 | Parameters |
| 1499 | ~~~~~~~~~~ |
| 1500 | |
| 1501 | +------------------+--------------------------+----------------------------------+ |
| 1502 | | Type | Name | Schema | |
| 1503 | +==================+==========================+==================================+ |
| 1504 | | **Path** | **artifactId**\ *require | string | |
| 1505 | | | d* | | |
| 1506 | +------------------+--------------------------+----------------------------------+ |
| 1507 | | **Path** | **resourceId**\ *require | string | |
| 1508 | | | d* | | |
| 1509 | +------------------+--------------------------+----------------------------------+ |
| 1510 | |
| 1511 | Responses |
| 1512 | ~~~~~~~~~ |
| 1513 | |
| 1514 | +---------+----------------------------------------------------+----------------+ |
| 1515 | | HTTP | Description | Schema | |
| 1516 | | Code | | | |
| 1517 | +=========+====================================================+================+ |
| 1518 | | **200** | Resource artifact downloaded | No Content | |
| 1519 | +---------+----------------------------------------------------+----------------+ |
| 1520 | | **404** | Resource/Artifact not found | No Content | |
| 1521 | +---------+----------------------------------------------------+----------------+ |
| 1522 | |
| 1523 | Consumes |
| 1524 | ~~~~~~~~ |
| 1525 | |
| 1526 | - ``application/json`` |
| 1527 | |
| 1528 | Produces |
| 1529 | ~~~~~~~~ |
| 1530 | |
| 1531 | - ``application/json`` |
| 1532 | |
| 1533 | Tags |
| 1534 | ~~~~ |
| 1535 | |
| 1536 | - Resource Artifact Servlet |
| 1537 | |
| 1538 | Delete Artifact |
| 1539 | --------------- |
| 1540 | |
| 1541 | :: |
| 1542 | |
| 1543 | DELETE /v1/catalog/resources/{resourceId}/artifacts/{artifactId} |
| 1544 | |
| 1545 | Description |
| 1546 | ~~~~~~~~~~~ |
| 1547 | |
| 1548 | Returns delete artifact |
| 1549 | |
| 1550 | Parameters |
| 1551 | ~~~~~~~~~~ |
| 1552 | |
| 1553 | +------------------+--------------------------+----------------------------------+ |
| 1554 | | Type | Name | Schema | |
| 1555 | +==================+==========================+==================================+ |
| 1556 | | **Path** | **artifactId**\ *require | string | |
| 1557 | | | d* | | |
| 1558 | +------------------+--------------------------+----------------------------------+ |
| 1559 | | **Path** | **resourceId**\ *require | string | |
| 1560 | | | d* | | |
| 1561 | +------------------+--------------------------+----------------------------------+ |
| 1562 | |
| 1563 | Responses |
| 1564 | ~~~~~~~~~ |
| 1565 | |
| 1566 | +---------+----------------------------------------------------+----------------+ |
| 1567 | | HTTP | Description | Schema | |
| 1568 | | Code | | | |
| 1569 | +=========+====================================================+================+ |
| 1570 | | **201** | Resource created | No Content | |
| 1571 | +---------+----------------------------------------------------+----------------+ |
| 1572 | | **400** | Invalid content / Missing content | No Content | |
| 1573 | +---------+----------------------------------------------------+----------------+ |
| 1574 | | **403** | Restricted operation | No Content | |
| 1575 | +---------+----------------------------------------------------+----------------+ |
| 1576 | |
| 1577 | Consumes |
| 1578 | ~~~~~~~~ |
| 1579 | |
| 1580 | - ``application/json`` |
| 1581 | |
| 1582 | Produces |
| 1583 | ~~~~~~~~ |
| 1584 | |
| 1585 | - ``application/json`` |
| 1586 | |
| 1587 | Tags |
| 1588 | ~~~~ |
| 1589 | |
| 1590 | - Resource Artifact Servlet |
| 1591 | |
| 1592 | Create Resource Attribute |
| 1593 | ------------------------- |
| 1594 | |
| 1595 | :: |
| 1596 | |
| 1597 | POST /v1/catalog/resources/{resourceId}/attributes |
| 1598 | |
| 1599 | Description |
| 1600 | ~~~~~~~~~~~ |
| 1601 | |
| 1602 | Returns created resource attribute |
| 1603 | |
| 1604 | Parameters |
| 1605 | ~~~~~~~~~~ |
| 1606 | |
| 1607 | +----------+-------------+--------------------------------------+------------------+ |
| 1608 | | Type | Name | Description | Schema | |
| 1609 | +==========+=============+======================================+==================+ |
| 1610 | | **Header | **USER\_ID* | | string | |
| 1611 | | ** | *\ *optiona | | | |
| 1612 | | | l* | | | |
| 1613 | +----------+-------------+--------------------------------------+------------------+ |
| 1614 | | **Path** | **resourceI | resource id to update with new | string | |
| 1615 | | | d**\ *requi | attribute | | |
| 1616 | | | red* | | | |
| 1617 | +----------+-------------+--------------------------------------+------------------+ |
| 1618 | | **Body** | **body**\ * | Resource attribute to be created | string | |
| 1619 | | | required* | | | |
| 1620 | +----------+-------------+--------------------------------------+------------------+ |
| 1621 | |
| 1622 | Responses |
| 1623 | ~~~~~~~~~ |
| 1624 | |
| 1625 | +---------+----------------------------------------------------+----------------+ |
| 1626 | | HTTP | Description | Schema | |
| 1627 | | Code | | | |
| 1628 | +=========+====================================================+================+ |
| 1629 | | **201** | Resource property created | No Content | |
| 1630 | +---------+----------------------------------------------------+----------------+ |
| 1631 | | **400** | Invalid content / Missing content | No Content | |
| 1632 | +---------+----------------------------------------------------+----------------+ |
| 1633 | | **403** | Restricted operation | No Content | |
| 1634 | +---------+----------------------------------------------------+----------------+ |
| 1635 | | **409** | Resource attribute already exist | No Content | |
| 1636 | +---------+----------------------------------------------------+----------------+ |
| 1637 | |
| 1638 | Consumes |
| 1639 | ~~~~~~~~ |
| 1640 | |
| 1641 | - ``application/json`` |
| 1642 | |
| 1643 | Produces |
| 1644 | ~~~~~~~~ |
| 1645 | |
| 1646 | - ``application/json`` |
| 1647 | |
| 1648 | Tags |
| 1649 | ~~~~ |
| 1650 | |
| 1651 | - Resource Attribute Servlet |
| 1652 | |
| 1653 | Update Resource Attribute |
| 1654 | ------------------------- |
| 1655 | |
| 1656 | :: |
| 1657 | |
| 1658 | PUT /v1/catalog/resources/{resourceId}/attributes/{attributeId} |
| 1659 | |
| 1660 | Description |
| 1661 | ~~~~~~~~~~~ |
| 1662 | |
| 1663 | Returns updated attribute |
| 1664 | |
| 1665 | Parameters |
| 1666 | ~~~~~~~~~~ |
| 1667 | |
| 1668 | +----------+-------------+--------------------------------------+------------------+ |
| 1669 | | Type | Name | Description | Schema | |
| 1670 | +==========+=============+======================================+==================+ |
| 1671 | | **Header | **USER\_ID* | | string | |
| 1672 | | ** | *\ *optiona | | | |
| 1673 | | | l* | | | |
| 1674 | +----------+-------------+--------------------------------------+------------------+ |
| 1675 | | **Path** | **attribute | attribute id to update | string | |
| 1676 | | | Id**\ *requ | | | |
| 1677 | | | ired* | | | |
| 1678 | +----------+-------------+--------------------------------------+------------------+ |
| 1679 | | **Path** | **resourceI | resource id to update with new | string | |
| 1680 | | | d**\ *requi | attribute | | |
| 1681 | | | red* | | | |
| 1682 | +----------+-------------+--------------------------------------+------------------+ |
| 1683 | | **Body** | **body**\ * | Resource attribute to update | string | |
| 1684 | | | required* | | | |
| 1685 | +----------+-------------+--------------------------------------+------------------+ |
| 1686 | |
| 1687 | Responses |
| 1688 | ~~~~~~~~~ |
| 1689 | |
| 1690 | +---------+----------------------------------------------------+----------------+ |
| 1691 | | HTTP | Description | Schema | |
| 1692 | | Code | | | |
| 1693 | +=========+====================================================+================+ |
| 1694 | | **200** | Resource attribute updated | No Content | |
| 1695 | +---------+----------------------------------------------------+----------------+ |
| 1696 | | **400** | Invalid content / Missing content | No Content | |
| 1697 | +---------+----------------------------------------------------+----------------+ |
| 1698 | | **403** | Restricted operation | No Content | |
| 1699 | +---------+----------------------------------------------------+----------------+ |
| 1700 | |
| 1701 | Consumes |
| 1702 | ~~~~~~~~ |
| 1703 | |
| 1704 | - ``application/json`` |
| 1705 | |
| 1706 | Produces |
| 1707 | ~~~~~~~~ |
| 1708 | |
| 1709 | - ``application/json`` |
| 1710 | |
| 1711 | Tags |
| 1712 | ~~~~ |
| 1713 | |
| 1714 | - Resource Attribute Servlet |
| 1715 | |
| 1716 | Create Resource Attribute |
| 1717 | ------------------------- |
| 1718 | |
| 1719 | :: |
| 1720 | |
| 1721 | DELETE /v1/catalog/resources/{resourceId}/attributes/{attributeId} |
| 1722 | |
| 1723 | Description |
| 1724 | ~~~~~~~~~~~ |
| 1725 | |
| 1726 | Returns deleted attribute |
| 1727 | |
| 1728 | Parameters |
| 1729 | ~~~~~~~~~~ |
| 1730 | |
| 1731 | +----------+-------------+--------------------------------------+------------------+ |
| 1732 | | Type | Name | Description | Schema | |
| 1733 | +==========+=============+======================================+==================+ |
| 1734 | | **Header | **USER\_ID* | | string | |
| 1735 | | ** | *\ *optiona | | | |
| 1736 | | | l* | | | |
| 1737 | +----------+-------------+--------------------------------------+------------------+ |
| 1738 | | **Path** | **attribute | Attribute id to delete | string | |
| 1739 | | | Id**\ *requ | | | |
| 1740 | | | ired* | | | |
| 1741 | +----------+-------------+--------------------------------------+------------------+ |
| 1742 | | **Path** | **resourceI | resource id of attribute | string | |
| 1743 | | | d**\ *requi | | | |
| 1744 | | | red* | | | |
| 1745 | +----------+-------------+--------------------------------------+------------------+ |
| 1746 | |
| 1747 | Responses |
| 1748 | ~~~~~~~~~ |
| 1749 | |
| 1750 | +---------+----------------------------------------------------+----------------+ |
| 1751 | | HTTP | Description | Schema | |
| 1752 | | Code | | | |
| 1753 | +=========+====================================================+================+ |
| 1754 | | **204** | deleted attribute | No Content | |
| 1755 | +---------+----------------------------------------------------+----------------+ |
| 1756 | | **400** | Invalid content / Missing content | No Content | |
| 1757 | +---------+----------------------------------------------------+----------------+ |
| 1758 | | **403** | Restricted operation | No Content | |
| 1759 | +---------+----------------------------------------------------+----------------+ |
| 1760 | | **404** | Resource property not found | No Content | |
| 1761 | +---------+----------------------------------------------------+----------------+ |
| 1762 | |
| 1763 | Consumes |
| 1764 | ~~~~~~~~ |
| 1765 | |
| 1766 | - ``application/json`` |
| 1767 | |
| 1768 | Produces |
| 1769 | ~~~~~~~~ |
| 1770 | |
| 1771 | - ``application/json`` |
| 1772 | |
| 1773 | Tags |
| 1774 | ~~~~ |
| 1775 | |
| 1776 | - Resource Attribute Servlet |
| 1777 | |
| 1778 | Update Resource Metadata |
| 1779 | ------------------------ |
| 1780 | |
| 1781 | :: |
| 1782 | |
| 1783 | PUT /v1/catalog/resources/{resourceId}/metadata |
| 1784 | |
| 1785 | Description |
| 1786 | ~~~~~~~~~~~ |
| 1787 | |
| 1788 | Returns updated resource metadata |
| 1789 | |
| 1790 | Parameters |
| 1791 | ~~~~~~~~~~ |
| 1792 | |
| 1793 | +----------+-------------+--------------------------------------+------------------+ |
| 1794 | | Type | Name | Description | Schema | |
| 1795 | +==========+=============+======================================+==================+ |
| 1796 | | **Header | **USER\_ID* | | string | |
| 1797 | | ** | *\ *optiona | | | |
| 1798 | | | l* | | | |
| 1799 | +----------+-------------+--------------------------------------+------------------+ |
| 1800 | | **Path** | **resourceI | | string | |
| 1801 | | | d**\ *requi | | | |
| 1802 | | | red* | | | |
| 1803 | +----------+-------------+--------------------------------------+------------------+ |
| 1804 | | **Body** | **body**\ * | Resource metadata to be updated | string | |
| 1805 | | | required* | | | |
| 1806 | +----------+-------------+--------------------------------------+------------------+ |
| 1807 | |
| 1808 | Responses |
| 1809 | ~~~~~~~~~ |
| 1810 | |
| 1811 | +---------+----------------------------------------------------+----------------+ |
| 1812 | | HTTP | Description | Schema | |
| 1813 | | Code | | | |
| 1814 | +=========+====================================================+================+ |
| 1815 | | **200** | Resource metadata updated | No Content | |
| 1816 | +---------+----------------------------------------------------+----------------+ |
| 1817 | | **400** | Invalid content | No Content | |
| 1818 | +---------+----------------------------------------------------+----------------+ |
| 1819 | | **403** | Restricted operation | No Content | |
| 1820 | +---------+----------------------------------------------------+----------------+ |
| 1821 | |
| 1822 | Consumes |
| 1823 | ~~~~~~~~ |
| 1824 | |
| 1825 | - ``application/json`` |
| 1826 | |
| 1827 | Produces |
| 1828 | ~~~~~~~~ |
| 1829 | |
| 1830 | - ``application/json`` |
| 1831 | |
| 1832 | Tags |
| 1833 | ~~~~ |
| 1834 | |
| 1835 | - Resources Catalog |
| 1836 | |
| 1837 | Create Resource Property |
| 1838 | ------------------------ |
| 1839 | |
| 1840 | :: |
| 1841 | |
| 1842 | POST /v1/catalog/resources/{resourceId}/properties |
| 1843 | |
| 1844 | Description |
| 1845 | ~~~~~~~~~~~ |
| 1846 | |
| 1847 | Returns created resource property |
| 1848 | |
| 1849 | Parameters |
| 1850 | ~~~~~~~~~~ |
| 1851 | |
| 1852 | +----------+-------------+--------------------------------------+------------------+ |
| 1853 | | Type | Name | Description | Schema | |
| 1854 | +==========+=============+======================================+==================+ |
| 1855 | | **Header | **USER\_ID* | | string | |
| 1856 | | ** | *\ *optiona | | | |
| 1857 | | | l* | | | |
| 1858 | +----------+-------------+--------------------------------------+------------------+ |
| 1859 | | **Path** | **resourceI | resource id to update with new | string | |
| 1860 | | | d**\ *requi | property | | |
| 1861 | | | red* | | | |
| 1862 | +----------+-------------+--------------------------------------+------------------+ |
| 1863 | | **Body** | **body**\ * | Resource property to be created | string | |
| 1864 | | | required* | | | |
| 1865 | +----------+-------------+--------------------------------------+------------------+ |
| 1866 | |
| 1867 | Responses |
| 1868 | ~~~~~~~~~ |
| 1869 | |
| 1870 | +---------+----------------------------------------------------+----------------+ |
| 1871 | | HTTP | Description | Schema | |
| 1872 | | Code | | | |
| 1873 | +=========+====================================================+================+ |
| 1874 | | **201** | Resource property created | No Content | |
| 1875 | +---------+----------------------------------------------------+----------------+ |
| 1876 | | **400** | Invalid content / Missing content | No Content | |
| 1877 | +---------+----------------------------------------------------+----------------+ |
| 1878 | | **403** | Restricted operation | No Content | |
| 1879 | +---------+----------------------------------------------------+----------------+ |
| 1880 | | **409** | Resource property already exist | No Content | |
| 1881 | +---------+----------------------------------------------------+----------------+ |
| 1882 | |
| 1883 | Consumes |
| 1884 | ~~~~~~~~ |
| 1885 | |
| 1886 | - ``application/json`` |
| 1887 | |
| 1888 | Produces |
| 1889 | ~~~~~~~~ |
| 1890 | |
| 1891 | - ``application/json`` |
| 1892 | |
| 1893 | Tags |
| 1894 | ~~~~ |
| 1895 | |
| 1896 | - Resource Property Servlet |
| 1897 | |
| 1898 | Create Resource Property |
| 1899 | ------------------------ |
| 1900 | |
| 1901 | :: |
| 1902 | |
| 1903 | GET /v1/catalog/resources/{resourceId}/properties/{propertyId} |
| 1904 | |
| 1905 | Description |
| 1906 | ~~~~~~~~~~~ |
| 1907 | |
| 1908 | Returns property of resource |
| 1909 | |
| 1910 | Parameters |
| 1911 | ~~~~~~~~~~ |
| 1912 | |
| 1913 | +----------+-------------+--------------------------------------+------------------+ |
| 1914 | | Type | Name | Description | Schema | |
| 1915 | +==========+=============+======================================+==================+ |
| 1916 | | **Header | **USER\_ID* | | string | |
| 1917 | | ** | *\ *optiona | | | |
| 1918 | | | l* | | | |
| 1919 | +----------+-------------+--------------------------------------+------------------+ |
| 1920 | | **Path** | **propertyI | proerty id to get | string | |
| 1921 | | | d**\ *requi | | | |
| 1922 | | | red* | | | |
| 1923 | +----------+-------------+--------------------------------------+------------------+ |
| 1924 | | **Path** | **resourceI | resource id of property | string | |
| 1925 | | | d**\ *requi | | | |
| 1926 | | | red* | | | |
| 1927 | +----------+-------------+--------------------------------------+------------------+ |
| 1928 | |
| 1929 | Responses |
| 1930 | ~~~~~~~~~ |
| 1931 | |
| 1932 | +---------+----------------------------------------------------+----------------+ |
| 1933 | | HTTP | Description | Schema | |
| 1934 | | Code | | | |
| 1935 | +=========+====================================================+================+ |
| 1936 | | **200** | property | No Content | |
| 1937 | +---------+----------------------------------------------------+----------------+ |
| 1938 | | **400** | Invalid content / Missing content | No Content | |
| 1939 | +---------+----------------------------------------------------+----------------+ |
| 1940 | | **403** | Restricted operation | No Content | |
| 1941 | +---------+----------------------------------------------------+----------------+ |
| 1942 | | **404** | Resource property not found | No Content | |
| 1943 | +---------+----------------------------------------------------+----------------+ |
| 1944 | |
| 1945 | Consumes |
| 1946 | ~~~~~~~~ |
| 1947 | |
| 1948 | - ``application/json`` |
| 1949 | |
| 1950 | Produces |
| 1951 | ~~~~~~~~ |
| 1952 | |
| 1953 | - ``application/json`` |
| 1954 | |
| 1955 | Tags |
| 1956 | ~~~~ |
| 1957 | |
| 1958 | - Resource Property Servlet |
| 1959 | |
| 1960 | Update Resource Property |
| 1961 | ------------------------ |
| 1962 | |
| 1963 | :: |
| 1964 | |
| 1965 | PUT /v1/catalog/resources/{resourceId}/properties/{propertyId} |
| 1966 | |
| 1967 | Description |
| 1968 | ~~~~~~~~~~~ |
| 1969 | |
| 1970 | Returns updated property |
| 1971 | |
| 1972 | Parameters |
| 1973 | ~~~~~~~~~~ |
| 1974 | |
| 1975 | +----------+-------------+--------------------------------------+------------------+ |
| 1976 | | Type | Name | Description | Schema | |
| 1977 | +==========+=============+======================================+==================+ |
| 1978 | | **Header | **USER\_ID* | | string | |
| 1979 | | ** | *\ *optiona | | | |
| 1980 | | | l* | | | |
| 1981 | +----------+-------------+--------------------------------------+------------------+ |
| 1982 | | **Path** | **propertyI | proerty id to update | string | |
| 1983 | | | d**\ *requi | | | |
| 1984 | | | red* | | | |
| 1985 | +----------+-------------+--------------------------------------+------------------+ |
| 1986 | | **Path** | **resourceI | resource id to update with new | string | |
| 1987 | | | d**\ *requi | property | | |
| 1988 | | | red* | | | |
| 1989 | +----------+-------------+--------------------------------------+------------------+ |
| 1990 | | **Body** | **body**\ * | Resource property to update | string | |
| 1991 | | | required* | | | |
| 1992 | +----------+-------------+--------------------------------------+------------------+ |
| 1993 | |
| 1994 | Responses |
| 1995 | ~~~~~~~~~ |
| 1996 | |
| 1997 | +---------+----------------------------------------------------+----------------+ |
| 1998 | | HTTP | Description | Schema | |
| 1999 | | Code | | | |
| 2000 | +=========+====================================================+================+ |
| 2001 | | **200** | Resource property updated | No Content | |
| 2002 | +---------+----------------------------------------------------+----------------+ |
| 2003 | | **400** | Invalid content / Missing content | No Content | |
| 2004 | +---------+----------------------------------------------------+----------------+ |
| 2005 | | **403** | Restricted operation | No Content | |
| 2006 | +---------+----------------------------------------------------+----------------+ |
| 2007 | |
| 2008 | Consumes |
| 2009 | ~~~~~~~~ |
| 2010 | |
| 2011 | - ``application/json`` |
| 2012 | |
| 2013 | Produces |
| 2014 | ~~~~~~~~ |
| 2015 | |
| 2016 | - ``application/json`` |
| 2017 | |
| 2018 | Tags |
| 2019 | ~~~~ |
| 2020 | |
| 2021 | - Resource Property Servlet |
| 2022 | |
| 2023 | Create Resource Property |
| 2024 | ------------------------ |
| 2025 | |
| 2026 | :: |
| 2027 | |
| 2028 | DELETE /v1/catalog/resources/{resourceId}/properties/{propertyId} |
| 2029 | |
| 2030 | Description |
| 2031 | ~~~~~~~~~~~ |
| 2032 | |
| 2033 | Returns deleted property |
| 2034 | |
| 2035 | Parameters |
| 2036 | ~~~~~~~~~~ |
| 2037 | |
| 2038 | +----------+-------------+--------------------------------------+------------------+ |
| 2039 | | Type | Name | Description | Schema | |
| 2040 | +==========+=============+======================================+==================+ |
| 2041 | | **Header | **USER\_ID* | | string | |
| 2042 | | ** | *\ *optiona | | | |
| 2043 | | | l* | | | |
| 2044 | +----------+-------------+--------------------------------------+------------------+ |
| 2045 | | **Path** | **propertyI | Property id to delete | string | |
| 2046 | | | d**\ *requi | | | |
| 2047 | | | red* | | | |
| 2048 | +----------+-------------+--------------------------------------+------------------+ |
| 2049 | | **Path** | **resourceI | resource id of property | string | |
| 2050 | | | d**\ *requi | | | |
| 2051 | | | red* | | | |
| 2052 | +----------+-------------+--------------------------------------+------------------+ |
| 2053 | |
| 2054 | Responses |
| 2055 | ~~~~~~~~~ |
| 2056 | |
| 2057 | +---------+----------------------------------------------------+----------------+ |
| 2058 | | HTTP | Description | Schema | |
| 2059 | | Code | | | |
| 2060 | +=========+====================================================+================+ |
| 2061 | | **204** | deleted property | No Content | |
| 2062 | +---------+----------------------------------------------------+----------------+ |
| 2063 | | **400** | Invalid content / Missing content | No Content | |
| 2064 | +---------+----------------------------------------------------+----------------+ |
| 2065 | | **403** | Restricted operation | No Content | |
| 2066 | +---------+----------------------------------------------------+----------------+ |
| 2067 | | **404** | Resource property not found | No Content | |
| 2068 | +---------+----------------------------------------------------+----------------+ |
| 2069 | |
| 2070 | Consumes |
| 2071 | ~~~~~~~~ |
| 2072 | |
| 2073 | - ``application/json`` |
| 2074 | |
| 2075 | Produces |
| 2076 | ~~~~~~~~ |
| 2077 | |
| 2078 | - ``application/json`` |
| 2079 | |
| 2080 | Tags |
| 2081 | ~~~~ |
| 2082 | |
| 2083 | - Resource Property Servlet |
| 2084 | |
| 2085 | Create Artifact and Attach to interface |
| 2086 | --------------------------------------- |
| 2087 | |
| 2088 | :: |
| 2089 | |
| 2090 | POST /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts |
| 2091 | |
| 2092 | Description |
| 2093 | ~~~~~~~~~~~ |
| 2094 | |
| 2095 | Returns created resource |
| 2096 | |
| 2097 | Parameters |
| 2098 | ~~~~~~~~~~ |
| 2099 | |
| 2100 | +----------+-------------+--------------------------------------+------------------+ |
| 2101 | | Type | Name | Description | Schema | |
| 2102 | +==========+=============+======================================+==================+ |
| 2103 | | **Header | **Content-M | | string | |
| 2104 | | ** | D5**\ *opti | | | |
| 2105 | | | onal* | | | |
| 2106 | +----------+-------------+--------------------------------------+------------------+ |
| 2107 | | **Header | **USER\_ID* | | string | |
| 2108 | | ** | *\ *optiona | | | |
| 2109 | | | l* | | | |
| 2110 | +----------+-------------+--------------------------------------+------------------+ |
| 2111 | | **Path** | **interface | | string | |
| 2112 | | | Type**\ *re | | | |
| 2113 | | | quired* | | | |
| 2114 | +----------+-------------+--------------------------------------+------------------+ |
| 2115 | | **Path** | **operation | | string | |
| 2116 | | | **\ *requir | | | |
| 2117 | | | ed* | | | |
| 2118 | +----------+-------------+--------------------------------------+------------------+ |
| 2119 | | **Path** | **resourceI | | string | |
| 2120 | | | d**\ *requi | | | |
| 2121 | | | red* | | | |
| 2122 | +----------+-------------+--------------------------------------+------------------+ |
| 2123 | | **Body** | **body**\ * | json describe the artifact | string | |
| 2124 | | | required* | | | |
| 2125 | +----------+-------------+--------------------------------------+------------------+ |
| 2126 | |
| 2127 | Responses |
| 2128 | ~~~~~~~~~ |
| 2129 | |
| 2130 | +---------+----------------------------------------------------+----------------+ |
| 2131 | | HTTP | Description | Schema | |
| 2132 | | Code | | | |
| 2133 | +=========+====================================================+================+ |
| 2134 | | **201** | Resource created | No Content | |
| 2135 | +---------+----------------------------------------------------+----------------+ |
| 2136 | | **400** | Invalid content / Missing content | No Content | |
| 2137 | +---------+----------------------------------------------------+----------------+ |
| 2138 | | **403** | Restricted operation | No Content | |
| 2139 | +---------+----------------------------------------------------+----------------+ |
| 2140 | | **409** | Artifact already exist | No Content | |
| 2141 | +---------+----------------------------------------------------+----------------+ |
| 2142 | |
| 2143 | Consumes |
| 2144 | ~~~~~~~~ |
| 2145 | |
| 2146 | - ``application/json`` |
| 2147 | |
| 2148 | Produces |
| 2149 | ~~~~~~~~ |
| 2150 | |
| 2151 | - ``application/json`` |
| 2152 | |
| 2153 | Tags |
| 2154 | ~~~~ |
| 2155 | |
| 2156 | - Resource Artifact Servlet |
| 2157 | |
| 2158 | update Artifact Attach to interface |
| 2159 | ----------------------------------- |
| 2160 | |
| 2161 | :: |
| 2162 | |
| 2163 | POST /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts/{artifactId} |
| 2164 | |
| 2165 | Description |
| 2166 | ~~~~~~~~~~~ |
| 2167 | |
| 2168 | updates artifact by interface |
| 2169 | |
| 2170 | Parameters |
| 2171 | ~~~~~~~~~~ |
| 2172 | |
| 2173 | +----------+-------------+--------------------------------------+------------------+ |
| 2174 | | Type | Name | Description | Schema | |
| 2175 | +==========+=============+======================================+==================+ |
| 2176 | | **Header | **Content-M | | string | |
| 2177 | | ** | D5**\ *opti | | | |
| 2178 | | | onal* | | | |
| 2179 | +----------+-------------+--------------------------------------+------------------+ |
| 2180 | | **Header | **USER\_ID* | | string | |
| 2181 | | ** | *\ *optiona | | | |
| 2182 | | | l* | | | |
| 2183 | +----------+-------------+--------------------------------------+------------------+ |
| 2184 | | **Path** | **artifactI | | string | |
| 2185 | | | d**\ *requi | | | |
| 2186 | | | red* | | | |
| 2187 | +----------+-------------+--------------------------------------+------------------+ |
| 2188 | | **Path** | **interface | | string | |
| 2189 | | | Type**\ *re | | | |
| 2190 | | | quired* | | | |
| 2191 | +----------+-------------+--------------------------------------+------------------+ |
| 2192 | | **Path** | **operation | | string | |
| 2193 | | | **\ *requir | | | |
| 2194 | | | ed* | | | |
| 2195 | +----------+-------------+--------------------------------------+------------------+ |
| 2196 | | **Path** | **resourceI | | string | |
| 2197 | | | d**\ *requi | | | |
| 2198 | | | red* | | | |
| 2199 | +----------+-------------+--------------------------------------+------------------+ |
| 2200 | | **Body** | **body**\ * | json describe the artifact | string | |
| 2201 | | | required* | | | |
| 2202 | +----------+-------------+--------------------------------------+------------------+ |
| 2203 | |
| 2204 | Responses |
| 2205 | ~~~~~~~~~ |
| 2206 | |
| 2207 | +---------+----------------------------------------------------+----------------+ |
| 2208 | | HTTP | Description | Schema | |
| 2209 | | Code | | | |
| 2210 | +=========+====================================================+================+ |
| 2211 | | **201** | delete artifact under interface deleted | No Content | |
| 2212 | +---------+----------------------------------------------------+----------------+ |
| 2213 | | **400** | Invalid content / Missing content | No Content | |
| 2214 | +---------+----------------------------------------------------+----------------+ |
| 2215 | | **403** | Restricted operation | No Content | |
| 2216 | +---------+----------------------------------------------------+----------------+ |
| 2217 | | **409** | Artifact already exist | No Content | |
| 2218 | +---------+----------------------------------------------------+----------------+ |
| 2219 | |
| 2220 | Consumes |
| 2221 | ~~~~~~~~ |
| 2222 | |
| 2223 | - ``application/json`` |
| 2224 | |
| 2225 | Produces |
| 2226 | ~~~~~~~~ |
| 2227 | |
| 2228 | - ``application/json`` |
| 2229 | |
| 2230 | Tags |
| 2231 | ~~~~ |
| 2232 | |
| 2233 | - Resource Artifact Servlet |
| 2234 | |
| 2235 | delete Artifact from interface |
| 2236 | ------------------------------ |
| 2237 | |
| 2238 | :: |
| 2239 | |
| 2240 | DELETE /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts/{artifactId} |
| 2241 | |
| 2242 | Description |
| 2243 | ~~~~~~~~~~~ |
| 2244 | |
| 2245 | delete matching artifact from interface |
| 2246 | |
| 2247 | Parameters |
| 2248 | ~~~~~~~~~~ |
| 2249 | |
| 2250 | +------------------+--------------------------+----------------------------------+ |
| 2251 | | Type | Name | Schema | |
| 2252 | +==================+==========================+==================================+ |
| 2253 | | **Path** | **artifactId**\ *require | string | |
| 2254 | | | d* | | |
| 2255 | +------------------+--------------------------+----------------------------------+ |
| 2256 | | **Path** | **interfaceType**\ *requ | string | |
| 2257 | | | ired* | | |
| 2258 | +------------------+--------------------------+----------------------------------+ |
| 2259 | | **Path** | **operation**\ *required | string | |
| 2260 | | | * | | |
| 2261 | +------------------+--------------------------+----------------------------------+ |
| 2262 | | **Path** | **resourceId**\ *require | string | |
| 2263 | | | d* | | |
| 2264 | +------------------+--------------------------+----------------------------------+ |
| 2265 | |
| 2266 | Responses |
| 2267 | ~~~~~~~~~ |
| 2268 | |
| 2269 | +---------+----------------------------------------------------+----------------+ |
| 2270 | | HTTP | Description | Schema | |
| 2271 | | Code | | | |
| 2272 | +=========+====================================================+================+ |
| 2273 | | **201** | delete artifact under interface deleted | No Content | |
| 2274 | +---------+----------------------------------------------------+----------------+ |
| 2275 | | **400** | Invalid content / Missing content | No Content | |
| 2276 | +---------+----------------------------------------------------+----------------+ |
| 2277 | | **403** | Restricted operation | No Content | |
| 2278 | +---------+----------------------------------------------------+----------------+ |
| 2279 | | **409** | Artifact already exist | No Content | |
| 2280 | +---------+----------------------------------------------------+----------------+ |
| 2281 | |
| 2282 | Consumes |
| 2283 | ~~~~~~~~ |
| 2284 | |
| 2285 | - ``application/json`` |
| 2286 | |
| 2287 | Produces |
| 2288 | ~~~~~~~~ |
| 2289 | |
| 2290 | - ``application/json`` |
| 2291 | |
| 2292 | Tags |
| 2293 | ~~~~ |
| 2294 | |
| 2295 | - Resource Artifact Servlet |
| 2296 | |
| 2297 | DELETE /v1/catalog/resources/{resourcename}/{version} |
| 2298 | ----------------------------------------------------- |
| 2299 | |
| 2300 | Parameters |
| 2301 | ~~~~~~~~~~ |
| 2302 | |
| 2303 | +------------------+--------------------------+----------------------------------+ |
| 2304 | | Type | Name | Schema | |
| 2305 | +==================+==========================+==================================+ |
| 2306 | | **Path** | **resourceName**\ *requi | string | |
| 2307 | | | red* | | |
| 2308 | +------------------+--------------------------+----------------------------------+ |
| 2309 | | **Path** | **version**\ *required* | string | |
| 2310 | +------------------+--------------------------+----------------------------------+ |
| 2311 | |
| 2312 | Responses |
| 2313 | ~~~~~~~~~ |
| 2314 | |
| 2315 | +---------+----------------------------------------------------+----------------+ |
| 2316 | | HTTP | Description | Schema | |
| 2317 | | Code | | | |
| 2318 | +=========+====================================================+================+ |
| 2319 | | **defau | successful operation | No Content | |
| 2320 | | lt** | | | |
| 2321 | +---------+----------------------------------------------------+----------------+ |
| 2322 | |
| 2323 | Tags |
| 2324 | ~~~~ |
| 2325 | |
| 2326 | - Resources Catalog |
| 2327 | |
| 2328 | Create Service |
| 2329 | -------------- |
| 2330 | |
| 2331 | :: |
| 2332 | |
| 2333 | POST /v1/catalog/services |
| 2334 | |
| 2335 | Description |
| 2336 | ~~~~~~~~~~~ |
| 2337 | |
| 2338 | Returns created service |
| 2339 | |
| 2340 | Parameters |
| 2341 | ~~~~~~~~~~ |
| 2342 | |
| 2343 | +----------+-------------+--------------------------------------+------------------+ |
| 2344 | | Type | Name | Description | Schema | |
| 2345 | +==========+=============+======================================+==================+ |
| 2346 | | **Header | **USER\_ID* | | string | |
| 2347 | | ** | *\ *optiona | | | |
| 2348 | | | l* | | | |
| 2349 | +----------+-------------+--------------------------------------+------------------+ |
| 2350 | | **Body** | **body**\ * | Service object to be created | string | |
| 2351 | | | required* | | | |
| 2352 | +----------+-------------+--------------------------------------+------------------+ |
| 2353 | |
| 2354 | Responses |
| 2355 | ~~~~~~~~~ |
| 2356 | |
| 2357 | +---------+----------------------------------------------------+----------------+ |
| 2358 | | HTTP | Description | Schema | |
| 2359 | | Code | | | |
| 2360 | +=========+====================================================+================+ |
| 2361 | | **200** | successful operation | `Service <#_se | |
| 2362 | | | | rvice>`__ | |
| 2363 | +---------+----------------------------------------------------+----------------+ |
| 2364 | | **201** | Service created | No Content | |
| 2365 | +---------+----------------------------------------------------+----------------+ |
| 2366 | | **400** | Invalid content / Missing content | No Content | |
| 2367 | +---------+----------------------------------------------------+----------------+ |
| 2368 | | **403** | Restricted operation | No Content | |
| 2369 | +---------+----------------------------------------------------+----------------+ |
| 2370 | | **409** | Service already exist | No Content | |
| 2371 | +---------+----------------------------------------------------+----------------+ |
| 2372 | |
| 2373 | Consumes |
| 2374 | ~~~~~~~~ |
| 2375 | |
| 2376 | - ``application/json`` |
| 2377 | |
| 2378 | Produces |
| 2379 | ~~~~~~~~ |
| 2380 | |
| 2381 | - ``application/json`` |
| 2382 | |
| 2383 | Tags |
| 2384 | ~~~~ |
| 2385 | |
| 2386 | - Service Catalog |
| 2387 | |
| 2388 | Retrieve Distributions |
| 2389 | ---------------------- |
| 2390 | |
| 2391 | :: |
| 2392 | |
| 2393 | GET /v1/catalog/services/distribution/{did} |
| 2394 | |
| 2395 | Description |
| 2396 | ~~~~~~~~~~~ |
| 2397 | |
| 2398 | Return the list of distribution status objects |
| 2399 | |
| 2400 | Parameters |
| 2401 | ~~~~~~~~~~ |
| 2402 | |
| 2403 | +------------------+--------------------------+----------------------------------+ |
| 2404 | | Type | Name | Schema | |
| 2405 | +==================+==========================+==================================+ |
| 2406 | | **Header** | **USER\_ID**\ *optional* | string | |
| 2407 | +------------------+--------------------------+----------------------------------+ |
| 2408 | | **Path** | **did**\ *required* | string | |
| 2409 | +------------------+--------------------------+----------------------------------+ |
| 2410 | |
| 2411 | Responses |
| 2412 | ~~~~~~~~~ |
| 2413 | |
| 2414 | +---------+----------------------------------------------------+----------------+ |
| 2415 | | HTTP | Description | Schema | |
| 2416 | | Code | | | |
| 2417 | +=========+====================================================+================+ |
| 2418 | | **200** | Service found | No Content | |
| 2419 | +---------+----------------------------------------------------+----------------+ |
| 2420 | | **403** | Restricted operation | No Content | |
| 2421 | +---------+----------------------------------------------------+----------------+ |
| 2422 | | **404** | Status not found | No Content | |
| 2423 | +---------+----------------------------------------------------+----------------+ |
| 2424 | |
| 2425 | Consumes |
| 2426 | ~~~~~~~~ |
| 2427 | |
| 2428 | - ``application/json`` |
| 2429 | |
| 2430 | Produces |
| 2431 | ~~~~~~~~ |
| 2432 | |
| 2433 | - ``application/json`` |
| 2434 | |
| 2435 | Tags |
| 2436 | ~~~~ |
| 2437 | |
| 2438 | - Distribution Service Servlet |
| 2439 | |
| 2440 | Retrieve Service |
| 2441 | ---------------- |
| 2442 | |
| 2443 | :: |
| 2444 | |
| 2445 | GET /v1/catalog/services/serviceName/{serviceName}/serviceVersion/{serviceVersion} |
| 2446 | |
| 2447 | Description |
| 2448 | ~~~~~~~~~~~ |
| 2449 | |
| 2450 | Returns service according to name and version |
| 2451 | |
| 2452 | Parameters |
| 2453 | ~~~~~~~~~~ |
| 2454 | |
| 2455 | +------------------+--------------------------+----------------------------------+ |
| 2456 | | Type | Name | Schema | |
| 2457 | +==================+==========================+==================================+ |
| 2458 | | **Header** | **USER\_ID**\ *optional* | string | |
| 2459 | +------------------+--------------------------+----------------------------------+ |
| 2460 | | **Path** | **serviceName**\ *requir | string | |
| 2461 | | | ed* | | |
| 2462 | +------------------+--------------------------+----------------------------------+ |
| 2463 | | **Path** | **serviceVersion**\ *req | string | |
| 2464 | | | uired* | | |
| 2465 | +------------------+--------------------------+----------------------------------+ |
| 2466 | |
| 2467 | Responses |
| 2468 | ~~~~~~~~~ |
| 2469 | |
| 2470 | +---------+----------------------------------------------------+----------------+ |
| 2471 | | HTTP | Description | Schema | |
| 2472 | | Code | | | |
| 2473 | +=========+====================================================+================+ |
| 2474 | | **200** | Service found | No Content | |
| 2475 | +---------+----------------------------------------------------+----------------+ |
| 2476 | | **403** | Restricted operation | No Content | |
| 2477 | +---------+----------------------------------------------------+----------------+ |
| 2478 | | **404** | Service not found | No Content | |
| 2479 | +---------+----------------------------------------------------+----------------+ |
| 2480 | |
| 2481 | Consumes |
| 2482 | ~~~~~~~~ |
| 2483 | |
| 2484 | - ``application/json`` |
| 2485 | |
| 2486 | Produces |
| 2487 | ~~~~~~~~ |
| 2488 | |
| 2489 | - ``application/json`` |
| 2490 | |
| 2491 | Tags |
| 2492 | ~~~~ |
| 2493 | |
| 2494 | - Service Catalog |
| 2495 | |
| 2496 | Download service artifact |
| 2497 | ------------------------- |
| 2498 | |
| 2499 | :: |
| 2500 | |
| 2501 | GET /v1/catalog/services/toscatoheat/{artifactName} |
| 2502 | |
| 2503 | Description |
| 2504 | ~~~~~~~~~~~ |
| 2505 | |
| 2506 | Returns downloaded artifact |
| 2507 | |
| 2508 | Parameters |
| 2509 | ~~~~~~~~~~ |
| 2510 | |
| 2511 | +------------------+--------------------------+----------------------------------+ |
| 2512 | | Type | Name | Schema | |
| 2513 | +==================+==========================+==================================+ |
| 2514 | | **Path** | **artifactName**\ *requi | string | |
| 2515 | | | red* | | |
| 2516 | +------------------+--------------------------+----------------------------------+ |
| 2517 | |
| 2518 | Responses |
| 2519 | ~~~~~~~~~ |
| 2520 | |
| 2521 | +---------+----------------------------------------------------+----------------+ |
| 2522 | | HTTP | Description | Schema | |
| 2523 | | Code | | | |
| 2524 | +=========+====================================================+================+ |
| 2525 | | **200** | Artifact downloaded | No Content | |
| 2526 | +---------+----------------------------------------------------+----------------+ |
| 2527 | | **401** | Authorization required | No Content | |
| 2528 | +---------+----------------------------------------------------+----------------+ |
| 2529 | | **403** | Restricted operation | No Content | |
| 2530 | +---------+----------------------------------------------------+----------------+ |
| 2531 | | **404** | Artifact not found | No Content | |
| 2532 | +---------+----------------------------------------------------+----------------+ |
| 2533 | |
| 2534 | Consumes |
| 2535 | ~~~~~~~~ |
| 2536 | |
| 2537 | - ``application/json`` |
| 2538 | |
| 2539 | Produces |
| 2540 | ~~~~~~~~ |
| 2541 | |
| 2542 | - ``application/octet-stream`` |
| 2543 | |
| 2544 | Tags |
| 2545 | ~~~~ |
| 2546 | |
| 2547 | - Service Catalog |
| 2548 | |
| 2549 | validate service name |
| 2550 | --------------------- |
| 2551 | |
| 2552 | :: |
| 2553 | |
| 2554 | GET /v1/catalog/services/validate-name/{serviceName} |
| 2555 | |
| 2556 | Description |
| 2557 | ~~~~~~~~~~~ |
| 2558 | |
| 2559 | checks if the chosen service name is available |
| 2560 | |
| 2561 | Parameters |
| 2562 | ~~~~~~~~~~ |
| 2563 | |
| 2564 | +------------------+--------------------------+----------------------------------+ |
| 2565 | | Type | Name | Schema | |
| 2566 | +==================+==========================+==================================+ |
| 2567 | | **Header** | **USER\_ID**\ *optional* | string | |
| 2568 | +------------------+--------------------------+----------------------------------+ |
| 2569 | | **Path** | **serviceName**\ *requir | string | |
| 2570 | | | ed* | | |
| 2571 | +------------------+--------------------------+----------------------------------+ |
| 2572 | |
| 2573 | Responses |
| 2574 | ~~~~~~~~~ |
| 2575 | |
| 2576 | +---------+----------------------------------------------------+----------------+ |
| 2577 | | HTTP | Description | Schema | |
| 2578 | | Code | | | |
| 2579 | +=========+====================================================+================+ |
| 2580 | | **200** | Service found | No Content | |
| 2581 | +---------+----------------------------------------------------+----------------+ |
| 2582 | | **403** | Restricted operation | No Content | |
| 2583 | +---------+----------------------------------------------------+----------------+ |
| 2584 | |
| 2585 | Consumes |
| 2586 | ~~~~~~~~ |
| 2587 | |
| 2588 | - ``application/json`` |
| 2589 | |
| 2590 | Produces |
| 2591 | ~~~~~~~~ |
| 2592 | |
| 2593 | - ``application/json`` |
| 2594 | |
| 2595 | Tags |
| 2596 | ~~~~ |
| 2597 | |
| 2598 | - Service Catalog |
| 2599 | |
| 2600 | Get Inputs only |
| 2601 | --------------- |
| 2602 | |
| 2603 | :: |
| 2604 | |
| 2605 | GET /v1/catalog/services/{componentId}/inputs |
| 2606 | |
| 2607 | Description |
| 2608 | ~~~~~~~~~~~ |
| 2609 | |
| 2610 | Returns Inputs list |
| 2611 | |
| 2612 | Parameters |
| 2613 | ~~~~~~~~~~ |
| 2614 | |
| 2615 | +------------------+--------------------------+----------------------------------+ |
| 2616 | | Type | Name | Schema | |
| 2617 | +==================+==========================+==================================+ |
| 2618 | | **Header** | **USER\_ID**\ *optional* | string | |
| 2619 | +------------------+--------------------------+----------------------------------+ |
| 2620 | | **Path** | **componentId**\ *requir | string | |
| 2621 | | | ed* | | |
| 2622 | +------------------+--------------------------+----------------------------------+ |
| 2623 | | **Path** | **componentType**\ *requ | string | |
| 2624 | | | ired* | | |
| 2625 | +------------------+--------------------------+----------------------------------+ |
| 2626 | | **Query** | **amount**\ *optional* | integer (int32) | |
| 2627 | +------------------+--------------------------+----------------------------------+ |
| 2628 | | **Query** | **fromId**\ *optional* | string | |
| 2629 | +------------------+--------------------------+----------------------------------+ |
| 2630 | |
| 2631 | Responses |
| 2632 | ~~~~~~~~~ |
| 2633 | |
| 2634 | +---------+----------------------------------------------------+----------------+ |
| 2635 | | HTTP | Description | Schema | |
| 2636 | | Code | | | |
| 2637 | +=========+====================================================+================+ |
| 2638 | | **200** | Component found | No Content | |
| 2639 | +---------+----------------------------------------------------+----------------+ |
| 2640 | | **403** | Restricted operation | No Content | |
| 2641 | +---------+----------------------------------------------------+----------------+ |
| 2642 | | **404** | Component not found | No Content | |
| 2643 | +---------+----------------------------------------------------+----------------+ |
| 2644 | |
| 2645 | Consumes |
| 2646 | ~~~~~~~~ |
| 2647 | |
| 2648 | - ``application/json`` |
| 2649 | |
| 2650 | Produces |
| 2651 | ~~~~~~~~ |
| 2652 | |
| 2653 | - ``application/json`` |
| 2654 | |
| 2655 | Tags |
| 2656 | ~~~~ |
| 2657 | |
| 2658 | - Input Catalog |
| 2659 | |
| 2660 | Retrieve Service |
| 2661 | ---------------- |
| 2662 | |
| 2663 | :: |
| 2664 | |
| 2665 | GET /v1/catalog/services/{serviceId} |
| 2666 | |
| 2667 | Description |
| 2668 | ~~~~~~~~~~~ |
| 2669 | |
| 2670 | Returns service according to serviceId |
| 2671 | |
| 2672 | Parameters |
| 2673 | ~~~~~~~~~~ |
| 2674 | |
| 2675 | +------------------+--------------------------+----------------------------------+ |
| 2676 | | Type | Name | Schema | |
| 2677 | +==================+==========================+==================================+ |
| 2678 | | **Header** | **USER\_ID**\ *optional* | string | |
| 2679 | +------------------+--------------------------+----------------------------------+ |
| 2680 | | **Path** | **serviceId**\ *required | string | |
| 2681 | | | * | | |
| 2682 | +------------------+--------------------------+----------------------------------+ |
| 2683 | |
| 2684 | Responses |
| 2685 | ~~~~~~~~~ |
| 2686 | |
| 2687 | +---------+----------------------------------------------------+----------------+ |
| 2688 | | HTTP | Description | Schema | |
| 2689 | | Code | | | |
| 2690 | +=========+====================================================+================+ |
| 2691 | | **200** | Service found | No Content | |
| 2692 | +---------+----------------------------------------------------+----------------+ |
| 2693 | | **403** | Restricted operation | No Content | |
| 2694 | +---------+----------------------------------------------------+----------------+ |
| 2695 | | **404** | Service not found | No Content | |
| 2696 | +---------+----------------------------------------------------+----------------+ |
| 2697 | |
| 2698 | Consumes |
| 2699 | ~~~~~~~~ |
| 2700 | |
| 2701 | - ``application/json`` |
| 2702 | |
| 2703 | Produces |
| 2704 | ~~~~~~~~ |
| 2705 | |
| 2706 | - ``application/json`` |
| 2707 | |
| 2708 | Tags |
| 2709 | ~~~~ |
| 2710 | |
| 2711 | - Service Catalog |
| 2712 | |
| 2713 | DELETE /v1/catalog/services/{serviceid} |
| 2714 | --------------------------------------- |
| 2715 | |
| 2716 | Parameters |
| 2717 | ~~~~~~~~~~ |
| 2718 | |
| 2719 | +------------------+--------------------------+----------------------------------+ |
| 2720 | | Type | Name | Schema | |
| 2721 | +==================+==========================+==================================+ |
| 2722 | | **Path** | **serviceId**\ *required | string | |
| 2723 | | | * | | |
| 2724 | +------------------+--------------------------+----------------------------------+ |
| 2725 | |
| 2726 | Responses |
| 2727 | ~~~~~~~~~ |
| 2728 | |
| 2729 | +---------+----------------------------------------------------+----------------+ |
| 2730 | | HTTP | Description | Schema | |
| 2731 | | Code | | | |
| 2732 | +=========+====================================================+================+ |
| 2733 | | **defau | successful operation | No Content | |
| 2734 | | lt** | | | |
| 2735 | +---------+----------------------------------------------------+----------------+ |
| 2736 | |
| 2737 | Tags |
| 2738 | ~~~~ |
| 2739 | |
| 2740 | - Service Catalog |
| 2741 | |
| 2742 | Create Additional Information Label and Value |
| 2743 | --------------------------------------------- |
| 2744 | |
| 2745 | :: |
| 2746 | |
| 2747 | POST /v1/catalog/services/{serviceId}/additionalinfo |
| 2748 | |
| 2749 | Description |
| 2750 | ~~~~~~~~~~~ |
| 2751 | |
| 2752 | Returns created Additional Inforamtion property |
| 2753 | |
| 2754 | Parameters |
| 2755 | ~~~~~~~~~~ |
| 2756 | |
| 2757 | +----------+-------------+--------------------------------------+------------------+ |
| 2758 | | Type | Name | Description | Schema | |
| 2759 | +==========+=============+======================================+==================+ |
| 2760 | | **Header | **USER\_ID* | | string | |
| 2761 | | ** | *\ *optiona | | | |
| 2762 | | | l* | | | |
| 2763 | +----------+-------------+--------------------------------------+------------------+ |
| 2764 | | **Path** | **serviceId | service id to update with new | string | |
| 2765 | | | **\ *requir | property | | |
| 2766 | | | ed* | | | |
| 2767 | +----------+-------------+--------------------------------------+------------------+ |
| 2768 | | **Body** | **body**\ * | Additional information key value to | string | |
| 2769 | | | required* | be created | | |
| 2770 | +----------+-------------+--------------------------------------+------------------+ |
| 2771 | |
| 2772 | Responses |
| 2773 | ~~~~~~~~~ |
| 2774 | |
| 2775 | +---------+----------------------------------------------------+----------------+ |
| 2776 | | HTTP | Description | Schema | |
| 2777 | | Code | | | |
| 2778 | +=========+====================================================+================+ |
| 2779 | | **201** | Additional information created | No Content | |
| 2780 | +---------+----------------------------------------------------+----------------+ |
| 2781 | | **400** | Invalid content / Missing content | No Content | |
| 2782 | +---------+----------------------------------------------------+----------------+ |
| 2783 | | **403** | Restricted operation | No Content | |
| 2784 | +---------+----------------------------------------------------+----------------+ |
| 2785 | | **409** | Additional information key already exist | No Content | |
| 2786 | +---------+----------------------------------------------------+----------------+ |
| 2787 | |
| 2788 | Consumes |
| 2789 | ~~~~~~~~ |
| 2790 | |
| 2791 | - ``application/json`` |
| 2792 | |
| 2793 | Produces |
| 2794 | ~~~~~~~~ |
| 2795 | |
| 2796 | - ``application/json`` |
| 2797 | |
| 2798 | Tags |
| 2799 | ~~~~ |
| 2800 | |
| 2801 | - Additional Information Servlet |
| 2802 | |
| 2803 | Get all Additional Information under service |
| 2804 | -------------------------------------------- |
| 2805 | |
| 2806 | :: |
| 2807 | |
| 2808 | GET /v1/catalog/services/{serviceId}/additionalinfo |
| 2809 | |
| 2810 | Description |
| 2811 | ~~~~~~~~~~~ |
| 2812 | |
| 2813 | Returns Additional Inforamtion property |
| 2814 | |
| 2815 | Parameters |
| 2816 | ~~~~~~~~~~ |
| 2817 | |
| 2818 | +----------+-------------+--------------------------------------+------------------+ |
| 2819 | | Type | Name | Description | Schema | |
| 2820 | +==========+=============+======================================+==================+ |
| 2821 | | **Header | **USER\_ID* | | string | |
| 2822 | | ** | *\ *optiona | | | |
| 2823 | | | l* | | | |
| 2824 | +----------+-------------+--------------------------------------+------------------+ |
| 2825 | | **Path** | **serviceId | service id to update with new | string | |
| 2826 | | | **\ *requir | property | | |
| 2827 | | | ed* | | | |
| 2828 | +----------+-------------+--------------------------------------+------------------+ |
| 2829 | |
| 2830 | Responses |
| 2831 | ~~~~~~~~~ |
| 2832 | |
| 2833 | +---------+----------------------------------------------------+----------------+ |
| 2834 | | HTTP | Description | Schema | |
| 2835 | | Code | | | |
| 2836 | +=========+====================================================+================+ |
| 2837 | | **200** | list of additional information | No Content | |
| 2838 | +---------+----------------------------------------------------+----------------+ |
| 2839 | | **400** | Invalid content / Missing content | No Content | |
| 2840 | +---------+----------------------------------------------------+----------------+ |
| 2841 | | **403** | Restricted operation | No Content | |
| 2842 | +---------+----------------------------------------------------+----------------+ |
| 2843 | | **409** | Additional information key already exist | No Content | |
| 2844 | +---------+----------------------------------------------------+----------------+ |
| 2845 | |
| 2846 | Consumes |
| 2847 | ~~~~~~~~ |
| 2848 | |
| 2849 | - ``application/json`` |
| 2850 | |
| 2851 | Produces |
| 2852 | ~~~~~~~~ |
| 2853 | |
| 2854 | - ``application/json`` |
| 2855 | |
| 2856 | Tags |
| 2857 | ~~~~ |
| 2858 | |
| 2859 | - Additional Information Servlet |
| 2860 | |
| 2861 | Get Additional Information by id |
| 2862 | -------------------------------- |
| 2863 | |
| 2864 | :: |
| 2865 | |
| 2866 | GET /v1/catalog/services/{serviceId}/additionalinfo/{labelId} |
| 2867 | |
| 2868 | Description |
| 2869 | ~~~~~~~~~~~ |
| 2870 | |
| 2871 | Returns Additional Inforamtion property |
| 2872 | |
| 2873 | Parameters |
| 2874 | ~~~~~~~~~~ |
| 2875 | |
| 2876 | +----------+-------------+--------------------------------------+------------------+ |
| 2877 | | Type | Name | Description | Schema | |
| 2878 | +==========+=============+======================================+==================+ |
| 2879 | | **Header | **USER\_ID* | | string | |
| 2880 | | ** | *\ *optiona | | | |
| 2881 | | | l* | | | |
| 2882 | +----------+-------------+--------------------------------------+------------------+ |
| 2883 | | **Path** | **labelId** | label id | string | |
| 2884 | | | \ *required | | | |
| 2885 | | | * | | | |
| 2886 | +----------+-------------+--------------------------------------+------------------+ |
| 2887 | | **Path** | **serviceId | service id to update with new | string | |
| 2888 | | | **\ *requir | property | | |
| 2889 | | | ed* | | | |
| 2890 | +----------+-------------+--------------------------------------+------------------+ |
| 2891 | |
| 2892 | Responses |
| 2893 | ~~~~~~~~~ |
| 2894 | |
| 2895 | +---------+----------------------------------------------------+----------------+ |
| 2896 | | HTTP | Description | Schema | |
| 2897 | | Code | | | |
| 2898 | +=========+====================================================+================+ |
| 2899 | | **200** | fetched additional information | No Content | |
| 2900 | +---------+----------------------------------------------------+----------------+ |
| 2901 | | **400** | Invalid content / Missing content | No Content | |
| 2902 | +---------+----------------------------------------------------+----------------+ |
| 2903 | | **403** | Restricted operation | No Content | |
| 2904 | +---------+----------------------------------------------------+----------------+ |
| 2905 | | **409** | Additional information key already exist | No Content | |
| 2906 | +---------+----------------------------------------------------+----------------+ |
| 2907 | |
| 2908 | Consumes |
| 2909 | ~~~~~~~~ |
| 2910 | |
| 2911 | - ``application/json`` |
| 2912 | |
| 2913 | Produces |
| 2914 | ~~~~~~~~ |
| 2915 | |
| 2916 | - ``application/json`` |
| 2917 | |
| 2918 | Tags |
| 2919 | ~~~~ |
| 2920 | |
| 2921 | - Additional Information Servlet |
| 2922 | |
| 2923 | Update Additional Information Label and Value |
| 2924 | --------------------------------------------- |
| 2925 | |
| 2926 | :: |
| 2927 | |
| 2928 | PUT /v1/catalog/services/{serviceId}/additionalinfo/{labelId} |
| 2929 | |
| 2930 | Description |
| 2931 | ~~~~~~~~~~~ |
| 2932 | |
| 2933 | Returns updated Additional Inforamtion property |
| 2934 | |
| 2935 | Parameters |
| 2936 | ~~~~~~~~~~ |
| 2937 | |
| 2938 | +----------+-------------+--------------------------------------+------------------+ |
| 2939 | | Type | Name | Description | Schema | |
| 2940 | +==========+=============+======================================+==================+ |
| 2941 | | **Header | **USER\_ID* | | string | |
| 2942 | | ** | *\ *optiona | | | |
| 2943 | | | l* | | | |
| 2944 | +----------+-------------+--------------------------------------+------------------+ |
| 2945 | | **Path** | **labelId** | label id | string | |
| 2946 | | | \ *required | | | |
| 2947 | | | * | | | |
| 2948 | +----------+-------------+--------------------------------------+------------------+ |
| 2949 | | **Path** | **serviceId | service id to update with new | string | |
| 2950 | | | **\ *requir | property | | |
| 2951 | | | ed* | | | |
| 2952 | +----------+-------------+--------------------------------------+------------------+ |
| 2953 | | **Body** | **body**\ * | Additional information key value to | string | |
| 2954 | | | required* | be created | | |
| 2955 | +----------+-------------+--------------------------------------+------------------+ |
| 2956 | |
| 2957 | Responses |
| 2958 | ~~~~~~~~~ |
| 2959 | |
| 2960 | +---------+----------------------------------------------------+----------------+ |
| 2961 | | HTTP | Description | Schema | |
| 2962 | | Code | | | |
| 2963 | +=========+====================================================+================+ |
| 2964 | | **200** | Additional information updated | No Content | |
| 2965 | +---------+----------------------------------------------------+----------------+ |
| 2966 | | **400** | Invalid content / Missing content | No Content | |
| 2967 | +---------+----------------------------------------------------+----------------+ |
| 2968 | | **403** | Restricted operation | No Content | |
| 2969 | +---------+----------------------------------------------------+----------------+ |
| 2970 | | **409** | Additional information key already exist | No Content | |
| 2971 | +---------+----------------------------------------------------+----------------+ |
| 2972 | |
| 2973 | Consumes |
| 2974 | ~~~~~~~~ |
| 2975 | |
| 2976 | - ``application/json`` |
| 2977 | |
| 2978 | Produces |
| 2979 | ~~~~~~~~ |
| 2980 | |
| 2981 | - ``application/json`` |
| 2982 | |
| 2983 | Tags |
| 2984 | ~~~~ |
| 2985 | |
| 2986 | - Additional Information Servlet |
| 2987 | |
| 2988 | Create Additional Information Label and Value |
| 2989 | --------------------------------------------- |
| 2990 | |
| 2991 | :: |
| 2992 | |
| 2993 | DELETE /v1/catalog/services/{serviceId}/additionalinfo/{labelId} |
| 2994 | |
| 2995 | Description |
| 2996 | ~~~~~~~~~~~ |
| 2997 | |
| 2998 | Returns deleted Additional Inforamtion property |
| 2999 | |
| 3000 | Parameters |
| 3001 | ~~~~~~~~~~ |
| 3002 | |
| 3003 | +----------+-------------+--------------------------------------+------------------+ |
| 3004 | | Type | Name | Description | Schema | |
| 3005 | +==========+=============+======================================+==================+ |
| 3006 | | **Header | **USER\_ID* | | string | |
| 3007 | | ** | *\ *optiona | | | |
| 3008 | | | l* | | | |
| 3009 | +----------+-------------+--------------------------------------+------------------+ |
| 3010 | | **Path** | **labelId** | label id | string | |
| 3011 | | | \ *required | | | |
| 3012 | | | * | | | |
| 3013 | +----------+-------------+--------------------------------------+------------------+ |
| 3014 | | **Path** | **serviceId | service id to update with new | string | |
| 3015 | | | **\ *requir | property | | |
| 3016 | | | ed* | | | |
| 3017 | +----------+-------------+--------------------------------------+------------------+ |
| 3018 | |
| 3019 | Responses |
| 3020 | ~~~~~~~~~ |
| 3021 | |
| 3022 | +---------+----------------------------------------------------+----------------+ |
| 3023 | | HTTP | Description | Schema | |
| 3024 | | Code | | | |
| 3025 | +=========+====================================================+================+ |
| 3026 | | **200** | Additional information deleted | No Content | |
| 3027 | +---------+----------------------------------------------------+----------------+ |
| 3028 | | **400** | Invalid content / Missing content | No Content | |
| 3029 | +---------+----------------------------------------------------+----------------+ |
| 3030 | | **403** | Restricted operation | No Content | |
| 3031 | +---------+----------------------------------------------------+----------------+ |
| 3032 | | **409** | Additional information key already exist | No Content | |
| 3033 | +---------+----------------------------------------------------+----------------+ |
| 3034 | |
| 3035 | Consumes |
| 3036 | ~~~~~~~~ |
| 3037 | |
| 3038 | - ``application/json`` |
| 3039 | |
| 3040 | Produces |
| 3041 | ~~~~~~~~ |
| 3042 | |
| 3043 | - ``application/json`` |
| 3044 | |
| 3045 | Tags |
| 3046 | ~~~~ |
| 3047 | |
| 3048 | - Additional Information Servlet |
| 3049 | |
| 3050 | Create Artifact |
| 3051 | --------------- |
| 3052 | |
| 3053 | :: |
| 3054 | |
| 3055 | POST /v1/catalog/services/{serviceId}/artifacts |
| 3056 | |
| 3057 | Description |
| 3058 | ~~~~~~~~~~~ |
| 3059 | |
| 3060 | Returns created ArtifactDefinition |
| 3061 | |
| 3062 | Parameters |
| 3063 | ~~~~~~~~~~ |
| 3064 | |
| 3065 | +----------+-------------+--------------------------------------+------------------+ |
| 3066 | | Type | Name | Description | Schema | |
| 3067 | +==========+=============+======================================+==================+ |
| 3068 | | **Path** | **serviceId | | string | |
| 3069 | | | **\ *requir | | | |
| 3070 | | | ed* | | | |
| 3071 | +----------+-------------+--------------------------------------+------------------+ |
| 3072 | | **Body** | **body**\ * | json describe the artifact | string | |
| 3073 | | | required* | | | |
| 3074 | +----------+-------------+--------------------------------------+------------------+ |
| 3075 | |
| 3076 | Responses |
| 3077 | ~~~~~~~~~ |
| 3078 | |
| 3079 | +---------+----------------------------------------------------+----------------+ |
| 3080 | | HTTP | Description | Schema | |
| 3081 | | Code | | | |
| 3082 | +=========+====================================================+================+ |
| 3083 | | **201** | Resource created | No Content | |
| 3084 | +---------+----------------------------------------------------+----------------+ |
| 3085 | | **400** | Invalid content / Missing content | No Content | |
| 3086 | +---------+----------------------------------------------------+----------------+ |
| 3087 | | **403** | Restricted operation | No Content | |
| 3088 | +---------+----------------------------------------------------+----------------+ |
| 3089 | | **409** | Artifact already exist | No Content | |
| 3090 | +---------+----------------------------------------------------+----------------+ |
| 3091 | |
| 3092 | Consumes |
| 3093 | ~~~~~~~~ |
| 3094 | |
| 3095 | - ``application/json`` |
| 3096 | |
| 3097 | Produces |
| 3098 | ~~~~~~~~ |
| 3099 | |
| 3100 | - ``application/json`` |
| 3101 | |
| 3102 | Tags |
| 3103 | ~~~~ |
| 3104 | |
| 3105 | - Resource Artifact Servlet |
| 3106 | |
| 3107 | Update Api Artifact |
| 3108 | ------------------- |
| 3109 | |
| 3110 | :: |
| 3111 | |
| 3112 | POST /v1/catalog/services/{serviceId}/artifacts/api/{artifactId} |
| 3113 | |
| 3114 | Description |
| 3115 | ~~~~~~~~~~~ |
| 3116 | |
| 3117 | Returns created ArtifactDefinition |
| 3118 | |
| 3119 | Parameters |
| 3120 | ~~~~~~~~~~ |
| 3121 | |
| 3122 | +----------+-------------+--------------------------------------+------------------+ |
| 3123 | | Type | Name | Description | Schema | |
| 3124 | +==========+=============+======================================+==================+ |
| 3125 | | **Header | **Content-M | | string | |
| 3126 | | ** | D5**\ *opti | | | |
| 3127 | | | onal* | | | |
| 3128 | +----------+-------------+--------------------------------------+------------------+ |
| 3129 | | **Header | **USER\_ID* | | string | |
| 3130 | | ** | *\ *optiona | | | |
| 3131 | | | l* | | | |
| 3132 | +----------+-------------+--------------------------------------+------------------+ |
| 3133 | | **Path** | **artifactI | | string | |
| 3134 | | | d**\ *requi | | | |
| 3135 | | | red* | | | |
| 3136 | +----------+-------------+--------------------------------------+------------------+ |
| 3137 | | **Path** | **serviceId | | string | |
| 3138 | | | **\ *requir | | | |
| 3139 | | | ed* | | | |
| 3140 | +----------+-------------+--------------------------------------+------------------+ |
| 3141 | | **Body** | **body**\ * | json describe the artifact | string | |
| 3142 | | | required* | | | |
| 3143 | +----------+-------------+--------------------------------------+------------------+ |
| 3144 | |
| 3145 | Responses |
| 3146 | ~~~~~~~~~ |
| 3147 | |
| 3148 | +---------+----------------------------------------------------+----------------+ |
| 3149 | | HTTP | Description | Schema | |
| 3150 | | Code | | | |
| 3151 | +=========+====================================================+================+ |
| 3152 | | **200** | Api Artifact Updated | No Content | |
| 3153 | +---------+----------------------------------------------------+----------------+ |
| 3154 | | **400** | Invalid content / Missing content | No Content | |
| 3155 | +---------+----------------------------------------------------+----------------+ |
| 3156 | | **403** | Restricted operation | No Content | |
| 3157 | +---------+----------------------------------------------------+----------------+ |
| 3158 | |
| 3159 | Consumes |
| 3160 | ~~~~~~~~ |
| 3161 | |
| 3162 | - ``application/json`` |
| 3163 | |
| 3164 | Produces |
| 3165 | ~~~~~~~~ |
| 3166 | |
| 3167 | - ``application/json`` |
| 3168 | |
| 3169 | Tags |
| 3170 | ~~~~ |
| 3171 | |
| 3172 | - Resource Artifact Servlet |
| 3173 | |
| 3174 | Delete Api Artifact |
| 3175 | ------------------- |
| 3176 | |
| 3177 | :: |
| 3178 | |
| 3179 | DELETE /v1/catalog/services/{serviceId}/artifacts/api/{artifactId} |
| 3180 | |
| 3181 | Description |
| 3182 | ~~~~~~~~~~~ |
| 3183 | |
| 3184 | Returns Deleted ArtifactDefinition |
| 3185 | |
| 3186 | Parameters |
| 3187 | ~~~~~~~~~~ |
| 3188 | |
| 3189 | +------------------+--------------------------+----------------------------------+ |
| 3190 | | Type | Name | Schema | |
| 3191 | +==================+==========================+==================================+ |
| 3192 | | **Header** | **Content-MD5**\ *option | string | |
| 3193 | | | al* | | |
| 3194 | +------------------+--------------------------+----------------------------------+ |
| 3195 | | **Header** | **USER\_ID**\ *optional* | string | |
| 3196 | +------------------+--------------------------+----------------------------------+ |
| 3197 | | **Path** | **artifactId**\ *require | string | |
| 3198 | | | d* | | |
| 3199 | +------------------+--------------------------+----------------------------------+ |
| 3200 | | **Path** | **serviceId**\ *required | string | |
| 3201 | | | * | | |
| 3202 | +------------------+--------------------------+----------------------------------+ |
| 3203 | |
| 3204 | Responses |
| 3205 | ~~~~~~~~~ |
| 3206 | |
| 3207 | +---------+----------------------------------------------------+----------------+ |
| 3208 | | HTTP | Description | Schema | |
| 3209 | | Code | | | |
| 3210 | +=========+====================================================+================+ |
| 3211 | | **204** | Api Artifact deleted | No Content | |
| 3212 | +---------+----------------------------------------------------+----------------+ |
| 3213 | | **403** | Restricted operation | No Content | |
| 3214 | +---------+----------------------------------------------------+----------------+ |
| 3215 | |
| 3216 | Consumes |
| 3217 | ~~~~~~~~ |
| 3218 | |
| 3219 | - ``application/json`` |
| 3220 | |
| 3221 | Produces |
| 3222 | ~~~~~~~~ |
| 3223 | |
| 3224 | - ``application/json`` |
| 3225 | |
| 3226 | Tags |
| 3227 | ~~~~ |
| 3228 | |
| 3229 | - Resource Artifact Servlet |
| 3230 | |
| 3231 | Update Artifact |
| 3232 | --------------- |
| 3233 | |
| 3234 | :: |
| 3235 | |
| 3236 | POST /v1/catalog/services/{serviceId}/artifacts/{artifactId} |
| 3237 | |
| 3238 | Description |
| 3239 | ~~~~~~~~~~~ |
| 3240 | |
| 3241 | Returns updated artifact |
| 3242 | |
| 3243 | Parameters |
| 3244 | ~~~~~~~~~~ |
| 3245 | |
| 3246 | +----------+-------------+--------------------------------------+------------------+ |
| 3247 | | Type | Name | Description | Schema | |
| 3248 | +==========+=============+======================================+==================+ |
| 3249 | | **Path** | **artifactI | | string | |
| 3250 | | | d**\ *requi | | | |
| 3251 | | | red* | | | |
| 3252 | +----------+-------------+--------------------------------------+------------------+ |
| 3253 | | **Path** | **serviceId | | string | |
| 3254 | | | **\ *requir | | | |
| 3255 | | | ed* | | | |
| 3256 | +----------+-------------+--------------------------------------+------------------+ |
| 3257 | | **Body** | **body**\ * | json describe the artifact | string | |
| 3258 | | | required* | | | |
| 3259 | +----------+-------------+--------------------------------------+------------------+ |
| 3260 | |
| 3261 | Responses |
| 3262 | ~~~~~~~~~ |
| 3263 | |
| 3264 | +---------+----------------------------------------------------+----------------+ |
| 3265 | | HTTP | Description | Schema | |
| 3266 | | Code | | | |
| 3267 | +=========+====================================================+================+ |
| 3268 | | **201** | Service artifact created | No Content | |
| 3269 | +---------+----------------------------------------------------+----------------+ |
| 3270 | | **400** | Invalid content / Missing content | No Content | |
| 3271 | +---------+----------------------------------------------------+----------------+ |
| 3272 | | **403** | Restricted operation | No Content | |
| 3273 | +---------+----------------------------------------------------+----------------+ |
| 3274 | |
| 3275 | Consumes |
| 3276 | ~~~~~~~~ |
| 3277 | |
| 3278 | - ``application/json`` |
| 3279 | |
| 3280 | Produces |
| 3281 | ~~~~~~~~ |
| 3282 | |
| 3283 | - ``application/json`` |
| 3284 | |
| 3285 | Tags |
| 3286 | ~~~~ |
| 3287 | |
| 3288 | - Resource Artifact Servlet |
| 3289 | |
| 3290 | Download service Artifact in Base64 |
| 3291 | ----------------------------------- |
| 3292 | |
| 3293 | :: |
| 3294 | |
| 3295 | GET /v1/catalog/services/{serviceId}/artifacts/{artifactId} |
| 3296 | |
| 3297 | Description |
| 3298 | ~~~~~~~~~~~ |
| 3299 | |
| 3300 | Returns downloaded artifact |
| 3301 | |
| 3302 | Parameters |
| 3303 | ~~~~~~~~~~ |
| 3304 | |
| 3305 | +------------------+--------------------------+----------------------------------+ |
| 3306 | | Type | Name | Schema | |
| 3307 | +==================+==========================+==================================+ |
| 3308 | | **Path** | **artifactId**\ *require | string | |
| 3309 | | | d* | | |
| 3310 | +------------------+--------------------------+----------------------------------+ |
| 3311 | | **Path** | **serviceId**\ *required | string | |
| 3312 | | | * | | |
| 3313 | +------------------+--------------------------+----------------------------------+ |
| 3314 | |
| 3315 | Responses |
| 3316 | ~~~~~~~~~ |
| 3317 | |
| 3318 | +---------+----------------------------------------------------+----------------+ |
| 3319 | | HTTP | Description | Schema | |
| 3320 | | Code | | | |
| 3321 | +=========+====================================================+================+ |
| 3322 | | **200** | Service artifact downloaded | No Content | |
| 3323 | +---------+----------------------------------------------------+----------------+ |
| 3324 | | **404** | Service/Artifact not found | No Content | |
| 3325 | +---------+----------------------------------------------------+----------------+ |
| 3326 | |
| 3327 | Consumes |
| 3328 | ~~~~~~~~ |
| 3329 | |
| 3330 | - ``application/json`` |
| 3331 | |
| 3332 | Produces |
| 3333 | ~~~~~~~~ |
| 3334 | |
| 3335 | - ``application/json`` |
| 3336 | |
| 3337 | Tags |
| 3338 | ~~~~ |
| 3339 | |
| 3340 | - Resource Artifact Servlet |
| 3341 | |
| 3342 | Delete Artifact |
| 3343 | --------------- |
| 3344 | |
| 3345 | :: |
| 3346 | |
| 3347 | DELETE /v1/catalog/services/{serviceId}/artifacts/{artifactId} |
| 3348 | |
| 3349 | Description |
| 3350 | ~~~~~~~~~~~ |
| 3351 | |
| 3352 | Returns delete artifact |
| 3353 | |
| 3354 | Parameters |
| 3355 | ~~~~~~~~~~ |
| 3356 | |
| 3357 | +------------------+--------------------------+----------------------------------+ |
| 3358 | | Type | Name | Schema | |
| 3359 | +==================+==========================+==================================+ |
| 3360 | | **Path** | **artifactId**\ *require | string | |
| 3361 | | | d* | | |
| 3362 | +------------------+--------------------------+----------------------------------+ |
| 3363 | | **Path** | **serviceId**\ *required | string | |
| 3364 | | | * | | |
| 3365 | +------------------+--------------------------+----------------------------------+ |
| 3366 | |
| 3367 | Responses |
| 3368 | ~~~~~~~~~ |
| 3369 | |
| 3370 | +---------+----------------------------------------------------+----------------+ |
| 3371 | | HTTP | Description | Schema | |
| 3372 | | Code | | | |
| 3373 | +=========+====================================================+================+ |
| 3374 | | **201** | Service artifact deleted | No Content | |
| 3375 | +---------+----------------------------------------------------+----------------+ |
| 3376 | | **400** | Invalid content / Missing content | No Content | |
| 3377 | +---------+----------------------------------------------------+----------------+ |
| 3378 | | **403** | Restricted operation | No Content | |
| 3379 | +---------+----------------------------------------------------+----------------+ |
| 3380 | |
| 3381 | Consumes |
| 3382 | ~~~~~~~~ |
| 3383 | |
| 3384 | - ``application/json`` |
| 3385 | |
| 3386 | Produces |
| 3387 | ~~~~~~~~ |
| 3388 | |
| 3389 | - ``application/json`` |
| 3390 | |
| 3391 | Tags |
| 3392 | ~~~~ |
| 3393 | |
| 3394 | - Resource Artifact Servlet |
| 3395 | |
| 3396 | Update Service Distribution State |
| 3397 | --------------------------------- |
| 3398 | |
| 3399 | :: |
| 3400 | |
| 3401 | POST /v1/catalog/services/{serviceId}/distribution-state/{state} |
| 3402 | |
| 3403 | Description |
| 3404 | ~~~~~~~~~~~ |
| 3405 | |
| 3406 | service with the changed distribution status |
| 3407 | |
| 3408 | Parameters |
| 3409 | ~~~~~~~~~~ |
| 3410 | |
| 3411 | +----------+-------------+--------------------------------------+------------------+ |
| 3412 | | Type | Name | Description | Schema | |
| 3413 | +==========+=============+======================================+==================+ |
| 3414 | | **Header | **USER\_ID* | | string | |
| 3415 | | ** | *\ *optiona | | | |
| 3416 | | | l* | | | |
| 3417 | +----------+-------------+--------------------------------------+------------------+ |
| 3418 | | **Path** | **serviceId | | string | |
| 3419 | | | **\ *requir | | | |
| 3420 | | | ed* | | | |
| 3421 | +----------+-------------+--------------------------------------+------------------+ |
| 3422 | | **Path** | **state**\ | | enum (approve, | |
| 3423 | | | *required* | | reject) | |
| 3424 | +----------+-------------+--------------------------------------+------------------+ |
| 3425 | | **Body** | **body**\ * | DistributionChangeInfo - get comment | `LifecycleChange | |
| 3426 | | | required* | out of body | InfoWithAction < | |
| 3427 | | | | | #_lifecyclechang | |
| 3428 | | | | | einfowithaction> | |
| 3429 | | | | | `__ | |
| 3430 | +----------+-------------+--------------------------------------+------------------+ |
| 3431 | |
| 3432 | Responses |
| 3433 | ~~~~~~~~~ |
| 3434 | |
| 3435 | +---------+----------------------------------------------------+----------------+ |
| 3436 | | HTTP | Description | Schema | |
| 3437 | | Code | | | |
| 3438 | +=========+====================================================+================+ |
| 3439 | | **200** | Service distribution state changed | No Content | |
| 3440 | +---------+----------------------------------------------------+----------------+ |
| 3441 | | **400** | Invalid content / Missing content | No Content | |
| 3442 | +---------+----------------------------------------------------+----------------+ |
| 3443 | | **403** | Service is not available for distribution | No Content | |
| 3444 | +---------+----------------------------------------------------+----------------+ |
| 3445 | | **404** | Requested service was not found | No Content | |
| 3446 | +---------+----------------------------------------------------+----------------+ |
| 3447 | | **409** | Restricted operation | No Content | |
| 3448 | +---------+----------------------------------------------------+----------------+ |
| 3449 | | **500** | Internal Server Error. Please try again later. | No Content | |
| 3450 | +---------+----------------------------------------------------+----------------+ |
| 3451 | |
| 3452 | Consumes |
| 3453 | ~~~~~~~~ |
| 3454 | |
| 3455 | - ``application/json`` |
| 3456 | |
| 3457 | Produces |
| 3458 | ~~~~~~~~ |
| 3459 | |
| 3460 | - ``application/json`` |
| 3461 | |
| 3462 | Tags |
| 3463 | ~~~~ |
| 3464 | |
| 3465 | - Service Catalog |
| 3466 | |
| 3467 | Mark distribution as deployed |
| 3468 | ----------------------------- |
| 3469 | |
| 3470 | :: |
| 3471 | |
| 3472 | POST /v1/catalog/services/{serviceId}/distribution/{did}/markDeployed |
| 3473 | |
| 3474 | Description |
| 3475 | ~~~~~~~~~~~ |
| 3476 | |
| 3477 | relevant audit record will be created |
| 3478 | |
| 3479 | Parameters |
| 3480 | ~~~~~~~~~~ |
| 3481 | |
| 3482 | +------------------+--------------------------+----------------------------------+ |
| 3483 | | Type | Name | Schema | |
| 3484 | +==================+==========================+==================================+ |
| 3485 | | **Header** | **USER\_ID**\ *optional* | string | |
| 3486 | +------------------+--------------------------+----------------------------------+ |
| 3487 | | **Path** | **did**\ *required* | string | |
| 3488 | +------------------+--------------------------+----------------------------------+ |
| 3489 | | **Path** | **serviceId**\ *required | string | |
| 3490 | | | * | | |
| 3491 | +------------------+--------------------------+----------------------------------+ |
| 3492 | |
| 3493 | Responses |
| 3494 | ~~~~~~~~~ |
| 3495 | |
| 3496 | +---------+----------------------------------------------------+----------------+ |
| 3497 | | HTTP | Description | Schema | |
| 3498 | | Code | | | |
| 3499 | +=========+====================================================+================+ |
| 3500 | | **200** | Service was marked as deployed | No Content | |
| 3501 | +---------+----------------------------------------------------+----------------+ |
| 3502 | | **400** | Invalid content / Missing content | No Content | |
| 3503 | +---------+----------------------------------------------------+----------------+ |
| 3504 | | **403** | Service is not available | No Content | |
| 3505 | +---------+----------------------------------------------------+----------------+ |
| 3506 | | **404** | Requested service was not found | No Content | |
| 3507 | +---------+----------------------------------------------------+----------------+ |
| 3508 | | **409** | Restricted operation | No Content | |
| 3509 | +---------+----------------------------------------------------+----------------+ |
| 3510 | | **500** | Internal Server Error. Please try again later. | No Content | |
| 3511 | +---------+----------------------------------------------------+----------------+ |
| 3512 | |
| 3513 | Consumes |
| 3514 | ~~~~~~~~ |
| 3515 | |
| 3516 | - ``application/json`` |
| 3517 | |
| 3518 | Produces |
| 3519 | ~~~~~~~~ |
| 3520 | |
| 3521 | - ``application/json`` |
| 3522 | |
| 3523 | Tags |
| 3524 | ~~~~ |
| 3525 | |
| 3526 | - Service Catalog |
| 3527 | |
| 3528 | Activate distribution |
| 3529 | --------------------- |
| 3530 | |
| 3531 | :: |
| 3532 | |
| 3533 | POST /v1/catalog/services/{serviceId}/distribution/{env}/activate |
| 3534 | |
| 3535 | Description |
| 3536 | ~~~~~~~~~~~ |
| 3537 | |
| 3538 | activate distribution |
| 3539 | |
| 3540 | Parameters |
| 3541 | ~~~~~~~~~~ |
| 3542 | |
| 3543 | +------------------+--------------------------+----------------------------------+ |
| 3544 | | Type | Name | Schema | |
| 3545 | +==================+==========================+==================================+ |
| 3546 | | **Header** | **USER\_ID**\ *optional* | string | |
| 3547 | +------------------+--------------------------+----------------------------------+ |
| 3548 | | **Path** | **env**\ *required* | string | |
| 3549 | +------------------+--------------------------+----------------------------------+ |
| 3550 | | **Path** | **serviceId**\ *required | string | |
| 3551 | | | * | | |
| 3552 | +------------------+--------------------------+----------------------------------+ |
| 3553 | |
| 3554 | Responses |
| 3555 | ~~~~~~~~~ |
| 3556 | |
| 3557 | +---------+----------------------------------------------------+----------------+ |
| 3558 | | HTTP | Description | Schema | |
| 3559 | | Code | | | |
| 3560 | +=========+====================================================+================+ |
| 3561 | | **200** | OK | No Content | |
| 3562 | +---------+----------------------------------------------------+----------------+ |
| 3563 | | **404** | Requested service was not found | No Content | |
| 3564 | +---------+----------------------------------------------------+----------------+ |
| 3565 | | **409** | Service cannot be distributed due to missing | No Content | |
| 3566 | | | deployment artifacts | | |
| 3567 | +---------+----------------------------------------------------+----------------+ |
| 3568 | | **500** | Internal Server Error. Please try again later. | No Content | |
| 3569 | +---------+----------------------------------------------------+----------------+ |
| 3570 | |
| 3571 | Consumes |
| 3572 | ~~~~~~~~ |
| 3573 | |
| 3574 | - ``application/json`` |
| 3575 | |
| 3576 | Produces |
| 3577 | ~~~~~~~~ |
| 3578 | |
| 3579 | - ``application/json`` |
| 3580 | |
| 3581 | Tags |
| 3582 | ~~~~ |
| 3583 | |
| 3584 | - Service Catalog |
| 3585 | |
| 3586 | Update Service Metadata |
| 3587 | ----------------------- |
| 3588 | |
| 3589 | :: |
| 3590 | |
| 3591 | PUT /v1/catalog/services/{serviceId}/metadata |
| 3592 | |
| 3593 | Description |
| 3594 | ~~~~~~~~~~~ |
| 3595 | |
| 3596 | Returns updated service |
| 3597 | |
| 3598 | Parameters |
| 3599 | ~~~~~~~~~~ |
| 3600 | |
| 3601 | +----------+-------------+--------------------------------------+------------------+ |
| 3602 | | Type | Name | Description | Schema | |
| 3603 | +==========+=============+======================================+==================+ |
| 3604 | | **Header | **USER\_ID* | | string | |
| 3605 | | ** | *\ *optiona | | | |
| 3606 | | | l* | | | |
| 3607 | +----------+-------------+--------------------------------------+------------------+ |
| 3608 | | **Path** | **serviceId | | string | |
| 3609 | | | **\ *requir | | | |
| 3610 | | | ed* | | | |
| 3611 | +----------+-------------+--------------------------------------+------------------+ |
| 3612 | | **Body** | **body**\ * | Service object to be Updated | string | |
| 3613 | | | required* | | | |
| 3614 | +----------+-------------+--------------------------------------+------------------+ |
| 3615 | |
| 3616 | Responses |
| 3617 | ~~~~~~~~~ |
| 3618 | |
| 3619 | +---------+----------------------------------------------------+----------------+ |
| 3620 | | HTTP | Description | Schema | |
| 3621 | | Code | | | |
| 3622 | +=========+====================================================+================+ |
| 3623 | | **200** | Service Updated | No Content | |
| 3624 | +---------+----------------------------------------------------+----------------+ |
| 3625 | | **400** | Invalid content / Missing content | No Content | |
| 3626 | +---------+----------------------------------------------------+----------------+ |
| 3627 | | **403** | Restricted operation | No Content | |
| 3628 | +---------+----------------------------------------------------+----------------+ |
| 3629 | |
| 3630 | Consumes |
| 3631 | ~~~~~~~~ |
| 3632 | |
| 3633 | - ``application/json`` |
| 3634 | |
| 3635 | Produces |
| 3636 | ~~~~~~~~ |
| 3637 | |
| 3638 | - ``application/json`` |
| 3639 | |
| 3640 | Tags |
| 3641 | ~~~~ |
| 3642 | |
| 3643 | - Service Catalog |
| 3644 | |
| 3645 | POST /v1/catalog/services/{serviceid}/tempUrlToBeDeleted |
| 3646 | -------------------------------------------------------- |
| 3647 | |
| 3648 | Parameters |
| 3649 | ~~~~~~~~~~ |
| 3650 | |
| 3651 | +------------------+--------------------------+----------------------------------+ |
| 3652 | | Type | Name | Schema | |
| 3653 | +==================+==========================+==================================+ |
| 3654 | | **Header** | **USER\_ID**\ *optional* | string | |
| 3655 | +------------------+--------------------------+----------------------------------+ |
| 3656 | | **Path** | **serviceId**\ *required | string | |
| 3657 | | | * | | |
| 3658 | +------------------+--------------------------+----------------------------------+ |
| 3659 | |
| 3660 | Responses |
| 3661 | ~~~~~~~~~ |
| 3662 | |
| 3663 | +---------+----------------------------------------------------+----------------+ |
| 3664 | | HTTP | Description | Schema | |
| 3665 | | Code | | | |
| 3666 | +=========+====================================================+================+ |
| 3667 | | **200** | OK | No Content | |
| 3668 | +---------+----------------------------------------------------+----------------+ |
| 3669 | | **500** | Internal Server Error. Please try again later. | No Content | |
| 3670 | +---------+----------------------------------------------------+----------------+ |
| 3671 | |
| 3672 | Consumes |
| 3673 | ~~~~~~~~ |
| 3674 | |
| 3675 | - ``application/json`` |
| 3676 | |
| 3677 | Produces |
| 3678 | ~~~~~~~~ |
| 3679 | |
| 3680 | - ``application/json`` |
| 3681 | |
| 3682 | Tags |
| 3683 | ~~~~ |
| 3684 | |
| 3685 | - Service Catalog |
| 3686 | |
| 3687 | DELETE /v1/catalog/services/{servicename}/{version} |
| 3688 | --------------------------------------------------- |
| 3689 | |
| 3690 | Parameters |
| 3691 | ~~~~~~~~~~ |
| 3692 | |
| 3693 | +------------------+--------------------------+----------------------------------+ |
| 3694 | | Type | Name | Schema | |
| 3695 | +==================+==========================+==================================+ |
| 3696 | | **Path** | **serviceName**\ *requir | string | |
| 3697 | | | ed* | | |
| 3698 | +------------------+--------------------------+----------------------------------+ |
| 3699 | | **Path** | **version**\ *required* | string | |
| 3700 | +------------------+--------------------------+----------------------------------+ |
| 3701 | |
| 3702 | Responses |
| 3703 | ~~~~~~~~~ |
| 3704 | |
| 3705 | +---------+----------------------------------------------------+----------------+ |
| 3706 | | HTTP | Description | Schema | |
| 3707 | | Code | | | |
| 3708 | +=========+====================================================+================+ |
| 3709 | | **defau | successful operation | No Content | |
| 3710 | | lt** | | | |
| 3711 | +---------+----------------------------------------------------+----------------+ |
| 3712 | |
| 3713 | Tags |
| 3714 | ~~~~ |
| 3715 | |
| 3716 | - Service Catalog |
| 3717 | |
| 3718 | Retrieve Distributions |
| 3719 | ---------------------- |
| 3720 | |
| 3721 | :: |
| 3722 | |
| 3723 | GET /v1/catalog/services/{serviceUUID}/distribution |
| 3724 | |
| 3725 | Description |
| 3726 | ~~~~~~~~~~~ |
| 3727 | |
| 3728 | Returns list bases on the information extracted from Auditing Records |
| 3729 | according to service uuid |
| 3730 | |
| 3731 | Parameters |
| 3732 | ~~~~~~~~~~ |
| 3733 | |
| 3734 | +------------------+--------------------------+----------------------------------+ |
| 3735 | | Type | Name | Schema | |
| 3736 | +==================+==========================+==================================+ |
| 3737 | | **Header** | **USER\_ID**\ *optional* | string | |
| 3738 | +------------------+--------------------------+----------------------------------+ |
| 3739 | | **Path** | **serviceUUID**\ *requir | string | |
| 3740 | | | ed* | | |
| 3741 | +------------------+--------------------------+----------------------------------+ |
| 3742 | |
| 3743 | Responses |
| 3744 | ~~~~~~~~~ |
| 3745 | |
| 3746 | +---------+----------------------------------------------------+----------------+ |
| 3747 | | HTTP | Description | Schema | |
| 3748 | | Code | | | |
| 3749 | +=========+====================================================+================+ |
| 3750 | | **200** | Service found | No Content | |
| 3751 | +---------+----------------------------------------------------+----------------+ |
| 3752 | | **403** | Restricted operation | No Content | |
| 3753 | +---------+----------------------------------------------------+----------------+ |
| 3754 | | **404** | Service not found | No Content | |
| 3755 | +---------+----------------------------------------------------+----------------+ |
| 3756 | |
| 3757 | Consumes |
| 3758 | ~~~~~~~~ |
| 3759 | |
| 3760 | - ``application/json`` |
| 3761 | |
| 3762 | Produces |
| 3763 | ~~~~~~~~ |
| 3764 | |
| 3765 | - ``application/json`` |
| 3766 | |
| 3767 | Tags |
| 3768 | ~~~~ |
| 3769 | |
| 3770 | - Distribution Service Servlet |
| 3771 | |
| 3772 | Create Resource from yaml |
| 3773 | ------------------------- |
| 3774 | |
| 3775 | :: |
| 3776 | |
| 3777 | POST /v1/catalog/upload/{resourceAuthority} |
| 3778 | |
| 3779 | Description |
| 3780 | ~~~~~~~~~~~ |
| 3781 | |
| 3782 | Returns created resource |
| 3783 | |
| 3784 | Parameters |
| 3785 | ~~~~~~~~~~ |
| 3786 | |
| 3787 | +---------+------------+----------------------------------+----------------+---------+ |
| 3788 | | Type | Name | Description | Schema | Default | |
| 3789 | +=========+============+==================================+================+=========+ |
| 3790 | | **Heade | **USER\_ID | | string | | |
| 3791 | | r** | **\ *optio | | | | |
| 3792 | | | nal* | | | | |
| 3793 | +---------+------------+----------------------------------+----------------+---------+ |
| 3794 | | **Path* | **resource | validValues: normative-resource | enum | | |
| 3795 | | * | Authority* | / user-resource | (multipart, | | |
| 3796 | | | *\ *requir | | user-resource, | | |
| 3797 | | | ed* | | user-resource- | | |
| 3798 | | | | | ui-import) | | |
| 3799 | +---------+------------+----------------------------------+----------------+---------+ |
| 3800 | | **Query | **createNe | | boolean | ``"true | |
| 3801 | | ** | wVersion** | | | "`` | |
| 3802 | | | \ *optiona | | | | |
| 3803 | | | l* | | | | |
| 3804 | +---------+------------+----------------------------------+----------------+---------+ |
| 3805 | | **FormD | **resource | resourceMetadata | string | | |
| 3806 | | ata** | Metadata** | | | | |
| 3807 | | | \ *optiona | | | | |
| 3808 | | | l* | | | | |
| 3809 | +---------+------------+----------------------------------+----------------+---------+ |
| 3810 | | **FormD | **resource | FileInputStream | file | | |
| 3811 | | ata** | Zip**\ *op | | | | |
| 3812 | | | tional* | | | | |
| 3813 | +---------+------------+----------------------------------+----------------+---------+ |
| 3814 | |
| 3815 | Responses |
| 3816 | ~~~~~~~~~ |
| 3817 | |
| 3818 | +---------+----------------------------------------------------+----------------+ |
| 3819 | | HTTP | Description | Schema | |
| 3820 | | Code | | | |
| 3821 | +=========+====================================================+================+ |
| 3822 | | **201** | Resource created | No Content | |
| 3823 | +---------+----------------------------------------------------+----------------+ |
| 3824 | | **400** | Invalid content / Missing content | No Content | |
| 3825 | +---------+----------------------------------------------------+----------------+ |
| 3826 | | **403** | Restricted operation | No Content | |
| 3827 | +---------+----------------------------------------------------+----------------+ |
| 3828 | | **409** | Resource already exist | No Content | |
| 3829 | +---------+----------------------------------------------------+----------------+ |
| 3830 | |
| 3831 | Consumes |
| 3832 | ~~~~~~~~ |
| 3833 | |
| 3834 | - ``multipart/form-data`` |
| 3835 | |
| 3836 | Produces |
| 3837 | ~~~~~~~~ |
| 3838 | |
| 3839 | - ``application/json`` |
| 3840 | |
| 3841 | Tags |
| 3842 | ~~~~ |
| 3843 | |
| 3844 | - Resources Catalog Upload |
| 3845 | |
| 3846 | Create Capability Type from yaml |
| 3847 | -------------------------------- |
| 3848 | |
| 3849 | :: |
| 3850 | |
| 3851 | POST /v1/catalog/uploadType/capability |
| 3852 | |
| 3853 | Description |
| 3854 | ~~~~~~~~~~~ |
| 3855 | |
| 3856 | Returns created Capability Type |
| 3857 | |
| 3858 | Parameters |
| 3859 | ~~~~~~~~~~ |
| 3860 | |
| 3861 | +----------+-------------+--------------------------------------+------------------+ |
| 3862 | | Type | Name | Description | Schema | |
| 3863 | +==========+=============+======================================+==================+ |
| 3864 | | **Header | **USER\_ID* | | string | |
| 3865 | | ** | *\ *optiona | | | |
| 3866 | | | l* | | | |
| 3867 | +----------+-------------+--------------------------------------+------------------+ |
| 3868 | | **FormDa | **capabilit | FileInputStream | file | |
| 3869 | | ta** | yTypeZip**\ | | | |
| 3870 | | | *optional* | | | |
| 3871 | +----------+-------------+--------------------------------------+------------------+ |
| 3872 | |
| 3873 | Responses |
| 3874 | ~~~~~~~~~ |
| 3875 | |
| 3876 | +---------+----------------------------------------------------+----------------+ |
| 3877 | | HTTP | Description | Schema | |
| 3878 | | Code | | | |
| 3879 | +=========+====================================================+================+ |
| 3880 | | **201** | Capability Type created | No Content | |
| 3881 | +---------+----------------------------------------------------+----------------+ |
| 3882 | | **400** | Invalid content / Missing content | No Content | |
| 3883 | +---------+----------------------------------------------------+----------------+ |
| 3884 | | **403** | Restricted operation | No Content | |
| 3885 | +---------+----------------------------------------------------+----------------+ |
| 3886 | | **409** | Capability Type already exist | No Content | |
| 3887 | +---------+----------------------------------------------------+----------------+ |
| 3888 | |
| 3889 | Consumes |
| 3890 | ~~~~~~~~ |
| 3891 | |
| 3892 | - ``multipart/form-data`` |
| 3893 | |
| 3894 | Produces |
| 3895 | ~~~~~~~~ |
| 3896 | |
| 3897 | - ``application/json`` |
| 3898 | |
| 3899 | Tags |
| 3900 | ~~~~ |
| 3901 | |
| 3902 | - Catalog Types Upload |
| 3903 | |
| 3904 | Create Categories from yaml |
| 3905 | --------------------------- |
| 3906 | |
| 3907 | :: |
| 3908 | |
| 3909 | POST /v1/catalog/uploadType/categories |
| 3910 | |
| 3911 | Description |
| 3912 | ~~~~~~~~~~~ |
| 3913 | |
| 3914 | Returns created categories |
| 3915 | |
| 3916 | Parameters |
| 3917 | ~~~~~~~~~~ |
| 3918 | |
| 3919 | +----------+-------------+--------------------------------------+------------------+ |
| 3920 | | Type | Name | Description | Schema | |
| 3921 | +==========+=============+======================================+==================+ |
| 3922 | | **Header | **USER\_ID* | | string | |
| 3923 | | ** | *\ *optiona | | | |
| 3924 | | | l* | | | |
| 3925 | +----------+-------------+--------------------------------------+------------------+ |
| 3926 | | **FormDa | **categorie | FileInputStream | file | |
| 3927 | | ta** | sZip**\ *op | | | |
| 3928 | | | tional* | | | |
| 3929 | +----------+-------------+--------------------------------------+------------------+ |
| 3930 | |
| 3931 | Responses |
| 3932 | ~~~~~~~~~ |
| 3933 | |
| 3934 | +---------+----------------------------------------------------+----------------+ |
| 3935 | | HTTP | Description | Schema | |
| 3936 | | Code | | | |
| 3937 | +=========+====================================================+================+ |
| 3938 | | **201** | Categories created | No Content | |
| 3939 | +---------+----------------------------------------------------+----------------+ |
| 3940 | | **400** | Invalid content / Missing content | No Content | |
| 3941 | +---------+----------------------------------------------------+----------------+ |
| 3942 | | **403** | Restricted operation | No Content | |
| 3943 | +---------+----------------------------------------------------+----------------+ |
| 3944 | | **409** | Category already exist | No Content | |
| 3945 | +---------+----------------------------------------------------+----------------+ |
| 3946 | |
| 3947 | Consumes |
| 3948 | ~~~~~~~~ |
| 3949 | |
| 3950 | - ``multipart/form-data`` |
| 3951 | |
| 3952 | Produces |
| 3953 | ~~~~~~~~ |
| 3954 | |
| 3955 | - ``application/json`` |
| 3956 | |
| 3957 | Tags |
| 3958 | ~~~~ |
| 3959 | |
| 3960 | - Catalog Types Upload |
| 3961 | |
| 3962 | Create Categories from yaml |
| 3963 | --------------------------- |
| 3964 | |
| 3965 | :: |
| 3966 | |
| 3967 | POST /v1/catalog/uploadType/datatypes |
| 3968 | |
| 3969 | Description |
| 3970 | ~~~~~~~~~~~ |
| 3971 | |
| 3972 | Returns created data types |
| 3973 | |
| 3974 | Parameters |
| 3975 | ~~~~~~~~~~ |
| 3976 | |
| 3977 | +----------+-------------+--------------------------------------+------------------+ |
| 3978 | | Type | Name | Description | Schema | |
| 3979 | +==========+=============+======================================+==================+ |
| 3980 | | **Header | **USER\_ID* | | string | |
| 3981 | | ** | *\ *optiona | | | |
| 3982 | | | l* | | | |
| 3983 | +----------+-------------+--------------------------------------+------------------+ |
| 3984 | | **FormDa | **dataTypes | FileInputStream | file | |
| 3985 | | ta** | Zip**\ *opt | | | |
| 3986 | | | ional* | | | |
| 3987 | +----------+-------------+--------------------------------------+------------------+ |
| 3988 | |
| 3989 | Responses |
| 3990 | ~~~~~~~~~ |
| 3991 | |
| 3992 | +---------+----------------------------------------------------+----------------+ |
| 3993 | | HTTP | Description | Schema | |
| 3994 | | Code | | | |
| 3995 | +=========+====================================================+================+ |
| 3996 | | **201** | Data types created | No Content | |
| 3997 | +---------+----------------------------------------------------+----------------+ |
| 3998 | | **400** | Invalid content / Missing content | No Content | |
| 3999 | +---------+----------------------------------------------------+----------------+ |
| 4000 | | **403** | Restricted operation | No Content | |
| 4001 | +---------+----------------------------------------------------+----------------+ |
| 4002 | | **409** | Data types already exist | No Content | |
| 4003 | +---------+----------------------------------------------------+----------------+ |
| 4004 | |
| 4005 | Consumes |
| 4006 | ~~~~~~~~ |
| 4007 | |
| 4008 | - ``multipart/form-data`` |
| 4009 | |
| 4010 | Produces |
| 4011 | ~~~~~~~~ |
| 4012 | |
| 4013 | - ``application/json`` |
| 4014 | |
| 4015 | Tags |
| 4016 | ~~~~ |
| 4017 | |
| 4018 | - Catalog Types Upload |
| 4019 | |
| 4020 | Create GroupTypes from yaml |
| 4021 | --------------------------- |
| 4022 | |
| 4023 | :: |
| 4024 | |
| 4025 | POST /v1/catalog/uploadType/grouptypes |
| 4026 | |
| 4027 | Description |
| 4028 | ~~~~~~~~~~~ |
| 4029 | |
| 4030 | Returns created group types |
| 4031 | |
| 4032 | Parameters |
| 4033 | ~~~~~~~~~~ |
| 4034 | |
| 4035 | +----------+-------------+--------------------------------------+------------------+ |
| 4036 | | Type | Name | Description | Schema | |
| 4037 | +==========+=============+======================================+==================+ |
| 4038 | | **Header | **USER\_ID* | | string | |
| 4039 | | ** | *\ *optiona | | | |
| 4040 | | | l* | | | |
| 4041 | +----------+-------------+--------------------------------------+------------------+ |
| 4042 | | **FormDa | **groupType | FileInputStream | file | |
| 4043 | | ta** | sZip**\ *op | | | |
| 4044 | | | tional* | | | |
| 4045 | +----------+-------------+--------------------------------------+------------------+ |
| 4046 | |
| 4047 | Responses |
| 4048 | ~~~~~~~~~ |
| 4049 | |
| 4050 | +---------+----------------------------------------------------+----------------+ |
| 4051 | | HTTP | Description | Schema | |
| 4052 | | Code | | | |
| 4053 | +=========+====================================================+================+ |
| 4054 | | **201** | group types created | No Content | |
| 4055 | +---------+----------------------------------------------------+----------------+ |
| 4056 | | **400** | Invalid content / Missing content | No Content | |
| 4057 | +---------+----------------------------------------------------+----------------+ |
| 4058 | | **403** | Restricted operation | No Content | |
| 4059 | +---------+----------------------------------------------------+----------------+ |
| 4060 | | **409** | group types already exist | No Content | |
| 4061 | +---------+----------------------------------------------------+----------------+ |
| 4062 | |
| 4063 | Consumes |
| 4064 | ~~~~~~~~ |
| 4065 | |
| 4066 | - ``multipart/form-data`` |
| 4067 | |
| 4068 | Produces |
| 4069 | ~~~~~~~~ |
| 4070 | |
| 4071 | - ``application/json`` |
| 4072 | |
| 4073 | Tags |
| 4074 | ~~~~ |
| 4075 | |
| 4076 | - Catalog Types Upload |
| 4077 | |
| 4078 | Create Interface Lyfecycle Type from yaml |
| 4079 | ----------------------------------------- |
| 4080 | |
| 4081 | :: |
| 4082 | |
| 4083 | POST /v1/catalog/uploadType/interfaceLifecycle |
| 4084 | |
| 4085 | Description |
| 4086 | ~~~~~~~~~~~ |
| 4087 | |
| 4088 | Returns created Interface Lifecycle Type |
| 4089 | |
| 4090 | Parameters |
| 4091 | ~~~~~~~~~~ |
| 4092 | |
| 4093 | +----------+-------------+--------------------------------------+------------------+ |
| 4094 | | Type | Name | Description | Schema | |
| 4095 | +==========+=============+======================================+==================+ |
| 4096 | | **Header | **USER\_ID* | | string | |
| 4097 | | ** | *\ *optiona | | | |
| 4098 | | | l* | | | |
| 4099 | +----------+-------------+--------------------------------------+------------------+ |
| 4100 | | **FormDa | **interface | FileInputStream | file | |
| 4101 | | ta** | LifecycleTy | | | |
| 4102 | | | peZip**\ *o | | | |
| 4103 | | | ptional* | | | |
| 4104 | +----------+-------------+--------------------------------------+------------------+ |
| 4105 | |
| 4106 | Responses |
| 4107 | ~~~~~~~~~ |
| 4108 | |
| 4109 | +---------+----------------------------------------------------+----------------+ |
| 4110 | | HTTP | Description | Schema | |
| 4111 | | Code | | | |
| 4112 | +=========+====================================================+================+ |
| 4113 | | **201** | Interface Lifecycle Type created | No Content | |
| 4114 | +---------+----------------------------------------------------+----------------+ |
| 4115 | | **400** | Invalid content / Missing content | No Content | |
| 4116 | +---------+----------------------------------------------------+----------------+ |
| 4117 | | **403** | Restricted operation | No Content | |
| 4118 | +---------+----------------------------------------------------+----------------+ |
| 4119 | | **409** | Interface Lifecycle Type already exist | No Content | |
| 4120 | +---------+----------------------------------------------------+----------------+ |
| 4121 | |
| 4122 | Consumes |
| 4123 | ~~~~~~~~ |
| 4124 | |
| 4125 | - ``multipart/form-data`` |
| 4126 | |
| 4127 | Produces |
| 4128 | ~~~~~~~~ |
| 4129 | |
| 4130 | - ``application/json`` |
| 4131 | |
| 4132 | Tags |
| 4133 | ~~~~ |
| 4134 | |
| 4135 | - Catalog Types Upload |
| 4136 | |
| 4137 | Create PolicyTypes from yaml |
| 4138 | ---------------------------- |
| 4139 | |
| 4140 | :: |
| 4141 | |
| 4142 | POST /v1/catalog/uploadType/policytypes |
| 4143 | |
| 4144 | Description |
| 4145 | ~~~~~~~~~~~ |
| 4146 | |
| 4147 | Returns created policy types |
| 4148 | |
| 4149 | Parameters |
| 4150 | ~~~~~~~~~~ |
| 4151 | |
| 4152 | +----------+-------------+--------------------------------------+------------------+ |
| 4153 | | Type | Name | Description | Schema | |
| 4154 | +==========+=============+======================================+==================+ |
| 4155 | | **Header | **USER\_ID* | | string | |
| 4156 | | ** | *\ *optiona | | | |
| 4157 | | | l* | | | |
| 4158 | +----------+-------------+--------------------------------------+------------------+ |
| 4159 | | **FormDa | **policyTyp | FileInputStream | file | |
| 4160 | | ta** | esZip**\ *o | | | |
| 4161 | | | ptional* | | | |
| 4162 | +----------+-------------+--------------------------------------+------------------+ |
| 4163 | |
| 4164 | Responses |
| 4165 | ~~~~~~~~~ |
| 4166 | |
| 4167 | +---------+----------------------------------------------------+----------------+ |
| 4168 | | HTTP | Description | Schema | |
| 4169 | | Code | | | |
| 4170 | +=========+====================================================+================+ |
| 4171 | | **201** | policy types created | No Content | |
| 4172 | +---------+----------------------------------------------------+----------------+ |
| 4173 | | **400** | Invalid content / Missing content | No Content | |
| 4174 | +---------+----------------------------------------------------+----------------+ |
| 4175 | | **403** | Restricted operation | No Content | |
| 4176 | +---------+----------------------------------------------------+----------------+ |
| 4177 | | **409** | policy types already exist | No Content | |
| 4178 | +---------+----------------------------------------------------+----------------+ |
| 4179 | |
| 4180 | Consumes |
| 4181 | ~~~~~~~~ |
| 4182 | |
| 4183 | - ``multipart/form-data`` |
| 4184 | |
| 4185 | Produces |
| 4186 | ~~~~~~~~ |
| 4187 | |
| 4188 | - ``application/json`` |
| 4189 | |
| 4190 | Tags |
| 4191 | ~~~~ |
| 4192 | |
| 4193 | - Catalog Types Upload |
| 4194 | |
| 4195 | Change Resource lifecycle State |
| 4196 | ------------------------------- |
| 4197 | |
| 4198 | :: |
| 4199 | |
| 4200 | POST /v1/catalog/{componentCollection}/{componentId}/lifecycleState/{lifecycleOperation} |
| 4201 | |
| 4202 | Parameters |
| 4203 | ~~~~~~~~~~ |
| 4204 | |
| 4205 | +----------+-------------+--------------------------------------+------------------+ |
| 4206 | | Type | Name | Description | Schema | |
| 4207 | +==========+=============+======================================+==================+ |
| 4208 | | **Header | **USER\_ID* | id of user initiating the operation | string | |
| 4209 | | ** | *\ *optiona | | | |
| 4210 | | | l* | | | |
| 4211 | +----------+-------------+--------------------------------------+------------------+ |
| 4212 | | **Path** | **component | validValues: resources / services / | enum (resources, | |
| 4213 | | | Collection* | products | services, | |
| 4214 | | | *\ *require | | products) | |
| 4215 | | | d* | | | |
| 4216 | +----------+-------------+--------------------------------------+------------------+ |
| 4217 | | **Path** | **component | id of component to be changed | string | |
| 4218 | | | Id**\ *requ | | | |
| 4219 | | | ired* | | | |
| 4220 | +----------+-------------+--------------------------------------+------------------+ |
| 4221 | | **Path** | **lifecycle | | enum (checkout, | |
| 4222 | | | Operation** | | undoCheckout, | |
| 4223 | | | \ *required | | checkin, | |
| 4224 | | | * | | certificationReq | |
| 4225 | | | | | uest, | |
| 4226 | | | | | startCertificati | |
| 4227 | | | | | on, | |
| 4228 | | | | | failCertificatio | |
| 4229 | | | | | n, | |
| 4230 | | | | | cancelCertificat | |
| 4231 | | | | | ion, | |
| 4232 | | | | | certify) | |
| 4233 | +----------+-------------+--------------------------------------+------------------+ |
| 4234 | | **Body** | **body**\ * | LifecycleChangeInfo - relevant for | string | |
| 4235 | | | optional* | checkin, failCertification, | | |
| 4236 | | | | cancelCertification | | |
| 4237 | +----------+-------------+--------------------------------------+------------------+ |
| 4238 | |
| 4239 | Responses |
| 4240 | ~~~~~~~~~ |
| 4241 | |
| 4242 | +---------+----------------------------------------------------+----------------+ |
| 4243 | | HTTP | Description | Schema | |
| 4244 | | Code | | | |
| 4245 | +=========+====================================================+================+ |
| 4246 | | **200** | Resource state changed | No Content | |
| 4247 | +---------+----------------------------------------------------+----------------+ |
| 4248 | | **403** | Restricted operation | No Content | |
| 4249 | +---------+----------------------------------------------------+----------------+ |
| 4250 | | **409** | Resource already exist | No Content | |
| 4251 | +---------+----------------------------------------------------+----------------+ |
| 4252 | |
| 4253 | Consumes |
| 4254 | ~~~~~~~~ |
| 4255 | |
| 4256 | - ``application/json`` |
| 4257 | |
| 4258 | Produces |
| 4259 | ~~~~~~~~ |
| 4260 | |
| 4261 | - ``application/json`` |
| 4262 | |
| 4263 | Tags |
| 4264 | ~~~~ |
| 4265 | |
| 4266 | - Lifecycle Actions Servlet |
| 4267 | |
| 4268 | Get Component Requirments And Capabilities |
| 4269 | ------------------------------------------ |
| 4270 | |
| 4271 | :: |
| 4272 | |
| 4273 | GET /v1/catalog/{componentType}/latestversion/notabstract |
| 4274 | |
| 4275 | Description |
| 4276 | ~~~~~~~~~~~ |
| 4277 | |
| 4278 | Returns Requirments And Capabilities according to componentId |
| 4279 | |
| 4280 | Parameters |
| 4281 | ~~~~~~~~~~ |
| 4282 | |
| 4283 | +----------+-------------+--------------------------------------+------------------+ |
| 4284 | | Type | Name | Description | Schema | |
| 4285 | +==========+=============+======================================+==================+ |
| 4286 | | **Header | **USER\_ID* | | string | |
| 4287 | | ** | *\ *optiona | | | |
| 4288 | | | l* | | | |
| 4289 | +----------+-------------+--------------------------------------+------------------+ |
| 4290 | | **Path** | **component | | string | |
| 4291 | | | Type**\ *re | | | |
| 4292 | | | quired* | | | |
| 4293 | +----------+-------------+--------------------------------------+------------------+ |
| 4294 | | **Query* | **internalC | | string | |
| 4295 | | * | omponentTyp | | | |
| 4296 | | | e**\ *optio | | | |
| 4297 | | | nal* | | | |
| 4298 | +----------+-------------+--------------------------------------+------------------+ |
| 4299 | | **Body** | **body**\ * | Consumer Object to be created | < string > array | |
| 4300 | | | required* | | | |
| 4301 | +----------+-------------+--------------------------------------+------------------+ |
| 4302 | |
| 4303 | Responses |
| 4304 | ~~~~~~~~~ |
| 4305 | |
| 4306 | +---------+----------------------------------------------------+----------------+ |
| 4307 | | HTTP | Description | Schema | |
| 4308 | | Code | | | |
| 4309 | +=========+====================================================+================+ |
| 4310 | | **200** | Component found | No Content | |
| 4311 | +---------+----------------------------------------------------+----------------+ |
| 4312 | | **403** | Restricted operation | No Content | |
| 4313 | +---------+----------------------------------------------------+----------------+ |
| 4314 | | **404** | Component not found | No Content | |
| 4315 | +---------+----------------------------------------------------+----------------+ |
| 4316 | |
| 4317 | Consumes |
| 4318 | ~~~~~~~~ |
| 4319 | |
| 4320 | - ``application/json`` |
| 4321 | |
| 4322 | Produces |
| 4323 | ~~~~~~~~ |
| 4324 | |
| 4325 | - ``application/json`` |
| 4326 | |
| 4327 | Tags |
| 4328 | ~~~~ |
| 4329 | |
| 4330 | - Component Servlet |
| 4331 | |
| 4332 | Get Component uid only |
| 4333 | ---------------------- |
| 4334 | |
| 4335 | :: |
| 4336 | |
| 4337 | GET /v1/catalog/{componentType}/latestversion/notabstract/metadata |
| 4338 | |
| 4339 | Description |
| 4340 | ~~~~~~~~~~~ |
| 4341 | |
| 4342 | Returns componentId |
| 4343 | |
| 4344 | Parameters |
| 4345 | ~~~~~~~~~~ |
| 4346 | |
| 4347 | +----------+-------------+--------------------------------------+------------------+ |
| 4348 | | Type | Name | Description | Schema | |
| 4349 | +==========+=============+======================================+==================+ |
| 4350 | | **Header | **USER\_ID* | | string | |
| 4351 | | ** | *\ *optiona | | | |
| 4352 | | | l* | | | |
| 4353 | +----------+-------------+--------------------------------------+------------------+ |
| 4354 | | **Path** | **component | | string | |
| 4355 | | | Type**\ *re | | | |
| 4356 | | | quired* | | | |
| 4357 | +----------+-------------+--------------------------------------+------------------+ |
| 4358 | | **Query* | **internalC | | string | |
| 4359 | | * | omponentTyp | | | |
| 4360 | | | e**\ *optio | | | |
| 4361 | | | nal* | | | |
| 4362 | +----------+-------------+--------------------------------------+------------------+ |
| 4363 | | **Body** | **body**\ * | uid list | string | |
| 4364 | | | required* | | | |
| 4365 | +----------+-------------+--------------------------------------+------------------+ |
| 4366 | |
| 4367 | Responses |
| 4368 | ~~~~~~~~~ |
| 4369 | |
| 4370 | +---------+----------------------------------------------------+----------------+ |
| 4371 | | HTTP | Description | Schema | |
| 4372 | | Code | | | |
| 4373 | +=========+====================================================+================+ |
| 4374 | | **200** | Component found | No Content | |
| 4375 | +---------+----------------------------------------------------+----------------+ |
| 4376 | | **403** | Restricted operation | No Content | |
| 4377 | +---------+----------------------------------------------------+----------------+ |
| 4378 | | **404** | Component not found | No Content | |
| 4379 | +---------+----------------------------------------------------+----------------+ |
| 4380 | |
| 4381 | Consumes |
| 4382 | ~~~~~~~~ |
| 4383 | |
| 4384 | - ``application/json`` |
| 4385 | |
| 4386 | Produces |
| 4387 | ~~~~~~~~ |
| 4388 | |
| 4389 | - ``application/json`` |
| 4390 | |
| 4391 | Tags |
| 4392 | ~~~~ |
| 4393 | |
| 4394 | - Component Servlet |
| 4395 | |
| 4396 | Get Component instances |
| 4397 | ----------------------- |
| 4398 | |
| 4399 | :: |
| 4400 | |
| 4401 | GET /v1/catalog/{componentType}/{componentId}/componentInstances |
| 4402 | |
| 4403 | Description |
| 4404 | ~~~~~~~~~~~ |
| 4405 | |
| 4406 | Returns component instances |
| 4407 | |
| 4408 | Parameters |
| 4409 | ~~~~~~~~~~ |
| 4410 | |
| 4411 | +----------+-------------+--------------------------------------+------------------+ |
| 4412 | | Type | Name | Description | Schema | |
| 4413 | +==========+=============+======================================+==================+ |
| 4414 | | **Header | **USER\_ID* | | string | |
| 4415 | | ** | *\ *optiona | | | |
| 4416 | | | l* | | | |
| 4417 | +----------+-------------+--------------------------------------+------------------+ |
| 4418 | | **Path** | **component | | string | |
| 4419 | | | Id**\ *requ | | | |
| 4420 | | | ired* | | | |
| 4421 | +----------+-------------+--------------------------------------+------------------+ |
| 4422 | | **Path** | **component | | string | |
| 4423 | | | Type**\ *re | | | |
| 4424 | | | quired* | | | |
| 4425 | +----------+-------------+--------------------------------------+------------------+ |
| 4426 | | **Query* | **searchTex | | string | |
| 4427 | | * | t**\ *optio | | | |
| 4428 | | | nal* | | | |
| 4429 | +----------+-------------+--------------------------------------+------------------+ |
| 4430 | | **Body** | **body**\ * | uid list | string | |
| 4431 | | | required* | | | |
| 4432 | +----------+-------------+--------------------------------------+------------------+ |
| 4433 | |
| 4434 | Responses |
| 4435 | ~~~~~~~~~ |
| 4436 | |
| 4437 | +---------+----------------------------------------------------+----------------+ |
| 4438 | | HTTP | Description | Schema | |
| 4439 | | Code | | | |
| 4440 | +=========+====================================================+================+ |
| 4441 | | **200** | Component found | No Content | |
| 4442 | +---------+----------------------------------------------------+----------------+ |
| 4443 | | **403** | Restricted operation | No Content | |
| 4444 | +---------+----------------------------------------------------+----------------+ |
| 4445 | | **404** | Component not found | No Content | |
| 4446 | +---------+----------------------------------------------------+----------------+ |
| 4447 | |
| 4448 | Consumes |
| 4449 | ~~~~~~~~ |
| 4450 | |
| 4451 | - ``application/json`` |
| 4452 | |
| 4453 | Produces |
| 4454 | ~~~~~~~~ |
| 4455 | |
| 4456 | - ``application/json`` |
| 4457 | |
| 4458 | Tags |
| 4459 | ~~~~ |
| 4460 | |
| 4461 | - Component Servlet |
| 4462 | |
| 4463 | Get properties |
| 4464 | -------------- |
| 4465 | |
| 4466 | :: |
| 4467 | |
| 4468 | GET /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{inputId}/properties |
| 4469 | |
| 4470 | Description |
| 4471 | ~~~~~~~~~~~ |
| 4472 | |
| 4473 | Returns properties list |
| 4474 | |
| 4475 | Parameters |
| 4476 | ~~~~~~~~~~ |
| 4477 | |
| 4478 | +------------------+--------------------------+----------------------------------+ |
| 4479 | | Type | Name | Schema | |
| 4480 | +==================+==========================+==================================+ |
| 4481 | | **Header** | **USER\_ID**\ *optional* | string | |
| 4482 | +------------------+--------------------------+----------------------------------+ |
| 4483 | | **Path** | **componentId**\ *requir | string | |
| 4484 | | | ed* | | |
| 4485 | +------------------+--------------------------+----------------------------------+ |
| 4486 | | **Path** | **componentType**\ *requ | string | |
| 4487 | | | ired* | | |
| 4488 | +------------------+--------------------------+----------------------------------+ |
| 4489 | | **Path** | **inputId**\ *required* | string | |
| 4490 | +------------------+--------------------------+----------------------------------+ |
| 4491 | | **Path** | **instanceId**\ *require | string | |
| 4492 | | | d* | | |
| 4493 | +------------------+--------------------------+----------------------------------+ |
| 4494 | |
| 4495 | Responses |
| 4496 | ~~~~~~~~~ |
| 4497 | |
| 4498 | +---------+----------------------------------------------------+----------------+ |
| 4499 | | HTTP | Description | Schema | |
| 4500 | | Code | | | |
| 4501 | +=========+====================================================+================+ |
| 4502 | | **200** | Component found | No Content | |
| 4503 | +---------+----------------------------------------------------+----------------+ |
| 4504 | | **403** | Restricted operation | No Content | |
| 4505 | +---------+----------------------------------------------------+----------------+ |
| 4506 | | **404** | Component not found | No Content | |
| 4507 | +---------+----------------------------------------------------+----------------+ |
| 4508 | |
| 4509 | Consumes |
| 4510 | ~~~~~~~~ |
| 4511 | |
| 4512 | - ``application/json`` |
| 4513 | |
| 4514 | Produces |
| 4515 | ~~~~~~~~ |
| 4516 | |
| 4517 | - ``application/json`` |
| 4518 | |
| 4519 | Tags |
| 4520 | ~~~~ |
| 4521 | |
| 4522 | - Input Catalog |
| 4523 | |
| 4524 | Get Inputs only |
| 4525 | --------------- |
| 4526 | |
| 4527 | :: |
| 4528 | |
| 4529 | GET /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/inputs |
| 4530 | |
| 4531 | Description |
| 4532 | ~~~~~~~~~~~ |
| 4533 | |
| 4534 | Returns Inputs list |
| 4535 | |
| 4536 | Parameters |
| 4537 | ~~~~~~~~~~ |
| 4538 | |
| 4539 | +------------------+--------------------------+----------------------------------+ |
| 4540 | | Type | Name | Schema | |
| 4541 | +==================+==========================+==================================+ |
| 4542 | | **Header** | **USER\_ID**\ *optional* | string | |
| 4543 | +------------------+--------------------------+----------------------------------+ |
| 4544 | | **Path** | **componentId**\ *requir | string | |
| 4545 | | | ed* | | |
| 4546 | +------------------+--------------------------+----------------------------------+ |
| 4547 | | **Path** | **componentType**\ *requ | string | |
| 4548 | | | ired* | | |
| 4549 | +------------------+--------------------------+----------------------------------+ |
| 4550 | | **Path** | **instanceId**\ *require | string | |
| 4551 | | | d* | | |
| 4552 | +------------------+--------------------------+----------------------------------+ |
| 4553 | | **Path** | **originComponentUid**\ | string | |
| 4554 | | | *required* | | |
| 4555 | +------------------+--------------------------+----------------------------------+ |
| 4556 | |
| 4557 | Responses |
| 4558 | ~~~~~~~~~ |
| 4559 | |
| 4560 | +---------+----------------------------------------------------+----------------+ |
| 4561 | | HTTP | Description | Schema | |
| 4562 | | Code | | | |
| 4563 | +=========+====================================================+================+ |
| 4564 | | **200** | Component found | No Content | |
| 4565 | +---------+----------------------------------------------------+----------------+ |
| 4566 | | **403** | Restricted operation | No Content | |
| 4567 | +---------+----------------------------------------------------+----------------+ |
| 4568 | | **404** | Component not found | No Content | |
| 4569 | +---------+----------------------------------------------------+----------------+ |
| 4570 | |
| 4571 | Consumes |
| 4572 | ~~~~~~~~ |
| 4573 | |
| 4574 | - ``application/json`` |
| 4575 | |
| 4576 | Produces |
| 4577 | ~~~~~~~~ |
| 4578 | |
| 4579 | - ``application/json`` |
| 4580 | |
| 4581 | Tags |
| 4582 | ~~~~ |
| 4583 | |
| 4584 | - Input Catalog |
| 4585 | |
| 4586 | Create inputs on service |
| 4587 | ------------------------ |
| 4588 | |
| 4589 | :: |
| 4590 | |
| 4591 | POST /v1/catalog/{componentType}/{componentId}/create/inputs |
| 4592 | |
| 4593 | Description |
| 4594 | ~~~~~~~~~~~ |
| 4595 | |
| 4596 | Return inputs list |
| 4597 | |
| 4598 | Parameters |
| 4599 | ~~~~~~~~~~ |
| 4600 | |
| 4601 | +----------+-------------+--------------------------------------+------------------+ |
| 4602 | | Type | Name | Description | Schema | |
| 4603 | +==========+=============+======================================+==================+ |
| 4604 | | **Header | **USER\_ID* | | string | |
| 4605 | | ** | *\ *optiona | | | |
| 4606 | | | l* | | | |
| 4607 | +----------+-------------+--------------------------------------+------------------+ |
| 4608 | | **Path** | **component | | string | |
| 4609 | | | Id**\ *requ | | | |
| 4610 | | | ired* | | | |
| 4611 | +----------+-------------+--------------------------------------+------------------+ |
| 4612 | | **Path** | **component | | string | |
| 4613 | | | Type**\ *re | | | |
| 4614 | | | quired* | | | |
| 4615 | +----------+-------------+--------------------------------------+------------------+ |
| 4616 | | **Body** | **body**\ * | ComponentIns Inputs Object to be | string | |
| 4617 | | | required* | created | | |
| 4618 | +----------+-------------+--------------------------------------+------------------+ |
| 4619 | |
| 4620 | Responses |
| 4621 | ~~~~~~~~~ |
| 4622 | |
| 4623 | +---------+----------------------------------------------------+----------------+ |
| 4624 | | HTTP | Description | Schema | |
| 4625 | | Code | | | |
| 4626 | +=========+====================================================+================+ |
| 4627 | | **200** | Component found | No Content | |
| 4628 | +---------+----------------------------------------------------+----------------+ |
| 4629 | | **403** | Restricted operation | No Content | |
| 4630 | +---------+----------------------------------------------------+----------------+ |
| 4631 | | **404** | Component not found | No Content | |
| 4632 | +---------+----------------------------------------------------+----------------+ |
| 4633 | |
| 4634 | Consumes |
| 4635 | ~~~~~~~~ |
| 4636 | |
| 4637 | - ``application/json`` |
| 4638 | |
| 4639 | Produces |
| 4640 | ~~~~~~~~ |
| 4641 | |
| 4642 | - ``application/json`` |
| 4643 | |
| 4644 | Tags |
| 4645 | ~~~~ |
| 4646 | |
| 4647 | - Input Catalog |
| 4648 | |
| 4649 | Delete input from service |
| 4650 | ------------------------- |
| 4651 | |
| 4652 | :: |
| 4653 | |
| 4654 | DELETE /v1/catalog/{componentType}/{componentId}/delete/{inputId}/input |
| 4655 | |
| 4656 | Description |
| 4657 | ~~~~~~~~~~~ |
| 4658 | |
| 4659 | Delete service input |
| 4660 | |
| 4661 | Parameters |
| 4662 | ~~~~~~~~~~ |
| 4663 | |
| 4664 | +----------+-------------+--------------------------------------+------------------+ |
| 4665 | | Type | Name | Description | Schema | |
| 4666 | +==========+=============+======================================+==================+ |
| 4667 | | **Header | **USER\_ID* | | string | |
| 4668 | | ** | *\ *optiona | | | |
| 4669 | | | l* | | | |
| 4670 | +----------+-------------+--------------------------------------+------------------+ |
| 4671 | | **Path** | **component | | string | |
| 4672 | | | Id**\ *requ | | | |
| 4673 | | | ired* | | | |
| 4674 | +----------+-------------+--------------------------------------+------------------+ |
| 4675 | | **Path** | **component | | string | |
| 4676 | | | Type**\ *re | | | |
| 4677 | | | quired* | | | |
| 4678 | +----------+-------------+--------------------------------------+------------------+ |
| 4679 | | **Path** | **inputId** | | string | |
| 4680 | | | \ *required | | | |
| 4681 | | | * | | | |
| 4682 | +----------+-------------+--------------------------------------+------------------+ |
| 4683 | | **Body** | **body**\ * | Service Input to be deleted | string | |
| 4684 | | | required* | | | |
| 4685 | +----------+-------------+--------------------------------------+------------------+ |
| 4686 | |
| 4687 | Responses |
| 4688 | ~~~~~~~~~ |
| 4689 | |
| 4690 | +---------+----------------------------------------------------+----------------+ |
| 4691 | | HTTP | Description | Schema | |
| 4692 | | Code | | | |
| 4693 | +=========+====================================================+================+ |
| 4694 | | **200** | Input deleted | No Content | |
| 4695 | +---------+----------------------------------------------------+----------------+ |
| 4696 | | **403** | Restricted operation | No Content | |
| 4697 | +---------+----------------------------------------------------+----------------+ |
| 4698 | | **404** | Input not found | No Content | |
| 4699 | +---------+----------------------------------------------------+----------------+ |
| 4700 | |
| 4701 | Consumes |
| 4702 | ~~~~~~~~ |
| 4703 | |
| 4704 | - ``application/json`` |
| 4705 | |
| 4706 | Produces |
| 4707 | ~~~~~~~~ |
| 4708 | |
| 4709 | - ``application/json`` |
| 4710 | |
| 4711 | Tags |
| 4712 | ~~~~ |
| 4713 | |
| 4714 | - Input Catalog |
| 4715 | |
| 4716 | Retrieve Resource |
| 4717 | ----------------- |
| 4718 | |
| 4719 | :: |
| 4720 | |
| 4721 | GET /v1/catalog/{componentType}/{componentId}/filteredDataByParams |
| 4722 | |
| 4723 | Description |
| 4724 | ~~~~~~~~~~~ |
| 4725 | |
| 4726 | Returns resource according to resourceId |
| 4727 | |
| 4728 | Parameters |
| 4729 | ~~~~~~~~~~ |
| 4730 | |
| 4731 | +------------------+--------------------------+----------------------------------+ |
| 4732 | | Type | Name | Schema | |
| 4733 | +==================+==========================+==================================+ |
| 4734 | | **Header** | **USER\_ID**\ *optional* | string | |
| 4735 | +------------------+--------------------------+----------------------------------+ |
| 4736 | | **Path** | **componentId**\ *requir | string | |
| 4737 | | | ed* | | |
| 4738 | +------------------+--------------------------+----------------------------------+ |
| 4739 | | **Path** | **componentType**\ *requ | string | |
| 4740 | | | ired* | | |
| 4741 | +------------------+--------------------------+----------------------------------+ |
| 4742 | | **Query** | **include**\ *optional* | < string > array(multi) | |
| 4743 | +------------------+--------------------------+----------------------------------+ |
| 4744 | |
| 4745 | Responses |
| 4746 | ~~~~~~~~~ |
| 4747 | |
| 4748 | +---------+----------------------------------------------------+----------------+ |
| 4749 | | HTTP | Description | Schema | |
| 4750 | | Code | | | |
| 4751 | +=========+====================================================+================+ |
| 4752 | | **200** | Resource found | No Content | |
| 4753 | +---------+----------------------------------------------------+----------------+ |
| 4754 | | **403** | Restricted operation | No Content | |
| 4755 | +---------+----------------------------------------------------+----------------+ |
| 4756 | | **404** | Resource not found | No Content | |
| 4757 | +---------+----------------------------------------------------+----------------+ |
| 4758 | |
| 4759 | Consumes |
| 4760 | ~~~~~~~~ |
| 4761 | |
| 4762 | - ``application/json`` |
| 4763 | |
| 4764 | Produces |
| 4765 | ~~~~~~~~ |
| 4766 | |
| 4767 | - ``application/json`` |
| 4768 | |
| 4769 | Tags |
| 4770 | ~~~~ |
| 4771 | |
| 4772 | - Component Servlet |
| 4773 | |
| 4774 | Retrieve properties belonging to component instances of specific component by name and optionally resource type |
| 4775 | --------------------------------------------------------------------------------------------------------------- |
| 4776 | |
| 4777 | :: |
| 4778 | |
| 4779 | GET /v1/catalog/{componentType}/{componentId}/filteredproperties/{propertyNameFragment} |
| 4780 | |
| 4781 | Description |
| 4782 | ~~~~~~~~~~~ |
| 4783 | |
| 4784 | Returns properties belonging to component instances of specific |
| 4785 | component by name and optionally resource type |
| 4786 | |
| 4787 | Parameters |
| 4788 | ~~~~~~~~~~ |
| 4789 | |
| 4790 | +------------------+--------------------------+----------------------------------+ |
| 4791 | | Type | Name | Schema | |
| 4792 | +==================+==========================+==================================+ |
| 4793 | | **Header** | **USER\_ID**\ *optional* | string | |
| 4794 | +------------------+--------------------------+----------------------------------+ |
| 4795 | | **Path** | **componentId**\ *requir | string | |
| 4796 | | | ed* | | |
| 4797 | +------------------+--------------------------+----------------------------------+ |
| 4798 | | **Path** | **componentType**\ *requ | string | |
| 4799 | | | ired* | | |
| 4800 | +------------------+--------------------------+----------------------------------+ |
| 4801 | | **Path** | **propertyNameFragment** | string | |
| 4802 | | | \ *required* | | |
| 4803 | +------------------+--------------------------+----------------------------------+ |
| 4804 | | **Query** | **resourceType**\ *optio | < string > array(multi) | |
| 4805 | | | nal* | | |
| 4806 | +------------------+--------------------------+----------------------------------+ |
| 4807 | |
| 4808 | Responses |
| 4809 | ~~~~~~~~~ |
| 4810 | |
| 4811 | +---------+----------------------------------------------------+----------------+ |
| 4812 | | HTTP | Description | Schema | |
| 4813 | | Code | | | |
| 4814 | +=========+====================================================+================+ |
| 4815 | | **200** | Component found | No Content | |
| 4816 | +---------+----------------------------------------------------+----------------+ |
| 4817 | | **403** | Restricted operation | No Content | |
| 4818 | +---------+----------------------------------------------------+----------------+ |
| 4819 | | **404** | Component not found | No Content | |
| 4820 | +---------+----------------------------------------------------+----------------+ |
| 4821 | |
| 4822 | Consumes |
| 4823 | ~~~~~~~~ |
| 4824 | |
| 4825 | - ``application/json`` |
| 4826 | |
| 4827 | Produces |
| 4828 | ~~~~~~~~ |
| 4829 | |
| 4830 | - ``application/json`` |
| 4831 | |
| 4832 | Tags |
| 4833 | ~~~~ |
| 4834 | |
| 4835 | - Component Servlet |
| 4836 | |
| 4837 | Get inputs |
| 4838 | ---------- |
| 4839 | |
| 4840 | :: |
| 4841 | |
| 4842 | GET /v1/catalog/{componentType}/{componentId}/inputs/{inputId} |
| 4843 | |
| 4844 | Description |
| 4845 | ~~~~~~~~~~~ |
| 4846 | |
| 4847 | Returns inputs list |
| 4848 | |
| 4849 | Parameters |
| 4850 | ~~~~~~~~~~ |
| 4851 | |
| 4852 | +------------------+--------------------------+----------------------------------+ |
| 4853 | | Type | Name | Schema | |
| 4854 | +==================+==========================+==================================+ |
| 4855 | | **Header** | **USER\_ID**\ *optional* | string | |
| 4856 | +------------------+--------------------------+----------------------------------+ |
| 4857 | | **Path** | **componentId**\ *requir | string | |
| 4858 | | | ed* | | |
| 4859 | +------------------+--------------------------+----------------------------------+ |
| 4860 | | **Path** | **componentType**\ *requ | string | |
| 4861 | | | ired* | | |
| 4862 | +------------------+--------------------------+----------------------------------+ |
| 4863 | | **Path** | **inputId**\ *required* | string | |
| 4864 | +------------------+--------------------------+----------------------------------+ |
| 4865 | |
| 4866 | Responses |
| 4867 | ~~~~~~~~~ |
| 4868 | |
| 4869 | +---------+----------------------------------------------------+----------------+ |
| 4870 | | HTTP | Description | Schema | |
| 4871 | | Code | | | |
| 4872 | +=========+====================================================+================+ |
| 4873 | | **200** | Component found | No Content | |
| 4874 | +---------+----------------------------------------------------+----------------+ |
| 4875 | | **403** | Restricted operation | No Content | |
| 4876 | +---------+----------------------------------------------------+----------------+ |
| 4877 | | **404** | Component not found | No Content | |
| 4878 | +---------+----------------------------------------------------+----------------+ |
| 4879 | |
| 4880 | Consumes |
| 4881 | ~~~~~~~~ |
| 4882 | |
| 4883 | - ``application/json`` |
| 4884 | |
| 4885 | Produces |
| 4886 | ~~~~~~~~ |
| 4887 | |
| 4888 | - ``application/json`` |
| 4889 | |
| 4890 | Tags |
| 4891 | ~~~~ |
| 4892 | |
| 4893 | - Input Catalog |
| 4894 | |
| 4895 | Get inputs |
| 4896 | ---------- |
| 4897 | |
| 4898 | :: |
| 4899 | |
| 4900 | GET /v1/catalog/{componentType}/{componentId}/inputs/{inputId}/inputs |
| 4901 | |
| 4902 | Description |
| 4903 | ~~~~~~~~~~~ |
| 4904 | |
| 4905 | Returns inputs list |
| 4906 | |
| 4907 | Parameters |
| 4908 | ~~~~~~~~~~ |
| 4909 | |
| 4910 | +------------------+--------------------------+----------------------------------+ |
| 4911 | | Type | Name | Schema | |
| 4912 | +==================+==========================+==================================+ |
| 4913 | | **Header** | **USER\_ID**\ *optional* | string | |
| 4914 | +------------------+--------------------------+----------------------------------+ |
| 4915 | | **Path** | **componentId**\ *requir | string | |
| 4916 | | | ed* | | |
| 4917 | +------------------+--------------------------+----------------------------------+ |
| 4918 | | **Path** | **componentType**\ *requ | string | |
| 4919 | | | ired* | | |
| 4920 | +------------------+--------------------------+----------------------------------+ |
| 4921 | | **Path** | **inputId**\ *required* | string | |
| 4922 | +------------------+--------------------------+----------------------------------+ |
| 4923 | |
| 4924 | Responses |
| 4925 | ~~~~~~~~~ |
| 4926 | |
| 4927 | +---------+----------------------------------------------------+----------------+ |
| 4928 | | HTTP | Description | Schema | |
| 4929 | | Code | | | |
| 4930 | +=========+====================================================+================+ |
| 4931 | | **200** | Component found | No Content | |
| 4932 | +---------+----------------------------------------------------+----------------+ |
| 4933 | | **403** | Restricted operation | No Content | |
| 4934 | +---------+----------------------------------------------------+----------------+ |
| 4935 | | **404** | Component not found | No Content | |
| 4936 | +---------+----------------------------------------------------+----------------+ |
| 4937 | |
| 4938 | Consumes |
| 4939 | ~~~~~~~~ |
| 4940 | |
| 4941 | - ``application/json`` |
| 4942 | |
| 4943 | Produces |
| 4944 | ~~~~~~~~ |
| 4945 | |
| 4946 | - ``application/json`` |
| 4947 | |
| 4948 | Tags |
| 4949 | ~~~~ |
| 4950 | |
| 4951 | - Input Catalog |
| 4952 | |
| 4953 | Get Component Requirments And Capabilities |
| 4954 | ------------------------------------------ |
| 4955 | |
| 4956 | :: |
| 4957 | |
| 4958 | GET /v1/catalog/{componentType}/{componentId}/requirmentsCapabilities |
| 4959 | |
| 4960 | Description |
| 4961 | ~~~~~~~~~~~ |
| 4962 | |
| 4963 | Returns Requirements And Capabilities according to componentId |
| 4964 | |
| 4965 | Parameters |
| 4966 | ~~~~~~~~~~ |
| 4967 | |
| 4968 | +------------------+--------------------------+----------------------------------+ |
| 4969 | | Type | Name | Schema | |
| 4970 | +==================+==========================+==================================+ |
| 4971 | | **Header** | **USER\_ID**\ *optional* | string | |
| 4972 | +------------------+--------------------------+----------------------------------+ |
| 4973 | | **Path** | **componentId**\ *requir | string | |
| 4974 | | | ed* | | |
| 4975 | +------------------+--------------------------+----------------------------------+ |
| 4976 | | **Path** | **componentType**\ *requ | string | |
| 4977 | | | ired* | | |
| 4978 | +------------------+--------------------------+----------------------------------+ |
| 4979 | |
| 4980 | Responses |
| 4981 | ~~~~~~~~~ |
| 4982 | |
| 4983 | +---------+----------------------------------------------------+----------------+ |
| 4984 | | HTTP | Description | Schema | |
| 4985 | | Code | | | |
| 4986 | +=========+====================================================+================+ |
| 4987 | | **200** | Component found | No Content | |
| 4988 | +---------+----------------------------------------------------+----------------+ |
| 4989 | | **403** | Restricted operation | No Content | |
| 4990 | +---------+----------------------------------------------------+----------------+ |
| 4991 | | **404** | Component not found | No Content | |
| 4992 | +---------+----------------------------------------------------+----------------+ |
| 4993 | |
| 4994 | Consumes |
| 4995 | ~~~~~~~~ |
| 4996 | |
| 4997 | - ``application/json`` |
| 4998 | |
| 4999 | Produces |
| 5000 | ~~~~~~~~ |
| 5001 | |
| 5002 | - ``application/json`` |
| 5003 | |
| 5004 | Tags |
| 5005 | ~~~~ |
| 5006 | |
| 5007 | - Component Servlet |
| 5008 | |
| 5009 | Validate Component Conformance Level |
| 5010 | ------------------------------------ |
| 5011 | |
| 5012 | :: |
| 5013 | |
| 5014 | GET /v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation |
| 5015 | |
| 5016 | Description |
| 5017 | ~~~~~~~~~~~ |
| 5018 | |
| 5019 | Returns the result according to conformance level in BE config |
| 5020 | |
| 5021 | Parameters |
| 5022 | ~~~~~~~~~~ |
| 5023 | |
| 5024 | +------------------+--------------------------+----------------------------------+ |
| 5025 | | Type | Name | Schema | |
| 5026 | +==================+==========================+==================================+ |
| 5027 | | **Header** | **USER\_ID**\ *optional* | string | |
| 5028 | +------------------+--------------------------+----------------------------------+ |
| 5029 | | **Path** | **componentType**\ *requ | string | |
| 5030 | | | ired* | | |
| 5031 | +------------------+--------------------------+----------------------------------+ |
| 5032 | | **Path** | **componentUuid**\ *requ | string | |
| 5033 | | | ired* | | |
| 5034 | +------------------+--------------------------+----------------------------------+ |
| 5035 | |
| 5036 | Responses |
| 5037 | ~~~~~~~~~ |
| 5038 | |
| 5039 | +---------+----------------------------------------------------+----------------+ |
| 5040 | | HTTP | Description | Schema | |
| 5041 | | Code | | | |
| 5042 | +=========+====================================================+================+ |
| 5043 | | **200** | Component found | No Content | |
| 5044 | +---------+----------------------------------------------------+----------------+ |
| 5045 | | **403** | Restricted operation | No Content | |
| 5046 | +---------+----------------------------------------------------+----------------+ |
| 5047 | | **404** | Component not found | No Content | |
| 5048 | +---------+----------------------------------------------------+----------------+ |
| 5049 | |
| 5050 | Consumes |
| 5051 | ~~~~~~~~ |
| 5052 | |
| 5053 | - ``application/json`` |
| 5054 | |
| 5055 | Produces |
| 5056 | ~~~~~~~~ |
| 5057 | |
| 5058 | - ``application/json`` |
| 5059 | |
| 5060 | Tags |
| 5061 | ~~~~ |
| 5062 | |
| 5063 | - Component Servlet |
| 5064 | |
| 5065 | Get component Artifacts |
| 5066 | ----------------------- |
| 5067 | |
| 5068 | :: |
| 5069 | |
| 5070 | GET /v1/catalog/{containerComponentType}/{componentId}/artifactsByType/{artifactGroupType} |
| 5071 | |
| 5072 | Description |
| 5073 | ~~~~~~~~~~~ |
| 5074 | |
| 5075 | Returns artifacts |
| 5076 | |
| 5077 | Parameters |
| 5078 | ~~~~~~~~~~ |
| 5079 | |
| 5080 | +----------+-------------+--------------------------------------+------------------+ |
| 5081 | | Type | Name | Description | Schema | |
| 5082 | +==========+=============+======================================+==================+ |
| 5083 | | **Path** | **artifactG | | string | |
| 5084 | | | roupType**\ | | | |
| 5085 | | | *required* | | | |
| 5086 | +----------+-------------+--------------------------------------+------------------+ |
| 5087 | | **Path** | **component | | string | |
| 5088 | | | Id**\ *requ | | | |
| 5089 | | | ired* | | | |
| 5090 | +----------+-------------+--------------------------------------+------------------+ |
| 5091 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 5092 | | | ComponentTy | | services) | |
| 5093 | | | pe**\ *requ | | | |
| 5094 | | | ired* | | | |
| 5095 | +----------+-------------+--------------------------------------+------------------+ |
| 5096 | |
| 5097 | Responses |
| 5098 | ~~~~~~~~~ |
| 5099 | |
| 5100 | +---------+----------------------------------------------------+----------------+ |
| 5101 | | HTTP | Description | Schema | |
| 5102 | | Code | | | |
| 5103 | +=========+====================================================+================+ |
| 5104 | | **200** | Component artifacts | No Content | |
| 5105 | +---------+----------------------------------------------------+----------------+ |
| 5106 | | **404** | Resource/Artifact not found | No Content | |
| 5107 | +---------+----------------------------------------------------+----------------+ |
| 5108 | |
| 5109 | Consumes |
| 5110 | ~~~~~~~~ |
| 5111 | |
| 5112 | - ``application/json`` |
| 5113 | |
| 5114 | Produces |
| 5115 | ~~~~~~~~ |
| 5116 | |
| 5117 | - ``application/json`` |
| 5118 | |
| 5119 | Tags |
| 5120 | ~~~~ |
| 5121 | |
| 5122 | - Resource Artifact Servlet |
| 5123 | |
| 5124 | Get group artifacts |
| 5125 | ------------------- |
| 5126 | |
| 5127 | :: |
| 5128 | |
| 5129 | GET /v1/catalog/{containerComponentType}/{componentId}/groups/{groupId} |
| 5130 | |
| 5131 | Description |
| 5132 | ~~~~~~~~~~~ |
| 5133 | |
| 5134 | Returns artifacts metadata according to groupId |
| 5135 | |
| 5136 | Parameters |
| 5137 | ~~~~~~~~~~ |
| 5138 | |
| 5139 | +------------------+--------------------------+----------------------------------+ |
| 5140 | | Type | Name | Schema | |
| 5141 | +==================+==========================+==================================+ |
| 5142 | | **Header** | **USER\_ID**\ *optional* | string | |
| 5143 | +------------------+--------------------------+----------------------------------+ |
| 5144 | | **Path** | **componentId**\ *requir | string | |
| 5145 | | | ed* | | |
| 5146 | +------------------+--------------------------+----------------------------------+ |
| 5147 | | **Path** | **containerComponentType | string | |
| 5148 | | | **\ *required* | | |
| 5149 | +------------------+--------------------------+----------------------------------+ |
| 5150 | | **Path** | **groupId**\ *required* | string | |
| 5151 | +------------------+--------------------------+----------------------------------+ |
| 5152 | |
| 5153 | Responses |
| 5154 | ~~~~~~~~~ |
| 5155 | |
| 5156 | +---------+----------------------------------------------------+----------------+ |
| 5157 | | HTTP | Description | Schema | |
| 5158 | | Code | | | |
| 5159 | +=========+====================================================+================+ |
| 5160 | | **200** | group found | No Content | |
| 5161 | +---------+----------------------------------------------------+----------------+ |
| 5162 | | **403** | Restricted operation | No Content | |
| 5163 | +---------+----------------------------------------------------+----------------+ |
| 5164 | | **404** | Group not found | No Content | |
| 5165 | +---------+----------------------------------------------------+----------------+ |
| 5166 | |
| 5167 | Consumes |
| 5168 | ~~~~~~~~ |
| 5169 | |
| 5170 | - ``application/json`` |
| 5171 | |
| 5172 | Produces |
| 5173 | ~~~~~~~~ |
| 5174 | |
| 5175 | - ``application/json`` |
| 5176 | |
| 5177 | Tags |
| 5178 | ~~~~ |
| 5179 | |
| 5180 | - Resource Group Servlet |
| 5181 | |
| 5182 | Update Group Metadata |
| 5183 | --------------------- |
| 5184 | |
| 5185 | :: |
| 5186 | |
| 5187 | PUT /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/metadata |
| 5188 | |
| 5189 | Description |
| 5190 | ~~~~~~~~~~~ |
| 5191 | |
| 5192 | Returns updated group definition |
| 5193 | |
| 5194 | Parameters |
| 5195 | ~~~~~~~~~~ |
| 5196 | |
| 5197 | +----------+-------------+--------------------------------------+------------------+ |
| 5198 | | Type | Name | Description | Schema | |
| 5199 | +==========+=============+======================================+==================+ |
| 5200 | | **Header | **USER\_ID* | | string | |
| 5201 | | ** | *\ *optiona | | | |
| 5202 | | | l* | | | |
| 5203 | +----------+-------------+--------------------------------------+------------------+ |
| 5204 | | **Path** | **component | | string | |
| 5205 | | | Id**\ *requ | | | |
| 5206 | | | ired* | | | |
| 5207 | +----------+-------------+--------------------------------------+------------------+ |
| 5208 | | **Path** | **container | | string | |
| 5209 | | | ComponentTy | | | |
| 5210 | | | pe**\ *requ | | | |
| 5211 | | | ired* | | | |
| 5212 | +----------+-------------+--------------------------------------+------------------+ |
| 5213 | | **Path** | **groupUniq | | string | |
| 5214 | | | ueId**\ *re | | | |
| 5215 | | | quired* | | | |
| 5216 | +----------+-------------+--------------------------------------+------------------+ |
| 5217 | | **Body** | **body**\ * | Service object to be Updated | string | |
| 5218 | | | required* | | | |
| 5219 | +----------+-------------+--------------------------------------+------------------+ |
| 5220 | |
| 5221 | Responses |
| 5222 | ~~~~~~~~~ |
| 5223 | |
| 5224 | +---------+----------------------------------------------------+----------------+ |
| 5225 | | HTTP | Description | Schema | |
| 5226 | | Code | | | |
| 5227 | +=========+====================================================+================+ |
| 5228 | | **200** | Group Updated | No Content | |
| 5229 | +---------+----------------------------------------------------+----------------+ |
| 5230 | | **400** | Invalid content / Missing content | No Content | |
| 5231 | +---------+----------------------------------------------------+----------------+ |
| 5232 | | **403** | Restricted operation | No Content | |
| 5233 | +---------+----------------------------------------------------+----------------+ |
| 5234 | |
| 5235 | Consumes |
| 5236 | ~~~~~~~~ |
| 5237 | |
| 5238 | - ``application/json`` |
| 5239 | |
| 5240 | Produces |
| 5241 | ~~~~~~~~ |
| 5242 | |
| 5243 | - ``application/json`` |
| 5244 | |
| 5245 | Tags |
| 5246 | ~~~~ |
| 5247 | |
| 5248 | - Resource Group Servlet |
| 5249 | |
| 5250 | Updates List of properties on a group (only values) |
| 5251 | --------------------------------------------------- |
| 5252 | |
| 5253 | :: |
| 5254 | |
| 5255 | PUT /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties |
| 5256 | |
| 5257 | Description |
| 5258 | ~~~~~~~~~~~ |
| 5259 | |
| 5260 | Returns updated list of properties |
| 5261 | |
| 5262 | Parameters |
| 5263 | ~~~~~~~~~~ |
| 5264 | |
| 5265 | +----------+-------------+--------------------------------------+------------------+ |
| 5266 | | Type | Name | Description | Schema | |
| 5267 | +==========+=============+======================================+==================+ |
| 5268 | | **Header | **USER\_ID* | | string | |
| 5269 | | ** | *\ *optiona | | | |
| 5270 | | | l* | | | |
| 5271 | +----------+-------------+--------------------------------------+------------------+ |
| 5272 | | **Path** | **component | | string | |
| 5273 | | | Id**\ *requ | | | |
| 5274 | | | ired* | | | |
| 5275 | +----------+-------------+--------------------------------------+------------------+ |
| 5276 | | **Path** | **container | | string | |
| 5277 | | | ComponentTy | | | |
| 5278 | | | pe**\ *requ | | | |
| 5279 | | | ired* | | | |
| 5280 | +----------+-------------+--------------------------------------+------------------+ |
| 5281 | | **Path** | **groupUniq | | string | |
| 5282 | | | ueId**\ *re | | | |
| 5283 | | | quired* | | | |
| 5284 | +----------+-------------+--------------------------------------+------------------+ |
| 5285 | | **Body** | **body**\ * | Service object to be Updated | string | |
| 5286 | | | required* | | | |
| 5287 | +----------+-------------+--------------------------------------+------------------+ |
| 5288 | |
| 5289 | Responses |
| 5290 | ~~~~~~~~~ |
| 5291 | |
| 5292 | +---------+----------------------------------------------------+----------------+ |
| 5293 | | HTTP | Description | Schema | |
| 5294 | | Code | | | |
| 5295 | +=========+====================================================+================+ |
| 5296 | | **200** | Group Updated | No Content | |
| 5297 | +---------+----------------------------------------------------+----------------+ |
| 5298 | | **400** | Invalid content / Missing content | No Content | |
| 5299 | +---------+----------------------------------------------------+----------------+ |
| 5300 | | **403** | Restricted operation | No Content | |
| 5301 | +---------+----------------------------------------------------+----------------+ |
| 5302 | |
| 5303 | Consumes |
| 5304 | ~~~~~~~~ |
| 5305 | |
| 5306 | - ``application/json`` |
| 5307 | |
| 5308 | Produces |
| 5309 | ~~~~~~~~ |
| 5310 | |
| 5311 | - ``application/json`` |
| 5312 | |
| 5313 | Tags |
| 5314 | ~~~~ |
| 5315 | |
| 5316 | - Resource Group Servlet |
| 5317 | |
| 5318 | Create ComponentInstance |
| 5319 | ------------------------ |
| 5320 | |
| 5321 | :: |
| 5322 | |
| 5323 | POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance |
| 5324 | |
| 5325 | Description |
| 5326 | ~~~~~~~~~~~ |
| 5327 | |
| 5328 | Returns created ComponentInstance |
| 5329 | |
| 5330 | Parameters |
| 5331 | ~~~~~~~~~~ |
| 5332 | |
| 5333 | +----------+-------------+--------------------------------------+------------------+ |
| 5334 | | Type | Name | Description | Schema | |
| 5335 | +==========+=============+======================================+==================+ |
| 5336 | | **Header | **USER\_ID* | USER\_ID of modifier user | string | |
| 5337 | | ** | *\ *require | | | |
| 5338 | | | d* | | | |
| 5339 | +----------+-------------+--------------------------------------+------------------+ |
| 5340 | | **Path** | **component | | string | |
| 5341 | | | Id**\ *requ | | | |
| 5342 | | | ired* | | | |
| 5343 | +----------+-------------+--------------------------------------+------------------+ |
| 5344 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 5345 | | | ComponentTy | | services) | |
| 5346 | | | pe**\ *requ | | | |
| 5347 | | | ired* | | | |
| 5348 | +----------+-------------+--------------------------------------+------------------+ |
| 5349 | | **Body** | **body**\ * | RI object to be created | string | |
| 5350 | | | required* | | | |
| 5351 | +----------+-------------+--------------------------------------+------------------+ |
| 5352 | |
| 5353 | Responses |
| 5354 | ~~~~~~~~~ |
| 5355 | |
| 5356 | +---------+----------------------------------------------------+----------------+ |
| 5357 | | HTTP | Description | Schema | |
| 5358 | | Code | | | |
| 5359 | +=========+====================================================+================+ |
| 5360 | | **201** | Component created | No Content | |
| 5361 | +---------+----------------------------------------------------+----------------+ |
| 5362 | | **400** | Invalid content / Missing content | No Content | |
| 5363 | +---------+----------------------------------------------------+----------------+ |
| 5364 | | **403** | Restricted operation | No Content | |
| 5365 | +---------+----------------------------------------------------+----------------+ |
| 5366 | | **409** | Component instance already exist | No Content | |
| 5367 | +---------+----------------------------------------------------+----------------+ |
| 5368 | |
| 5369 | Consumes |
| 5370 | ~~~~~~~~ |
| 5371 | |
| 5372 | - ``application/json`` |
| 5373 | |
| 5374 | Produces |
| 5375 | ~~~~~~~~ |
| 5376 | |
| 5377 | - ``application/json`` |
| 5378 | |
| 5379 | Tags |
| 5380 | ~~~~ |
| 5381 | |
| 5382 | - Resource Instance Servlet |
| 5383 | |
| 5384 | Associate RI to RI |
| 5385 | ------------------ |
| 5386 | |
| 5387 | :: |
| 5388 | |
| 5389 | POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate |
| 5390 | |
| 5391 | Description |
| 5392 | ~~~~~~~~~~~ |
| 5393 | |
| 5394 | Returns created RelationshipInfo |
| 5395 | |
| 5396 | Parameters |
| 5397 | ~~~~~~~~~~ |
| 5398 | |
| 5399 | +----------+-------------+--------------------------------------+------------------+ |
| 5400 | | Type | Name | Description | Schema | |
| 5401 | +==========+=============+======================================+==================+ |
| 5402 | | **Header | **USER\_ID* | | string | |
| 5403 | | ** | *\ *optiona | | | |
| 5404 | | | l* | | | |
| 5405 | +----------+-------------+--------------------------------------+------------------+ |
| 5406 | | **Path** | **component | unique id of the container component | string | |
| 5407 | | | Id**\ *requ | | | |
| 5408 | | | ired* | | | |
| 5409 | +----------+-------------+--------------------------------------+------------------+ |
| 5410 | | **Path** | **container | allowed values are resources | enum (resources, | |
| 5411 | | | ComponentTy | /services / products | services, | |
| 5412 | | | pe**\ *requ | | products) | |
| 5413 | | | ired* | | | |
| 5414 | +----------+-------------+--------------------------------------+------------------+ |
| 5415 | | **Body** | **body**\ * | RelationshipInfo | string | |
| 5416 | | | required* | | | |
| 5417 | +----------+-------------+--------------------------------------+------------------+ |
| 5418 | |
| 5419 | Responses |
| 5420 | ~~~~~~~~~ |
| 5421 | |
| 5422 | +---------+----------------------------------------------------+----------------+ |
| 5423 | | HTTP | Description | Schema | |
| 5424 | | Code | | | |
| 5425 | +=========+====================================================+================+ |
| 5426 | | **201** | Relationship created | No Content | |
| 5427 | +---------+----------------------------------------------------+----------------+ |
| 5428 | | **400** | Invalid content / Missing content | No Content | |
| 5429 | +---------+----------------------------------------------------+----------------+ |
| 5430 | | **403** | Missing information | No Content | |
| 5431 | +---------+----------------------------------------------------+----------------+ |
| 5432 | | **409** | Relationship already exist | No Content | |
| 5433 | +---------+----------------------------------------------------+----------------+ |
| 5434 | |
| 5435 | Consumes |
| 5436 | ~~~~~~~~ |
| 5437 | |
| 5438 | - ``application/json`` |
| 5439 | |
| 5440 | Produces |
| 5441 | ~~~~~~~~ |
| 5442 | |
| 5443 | - ``application/json`` |
| 5444 | |
| 5445 | Tags |
| 5446 | ~~~~ |
| 5447 | |
| 5448 | - Resource Instance Servlet |
| 5449 | |
| 5450 | Create RI and associate RI to RI |
| 5451 | -------------------------------- |
| 5452 | |
| 5453 | :: |
| 5454 | |
| 5455 | POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate |
| 5456 | |
| 5457 | Description |
| 5458 | ~~~~~~~~~~~ |
| 5459 | |
| 5460 | Returns created RI and RelationshipInfo |
| 5461 | |
| 5462 | Parameters |
| 5463 | ~~~~~~~~~~ |
| 5464 | |
| 5465 | +----------+-------------+--------------------------------------+------------------+ |
| 5466 | | Type | Name | Description | Schema | |
| 5467 | +==========+=============+======================================+==================+ |
| 5468 | | **Path** | **component | | string | |
| 5469 | | | Id**\ *requ | | | |
| 5470 | | | ired* | | | |
| 5471 | +----------+-------------+--------------------------------------+------------------+ |
| 5472 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 5473 | | | ComponentTy | | services) | |
| 5474 | | | pe**\ *requ | | | |
| 5475 | | | ired* | | | |
| 5476 | +----------+-------------+--------------------------------------+------------------+ |
| 5477 | |
| 5478 | Responses |
| 5479 | ~~~~~~~~~ |
| 5480 | |
| 5481 | +---------+----------------------------------------------------+----------------+ |
| 5482 | | HTTP | Description | Schema | |
| 5483 | | Code | | | |
| 5484 | +=========+====================================================+================+ |
| 5485 | | **201** | RI created | No Content | |
| 5486 | +---------+----------------------------------------------------+----------------+ |
| 5487 | | **400** | Invalid content / Missing content | No Content | |
| 5488 | +---------+----------------------------------------------------+----------------+ |
| 5489 | | **403** | Restricted operation | No Content | |
| 5490 | +---------+----------------------------------------------------+----------------+ |
| 5491 | | **409** | Relationship already exist | No Content | |
| 5492 | +---------+----------------------------------------------------+----------------+ |
| 5493 | |
| 5494 | Consumes |
| 5495 | ~~~~~~~~ |
| 5496 | |
| 5497 | - ``application/json`` |
| 5498 | |
| 5499 | Produces |
| 5500 | ~~~~~~~~ |
| 5501 | |
| 5502 | - ``application/json`` |
| 5503 | |
| 5504 | Tags |
| 5505 | ~~~~ |
| 5506 | |
| 5507 | - Resource Instance Servlet |
| 5508 | |
| 5509 | Dissociate RI from RI |
| 5510 | --------------------- |
| 5511 | |
| 5512 | :: |
| 5513 | |
| 5514 | PUT /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/dissociate |
| 5515 | |
| 5516 | Description |
| 5517 | ~~~~~~~~~~~ |
| 5518 | |
| 5519 | Returns deleted RelationshipInfo |
| 5520 | |
| 5521 | Parameters |
| 5522 | ~~~~~~~~~~ |
| 5523 | |
| 5524 | +----------+-------------+--------------------------------------+------------------+ |
| 5525 | | Type | Name | Description | Schema | |
| 5526 | +==========+=============+======================================+==================+ |
| 5527 | | **Header | **USER\_ID* | | string | |
| 5528 | | ** | *\ *optiona | | | |
| 5529 | | | l* | | | |
| 5530 | +----------+-------------+--------------------------------------+------------------+ |
| 5531 | | **Path** | **component | unique id of the container component | string | |
| 5532 | | | Id**\ *requ | | | |
| 5533 | | | ired* | | | |
| 5534 | +----------+-------------+--------------------------------------+------------------+ |
| 5535 | | **Path** | **container | allowed values are resources | enum (resources, | |
| 5536 | | | ComponentTy | /services / products | services, | |
| 5537 | | | pe**\ *requ | | products) | |
| 5538 | | | ired* | | | |
| 5539 | +----------+-------------+--------------------------------------+------------------+ |
| 5540 | | **Body** | **body**\ * | RelationshipInfo | string | |
| 5541 | | | required* | | | |
| 5542 | +----------+-------------+--------------------------------------+------------------+ |
| 5543 | |
| 5544 | Responses |
| 5545 | ~~~~~~~~~ |
| 5546 | |
| 5547 | +---------+----------------------------------------------------+----------------+ |
| 5548 | | HTTP | Description | Schema | |
| 5549 | | Code | | | |
| 5550 | +=========+====================================================+================+ |
| 5551 | | **201** | Relationship deleted | No Content | |
| 5552 | +---------+----------------------------------------------------+----------------+ |
| 5553 | | **400** | Invalid content / Missing content | No Content | |
| 5554 | +---------+----------------------------------------------------+----------------+ |
| 5555 | | **403** | Missing information | No Content | |
| 5556 | +---------+----------------------------------------------------+----------------+ |
| 5557 | |
| 5558 | Consumes |
| 5559 | ~~~~~~~~ |
| 5560 | |
| 5561 | - ``application/json`` |
| 5562 | |
| 5563 | Produces |
| 5564 | ~~~~~~~~ |
| 5565 | |
| 5566 | - ``application/json`` |
| 5567 | |
| 5568 | Tags |
| 5569 | ~~~~ |
| 5570 | |
| 5571 | - Resource Instance Servlet |
| 5572 | |
| 5573 | Update resource instance multiple component |
| 5574 | ------------------------------------------- |
| 5575 | |
| 5576 | :: |
| 5577 | |
| 5578 | POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance |
| 5579 | |
| 5580 | Description |
| 5581 | ~~~~~~~~~~~ |
| 5582 | |
| 5583 | Returns updated resource instance |
| 5584 | |
| 5585 | Parameters |
| 5586 | ~~~~~~~~~~ |
| 5587 | |
| 5588 | +----------+-------------+--------------------------------------+------------------+ |
| 5589 | | Type | Name | Description | Schema | |
| 5590 | +==========+=============+======================================+==================+ |
| 5591 | | **Path** | **component | | string | |
| 5592 | | | Id**\ *requ | | | |
| 5593 | | | ired* | | | |
| 5594 | +----------+-------------+--------------------------------------+------------------+ |
| 5595 | | **Path** | **container | valid values: resources / services / | enum (resources, | |
| 5596 | | | ComponentTy | products | services, | |
| 5597 | | | pe**\ *requ | | products) | |
| 5598 | | | ired* | | | |
| 5599 | +----------+-------------+--------------------------------------+------------------+ |
| 5600 | | **Body** | **body**\ * | Component Instance JSON Array | string | |
| 5601 | | | required* | | | |
| 5602 | +----------+-------------+--------------------------------------+------------------+ |
| 5603 | |
| 5604 | Responses |
| 5605 | ~~~~~~~~~ |
| 5606 | |
| 5607 | +---------+----------------------------------------------------+----------------+ |
| 5608 | | HTTP | Description | Schema | |
| 5609 | | Code | | | |
| 5610 | +=========+====================================================+================+ |
| 5611 | | **200** | Resource instance updated | No Content | |
| 5612 | +---------+----------------------------------------------------+----------------+ |
| 5613 | | **400** | Invalid content / Missing content | No Content | |
| 5614 | +---------+----------------------------------------------------+----------------+ |
| 5615 | | **403** | Restricted operation | No Content | |
| 5616 | +---------+----------------------------------------------------+----------------+ |
| 5617 | |
| 5618 | Consumes |
| 5619 | ~~~~~~~~ |
| 5620 | |
| 5621 | - ``application/json`` |
| 5622 | |
| 5623 | Produces |
| 5624 | ~~~~~~~~ |
| 5625 | |
| 5626 | - ``application/json`` |
| 5627 | |
| 5628 | Tags |
| 5629 | ~~~~ |
| 5630 | |
| 5631 | - Resource Instance Servlet |
| 5632 | |
| 5633 | Update resource instance |
| 5634 | ------------------------ |
| 5635 | |
| 5636 | :: |
| 5637 | |
| 5638 | POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId} |
| 5639 | |
| 5640 | Description |
| 5641 | ~~~~~~~~~~~ |
| 5642 | |
| 5643 | Returns updated resource instance |
| 5644 | |
| 5645 | Parameters |
| 5646 | ~~~~~~~~~~ |
| 5647 | |
| 5648 | +----------+-------------+--------------------------------------+------------------+ |
| 5649 | | Type | Name | Description | Schema | |
| 5650 | +==========+=============+======================================+==================+ |
| 5651 | | **Path** | **component | | string | |
| 5652 | | | Id**\ *requ | | | |
| 5653 | | | ired* | | | |
| 5654 | +----------+-------------+--------------------------------------+------------------+ |
| 5655 | | **Path** | **component | | string | |
| 5656 | | | InstanceId* | | | |
| 5657 | | | *\ *require | | | |
| 5658 | | | d* | | | |
| 5659 | +----------+-------------+--------------------------------------+------------------+ |
| 5660 | | **Path** | **container | valid values: resources / services / | enum (resources, | |
| 5661 | | | ComponentTy | products | services, | |
| 5662 | | | pe**\ *requ | | products) | |
| 5663 | | | ired* | | | |
| 5664 | +----------+-------------+--------------------------------------+------------------+ |
| 5665 | |
| 5666 | Responses |
| 5667 | ~~~~~~~~~ |
| 5668 | |
| 5669 | +---------+----------------------------------------------------+----------------+ |
| 5670 | | HTTP | Description | Schema | |
| 5671 | | Code | | | |
| 5672 | +=========+====================================================+================+ |
| 5673 | | **200** | Resource instance updated | No Content | |
| 5674 | +---------+----------------------------------------------------+----------------+ |
| 5675 | | **400** | Invalid content / Missing content | No Content | |
| 5676 | +---------+----------------------------------------------------+----------------+ |
| 5677 | | **403** | Restricted operation | No Content | |
| 5678 | +---------+----------------------------------------------------+----------------+ |
| 5679 | |
| 5680 | Consumes |
| 5681 | ~~~~~~~~ |
| 5682 | |
| 5683 | - ``application/json`` |
| 5684 | |
| 5685 | Produces |
| 5686 | ~~~~~~~~ |
| 5687 | |
| 5688 | - ``application/json`` |
| 5689 | |
| 5690 | Tags |
| 5691 | ~~~~ |
| 5692 | |
| 5693 | - Resource Instance Servlet |
| 5694 | |
| 5695 | Load Resource Instance artifact payload |
| 5696 | --------------------------------------- |
| 5697 | |
| 5698 | :: |
| 5699 | |
| 5700 | POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts |
| 5701 | |
| 5702 | Description |
| 5703 | ~~~~~~~~~~~ |
| 5704 | |
| 5705 | Returns updated artifact |
| 5706 | |
| 5707 | Parameters |
| 5708 | ~~~~~~~~~~ |
| 5709 | |
| 5710 | +----------+-------------+--------------------------------------+------------------+ |
| 5711 | | Type | Name | Description | Schema | |
| 5712 | +==========+=============+======================================+==================+ |
| 5713 | | **Header | **Content-M | | string | |
| 5714 | | ** | D5**\ *opti | | | |
| 5715 | | | onal* | | | |
| 5716 | +----------+-------------+--------------------------------------+------------------+ |
| 5717 | | **Header | **USER\_ID* | | string | |
| 5718 | | ** | *\ *optiona | | | |
| 5719 | | | l* | | | |
| 5720 | +----------+-------------+--------------------------------------+------------------+ |
| 5721 | | **Path** | **component | | string | |
| 5722 | | | Id**\ *requ | | | |
| 5723 | | | ired* | | | |
| 5724 | +----------+-------------+--------------------------------------+------------------+ |
| 5725 | | **Path** | **component | | string | |
| 5726 | | | InstanceId* | | | |
| 5727 | | | *\ *require | | | |
| 5728 | | | d* | | | |
| 5729 | +----------+-------------+--------------------------------------+------------------+ |
| 5730 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 5731 | | | ComponentTy | | services) | |
| 5732 | | | pe**\ *requ | | | |
| 5733 | | | ired* | | | |
| 5734 | +----------+-------------+--------------------------------------+------------------+ |
| 5735 | | **Body** | **body**\ * | json describe the artifact | string | |
| 5736 | | | required* | | | |
| 5737 | +----------+-------------+--------------------------------------+------------------+ |
| 5738 | |
| 5739 | Responses |
| 5740 | ~~~~~~~~~ |
| 5741 | |
| 5742 | +---------+----------------------------------------------------+----------------+ |
| 5743 | | HTTP | Description | Schema | |
| 5744 | | Code | | | |
| 5745 | +=========+====================================================+================+ |
| 5746 | | **200** | Artifact updated | No Content | |
| 5747 | +---------+----------------------------------------------------+----------------+ |
| 5748 | | **400** | Invalid content / Missing content | No Content | |
| 5749 | +---------+----------------------------------------------------+----------------+ |
| 5750 | | **403** | Restricted operation | No Content | |
| 5751 | +---------+----------------------------------------------------+----------------+ |
| 5752 | |
| 5753 | Consumes |
| 5754 | ~~~~~~~~ |
| 5755 | |
| 5756 | - ``application/json`` |
| 5757 | |
| 5758 | Produces |
| 5759 | ~~~~~~~~ |
| 5760 | |
| 5761 | - ``application/json`` |
| 5762 | |
| 5763 | Tags |
| 5764 | ~~~~ |
| 5765 | |
| 5766 | - Resource Artifact Servlet |
| 5767 | |
| 5768 | Delete Resource Instance artifact |
| 5769 | --------------------------------- |
| 5770 | |
| 5771 | :: |
| 5772 | |
| 5773 | POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId} |
| 5774 | |
| 5775 | Description |
| 5776 | ~~~~~~~~~~~ |
| 5777 | |
| 5778 | Returns deleted artifact |
| 5779 | |
| 5780 | Parameters |
| 5781 | ~~~~~~~~~~ |
| 5782 | |
| 5783 | +----------+-------------+--------------------------------------+------------------+ |
| 5784 | | Type | Name | Description | Schema | |
| 5785 | +==========+=============+======================================+==================+ |
| 5786 | | **Header | **Content-M | | string | |
| 5787 | | ** | D5**\ *opti | | | |
| 5788 | | | onal* | | | |
| 5789 | +----------+-------------+--------------------------------------+------------------+ |
| 5790 | | **Header | **USER\_ID* | | string | |
| 5791 | | ** | *\ *optiona | | | |
| 5792 | | | l* | | | |
| 5793 | +----------+-------------+--------------------------------------+------------------+ |
| 5794 | | **Path** | **artifactI | | string | |
| 5795 | | | d**\ *requi | | | |
| 5796 | | | red* | | | |
| 5797 | +----------+-------------+--------------------------------------+------------------+ |
| 5798 | | **Path** | **component | | string | |
| 5799 | | | Id**\ *requ | | | |
| 5800 | | | ired* | | | |
| 5801 | +----------+-------------+--------------------------------------+------------------+ |
| 5802 | | **Path** | **component | | string | |
| 5803 | | | InstanceId* | | | |
| 5804 | | | *\ *require | | | |
| 5805 | | | d* | | | |
| 5806 | +----------+-------------+--------------------------------------+------------------+ |
| 5807 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 5808 | | | ComponentTy | | services) | |
| 5809 | | | pe**\ *requ | | | |
| 5810 | | | ired* | | | |
| 5811 | +----------+-------------+--------------------------------------+------------------+ |
| 5812 | | **Body** | **body**\ * | json describe the artifact | string | |
| 5813 | | | required* | | | |
| 5814 | +----------+-------------+--------------------------------------+------------------+ |
| 5815 | |
| 5816 | Responses |
| 5817 | ~~~~~~~~~ |
| 5818 | |
| 5819 | +---------+----------------------------------------------------+----------------+ |
| 5820 | | HTTP | Description | Schema | |
| 5821 | | Code | | | |
| 5822 | +=========+====================================================+================+ |
| 5823 | | **200** | Artifact updated | No Content | |
| 5824 | +---------+----------------------------------------------------+----------------+ |
| 5825 | | **400** | Invalid content / Missing content | No Content | |
| 5826 | +---------+----------------------------------------------------+----------------+ |
| 5827 | | **403** | Restricted operation | No Content | |
| 5828 | +---------+----------------------------------------------------+----------------+ |
| 5829 | |
| 5830 | Consumes |
| 5831 | ~~~~~~~~ |
| 5832 | |
| 5833 | - ``application/json`` |
| 5834 | |
| 5835 | Produces |
| 5836 | ~~~~~~~~ |
| 5837 | |
| 5838 | - ``application/json`` |
| 5839 | |
| 5840 | Tags |
| 5841 | ~~~~ |
| 5842 | |
| 5843 | - Resource Artifact Servlet |
| 5844 | |
| 5845 | Update Resource Instance HEAT\_ENV parameters |
| 5846 | --------------------------------------------- |
| 5847 | |
| 5848 | :: |
| 5849 | |
| 5850 | POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams |
| 5851 | |
| 5852 | Description |
| 5853 | ~~~~~~~~~~~ |
| 5854 | |
| 5855 | Returns updated artifact |
| 5856 | |
| 5857 | Parameters |
| 5858 | ~~~~~~~~~~ |
| 5859 | |
| 5860 | +----------+-------------+--------------------------------------+------------------+ |
| 5861 | | Type | Name | Description | Schema | |
| 5862 | +==========+=============+======================================+==================+ |
| 5863 | | **Path** | **artifactI | | string | |
| 5864 | | | d**\ *requi | | | |
| 5865 | | | red* | | | |
| 5866 | +----------+-------------+--------------------------------------+------------------+ |
| 5867 | | **Path** | **component | | string | |
| 5868 | | | Id**\ *requ | | | |
| 5869 | | | ired* | | | |
| 5870 | +----------+-------------+--------------------------------------+------------------+ |
| 5871 | | **Path** | **component | | string | |
| 5872 | | | InstanceId* | | | |
| 5873 | | | *\ *require | | | |
| 5874 | | | d* | | | |
| 5875 | +----------+-------------+--------------------------------------+------------------+ |
| 5876 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 5877 | | | ComponentTy | | services) | |
| 5878 | | | pe**\ *requ | | | |
| 5879 | | | ired* | | | |
| 5880 | +----------+-------------+--------------------------------------+------------------+ |
| 5881 | | **Body** | **body**\ * | json describe the artifact | string | |
| 5882 | | | required* | | | |
| 5883 | +----------+-------------+--------------------------------------+------------------+ |
| 5884 | |
| 5885 | Responses |
| 5886 | ~~~~~~~~~ |
| 5887 | |
| 5888 | +---------+----------------------------------------------------+----------------+ |
| 5889 | | HTTP | Description | Schema | |
| 5890 | | Code | | | |
| 5891 | +=========+====================================================+================+ |
| 5892 | | **200** | Artifact updated | No Content | |
| 5893 | +---------+----------------------------------------------------+----------------+ |
| 5894 | | **400** | Invalid content / Missing content | No Content | |
| 5895 | +---------+----------------------------------------------------+----------------+ |
| 5896 | | **403** | Restricted operation | No Content | |
| 5897 | +---------+----------------------------------------------------+----------------+ |
| 5898 | |
| 5899 | Consumes |
| 5900 | ~~~~~~~~ |
| 5901 | |
| 5902 | - ``application/json`` |
| 5903 | |
| 5904 | Produces |
| 5905 | ~~~~~~~~ |
| 5906 | |
| 5907 | - ``application/json`` |
| 5908 | |
| 5909 | Tags |
| 5910 | ~~~~ |
| 5911 | |
| 5912 | - Resource Artifact Servlet |
| 5913 | |
| 5914 | Update resource instance attribute |
| 5915 | ---------------------------------- |
| 5916 | |
| 5917 | :: |
| 5918 | |
| 5919 | POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attribute |
| 5920 | |
| 5921 | Description |
| 5922 | ~~~~~~~~~~~ |
| 5923 | |
| 5924 | Returns updated resource instance attribute |
| 5925 | |
| 5926 | Parameters |
| 5927 | ~~~~~~~~~~ |
| 5928 | |
| 5929 | +----------+-------------+--------------------------------------+------------------+ |
| 5930 | | Type | Name | Description | Schema | |
| 5931 | +==========+=============+======================================+==================+ |
| 5932 | | **Header | **USER\_ID* | id of user initiating the operation | string | |
| 5933 | | ** | *\ *optiona | | | |
| 5934 | | | l* | | | |
| 5935 | +----------+-------------+--------------------------------------+------------------+ |
| 5936 | | **Path** | **component | service id | string | |
| 5937 | | | Id**\ *requ | | | |
| 5938 | | | ired* | | | |
| 5939 | +----------+-------------+--------------------------------------+------------------+ |
| 5940 | | **Path** | **component | resource instance id | string | |
| 5941 | | | InstanceId* | | | |
| 5942 | | | *\ *require | | | |
| 5943 | | | d* | | | |
| 5944 | +----------+-------------+--------------------------------------+------------------+ |
| 5945 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 5946 | | | ComponentTy | | services) | |
| 5947 | | | pe**\ *requ | | | |
| 5948 | | | ired* | | | |
| 5949 | +----------+-------------+--------------------------------------+------------------+ |
| 5950 | |
| 5951 | Responses |
| 5952 | ~~~~~~~~~ |
| 5953 | |
| 5954 | +---------+----------------------------------------------------+----------------+ |
| 5955 | | HTTP | Description | Schema | |
| 5956 | | Code | | | |
| 5957 | +=========+====================================================+================+ |
| 5958 | | **201** | Resource instance created | No Content | |
| 5959 | +---------+----------------------------------------------------+----------------+ |
| 5960 | | **400** | Invalid content / Missing content | No Content | |
| 5961 | +---------+----------------------------------------------------+----------------+ |
| 5962 | | **403** | Restricted operation | No Content | |
| 5963 | +---------+----------------------------------------------------+----------------+ |
| 5964 | |
| 5965 | Consumes |
| 5966 | ~~~~~~~~ |
| 5967 | |
| 5968 | - ``application/json`` |
| 5969 | |
| 5970 | Produces |
| 5971 | ~~~~~~~~ |
| 5972 | |
| 5973 | - ``application/json`` |
| 5974 | |
| 5975 | Tags |
| 5976 | ~~~~ |
| 5977 | |
| 5978 | - Resource Instance Servlet |
| 5979 | |
| 5980 | Update resource instance |
| 5981 | ------------------------ |
| 5982 | |
| 5983 | :: |
| 5984 | |
| 5985 | POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion |
| 5986 | |
| 5987 | Description |
| 5988 | ~~~~~~~~~~~ |
| 5989 | |
| 5990 | Returns updated resource instance |
| 5991 | |
| 5992 | Parameters |
| 5993 | ~~~~~~~~~~ |
| 5994 | |
| 5995 | +----------+-------------+--------------------------------------+------------------+ |
| 5996 | | Type | Name | Description | Schema | |
| 5997 | +==========+=============+======================================+==================+ |
| 5998 | | **Path** | **component | | string | |
| 5999 | | | Id**\ *requ | | | |
| 6000 | | | ired* | | | |
| 6001 | +----------+-------------+--------------------------------------+------------------+ |
| 6002 | | **Path** | **component | | string | |
| 6003 | | | InstanceId* | | | |
| 6004 | | | *\ *require | | | |
| 6005 | | | d* | | | |
| 6006 | +----------+-------------+--------------------------------------+------------------+ |
| 6007 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 6008 | | | ComponentTy | | services) | |
| 6009 | | | pe**\ *requ | | | |
| 6010 | | | ired* | | | |
| 6011 | +----------+-------------+--------------------------------------+------------------+ |
| 6012 | |
| 6013 | Responses |
| 6014 | ~~~~~~~~~ |
| 6015 | |
| 6016 | +---------+----------------------------------------------------+----------------+ |
| 6017 | | HTTP | Description | Schema | |
| 6018 | | Code | | | |
| 6019 | +=========+====================================================+================+ |
| 6020 | | **201** | Resource instance created | No Content | |
| 6021 | +---------+----------------------------------------------------+----------------+ |
| 6022 | | **400** | Invalid content / Missing content | No Content | |
| 6023 | +---------+----------------------------------------------------+----------------+ |
| 6024 | | **403** | Restricted operation | No Content | |
| 6025 | +---------+----------------------------------------------------+----------------+ |
| 6026 | |
| 6027 | Consumes |
| 6028 | ~~~~~~~~ |
| 6029 | |
| 6030 | - ``application/json`` |
| 6031 | |
| 6032 | Produces |
| 6033 | ~~~~~~~~ |
| 6034 | |
| 6035 | - ``application/json`` |
| 6036 | |
| 6037 | Tags |
| 6038 | ~~~~ |
| 6039 | |
| 6040 | - Resource Instance Servlet |
| 6041 | |
| 6042 | Get group artifacts |
| 6043 | ------------------- |
| 6044 | |
| 6045 | :: |
| 6046 | |
| 6047 | GET /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstId} |
| 6048 | |
| 6049 | Description |
| 6050 | ~~~~~~~~~~~ |
| 6051 | |
| 6052 | Returns artifacts metadata according to groupInstId |
| 6053 | |
| 6054 | Parameters |
| 6055 | ~~~~~~~~~~ |
| 6056 | |
| 6057 | +------------------+--------------------------+----------------------------------+ |
| 6058 | | Type | Name | Schema | |
| 6059 | +==================+==========================+==================================+ |
| 6060 | | **Header** | **USER\_ID**\ *optional* | string | |
| 6061 | +------------------+--------------------------+----------------------------------+ |
| 6062 | | **Path** | **componentId**\ *requir | string | |
| 6063 | | | ed* | | |
| 6064 | +------------------+--------------------------+----------------------------------+ |
| 6065 | | **Path** | **componentInstanceId**\ | string | |
| 6066 | | | *required* | | |
| 6067 | +------------------+--------------------------+----------------------------------+ |
| 6068 | | **Path** | **containerComponentType | string | |
| 6069 | | | **\ *required* | | |
| 6070 | +------------------+--------------------------+----------------------------------+ |
| 6071 | | **Path** | **groupInstId**\ *requir | string | |
| 6072 | | | ed* | | |
| 6073 | +------------------+--------------------------+----------------------------------+ |
| 6074 | |
| 6075 | Responses |
| 6076 | ~~~~~~~~~ |
| 6077 | |
| 6078 | +---------+----------------------------------------------------+----------------+ |
| 6079 | | HTTP | Description | Schema | |
| 6080 | | Code | | | |
| 6081 | +=========+====================================================+================+ |
| 6082 | | **200** | group found | No Content | |
| 6083 | +---------+----------------------------------------------------+----------------+ |
| 6084 | | **403** | Restricted operation | No Content | |
| 6085 | +---------+----------------------------------------------------+----------------+ |
| 6086 | | **404** | Group not found | No Content | |
| 6087 | +---------+----------------------------------------------------+----------------+ |
| 6088 | |
| 6089 | Consumes |
| 6090 | ~~~~~~~~ |
| 6091 | |
| 6092 | - ``application/json`` |
| 6093 | |
| 6094 | Produces |
| 6095 | ~~~~~~~~ |
| 6096 | |
| 6097 | - ``application/json`` |
| 6098 | |
| 6099 | Tags |
| 6100 | ~~~~ |
| 6101 | |
| 6102 | - Resource Instance Servlet |
| 6103 | |
| 6104 | Update resource instance property |
| 6105 | --------------------------------- |
| 6106 | |
| 6107 | :: |
| 6108 | |
| 6109 | POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property |
| 6110 | |
| 6111 | Description |
| 6112 | ~~~~~~~~~~~ |
| 6113 | |
| 6114 | Returns updated resource instance property |
| 6115 | |
| 6116 | Parameters |
| 6117 | ~~~~~~~~~~ |
| 6118 | |
| 6119 | +----------+-------------+--------------------------------------+------------------+ |
| 6120 | | Type | Name | Description | Schema | |
| 6121 | +==========+=============+======================================+==================+ |
| 6122 | | **Header | **USER\_ID* | id of user initiating the operation | string | |
| 6123 | | ** | *\ *optiona | | | |
| 6124 | | | l* | | | |
| 6125 | +----------+-------------+--------------------------------------+------------------+ |
| 6126 | | **Path** | **component | service id | string | |
| 6127 | | | Id**\ *requ | | | |
| 6128 | | | ired* | | | |
| 6129 | +----------+-------------+--------------------------------------+------------------+ |
| 6130 | | **Path** | **component | resource instance id | string | |
| 6131 | | | InstanceId* | | | |
| 6132 | | | *\ *require | | | |
| 6133 | | | d* | | | |
| 6134 | +----------+-------------+--------------------------------------+------------------+ |
| 6135 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 6136 | | | ComponentTy | | services) | |
| 6137 | | | pe**\ *requ | | | |
| 6138 | | | ired* | | | |
| 6139 | +----------+-------------+--------------------------------------+------------------+ |
| 6140 | | **Path** | **groupInst | group instance id | string | |
| 6141 | | | anceId**\ * | | | |
| 6142 | | | required* | | | |
| 6143 | +----------+-------------+--------------------------------------+------------------+ |
| 6144 | |
| 6145 | Responses |
| 6146 | ~~~~~~~~~ |
| 6147 | |
| 6148 | +---------+----------------------------------------------------+----------------+ |
| 6149 | | HTTP | Description | Schema | |
| 6150 | | Code | | | |
| 6151 | +=========+====================================================+================+ |
| 6152 | | **201** | Resource instance created | No Content | |
| 6153 | +---------+----------------------------------------------------+----------------+ |
| 6154 | | **400** | Invalid content / Missing content | No Content | |
| 6155 | +---------+----------------------------------------------------+----------------+ |
| 6156 | | **403** | Restricted operation | No Content | |
| 6157 | +---------+----------------------------------------------------+----------------+ |
| 6158 | |
| 6159 | Consumes |
| 6160 | ~~~~~~~~ |
| 6161 | |
| 6162 | - ``application/json`` |
| 6163 | |
| 6164 | Produces |
| 6165 | ~~~~~~~~ |
| 6166 | |
| 6167 | - ``application/json`` |
| 6168 | |
| 6169 | Tags |
| 6170 | ~~~~ |
| 6171 | |
| 6172 | - Resource Instance Servlet |
| 6173 | |
| 6174 | Update resource instance property |
| 6175 | --------------------------------- |
| 6176 | |
| 6177 | :: |
| 6178 | |
| 6179 | POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/input |
| 6180 | |
| 6181 | Description |
| 6182 | ~~~~~~~~~~~ |
| 6183 | |
| 6184 | Returns updated resource instance property |
| 6185 | |
| 6186 | Parameters |
| 6187 | ~~~~~~~~~~ |
| 6188 | |
| 6189 | +----------+-------------+--------------------------------------+------------------+ |
| 6190 | | Type | Name | Description | Schema | |
| 6191 | +==========+=============+======================================+==================+ |
| 6192 | | **Header | **USER\_ID* | id of user initiating the operation | string | |
| 6193 | | ** | *\ *optiona | | | |
| 6194 | | | l* | | | |
| 6195 | +----------+-------------+--------------------------------------+------------------+ |
| 6196 | | **Path** | **component | service id | string | |
| 6197 | | | Id**\ *requ | | | |
| 6198 | | | ired* | | | |
| 6199 | +----------+-------------+--------------------------------------+------------------+ |
| 6200 | | **Path** | **component | resource instance id | string | |
| 6201 | | | InstanceId* | | | |
| 6202 | | | *\ *require | | | |
| 6203 | | | d* | | | |
| 6204 | +----------+-------------+--------------------------------------+------------------+ |
| 6205 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 6206 | | | ComponentTy | | services) | |
| 6207 | | | pe**\ *requ | | | |
| 6208 | | | ired* | | | |
| 6209 | +----------+-------------+--------------------------------------+------------------+ |
| 6210 | |
| 6211 | Responses |
| 6212 | ~~~~~~~~~ |
| 6213 | |
| 6214 | +---------+----------------------------------------------------+----------------+ |
| 6215 | | HTTP | Description | Schema | |
| 6216 | | Code | | | |
| 6217 | +=========+====================================================+================+ |
| 6218 | | **201** | Resource instance created | No Content | |
| 6219 | +---------+----------------------------------------------------+----------------+ |
| 6220 | | **400** | Invalid content / Missing content | No Content | |
| 6221 | +---------+----------------------------------------------------+----------------+ |
| 6222 | | **403** | Restricted operation | No Content | |
| 6223 | +---------+----------------------------------------------------+----------------+ |
| 6224 | |
| 6225 | Consumes |
| 6226 | ~~~~~~~~ |
| 6227 | |
| 6228 | - ``application/json`` |
| 6229 | |
| 6230 | Produces |
| 6231 | ~~~~~~~~ |
| 6232 | |
| 6233 | - ``application/json`` |
| 6234 | |
| 6235 | Tags |
| 6236 | ~~~~ |
| 6237 | |
| 6238 | - Resource Instance Servlet |
| 6239 | |
| 6240 | Update resource instance property |
| 6241 | --------------------------------- |
| 6242 | |
| 6243 | :: |
| 6244 | |
| 6245 | POST /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property |
| 6246 | |
| 6247 | Description |
| 6248 | ~~~~~~~~~~~ |
| 6249 | |
| 6250 | Returns updated resource instance property |
| 6251 | |
| 6252 | Parameters |
| 6253 | ~~~~~~~~~~ |
| 6254 | |
| 6255 | +----------+-------------+--------------------------------------+------------------+ |
| 6256 | | Type | Name | Description | Schema | |
| 6257 | +==========+=============+======================================+==================+ |
| 6258 | | **Header | **USER\_ID* | id of user initiating the operation | string | |
| 6259 | | ** | *\ *optiona | | | |
| 6260 | | | l* | | | |
| 6261 | +----------+-------------+--------------------------------------+------------------+ |
| 6262 | | **Path** | **component | service id | string | |
| 6263 | | | Id**\ *requ | | | |
| 6264 | | | ired* | | | |
| 6265 | +----------+-------------+--------------------------------------+------------------+ |
| 6266 | | **Path** | **component | resource instance id | string | |
| 6267 | | | InstanceId* | | | |
| 6268 | | | *\ *require | | | |
| 6269 | | | d* | | | |
| 6270 | +----------+-------------+--------------------------------------+------------------+ |
| 6271 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 6272 | | | ComponentTy | | services) | |
| 6273 | | | pe**\ *requ | | | |
| 6274 | | | ired* | | | |
| 6275 | +----------+-------------+--------------------------------------+------------------+ |
| 6276 | |
| 6277 | Responses |
| 6278 | ~~~~~~~~~ |
| 6279 | |
| 6280 | +---------+----------------------------------------------------+----------------+ |
| 6281 | | HTTP | Description | Schema | |
| 6282 | | Code | | | |
| 6283 | +=========+====================================================+================+ |
| 6284 | | **201** | Resource instance created | No Content | |
| 6285 | +---------+----------------------------------------------------+----------------+ |
| 6286 | | **400** | Invalid content / Missing content | No Content | |
| 6287 | +---------+----------------------------------------------------+----------------+ |
| 6288 | | **403** | Restricted operation | No Content | |
| 6289 | +---------+----------------------------------------------------+----------------+ |
| 6290 | |
| 6291 | Consumes |
| 6292 | ~~~~~~~~ |
| 6293 | |
| 6294 | - ``application/json`` |
| 6295 | |
| 6296 | Produces |
| 6297 | ~~~~~~~~ |
| 6298 | |
| 6299 | - ``application/json`` |
| 6300 | |
| 6301 | Tags |
| 6302 | ~~~~ |
| 6303 | |
| 6304 | - Resource Instance Servlet |
| 6305 | |
| 6306 | Update resource instance |
| 6307 | ------------------------ |
| 6308 | |
| 6309 | :: |
| 6310 | |
| 6311 | DELETE /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId} |
| 6312 | |
| 6313 | Description |
| 6314 | ~~~~~~~~~~~ |
| 6315 | |
| 6316 | Returns deleted resource instance property |
| 6317 | |
| 6318 | Parameters |
| 6319 | ~~~~~~~~~~ |
| 6320 | |
| 6321 | +----------+-------------+--------------------------------------+------------------+ |
| 6322 | | Type | Name | Description | Schema | |
| 6323 | +==========+=============+======================================+==================+ |
| 6324 | | **Header | **USER\_ID* | id of user initiating the operation | string | |
| 6325 | | ** | *\ *optiona | | | |
| 6326 | | | l* | | | |
| 6327 | +----------+-------------+--------------------------------------+------------------+ |
| 6328 | | **Path** | **component | service id | string | |
| 6329 | | | Id**\ *requ | | | |
| 6330 | | | ired* | | | |
| 6331 | +----------+-------------+--------------------------------------+------------------+ |
| 6332 | | **Path** | **component | resource instance id | string | |
| 6333 | | | InstanceId* | | | |
| 6334 | | | *\ *require | | | |
| 6335 | | | d* | | | |
| 6336 | +----------+-------------+--------------------------------------+------------------+ |
| 6337 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 6338 | | | ComponentTy | | services) | |
| 6339 | | | pe**\ *requ | | | |
| 6340 | | | ired* | | | |
| 6341 | +----------+-------------+--------------------------------------+------------------+ |
| 6342 | | **Path** | **propertyI | property id | string | |
| 6343 | | | d**\ *requi | | | |
| 6344 | | | red* | | | |
| 6345 | +----------+-------------+--------------------------------------+------------------+ |
| 6346 | |
| 6347 | Responses |
| 6348 | ~~~~~~~~~ |
| 6349 | |
| 6350 | +---------+----------------------------------------------------+----------------+ |
| 6351 | | HTTP | Description | Schema | |
| 6352 | | Code | | | |
| 6353 | +=========+====================================================+================+ |
| 6354 | | **201** | Resource instance created | No Content | |
| 6355 | +---------+----------------------------------------------------+----------------+ |
| 6356 | | **400** | Invalid content / Missing content | No Content | |
| 6357 | +---------+----------------------------------------------------+----------------+ |
| 6358 | | **403** | Restricted operation | No Content | |
| 6359 | +---------+----------------------------------------------------+----------------+ |
| 6360 | |
| 6361 | Consumes |
| 6362 | ~~~~~~~~ |
| 6363 | |
| 6364 | - ``application/json`` |
| 6365 | |
| 6366 | Produces |
| 6367 | ~~~~~~~~ |
| 6368 | |
| 6369 | - ``application/json`` |
| 6370 | |
| 6371 | Tags |
| 6372 | ~~~~ |
| 6373 | |
| 6374 | - Resource Instance Servlet |
| 6375 | |
| 6376 | Delete ResourceInstance |
| 6377 | ----------------------- |
| 6378 | |
| 6379 | :: |
| 6380 | |
| 6381 | DELETE /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId} |
| 6382 | |
| 6383 | Description |
| 6384 | ~~~~~~~~~~~ |
| 6385 | |
| 6386 | Returns delete resourceInstance |
| 6387 | |
| 6388 | Parameters |
| 6389 | ~~~~~~~~~~ |
| 6390 | |
| 6391 | +----------+-------------+--------------------------------------+------------------+ |
| 6392 | | Type | Name | Description | Schema | |
| 6393 | +==========+=============+======================================+==================+ |
| 6394 | | **Path** | **component | | string | |
| 6395 | | | Id**\ *requ | | | |
| 6396 | | | ired* | | | |
| 6397 | +----------+-------------+--------------------------------------+------------------+ |
| 6398 | | **Path** | **container | valid values: resources / services / | enum (resources, | |
| 6399 | | | ComponentTy | products | services, | |
| 6400 | | | pe**\ *requ | | products) | |
| 6401 | | | ired* | | | |
| 6402 | +----------+-------------+--------------------------------------+------------------+ |
| 6403 | | **Path** | **resourceI | | string | |
| 6404 | | | nstanceId** | | | |
| 6405 | | | \ *required | | | |
| 6406 | | | * | | | |
| 6407 | +----------+-------------+--------------------------------------+------------------+ |
| 6408 | |
| 6409 | Responses |
| 6410 | ~~~~~~~~~ |
| 6411 | |
| 6412 | +---------+----------------------------------------------------+----------------+ |
| 6413 | | HTTP | Description | Schema | |
| 6414 | | Code | | | |
| 6415 | +=========+====================================================+================+ |
| 6416 | | **201** | ResourceInstance deleted | No Content | |
| 6417 | +---------+----------------------------------------------------+----------------+ |
| 6418 | | **400** | Invalid content / Missing content | No Content | |
| 6419 | +---------+----------------------------------------------------+----------------+ |
| 6420 | | **403** | Restricted operation | No Content | |
| 6421 | +---------+----------------------------------------------------+----------------+ |
| 6422 | |
| 6423 | Consumes |
| 6424 | ~~~~~~~~ |
| 6425 | |
| 6426 | - ``application/json`` |
| 6427 | |
| 6428 | Produces |
| 6429 | ~~~~~~~~ |
| 6430 | |
| 6431 | - ``application/json`` |
| 6432 | |
| 6433 | Tags |
| 6434 | ~~~~ |
| 6435 | |
| 6436 | - Resource Instance Servlet |
| 6437 | |
| 6438 | Download component Artifact in Base64 |
| 6439 | ------------------------------------- |
| 6440 | |
| 6441 | :: |
| 6442 | |
| 6443 | GET /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifacts/{artifactId} |
| 6444 | |
| 6445 | Description |
| 6446 | ~~~~~~~~~~~ |
| 6447 | |
| 6448 | Returns downloaded artifact |
| 6449 | |
| 6450 | Parameters |
| 6451 | ~~~~~~~~~~ |
| 6452 | |
| 6453 | +----------+-------------+--------------------------------------+------------------+ |
| 6454 | | Type | Name | Description | Schema | |
| 6455 | +==========+=============+======================================+==================+ |
| 6456 | | **Path** | **artifactI | | string | |
| 6457 | | | d**\ *requi | | | |
| 6458 | | | red* | | | |
| 6459 | +----------+-------------+--------------------------------------+------------------+ |
| 6460 | | **Path** | **component | | string | |
| 6461 | | | Id**\ *requ | | | |
| 6462 | | | ired* | | | |
| 6463 | +----------+-------------+--------------------------------------+------------------+ |
| 6464 | | **Path** | **component | | string | |
| 6465 | | | InstanceId* | | | |
| 6466 | | | *\ *require | | | |
| 6467 | | | d* | | | |
| 6468 | +----------+-------------+--------------------------------------+------------------+ |
| 6469 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 6470 | | | ComponentTy | | services) | |
| 6471 | | | pe**\ *requ | | | |
| 6472 | | | ired* | | | |
| 6473 | +----------+-------------+--------------------------------------+------------------+ |
| 6474 | |
| 6475 | Responses |
| 6476 | ~~~~~~~~~ |
| 6477 | |
| 6478 | +---------+----------------------------------------------------+----------------+ |
| 6479 | | HTTP | Description | Schema | |
| 6480 | | Code | | | |
| 6481 | +=========+====================================================+================+ |
| 6482 | | **200** | ResourceInstance artifact downloaded | No Content | |
| 6483 | +---------+----------------------------------------------------+----------------+ |
| 6484 | | **404** | ResourceInstance/Artifact not found | No Content | |
| 6485 | +---------+----------------------------------------------------+----------------+ |
| 6486 | |
| 6487 | Consumes |
| 6488 | ~~~~~~~~ |
| 6489 | |
| 6490 | - ``application/json`` |
| 6491 | |
| 6492 | Produces |
| 6493 | ~~~~~~~~ |
| 6494 | |
| 6495 | - ``application/json`` |
| 6496 | |
| 6497 | Tags |
| 6498 | ~~~~ |
| 6499 | |
| 6500 | - Resource Artifact Servlet |
| 6501 | |
| 6502 | Get component Artifacts |
| 6503 | ----------------------- |
| 6504 | |
| 6505 | :: |
| 6506 | |
| 6507 | GET /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType} |
| 6508 | |
| 6509 | Description |
| 6510 | ~~~~~~~~~~~ |
| 6511 | |
| 6512 | Returns artifacts |
| 6513 | |
| 6514 | Parameters |
| 6515 | ~~~~~~~~~~ |
| 6516 | |
| 6517 | +----------+-------------+--------------------------------------+------------------+ |
| 6518 | | Type | Name | Description | Schema | |
| 6519 | +==========+=============+======================================+==================+ |
| 6520 | | **Path** | **artifactG | | string | |
| 6521 | | | roupType**\ | | | |
| 6522 | | | *required* | | | |
| 6523 | +----------+-------------+--------------------------------------+------------------+ |
| 6524 | | **Path** | **component | | string | |
| 6525 | | | Id**\ *requ | | | |
| 6526 | | | ired* | | | |
| 6527 | +----------+-------------+--------------------------------------+------------------+ |
| 6528 | | **Path** | **component | | string | |
| 6529 | | | InstanceId* | | | |
| 6530 | | | *\ *require | | | |
| 6531 | | | d* | | | |
| 6532 | +----------+-------------+--------------------------------------+------------------+ |
| 6533 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 6534 | | | ComponentTy | | services) | |
| 6535 | | | pe**\ *requ | | | |
| 6536 | | | ired* | | | |
| 6537 | +----------+-------------+--------------------------------------+------------------+ |
| 6538 | |
| 6539 | Responses |
| 6540 | ~~~~~~~~~ |
| 6541 | |
| 6542 | +---------+----------------------------------------------------+----------------+ |
| 6543 | | HTTP | Description | Schema | |
| 6544 | | Code | | | |
| 6545 | +=========+====================================================+================+ |
| 6546 | | **200** | Component artifacts | No Content | |
| 6547 | +---------+----------------------------------------------------+----------------+ |
| 6548 | | **404** | Resource/Artifact not found | No Content | |
| 6549 | +---------+----------------------------------------------------+----------------+ |
| 6550 | |
| 6551 | Consumes |
| 6552 | ~~~~~~~~ |
| 6553 | |
| 6554 | - ``application/json`` |
| 6555 | |
| 6556 | Produces |
| 6557 | ~~~~~~~~ |
| 6558 | |
| 6559 | - ``application/json`` |
| 6560 | |
| 6561 | Tags |
| 6562 | ~~~~ |
| 6563 | |
| 6564 | - Resource Artifact Servlet |
| 6565 | |
| 6566 | Update resource inputs |
| 6567 | ---------------------- |
| 6568 | |
| 6569 | :: |
| 6570 | |
| 6571 | POST /v1/catalog/{containerComponentType}/{componentId}/update/inputs |
| 6572 | |
| 6573 | Description |
| 6574 | ~~~~~~~~~~~ |
| 6575 | |
| 6576 | Returns updated input |
| 6577 | |
| 6578 | Parameters |
| 6579 | ~~~~~~~~~~ |
| 6580 | |
| 6581 | +----------+-------------+--------------------------------------+------------------+ |
| 6582 | | Type | Name | Description | Schema | |
| 6583 | +==========+=============+======================================+==================+ |
| 6584 | | **Path** | **component | | string | |
| 6585 | | | Id**\ *requ | | | |
| 6586 | | | ired* | | | |
| 6587 | +----------+-------------+--------------------------------------+------------------+ |
| 6588 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 6589 | | | ComponentTy | | services) | |
| 6590 | | | pe**\ *requ | | | |
| 6591 | | | ired* | | | |
| 6592 | +----------+-------------+--------------------------------------+------------------+ |
| 6593 | | **Body** | **body**\ * | json describe the input | string | |
| 6594 | | | required* | | | |
| 6595 | +----------+-------------+--------------------------------------+------------------+ |
| 6596 | |
| 6597 | Responses |
| 6598 | ~~~~~~~~~ |
| 6599 | |
| 6600 | +---------+----------------------------------------------------+----------------+ |
| 6601 | | HTTP | Description | Schema | |
| 6602 | | Code | | | |
| 6603 | +=========+====================================================+================+ |
| 6604 | | **200** | Input updated | No Content | |
| 6605 | +---------+----------------------------------------------------+----------------+ |
| 6606 | | **400** | Invalid content / Missing content | No Content | |
| 6607 | +---------+----------------------------------------------------+----------------+ |
| 6608 | | **403** | Restricted operation | No Content | |
| 6609 | +---------+----------------------------------------------------+----------------+ |
| 6610 | |
| 6611 | Consumes |
| 6612 | ~~~~~~~~ |
| 6613 | |
| 6614 | - ``application/json`` |
| 6615 | |
| 6616 | Produces |
| 6617 | ~~~~~~~~ |
| 6618 | |
| 6619 | - ``application/json`` |
| 6620 | |
| 6621 | Tags |
| 6622 | ~~~~ |
| 6623 | |
| 6624 | - Input Catalog |
| 6625 | |
| 6626 | Get component instance properties |
| 6627 | --------------------------------- |
| 6628 | |
| 6629 | :: |
| 6630 | |
| 6631 | GET /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/properties |
| 6632 | |
| 6633 | Description |
| 6634 | ~~~~~~~~~~~ |
| 6635 | |
| 6636 | Returns component instance properties |
| 6637 | |
| 6638 | Parameters |
| 6639 | ~~~~~~~~~~ |
| 6640 | |
| 6641 | +------------------+--------------------------+----------------------------------+ |
| 6642 | | Type | Name | Schema | |
| 6643 | +==================+==========================+==================================+ |
| 6644 | | **Header** | **USER\_ID**\ *optional* | string | |
| 6645 | +------------------+--------------------------+----------------------------------+ |
| 6646 | | **Path** | **componentInstanceUniqu | string | |
| 6647 | | | eId**\ *required* | | |
| 6648 | +------------------+--------------------------+----------------------------------+ |
| 6649 | | **Path** | **containerComponentId** | string | |
| 6650 | | | \ *required* | | |
| 6651 | +------------------+--------------------------+----------------------------------+ |
| 6652 | | **Path** | **containerComponentType | string | |
| 6653 | | | **\ *required* | | |
| 6654 | +------------------+--------------------------+----------------------------------+ |
| 6655 | |
| 6656 | Responses |
| 6657 | ~~~~~~~~~ |
| 6658 | |
| 6659 | +---------+----------------------------------------------------+----------------+ |
| 6660 | | HTTP | Description | Schema | |
| 6661 | | Code | | | |
| 6662 | +=========+====================================================+================+ |
| 6663 | | **200** | Properties found | No Content | |
| 6664 | +---------+----------------------------------------------------+----------------+ |
| 6665 | | **403** | Restricted operation | No Content | |
| 6666 | +---------+----------------------------------------------------+----------------+ |
| 6667 | | **404** | Component/Component Instance - not found | No Content | |
| 6668 | +---------+----------------------------------------------------+----------------+ |
| 6669 | |
| 6670 | Consumes |
| 6671 | ~~~~~~~~ |
| 6672 | |
| 6673 | - ``application/json`` |
| 6674 | |
| 6675 | Produces |
| 6676 | ~~~~~~~~ |
| 6677 | |
| 6678 | - ``application/json`` |
| 6679 | |
| 6680 | Tags |
| 6681 | ~~~~ |
| 6682 | |
| 6683 | - Resource Instance Servlet |
| 6684 | |
| 6685 | Create service proxy |
| 6686 | -------------------- |
| 6687 | |
| 6688 | :: |
| 6689 | |
| 6690 | POST /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy |
| 6691 | |
| 6692 | Description |
| 6693 | ~~~~~~~~~~~ |
| 6694 | |
| 6695 | Returns created service proxy |
| 6696 | |
| 6697 | Parameters |
| 6698 | ~~~~~~~~~~ |
| 6699 | |
| 6700 | +----------+-------------+--------------------------------------+------------------+ |
| 6701 | | Type | Name | Description | Schema | |
| 6702 | +==========+=============+======================================+==================+ |
| 6703 | | **Header | **USER\_ID* | USER\_ID of modifier user | string | |
| 6704 | | ** | *\ *require | | | |
| 6705 | | | d* | | | |
| 6706 | +----------+-------------+--------------------------------------+------------------+ |
| 6707 | | **Path** | **container | | string | |
| 6708 | | | ComponentId | | | |
| 6709 | | | **\ *requir | | | |
| 6710 | | | ed* | | | |
| 6711 | +----------+-------------+--------------------------------------+------------------+ |
| 6712 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 6713 | | | ComponentTy | | services) | |
| 6714 | | | pe**\ *requ | | | |
| 6715 | | | ired* | | | |
| 6716 | +----------+-------------+--------------------------------------+------------------+ |
| 6717 | | **Body** | **body**\ * | RI object to be created | string | |
| 6718 | | | required* | | | |
| 6719 | +----------+-------------+--------------------------------------+------------------+ |
| 6720 | |
| 6721 | Responses |
| 6722 | ~~~~~~~~~ |
| 6723 | |
| 6724 | +---------+----------------------------------------------------+----------------+ |
| 6725 | | HTTP | Description | Schema | |
| 6726 | | Code | | | |
| 6727 | +=========+====================================================+================+ |
| 6728 | | **201** | Service proxy created | No Content | |
| 6729 | +---------+----------------------------------------------------+----------------+ |
| 6730 | | **400** | Invalid content / Missing content | No Content | |
| 6731 | +---------+----------------------------------------------------+----------------+ |
| 6732 | | **403** | Restricted operation | No Content | |
| 6733 | +---------+----------------------------------------------------+----------------+ |
| 6734 | | **409** | Service proxy already exist | No Content | |
| 6735 | +---------+----------------------------------------------------+----------------+ |
| 6736 | |
| 6737 | Consumes |
| 6738 | ~~~~~~~~ |
| 6739 | |
| 6740 | - ``application/json`` |
| 6741 | |
| 6742 | Produces |
| 6743 | ~~~~~~~~ |
| 6744 | |
| 6745 | - ``application/json`` |
| 6746 | |
| 6747 | Tags |
| 6748 | ~~~~ |
| 6749 | |
| 6750 | - Resource Instance Servlet |
| 6751 | |
| 6752 | Delete service proxy |
| 6753 | -------------------- |
| 6754 | |
| 6755 | :: |
| 6756 | |
| 6757 | DELETE /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId} |
| 6758 | |
| 6759 | Description |
| 6760 | ~~~~~~~~~~~ |
| 6761 | |
| 6762 | Returns delete service proxy |
| 6763 | |
| 6764 | Parameters |
| 6765 | ~~~~~~~~~~ |
| 6766 | |
| 6767 | +----------+-------------+--------------------------------------+------------------+ |
| 6768 | | Type | Name | Description | Schema | |
| 6769 | +==========+=============+======================================+==================+ |
| 6770 | | **Path** | **container | | string | |
| 6771 | | | ComponentId | | | |
| 6772 | | | **\ *requir | | | |
| 6773 | | | ed* | | | |
| 6774 | +----------+-------------+--------------------------------------+------------------+ |
| 6775 | | **Path** | **container | valid values: resources / services / | enum (resources, | |
| 6776 | | | ComponentTy | products | services, | |
| 6777 | | | pe**\ *requ | | products) | |
| 6778 | | | ired* | | | |
| 6779 | +----------+-------------+--------------------------------------+------------------+ |
| 6780 | | **Path** | **servicePr | | string | |
| 6781 | | | oxyId**\ *r | | | |
| 6782 | | | equired* | | | |
| 6783 | +----------+-------------+--------------------------------------+------------------+ |
| 6784 | |
| 6785 | Responses |
| 6786 | ~~~~~~~~~ |
| 6787 | |
| 6788 | +---------+----------------------------------------------------+----------------+ |
| 6789 | | HTTP | Description | Schema | |
| 6790 | | Code | | | |
| 6791 | +=========+====================================================+================+ |
| 6792 | | **201** | Service proxy deleted | No Content | |
| 6793 | +---------+----------------------------------------------------+----------------+ |
| 6794 | | **400** | Invalid content / Missing content | No Content | |
| 6795 | +---------+----------------------------------------------------+----------------+ |
| 6796 | | **403** | Restricted operation | No Content | |
| 6797 | +---------+----------------------------------------------------+----------------+ |
| 6798 | |
| 6799 | Consumes |
| 6800 | ~~~~~~~~ |
| 6801 | |
| 6802 | - ``application/json`` |
| 6803 | |
| 6804 | Produces |
| 6805 | ~~~~~~~~ |
| 6806 | |
| 6807 | - ``application/json`` |
| 6808 | |
| 6809 | Tags |
| 6810 | ~~~~ |
| 6811 | |
| 6812 | - Resource Instance Servlet |
| 6813 | |
| 6814 | Update service proxy with new version |
| 6815 | ------------------------------------- |
| 6816 | |
| 6817 | :: |
| 6818 | |
| 6819 | POST /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}/changeVersion/{newServiceId} |
| 6820 | |
| 6821 | Description |
| 6822 | ~~~~~~~~~~~ |
| 6823 | |
| 6824 | Returns updated service proxy |
| 6825 | |
| 6826 | Parameters |
| 6827 | ~~~~~~~~~~ |
| 6828 | |
| 6829 | +----------+-------------+--------------------------------------+------------------+ |
| 6830 | | Type | Name | Description | Schema | |
| 6831 | +==========+=============+======================================+==================+ |
| 6832 | | **Path** | **container | | string | |
| 6833 | | | ComponentId | | | |
| 6834 | | | **\ *requir | | | |
| 6835 | | | ed* | | | |
| 6836 | +----------+-------------+--------------------------------------+------------------+ |
| 6837 | | **Path** | **container | valid values: resources / services | enum (resources, | |
| 6838 | | | ComponentTy | | services) | |
| 6839 | | | pe**\ *requ | | | |
| 6840 | | | ired* | | | |
| 6841 | +----------+-------------+--------------------------------------+------------------+ |
| 6842 | | **Path** | **servicePr | | string | |
| 6843 | | | oxyId**\ *r | | | |
| 6844 | | | equired* | | | |
| 6845 | +----------+-------------+--------------------------------------+------------------+ |
| 6846 | |
| 6847 | Responses |
| 6848 | ~~~~~~~~~ |
| 6849 | |
| 6850 | +---------+----------------------------------------------------+----------------+ |
| 6851 | | HTTP | Description | Schema | |
| 6852 | | Code | | | |
| 6853 | +=========+====================================================+================+ |
| 6854 | | **201** | Service proxy created | No Content | |
| 6855 | +---------+----------------------------------------------------+----------------+ |
| 6856 | | **400** | Invalid content / Missing content | No Content | |
| 6857 | +---------+----------------------------------------------------+----------------+ |
| 6858 | | **403** | Restricted operation | No Content | |
| 6859 | +---------+----------------------------------------------------+----------------+ |
| 6860 | |
| 6861 | Consumes |
| 6862 | ~~~~~~~~ |
| 6863 | |
| 6864 | - ``application/json`` |
| 6865 | |
| 6866 | Produces |
| 6867 | ~~~~~~~~ |
| 6868 | |
| 6869 | - ``application/json`` |
| 6870 | |
| 6871 | Tags |
| 6872 | ~~~~ |
| 6873 | |
| 6874 | - Resource Instance Servlet |
| 6875 | |
| 6876 | Update Group Instance Property Values |
| 6877 | ------------------------------------- |
| 6878 | |
| 6879 | :: |
| 6880 | |
| 6881 | PUT /v1/catalog/{containerComponentType}/{serviceId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId} |
| 6882 | |
| 6883 | Description |
| 6884 | ~~~~~~~~~~~ |
| 6885 | |
| 6886 | Returns updated group instance |
| 6887 | |
| 6888 | Parameters |
| 6889 | ~~~~~~~~~~ |
| 6890 | |
| 6891 | +----------+-------------+--------------------------------------+------------------+ |
| 6892 | | Type | Name | Description | Schema | |
| 6893 | +==========+=============+======================================+==================+ |
| 6894 | | **Header | **USER\_ID* | | string | |
| 6895 | | ** | *\ *optiona | | | |
| 6896 | | | l* | | | |
| 6897 | +----------+-------------+--------------------------------------+------------------+ |
| 6898 | | **Path** | **component | | string | |
| 6899 | | | InstanceId* | | | |
| 6900 | | | *\ *require | | | |
| 6901 | | | d* | | | |
| 6902 | +----------+-------------+--------------------------------------+------------------+ |
| 6903 | | **Path** | **groupInst | | string | |
| 6904 | | | anceId**\ * | | | |
| 6905 | | | required* | | | |
| 6906 | +----------+-------------+--------------------------------------+------------------+ |
| 6907 | | **Path** | **serviceId | | string | |
| 6908 | | | **\ *requir | | | |
| 6909 | | | ed* | | | |
| 6910 | +----------+-------------+--------------------------------------+------------------+ |
| 6911 | | **Body** | **body**\ * | Group instance object to be Updated | string | |
| 6912 | | | required* | | | |
| 6913 | +----------+-------------+--------------------------------------+------------------+ |
| 6914 | |
| 6915 | Responses |
| 6916 | ~~~~~~~~~ |
| 6917 | |
| 6918 | +---------+----------------------------------------------------+----------------+ |
| 6919 | | HTTP | Description | Schema | |
| 6920 | | Code | | | |
| 6921 | +=========+====================================================+================+ |
| 6922 | | **200** | Group Instance Property Values Updated | No Content | |
| 6923 | +---------+----------------------------------------------------+----------------+ |
| 6924 | | **400** | Invalid content / Missing content | No Content | |
| 6925 | +---------+----------------------------------------------------+----------------+ |
| 6926 | | **403** | Restricted operation | No Content | |
| 6927 | +---------+----------------------------------------------------+----------------+ |
| 6928 | |
| 6929 | Consumes |
| 6930 | ~~~~~~~~ |
| 6931 | |
| 6932 | - ``application/json`` |
| 6933 | |
| 6934 | Produces |
| 6935 | ~~~~~~~~ |
| 6936 | |
| 6937 | - ``application/json`` |
| 6938 | |
| 6939 | Tags |
| 6940 | ~~~~ |
| 6941 | |
| 6942 | - Service Catalog |
| 6943 | |
| 6944 | Retrieve the all resource, service and product categories |
| 6945 | --------------------------------------------------------- |
| 6946 | |
| 6947 | :: |
| 6948 | |
| 6949 | GET /v1/categories |
| 6950 | |
| 6951 | Description |
| 6952 | ~~~~~~~~~~~ |
| 6953 | |
| 6954 | Retrieve the all resource, service and product categories |
| 6955 | |
| 6956 | Parameters |
| 6957 | ~~~~~~~~~~ |
| 6958 | |
| 6959 | +------------------+--------------------------+----------------------------------+ |
| 6960 | | Type | Name | Schema | |
| 6961 | +==================+==========================+==================================+ |
| 6962 | | **Header** | **USER\_ID**\ *optional* | string | |
| 6963 | +------------------+--------------------------+----------------------------------+ |
| 6964 | |
| 6965 | Responses |
| 6966 | ~~~~~~~~~ |
| 6967 | |
| 6968 | +---------+----------------------------------------------------+----------------+ |
| 6969 | | HTTP | Description | Schema | |
| 6970 | | Code | | | |
| 6971 | +=========+====================================================+================+ |
| 6972 | | **200** | Returns categories Ok | No Content | |
| 6973 | +---------+----------------------------------------------------+----------------+ |
| 6974 | | **403** | Missing information | No Content | |
| 6975 | +---------+----------------------------------------------------+----------------+ |
| 6976 | | **409** | Restricted operation | No Content | |
| 6977 | +---------+----------------------------------------------------+----------------+ |
| 6978 | | **500** | Internal Server Error | No Content | |
| 6979 | +---------+----------------------------------------------------+----------------+ |
| 6980 | |
| 6981 | Consumes |
| 6982 | ~~~~~~~~ |
| 6983 | |
| 6984 | - ``application/json`` |
| 6985 | |
| 6986 | Produces |
| 6987 | ~~~~~~~~ |
| 6988 | |
| 6989 | - ``application/json`` |
| 6990 | |
| 6991 | Tags |
| 6992 | ~~~~ |
| 6993 | |
| 6994 | - Element Servlet |
| 6995 | |
| 6996 | Retrieve the list of all resource/service/product categories/sub-categories/groupings |
| 6997 | ------------------------------------------------------------------------------------- |
| 6998 | |
| 6999 | :: |
| 7000 | |
| 7001 | GET /v1/categories/{componentType} |
| 7002 | |
| 7003 | Description |
| 7004 | ~~~~~~~~~~~ |
| 7005 | |
| 7006 | Retrieve the list of all resource/service/product |
| 7007 | categories/sub-categories/groupings. |
| 7008 | |
| 7009 | Parameters |
| 7010 | ~~~~~~~~~~ |
| 7011 | |
| 7012 | +----------+-------------+--------------------------------------+------------------+ |
| 7013 | | Type | Name | Description | Schema | |
| 7014 | +==========+=============+======================================+==================+ |
| 7015 | | **Header | **USER\_ID* | | string | |
| 7016 | | ** | *\ *optiona | | | |
| 7017 | | | l* | | | |
| 7018 | +----------+-------------+--------------------------------------+------------------+ |
| 7019 | | **Path** | **component | allowed values are resources / | enum (resources, | |
| 7020 | | | Type**\ *re | services/ products | services, | |
| 7021 | | | quired* | | products) | |
| 7022 | +----------+-------------+--------------------------------------+------------------+ |
| 7023 | |
| 7024 | Responses |
| 7025 | ~~~~~~~~~ |
| 7026 | |
| 7027 | +---------+----------------------------------------------------+----------------+ |
| 7028 | | HTTP | Description | Schema | |
| 7029 | | Code | | | |
| 7030 | +=========+====================================================+================+ |
| 7031 | | **200** | Returns categories Ok | No Content | |
| 7032 | +---------+----------------------------------------------------+----------------+ |
| 7033 | | **400** | Invalid component type | No Content | |
| 7034 | +---------+----------------------------------------------------+----------------+ |
| 7035 | | **403** | Missing information | No Content | |
| 7036 | +---------+----------------------------------------------------+----------------+ |
| 7037 | | **409** | Restricted operation | No Content | |
| 7038 | +---------+----------------------------------------------------+----------------+ |
| 7039 | | **500** | Internal Server Error | No Content | |
| 7040 | +---------+----------------------------------------------------+----------------+ |
| 7041 | |
| 7042 | Consumes |
| 7043 | ~~~~~~~~ |
| 7044 | |
| 7045 | - ``application/json`` |
| 7046 | |
| 7047 | Produces |
| 7048 | ~~~~~~~~ |
| 7049 | |
| 7050 | - ``application/json`` |
| 7051 | |
| 7052 | Tags |
| 7053 | ~~~~ |
| 7054 | |
| 7055 | - Element Servlet |
| 7056 | |
| 7057 | Create new component category |
| 7058 | ----------------------------- |
| 7059 | |
| 7060 | :: |
| 7061 | |
| 7062 | POST /v1/category/{componentType} |
| 7063 | |
| 7064 | Description |
| 7065 | ~~~~~~~~~~~ |
| 7066 | |
| 7067 | Create new component category |
| 7068 | |
| 7069 | Parameters |
| 7070 | ~~~~~~~~~~ |
| 7071 | |
| 7072 | +----------+-------------+--------------------------------------+------------------+ |
| 7073 | | Type | Name | Description | Schema | |
| 7074 | +==========+=============+======================================+==================+ |
| 7075 | | **Header | **USER\_ID* | | string | |
| 7076 | | ** | *\ *optiona | | | |
| 7077 | | | l* | | | |
| 7078 | +----------+-------------+--------------------------------------+------------------+ |
| 7079 | | **Path** | **component | allowed values are resources | enum (resources, | |
| 7080 | | | Type**\ *re | /services / products | services, | |
| 7081 | | | quired* | | products) | |
| 7082 | +----------+-------------+--------------------------------------+------------------+ |
| 7083 | | **Body** | **body**\ * | Category to be created | string | |
| 7084 | | | required* | | | |
| 7085 | +----------+-------------+--------------------------------------+------------------+ |
| 7086 | |
| 7087 | Responses |
| 7088 | ~~~~~~~~~ |
| 7089 | |
| 7090 | +---------+----------------------------------------------------+----------------+ |
| 7091 | | HTTP | Description | Schema | |
| 7092 | | Code | | | |
| 7093 | +=========+====================================================+================+ |
| 7094 | | **201** | Category created | No Content | |
| 7095 | +---------+----------------------------------------------------+----------------+ |
| 7096 | | **400** | Invalid category data | No Content | |
| 7097 | +---------+----------------------------------------------------+----------------+ |
| 7098 | | **403** | USER\_ID header is missing | No Content | |
| 7099 | +---------+----------------------------------------------------+----------------+ |
| 7100 | | **409** | Category already exists / User not permitted to | No Content | |
| 7101 | | | perform the action | | |
| 7102 | +---------+----------------------------------------------------+----------------+ |
| 7103 | | **500** | General Error | No Content | |
| 7104 | +---------+----------------------------------------------------+----------------+ |
| 7105 | |
| 7106 | Consumes |
| 7107 | ~~~~~~~~ |
| 7108 | |
| 7109 | - ``application/json`` |
| 7110 | |
| 7111 | Produces |
| 7112 | ~~~~~~~~ |
| 7113 | |
| 7114 | - ``application/json`` |
| 7115 | |
| 7116 | Tags |
| 7117 | ~~~~ |
| 7118 | |
| 7119 | - Element Servlet |
| 7120 | |
| 7121 | Create new component sub-category |
| 7122 | --------------------------------- |
| 7123 | |
| 7124 | :: |
| 7125 | |
| 7126 | POST /v1/category/{componentType}/{categoryId}/subCategory |
| 7127 | |
| 7128 | Description |
| 7129 | ~~~~~~~~~~~ |
| 7130 | |
| 7131 | Create new component sub-category for existing category |
| 7132 | |
| 7133 | Parameters |
| 7134 | ~~~~~~~~~~ |
| 7135 | |
| 7136 | +----------+-------------+--------------------------------------+------------------+ |
| 7137 | | Type | Name | Description | Schema | |
| 7138 | +==========+=============+======================================+==================+ |
| 7139 | | **Header | **USER\_ID* | | string | |
| 7140 | | ** | *\ *optiona | | | |
| 7141 | | | l* | | | |
| 7142 | +----------+-------------+--------------------------------------+------------------+ |
| 7143 | | **Path** | **categoryI | Parent category unique ID | string | |
| 7144 | | | d**\ *requi | | | |
| 7145 | | | red* | | | |
| 7146 | +----------+-------------+--------------------------------------+------------------+ |
| 7147 | | **Path** | **component | allowed values are resources / | enum (resources, | |
| 7148 | | | Type**\ *re | products | products) | |
| 7149 | | | quired* | | | |
| 7150 | +----------+-------------+--------------------------------------+------------------+ |
| 7151 | | **Body** | **body**\ * | Subcategory to be created. e.g. | string | |
| 7152 | | | required* | {"name":"Resource-subcat"} | | |
| 7153 | +----------+-------------+--------------------------------------+------------------+ |
| 7154 | |
| 7155 | Responses |
| 7156 | ~~~~~~~~~ |
| 7157 | |
| 7158 | +---------+----------------------------------------------------+----------------+ |
| 7159 | | HTTP | Description | Schema | |
| 7160 | | Code | | | |
| 7161 | +=========+====================================================+================+ |
| 7162 | | **201** | Subcategory created | No Content | |
| 7163 | +---------+----------------------------------------------------+----------------+ |
| 7164 | | **400** | Invalid subcategory data | No Content | |
| 7165 | +---------+----------------------------------------------------+----------------+ |
| 7166 | | **403** | USER\_ID header is missing | No Content | |
| 7167 | +---------+----------------------------------------------------+----------------+ |
| 7168 | | **404** | Parent category wasn’t found | No Content | |
| 7169 | +---------+----------------------------------------------------+----------------+ |
| 7170 | | **409** | Subcategory already exists / User not permitted to | No Content | |
| 7171 | | | perform the action | | |
| 7172 | +---------+----------------------------------------------------+----------------+ |
| 7173 | | **500** | General Error | No Content | |
| 7174 | +---------+----------------------------------------------------+----------------+ |
| 7175 | |
| 7176 | Consumes |
| 7177 | ~~~~~~~~ |
| 7178 | |
| 7179 | - ``application/json`` |
| 7180 | |
| 7181 | Produces |
| 7182 | ~~~~~~~~ |
| 7183 | |
| 7184 | - ``application/json`` |
| 7185 | |
| 7186 | Tags |
| 7187 | ~~~~ |
| 7188 | |
| 7189 | - Element Servlet |
| 7190 | |
| 7191 | Create new component grouping |
| 7192 | ----------------------------- |
| 7193 | |
| 7194 | :: |
| 7195 | |
| 7196 | POST /v1/category/{componentType}/{categoryId}/subCategory/{subCategoryId}/grouping |
| 7197 | |
| 7198 | Description |
| 7199 | ~~~~~~~~~~~ |
| 7200 | |
| 7201 | Create new component grouping for existing sub-category |
| 7202 | |
| 7203 | Parameters |
| 7204 | ~~~~~~~~~~ |
| 7205 | |
| 7206 | +----------+-------------+--------------------------------------+------------------+ |
| 7207 | | Type | Name | Description | Schema | |
| 7208 | +==========+=============+======================================+==================+ |
| 7209 | | **Header | **USER\_ID* | | string | |
| 7210 | | ** | *\ *optiona | | | |
| 7211 | | | l* | | | |
| 7212 | +----------+-------------+--------------------------------------+------------------+ |
| 7213 | | **Path** | **categoryI | Parent category unique ID | string | |
| 7214 | | | d**\ *requi | | | |
| 7215 | | | red* | | | |
| 7216 | +----------+-------------+--------------------------------------+------------------+ |
| 7217 | | **Path** | **component | allowed values are products | enum (products) | |
| 7218 | | | Type**\ *re | | | |
| 7219 | | | quired* | | | |
| 7220 | +----------+-------------+--------------------------------------+------------------+ |
| 7221 | | **Path** | **subCatego | Parent sub-category unique ID | string | |
| 7222 | | | ryId**\ *re | | | |
| 7223 | | | quired* | | | |
| 7224 | +----------+-------------+--------------------------------------+------------------+ |
| 7225 | | **Body** | **body**\ * | Subcategory to be created | string | |
| 7226 | | | required* | | | |
| 7227 | +----------+-------------+--------------------------------------+------------------+ |
| 7228 | |
| 7229 | Responses |
| 7230 | ~~~~~~~~~ |
| 7231 | |
| 7232 | +---------+----------------------------------------------------+----------------+ |
| 7233 | | HTTP | Description | Schema | |
| 7234 | | Code | | | |
| 7235 | +=========+====================================================+================+ |
| 7236 | | **201** | Grouping created | No Content | |
| 7237 | +---------+----------------------------------------------------+----------------+ |
| 7238 | | **400** | Invalid grouping data | No Content | |
| 7239 | +---------+----------------------------------------------------+----------------+ |
| 7240 | | **403** | USER\_ID header is missing | No Content | |
| 7241 | +---------+----------------------------------------------------+----------------+ |
| 7242 | | **404** | Parent category or subcategory were not found | No Content | |
| 7243 | +---------+----------------------------------------------------+----------------+ |
| 7244 | | **409** | Grouping already exists / User not permitted to | No Content | |
| 7245 | | | perform the action | | |
| 7246 | +---------+----------------------------------------------------+----------------+ |
| 7247 | | **500** | General Error | No Content | |
| 7248 | +---------+----------------------------------------------------+----------------+ |
| 7249 | |
| 7250 | Consumes |
| 7251 | ~~~~~~~~ |
| 7252 | |
| 7253 | - ``application/json`` |
| 7254 | |
| 7255 | Produces |
| 7256 | ~~~~~~~~ |
| 7257 | |
| 7258 | - ``application/json`` |
| 7259 | |
| 7260 | Tags |
| 7261 | ~~~~ |
| 7262 | |
| 7263 | - Element Servlet |
| 7264 | |
| 7265 | Delete component category |
| 7266 | ------------------------- |
| 7267 | |
| 7268 | :: |
| 7269 | |
| 7270 | DELETE /v1/category/{componentType}/{categoryUniqueId} |
| 7271 | |
| 7272 | Description |
| 7273 | ~~~~~~~~~~~ |
| 7274 | |
| 7275 | Delete component category |
| 7276 | |
| 7277 | Parameters |
| 7278 | ~~~~~~~~~~ |
| 7279 | |
| 7280 | +------------------+--------------------------+----------------------------------+ |
| 7281 | | Type | Name | Schema | |
| 7282 | +==================+==========================+==================================+ |
| 7283 | | **Header** | **USER\_ID**\ *optional* | string | |
| 7284 | +------------------+--------------------------+----------------------------------+ |
| 7285 | | **Path** | **categoryUniqueId**\ *r | string | |
| 7286 | | | equired* | | |
| 7287 | +------------------+--------------------------+----------------------------------+ |
| 7288 | | **Path** | **componentType**\ *requ | string | |
| 7289 | | | ired* | | |
| 7290 | +------------------+--------------------------+----------------------------------+ |
| 7291 | |
| 7292 | Responses |
| 7293 | ~~~~~~~~~ |
| 7294 | |
| 7295 | +---------+----------------------------------------------------+----------------+ |
| 7296 | | HTTP | Description | Schema | |
| 7297 | | Code | | | |
| 7298 | +=========+====================================================+================+ |
| 7299 | | **200** | successful operation | `Category <#_c | |
| 7300 | | | | ategory>`__ | |
| 7301 | +---------+----------------------------------------------------+----------------+ |
| 7302 | | **204** | Category deleted | No Content | |
| 7303 | +---------+----------------------------------------------------+----------------+ |
| 7304 | | **403** | USER\_ID header is missing | No Content | |
| 7305 | +---------+----------------------------------------------------+----------------+ |
| 7306 | | **404** | Category not found | No Content | |
| 7307 | +---------+----------------------------------------------------+----------------+ |
| 7308 | | **409** | User not permitted to perform the action | No Content | |
| 7309 | +---------+----------------------------------------------------+----------------+ |
| 7310 | | **500** | General Error | No Content | |
| 7311 | +---------+----------------------------------------------------+----------------+ |
| 7312 | |
| 7313 | Consumes |
| 7314 | ~~~~~~~~ |
| 7315 | |
| 7316 | - ``application/json`` |
| 7317 | |
| 7318 | Produces |
| 7319 | ~~~~~~~~ |
| 7320 | |
| 7321 | - ``application/json`` |
| 7322 | |
| 7323 | Tags |
| 7324 | ~~~~ |
| 7325 | |
| 7326 | - Element Servlet |
| 7327 | |
| 7328 | Delete component category |
| 7329 | ------------------------- |
| 7330 | |
| 7331 | :: |
| 7332 | |
| 7333 | DELETE /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId} |
| 7334 | |
| 7335 | Description |
| 7336 | ~~~~~~~~~~~ |
| 7337 | |
| 7338 | Delete component category |
| 7339 | |
| 7340 | Parameters |
| 7341 | ~~~~~~~~~~ |
| 7342 | |
| 7343 | +------------------+--------------------------+----------------------------------+ |
| 7344 | | Type | Name | Schema | |
| 7345 | +==================+==========================+==================================+ |
| 7346 | | **Header** | **USER\_ID**\ *optional* | string | |
| 7347 | +------------------+--------------------------+----------------------------------+ |
| 7348 | | **Path** | **categoryUniqueId**\ *r | string | |
| 7349 | | | equired* | | |
| 7350 | +------------------+--------------------------+----------------------------------+ |
| 7351 | | **Path** | **componentType**\ *requ | string | |
| 7352 | | | ired* | | |
| 7353 | +------------------+--------------------------+----------------------------------+ |
| 7354 | | **Path** | **subCategoryUniqueId**\ | string | |
| 7355 | | | *required* | | |
| 7356 | +------------------+--------------------------+----------------------------------+ |
| 7357 | |
| 7358 | Responses |
| 7359 | ~~~~~~~~~ |
| 7360 | |
| 7361 | +---------+----------------------------------------------------+----------------+ |
| 7362 | | HTTP | Description | Schema | |
| 7363 | | Code | | | |
| 7364 | +=========+====================================================+================+ |
| 7365 | | **200** | successful operation | `Category <#_c | |
| 7366 | | | | ategory>`__ | |
| 7367 | +---------+----------------------------------------------------+----------------+ |
| 7368 | | **204** | Category deleted | No Content | |
| 7369 | +---------+----------------------------------------------------+----------------+ |
| 7370 | | **403** | USER\_ID header is missing | No Content | |
| 7371 | +---------+----------------------------------------------------+----------------+ |
| 7372 | | **404** | Category not found | No Content | |
| 7373 | +---------+----------------------------------------------------+----------------+ |
| 7374 | | **409** | User not permitted to perform the action | No Content | |
| 7375 | +---------+----------------------------------------------------+----------------+ |
| 7376 | | **500** | General Error | No Content | |
| 7377 | +---------+----------------------------------------------------+----------------+ |
| 7378 | |
| 7379 | Consumes |
| 7380 | ~~~~~~~~ |
| 7381 | |
| 7382 | - ``application/json`` |
| 7383 | |
| 7384 | Produces |
| 7385 | ~~~~~~~~ |
| 7386 | |
| 7387 | - ``application/json`` |
| 7388 | |
| 7389 | Tags |
| 7390 | ~~~~ |
| 7391 | |
| 7392 | - Element Servlet |
| 7393 | |
| 7394 | Delete component category |
| 7395 | ------------------------- |
| 7396 | |
| 7397 | :: |
| 7398 | |
| 7399 | DELETE /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}/grouping/{groupingUniqueId} |
| 7400 | |
| 7401 | Description |
| 7402 | ~~~~~~~~~~~ |
| 7403 | |
| 7404 | Delete component category |
| 7405 | |
| 7406 | Parameters |
| 7407 | ~~~~~~~~~~ |
| 7408 | |
| 7409 | +------------------+--------------------------+----------------------------------+ |
| 7410 | | Type | Name | Schema | |
| 7411 | +==================+==========================+==================================+ |
| 7412 | | **Header** | **USER\_ID**\ *optional* | string | |
| 7413 | +------------------+--------------------------+----------------------------------+ |
| 7414 | | **Path** | **categoryUniqueId**\ *r | string | |
| 7415 | | | equired* | | |
| 7416 | +------------------+--------------------------+----------------------------------+ |
| 7417 | | **Path** | **componentType**\ *requ | string | |
| 7418 | | | ired* | | |
| 7419 | +------------------+--------------------------+----------------------------------+ |
| 7420 | | **Path** | **groupingUniqueId**\ *r | string | |
| 7421 | | | equired* | | |
| 7422 | +------------------+--------------------------+----------------------------------+ |
| 7423 | | **Path** | **subCategoryUniqueId**\ | string | |
| 7424 | | | *required* | | |
| 7425 | +------------------+--------------------------+----------------------------------+ |
| 7426 | |
| 7427 | Responses |
| 7428 | ~~~~~~~~~ |
| 7429 | |
| 7430 | +---------+----------------------------------------------------+----------------+ |
| 7431 | | HTTP | Description | Schema | |
| 7432 | | Code | | | |
| 7433 | +=========+====================================================+================+ |
| 7434 | | **200** | successful operation | `Category <#_c | |
| 7435 | | | | ategory>`__ | |
| 7436 | +---------+----------------------------------------------------+----------------+ |
| 7437 | | **204** | Category deleted | No Content | |
| 7438 | +---------+----------------------------------------------------+----------------+ |
| 7439 | | **403** | USER\_ID header is missing | No Content | |
| 7440 | +---------+----------------------------------------------------+----------------+ |
| 7441 | | **404** | Category not found | No Content | |
| 7442 | +---------+----------------------------------------------------+----------------+ |
| 7443 | | **409** | User not permitted to perform the action | No Content | |
| 7444 | +---------+----------------------------------------------------+----------------+ |
| 7445 | | **500** | General Error | No Content | |
| 7446 | +---------+----------------------------------------------------+----------------+ |
| 7447 | |
| 7448 | Consumes |
| 7449 | ~~~~~~~~ |
| 7450 | |
| 7451 | - ``application/json`` |
| 7452 | |
| 7453 | Produces |
| 7454 | ~~~~~~~~ |
| 7455 | |
| 7456 | - ``application/json`` |
| 7457 | |
| 7458 | Tags |
| 7459 | ~~~~ |
| 7460 | |
| 7461 | - Element Servlet |
| 7462 | |
| 7463 | Retrieve all artifactTypes |
| 7464 | -------------------------- |
| 7465 | |
| 7466 | :: |
| 7467 | |
| 7468 | GET /v1/configuration/ui |
| 7469 | |
| 7470 | Description |
| 7471 | ~~~~~~~~~~~ |
| 7472 | |
| 7473 | Retrieve all artifactTypes |
| 7474 | |
| 7475 | Parameters |
| 7476 | ~~~~~~~~~~ |
| 7477 | |
| 7478 | +------------------+--------------------------+----------------------------------+ |
| 7479 | | Type | Name | Schema | |
| 7480 | +==================+==========================+==================================+ |
| 7481 | | **Header** | **USER\_ID**\ *optional* | string | |
| 7482 | +------------------+--------------------------+----------------------------------+ |
| 7483 | |
| 7484 | Responses |
| 7485 | ~~~~~~~~~ |
| 7486 | |
| 7487 | +---------+----------------------------------------------------+----------------+ |
| 7488 | | HTTP | Description | Schema | |
| 7489 | | Code | | | |
| 7490 | +=========+====================================================+================+ |
| 7491 | | **200** | Returns artifactTypes Ok | No Content | |
| 7492 | +---------+----------------------------------------------------+----------------+ |
| 7493 | | **404** | No artifactTypes were found | No Content | |
| 7494 | +---------+----------------------------------------------------+----------------+ |
| 7495 | | **500** | Internal Server Error | No Content | |
| 7496 | +---------+----------------------------------------------------+----------------+ |
| 7497 | |
| 7498 | Consumes |
| 7499 | ~~~~~~~~ |
| 7500 | |
| 7501 | - ``application/json`` |
| 7502 | |
| 7503 | Produces |
| 7504 | ~~~~~~~~ |
| 7505 | |
| 7506 | - ``application/json`` |
| 7507 | |
| 7508 | Tags |
| 7509 | ~~~~ |
| 7510 | |
| 7511 | - Element Servlet |
| 7512 | |
| 7513 | Consumer credentials |
| 7514 | -------------------- |
| 7515 | |
| 7516 | :: |
| 7517 | |
| 7518 | POST /v1/consumers |
| 7519 | |
| 7520 | Description |
| 7521 | ~~~~~~~~~~~ |
| 7522 | |
Idan Amit | fc411f0 | 2017-10-23 12:36:06 +0300 | [diff] [blame] | 7523 | Returns created ONAP consumer credentials |
Idan Amit | 6e30a1b | 2017-10-18 09:51:10 +0300 | [diff] [blame] | 7524 | |
| 7525 | Parameters |
| 7526 | ~~~~~~~~~~ |
| 7527 | |
| 7528 | +----------+-------------+--------------------------------------+------------------+ |
| 7529 | | Type | Name | Description | Schema | |
| 7530 | +==========+=============+======================================+==================+ |
| 7531 | | **Header | **USER\_ID* | | string | |
| 7532 | | ** | *\ *optiona | | | |
| 7533 | | | l* | | | |
| 7534 | +----------+-------------+--------------------------------------+------------------+ |
| 7535 | | **Body** | **body**\ * | Consumer Object to be created | string | |
| 7536 | | | required* | | | |
| 7537 | +----------+-------------+--------------------------------------+------------------+ |
| 7538 | |
| 7539 | Responses |
| 7540 | ~~~~~~~~~ |
| 7541 | |
| 7542 | +---------+----------------------------------------------------+----------------+ |
| 7543 | | HTTP | Description | Schema | |
| 7544 | | Code | | | |
| 7545 | +=========+====================================================+================+ |
| 7546 | | **201** | Consumer credentials created | No Content | |
| 7547 | +---------+----------------------------------------------------+----------------+ |
| 7548 | | **400** | Invalid content / Missing content | No Content | |
| 7549 | +---------+----------------------------------------------------+----------------+ |
| 7550 | | **403** | Restricted operation | No Content | |
| 7551 | +---------+----------------------------------------------------+----------------+ |
| 7552 | |
| 7553 | Consumes |
| 7554 | ~~~~~~~~ |
| 7555 | |
| 7556 | - ``application/json`` |
| 7557 | |
| 7558 | Produces |
| 7559 | ~~~~~~~~ |
| 7560 | |
| 7561 | - ``application/json`` |
| 7562 | |
| 7563 | Tags |
| 7564 | ~~~~ |
| 7565 | |
| 7566 | - Consumer Servlet |
| 7567 | |
| 7568 | Retrieve Consumer |
| 7569 | ----------------- |
| 7570 | |
| 7571 | :: |
| 7572 | |
| 7573 | GET /v1/consumers/{consumerId} |
| 7574 | |
| 7575 | Description |
| 7576 | ~~~~~~~~~~~ |
| 7577 | |
| 7578 | Returns consumer according to ConsumerID |
| 7579 | |
| 7580 | Parameters |
| 7581 | ~~~~~~~~~~ |
| 7582 | |
| 7583 | +------------------+--------------------------+----------------------------------+ |
| 7584 | | Type | Name | Schema | |
| 7585 | +==================+==========================+==================================+ |
| 7586 | | **Header** | **USER\_ID**\ *optional* | string | |
| 7587 | +------------------+--------------------------+----------------------------------+ |
| 7588 | | **Path** | **consumerId**\ *require | string | |
| 7589 | | | d* | | |
| 7590 | +------------------+--------------------------+----------------------------------+ |
| 7591 | |
| 7592 | Responses |
| 7593 | ~~~~~~~~~ |
| 7594 | |
| 7595 | +---------+----------------------------------------------------+----------------+ |
| 7596 | | HTTP | Description | Schema | |
| 7597 | | Code | | | |
| 7598 | +=========+====================================================+================+ |
| 7599 | | **200** | Consumer found | No Content | |
| 7600 | +---------+----------------------------------------------------+----------------+ |
| 7601 | | **403** | Restricted operation | No Content | |
| 7602 | +---------+----------------------------------------------------+----------------+ |
| 7603 | | **404** | Consumer not found | No Content | |
| 7604 | +---------+----------------------------------------------------+----------------+ |
| 7605 | |
| 7606 | Consumes |
| 7607 | ~~~~~~~~ |
| 7608 | |
| 7609 | - ``application/json`` |
| 7610 | |
| 7611 | Produces |
| 7612 | ~~~~~~~~ |
| 7613 | |
| 7614 | - ``application/json`` |
| 7615 | |
| 7616 | Tags |
| 7617 | ~~~~ |
| 7618 | |
| 7619 | - Consumer Servlet |
| 7620 | |
| 7621 | Deletes Consumer |
| 7622 | ---------------- |
| 7623 | |
| 7624 | :: |
| 7625 | |
| 7626 | DELETE /v1/consumers/{consumerId} |
| 7627 | |
| 7628 | Description |
| 7629 | ~~~~~~~~~~~ |
| 7630 | |
| 7631 | Returns deleted consumer according to ConsumerID |
| 7632 | |
| 7633 | Parameters |
| 7634 | ~~~~~~~~~~ |
| 7635 | |
| 7636 | +------------------+--------------------------+----------------------------------+ |
| 7637 | | Type | Name | Schema | |
| 7638 | +==================+==========================+==================================+ |
| 7639 | | **Header** | **USER\_ID**\ *optional* | string | |
| 7640 | +------------------+--------------------------+----------------------------------+ |
| 7641 | | **Path** | **consumerId**\ *require | string | |
| 7642 | | | d* | | |
| 7643 | +------------------+--------------------------+----------------------------------+ |
| 7644 | |
| 7645 | Responses |
| 7646 | ~~~~~~~~~ |
| 7647 | |
| 7648 | +---------+----------------------------------------------------+----------------+ |
| 7649 | | HTTP | Description | Schema | |
| 7650 | | Code | | | |
| 7651 | +=========+====================================================+================+ |
| 7652 | | **200** | successful operation | `ConsumerDefin | |
| 7653 | | | | ition <#_consu | |
| 7654 | | | | merdefinition> | |
| 7655 | | | | `__ | |
| 7656 | +---------+----------------------------------------------------+----------------+ |
| 7657 | | **204** | Consumer deleted | No Content | |
| 7658 | +---------+----------------------------------------------------+----------------+ |
| 7659 | | **403** | Restricted operation | No Content | |
| 7660 | +---------+----------------------------------------------------+----------------+ |
| 7661 | | **404** | Consumer not found | No Content | |
| 7662 | +---------+----------------------------------------------------+----------------+ |
| 7663 | |
| 7664 | Consumes |
| 7665 | ~~~~~~~~ |
| 7666 | |
| 7667 | - ``application/json`` |
| 7668 | |
| 7669 | Produces |
| 7670 | ~~~~~~~~ |
| 7671 | |
| 7672 | - ``application/json`` |
| 7673 | |
| 7674 | Tags |
| 7675 | ~~~~ |
| 7676 | |
| 7677 | - Consumer Servlet |
| 7678 | |
Idan Amit | fc411f0 | 2017-10-23 12:36:06 +0300 | [diff] [blame] | 7679 | Retrieve ONAP portal menu - MOC |
| 7680 | ------------------------------- |
Idan Amit | 6e30a1b | 2017-10-18 09:51:10 +0300 | [diff] [blame] | 7681 | |
| 7682 | :: |
| 7683 | |
| 7684 | GET /v1/ecompPortalMenu |
| 7685 | |
| 7686 | Description |
| 7687 | ~~~~~~~~~~~ |
| 7688 | |
Idan Amit | fc411f0 | 2017-10-23 12:36:06 +0300 | [diff] [blame] | 7689 | Retrieve ONAP portal menu |
Idan Amit | 6e30a1b | 2017-10-18 09:51:10 +0300 | [diff] [blame] | 7690 | |
| 7691 | Responses |
| 7692 | ~~~~~~~~~ |
| 7693 | |
| 7694 | +---------+----------------------------------------------------+----------------+ |
| 7695 | | HTTP | Description | Schema | |
| 7696 | | Code | | | |
| 7697 | +=========+====================================================+================+ |
Idan Amit | fc411f0 | 2017-10-23 12:36:06 +0300 | [diff] [blame] | 7698 | | **200** | Retrieve ONAP portal menu | No Content | |
Idan Amit | 6e30a1b | 2017-10-18 09:51:10 +0300 | [diff] [blame] | 7699 | +---------+----------------------------------------------------+----------------+ |
| 7700 | |
| 7701 | Consumes |
| 7702 | ~~~~~~~~ |
| 7703 | |
| 7704 | - ``application/json`` |
| 7705 | |
| 7706 | Produces |
| 7707 | ~~~~~~~~ |
| 7708 | |
| 7709 | - ``application/json`` |
| 7710 | |
| 7711 | Tags |
| 7712 | ~~~~ |
| 7713 | |
| 7714 | - Element Servlet |
| 7715 | |
| 7716 | Retrieve all followed |
| 7717 | --------------------- |
| 7718 | |
| 7719 | :: |
| 7720 | |
| 7721 | GET /v1/followed |
| 7722 | |
| 7723 | Description |
| 7724 | ~~~~~~~~~~~ |
| 7725 | |
| 7726 | Retrieve all followed |
| 7727 | |
| 7728 | Parameters |
| 7729 | ~~~~~~~~~~ |
| 7730 | |
| 7731 | +------------------+--------------------------+----------------------------------+ |
| 7732 | | Type | Name | Schema | |
| 7733 | +==================+==========================+==================================+ |
| 7734 | | **Header** | **USER\_ID**\ *optional* | string | |
| 7735 | +------------------+--------------------------+----------------------------------+ |
| 7736 | |
| 7737 | Responses |
| 7738 | ~~~~~~~~~ |
| 7739 | |
| 7740 | +---------+----------------------------------------------------+----------------+ |
| 7741 | | HTTP | Description | Schema | |
| 7742 | | Code | | | |
| 7743 | +=========+====================================================+================+ |
| 7744 | | **200** | Returns followed Ok | No Content | |
| 7745 | +---------+----------------------------------------------------+----------------+ |
| 7746 | | **404** | User not found | No Content | |
| 7747 | +---------+----------------------------------------------------+----------------+ |
| 7748 | | **500** | Internal Server Error | No Content | |
| 7749 | +---------+----------------------------------------------------+----------------+ |
| 7750 | |
| 7751 | Consumes |
| 7752 | ~~~~~~~~ |
| 7753 | |
| 7754 | - ``application/json`` |
| 7755 | |
| 7756 | Produces |
| 7757 | ~~~~~~~~ |
| 7758 | |
| 7759 | - ``application/json`` |
| 7760 | |
| 7761 | Tags |
| 7762 | ~~~~ |
| 7763 | |
| 7764 | - Element Servlet |
| 7765 | |
| 7766 | DELETE /v1/inactiveComponents/{componenttype} |
| 7767 | --------------------------------------------- |
| 7768 | |
| 7769 | Parameters |
| 7770 | ~~~~~~~~~~ |
| 7771 | |
| 7772 | +------------------+--------------------------+----------------------------------+ |
| 7773 | | Type | Name | Schema | |
| 7774 | +==================+==========================+==================================+ |
| 7775 | | **Path** | **componentType**\ *requ | string | |
| 7776 | | | ired* | | |
| 7777 | +------------------+--------------------------+----------------------------------+ |
| 7778 | |
| 7779 | Responses |
| 7780 | ~~~~~~~~~ |
| 7781 | |
| 7782 | +---------+----------------------------------------------------+----------------+ |
| 7783 | | HTTP | Description | Schema | |
| 7784 | | Code | | | |
| 7785 | +=========+====================================================+================+ |
| 7786 | | **defau | successful operation | No Content | |
| 7787 | | lt** | | | |
| 7788 | +---------+----------------------------------------------------+----------------+ |
| 7789 | |
| 7790 | Tags |
| 7791 | ~~~~ |
| 7792 | |
| 7793 | - Element Servlet |
| 7794 | |
| 7795 | Retrieve all propertyScopes |
| 7796 | --------------------------- |
| 7797 | |
| 7798 | :: |
| 7799 | |
| 7800 | GET /v1/propertyScopes |
| 7801 | |
| 7802 | Description |
| 7803 | ~~~~~~~~~~~ |
| 7804 | |
| 7805 | Retrieve all propertyScopes |
| 7806 | |
| 7807 | Parameters |
| 7808 | ~~~~~~~~~~ |
| 7809 | |
| 7810 | +------------------+--------------------------+----------------------------------+ |
| 7811 | | Type | Name | Schema | |
| 7812 | +==================+==========================+==================================+ |
| 7813 | | **Header** | **USER\_ID**\ *optional* | string | |
| 7814 | +------------------+--------------------------+----------------------------------+ |
| 7815 | |
| 7816 | Responses |
| 7817 | ~~~~~~~~~ |
| 7818 | |
| 7819 | +---------+----------------------------------------------------+----------------+ |
| 7820 | | HTTP | Description | Schema | |
| 7821 | | Code | | | |
| 7822 | +=========+====================================================+================+ |
| 7823 | | **200** | Returns propertyScopes Ok | No Content | |
| 7824 | +---------+----------------------------------------------------+----------------+ |
| 7825 | | **404** | No propertyScopes were found | No Content | |
| 7826 | +---------+----------------------------------------------------+----------------+ |
| 7827 | | **500** | Internal Server Error | No Content | |
| 7828 | +---------+----------------------------------------------------+----------------+ |
| 7829 | |
| 7830 | Consumes |
| 7831 | ~~~~~~~~ |
| 7832 | |
| 7833 | - ``application/json`` |
| 7834 | |
| 7835 | Produces |
| 7836 | ~~~~~~~~ |
| 7837 | |
| 7838 | - ``application/json`` |
| 7839 | |
| 7840 | Tags |
| 7841 | ~~~~ |
| 7842 | |
| 7843 | - Element Servlet |
| 7844 | |
| 7845 | Retrieve catalog resources and services |
| 7846 | --------------------------------------- |
| 7847 | |
| 7848 | :: |
| 7849 | |
| 7850 | GET /v1/screen |
| 7851 | |
| 7852 | Description |
| 7853 | ~~~~~~~~~~~ |
| 7854 | |
| 7855 | Retrieve catalog resources and services |
| 7856 | |
| 7857 | Parameters |
| 7858 | ~~~~~~~~~~ |
| 7859 | |
| 7860 | +------------------+--------------------------+----------------------------------+ |
| 7861 | | Type | Name | Schema | |
| 7862 | +==================+==========================+==================================+ |
| 7863 | | **Header** | **USER\_ID**\ *optional* | string | |
| 7864 | +------------------+--------------------------+----------------------------------+ |
| 7865 | | **Query** | **excludeTypes**\ *optio | < enum (PRODUCT, SERVICE, VF, | |
| 7866 | | | nal* | VFC, CP, VL, VFCMT, CVFC, PNF) > | |
| 7867 | | | | array(multi) | |
| 7868 | +------------------+--------------------------+----------------------------------+ |
| 7869 | |
| 7870 | Responses |
| 7871 | ~~~~~~~~~ |
| 7872 | |
| 7873 | +---------+----------------------------------------------------+----------------+ |
| 7874 | | HTTP | Description | Schema | |
| 7875 | | Code | | | |
| 7876 | +=========+====================================================+================+ |
| 7877 | | **200** | Returns resources and services Ok | No Content | |
| 7878 | +---------+----------------------------------------------------+----------------+ |
| 7879 | | **404** | User not found | No Content | |
| 7880 | +---------+----------------------------------------------------+----------------+ |
| 7881 | | **500** | Internal Server Error | No Content | |
| 7882 | +---------+----------------------------------------------------+----------------+ |
| 7883 | |
| 7884 | Consumes |
| 7885 | ~~~~~~~~ |
| 7886 | |
| 7887 | - ``application/json`` |
| 7888 | |
| 7889 | Produces |
| 7890 | ~~~~~~~~ |
| 7891 | |
| 7892 | - ``application/json`` |
| 7893 | |
| 7894 | Tags |
| 7895 | ~~~~ |
| 7896 | |
| 7897 | - Element Servlet |
| 7898 | |
| 7899 | Retrieve all tags |
| 7900 | ----------------- |
| 7901 | |
| 7902 | :: |
| 7903 | |
| 7904 | GET /v1/tags |
| 7905 | |
| 7906 | Description |
| 7907 | ~~~~~~~~~~~ |
| 7908 | |
| 7909 | Retrieve all tags |
| 7910 | |
| 7911 | Parameters |
| 7912 | ~~~~~~~~~~ |
| 7913 | |
| 7914 | +------------------+--------------------------+----------------------------------+ |
| 7915 | | Type | Name | Schema | |
| 7916 | +==================+==========================+==================================+ |
| 7917 | | **Header** | **USER\_ID**\ *optional* | string | |
| 7918 | +------------------+--------------------------+----------------------------------+ |
| 7919 | |
| 7920 | Responses |
| 7921 | ~~~~~~~~~ |
| 7922 | |
| 7923 | +---------+----------------------------------------------------+----------------+ |
| 7924 | | HTTP | Description | Schema | |
| 7925 | | Code | | | |
| 7926 | +=========+====================================================+================+ |
| 7927 | | **200** | Returns tags Ok | No Content | |
| 7928 | +---------+----------------------------------------------------+----------------+ |
| 7929 | | **404** | No tags were found | No Content | |
| 7930 | +---------+----------------------------------------------------+----------------+ |
| 7931 | | **500** | Internal Server Error | No Content | |
| 7932 | +---------+----------------------------------------------------+----------------+ |
| 7933 | |
| 7934 | Consumes |
| 7935 | ~~~~~~~~ |
| 7936 | |
| 7937 | - ``application/json`` |
| 7938 | |
| 7939 | Produces |
| 7940 | ~~~~~~~~ |
| 7941 | |
| 7942 | - ``application/json`` |
| 7943 | |
| 7944 | Tags |
| 7945 | ~~~~ |
| 7946 | |
| 7947 | - Element Servlet |
| 7948 | |
| 7949 | add user |
| 7950 | -------- |
| 7951 | |
| 7952 | :: |
| 7953 | |
| 7954 | POST /v1/user |
| 7955 | |
| 7956 | Description |
| 7957 | ~~~~~~~~~~~ |
| 7958 | |
| 7959 | Provision new user |
| 7960 | |
| 7961 | Parameters |
| 7962 | ~~~~~~~~~~ |
| 7963 | |
| 7964 | +----------+-------------+--------------------------------------+------------------+ |
| 7965 | | Type | Name | Description | Schema | |
| 7966 | +==========+=============+======================================+==================+ |
| 7967 | | **Header | **USER\_ID* | | string | |
| 7968 | | ** | *\ *optiona | | | |
| 7969 | | | l* | | | |
| 7970 | +----------+-------------+--------------------------------------+------------------+ |
| 7971 | | **Body** | **body**\ * | json describe the user | string | |
| 7972 | | | required* | | | |
| 7973 | +----------+-------------+--------------------------------------+------------------+ |
| 7974 | |
| 7975 | Responses |
| 7976 | ~~~~~~~~~ |
| 7977 | |
| 7978 | +---------+----------------------------------------------------+----------------+ |
| 7979 | | HTTP | Description | Schema | |
| 7980 | | Code | | | |
| 7981 | +=========+====================================================+================+ |
| 7982 | | **200** | successful operation | `User <#_user> | |
| 7983 | | | | `__ | |
| 7984 | +---------+----------------------------------------------------+----------------+ |
| 7985 | | **201** | New user created | No Content | |
| 7986 | +---------+----------------------------------------------------+----------------+ |
| 7987 | | **400** | Invalid Content. | No Content | |
| 7988 | +---------+----------------------------------------------------+----------------+ |
| 7989 | | **403** | Missing information | No Content | |
| 7990 | +---------+----------------------------------------------------+----------------+ |
| 7991 | | **405** | Method Not Allowed | No Content | |
| 7992 | +---------+----------------------------------------------------+----------------+ |
| 7993 | | **409** | User already exists | No Content | |
| 7994 | +---------+----------------------------------------------------+----------------+ |
| 7995 | | **500** | Internal Server Error | No Content | |
| 7996 | +---------+----------------------------------------------------+----------------+ |
| 7997 | |
| 7998 | Consumes |
| 7999 | ~~~~~~~~ |
| 8000 | |
| 8001 | - ``application/json`` |
| 8002 | |
| 8003 | Produces |
| 8004 | ~~~~~~~~ |
| 8005 | |
| 8006 | - ``application/json`` |
| 8007 | |
| 8008 | Tags |
| 8009 | ~~~~ |
| 8010 | |
| 8011 | - User Administration |
| 8012 | |
| 8013 | retrieve all administrators |
| 8014 | --------------------------- |
| 8015 | |
| 8016 | :: |
| 8017 | |
| 8018 | GET /v1/user/admins |
| 8019 | |
| 8020 | Description |
| 8021 | ~~~~~~~~~~~ |
| 8022 | |
| 8023 | Returns all administrators |
| 8024 | |
| 8025 | Parameters |
| 8026 | ~~~~~~~~~~ |
| 8027 | |
| 8028 | +------------------+--------------------------+----------------------------------+ |
| 8029 | | Type | Name | Schema | |
| 8030 | +==================+==========================+==================================+ |
| 8031 | | **Path** | **userId**\ *required* | string | |
| 8032 | +------------------+--------------------------+----------------------------------+ |
| 8033 | |
| 8034 | Responses |
| 8035 | ~~~~~~~~~ |
| 8036 | |
| 8037 | +---------+----------------------------------------------------+----------------+ |
| 8038 | | HTTP | Description | Schema | |
| 8039 | | Code | | | |
| 8040 | +=========+====================================================+================+ |
| 8041 | | **200** | Returns user Ok | No Content | |
| 8042 | +---------+----------------------------------------------------+----------------+ |
| 8043 | | **405** | Method Not Allowed | No Content | |
| 8044 | +---------+----------------------------------------------------+----------------+ |
| 8045 | | **500** | Internal Server Error | No Content | |
| 8046 | +---------+----------------------------------------------------+----------------+ |
| 8047 | |
| 8048 | Consumes |
| 8049 | ~~~~~~~~ |
| 8050 | |
| 8051 | - ``application/json`` |
| 8052 | |
| 8053 | Produces |
| 8054 | ~~~~~~~~ |
| 8055 | |
| 8056 | - ``application/json`` |
| 8057 | |
| 8058 | Tags |
| 8059 | ~~~~ |
| 8060 | |
| 8061 | - User Administration |
| 8062 | |
| 8063 | authorize |
| 8064 | --------- |
| 8065 | |
| 8066 | :: |
| 8067 | |
| 8068 | GET /v1/user/authorize |
| 8069 | |
| 8070 | Description |
| 8071 | ~~~~~~~~~~~ |
| 8072 | |
| 8073 | authorize user |
| 8074 | |
| 8075 | Parameters |
| 8076 | ~~~~~~~~~~ |
| 8077 | |
| 8078 | +------------------+--------------------------+----------------------------------+ |
| 8079 | | Type | Name | Schema | |
| 8080 | +==================+==========================+==================================+ |
| 8081 | | **Header** | **HTTP\_CSP\_EMAIL**\ *o | string | |
| 8082 | | | ptional* | | |
| 8083 | +------------------+--------------------------+----------------------------------+ |
| 8084 | | **Header** | **HTTP\_CSP\_FIRSTNAME** | string | |
| 8085 | | | \ *optional* | | |
| 8086 | +------------------+--------------------------+----------------------------------+ |
| 8087 | | **Header** | **HTTP\_CSP\_LASTNAME**\ | string | |
| 8088 | | | *optional* | | |
| 8089 | +------------------+--------------------------+----------------------------------+ |
| 8090 | | **Header** | **USER\_ID**\ *optional* | string | |
| 8091 | +------------------+--------------------------+----------------------------------+ |
| 8092 | |
| 8093 | Responses |
| 8094 | ~~~~~~~~~ |
| 8095 | |
| 8096 | +---------+----------------------------------------------------+----------------+ |
| 8097 | | HTTP | Description | Schema | |
| 8098 | | Code | | | |
| 8099 | +=========+====================================================+================+ |
| 8100 | | **200** | Returns user Ok | No Content | |
| 8101 | +---------+----------------------------------------------------+----------------+ |
| 8102 | | **403** | Restricted Access | No Content | |
| 8103 | +---------+----------------------------------------------------+----------------+ |
| 8104 | | **500** | Internal Server Error | No Content | |
| 8105 | +---------+----------------------------------------------------+----------------+ |
| 8106 | |
| 8107 | Consumes |
| 8108 | ~~~~~~~~ |
| 8109 | |
| 8110 | - ``application/json`` |
| 8111 | |
| 8112 | Produces |
| 8113 | ~~~~~~~~ |
| 8114 | |
| 8115 | - ``application/json`` |
| 8116 | |
| 8117 | Tags |
| 8118 | ~~~~ |
| 8119 | |
| 8120 | - User Administration |
| 8121 | |
| 8122 | Retrieve the list of all active ASDC users or only group of users having specific roles. |
| 8123 | ---------------------------------------------------------------------------------------- |
| 8124 | |
| 8125 | :: |
| 8126 | |
| 8127 | GET /v1/user/users |
| 8128 | |
| 8129 | Description |
| 8130 | ~~~~~~~~~~~ |
| 8131 | |
| 8132 | Returns list of users with the specified roles, or all of users in the |
| 8133 | case of empty *roles* header |
| 8134 | |
| 8135 | Parameters |
| 8136 | ~~~~~~~~~~ |
| 8137 | |
| 8138 | +----------+-------------+--------------------------------------+------------------+ |
| 8139 | | Type | Name | Description | Schema | |
| 8140 | +==========+=============+======================================+==================+ |
| 8141 | | **Header | **USER\_ID* | Any active user’s USER\_ID | string | |
| 8142 | | ** | *\ *optiona | | | |
| 8143 | | | l* | | | |
| 8144 | +----------+-------------+--------------------------------------+------------------+ |
| 8145 | | **Query* | **roles**\ | TESTER,DESIGNER,PRODUCT\_STRATEGIST, | string | |
| 8146 | | * | *optional* | OPS,PRODUCT\_MANAGER,GOVERNOR, | | |
| 8147 | | | | ADMIN OR all users by not typing | | |
| 8148 | | | | anything | | |
| 8149 | +----------+-------------+--------------------------------------+------------------+ |
| 8150 | |
| 8151 | Responses |
| 8152 | ~~~~~~~~~ |
| 8153 | |
| 8154 | +---------+----------------------------------------------------+----------------+ |
| 8155 | | HTTP | Description | Schema | |
| 8156 | | Code | | | |
| 8157 | +=========+====================================================+================+ |
| 8158 | | **200** | Returns users Ok | No Content | |
| 8159 | +---------+----------------------------------------------------+----------------+ |
| 8160 | | **204** | No provisioned ASDC users of requested role | No Content | |
| 8161 | +---------+----------------------------------------------------+----------------+ |
| 8162 | | **400** | Missing content | No Content | |
| 8163 | +---------+----------------------------------------------------+----------------+ |
| 8164 | | **403** | Restricted Access | No Content | |
| 8165 | +---------+----------------------------------------------------+----------------+ |
| 8166 | | **500** | Internal Server Error | No Content | |
| 8167 | +---------+----------------------------------------------------+----------------+ |
| 8168 | |
| 8169 | Consumes |
| 8170 | ~~~~~~~~ |
| 8171 | |
| 8172 | - ``application/json`` |
| 8173 | |
| 8174 | Produces |
| 8175 | ~~~~~~~~ |
| 8176 | |
| 8177 | - ``application/json`` |
| 8178 | |
| 8179 | Tags |
| 8180 | ~~~~ |
| 8181 | |
| 8182 | - User Administration |
| 8183 | |
| 8184 | retrieve user details |
| 8185 | --------------------- |
| 8186 | |
| 8187 | :: |
| 8188 | |
| 8189 | GET /v1/user/{userId} |
| 8190 | |
| 8191 | Description |
| 8192 | ~~~~~~~~~~~ |
| 8193 | |
| 8194 | Returns user details according to userId |
| 8195 | |
| 8196 | Parameters |
| 8197 | ~~~~~~~~~~ |
| 8198 | |
| 8199 | +----------+-------------+--------------------------------------+------------------+ |
| 8200 | | Type | Name | Description | Schema | |
| 8201 | +==========+=============+======================================+==================+ |
| 8202 | | **Path** | **userId**\ | userId of user to get | string | |
| 8203 | | | *required* | | | |
| 8204 | +----------+-------------+--------------------------------------+------------------+ |
| 8205 | |
| 8206 | Responses |
| 8207 | ~~~~~~~~~ |
| 8208 | |
| 8209 | +---------+----------------------------------------------------+----------------+ |
| 8210 | | HTTP | Description | Schema | |
| 8211 | | Code | | | |
| 8212 | +=========+====================================================+================+ |
| 8213 | | **200** | Returns user Ok | No Content | |
| 8214 | +---------+----------------------------------------------------+----------------+ |
| 8215 | | **404** | User not found | No Content | |
| 8216 | +---------+----------------------------------------------------+----------------+ |
| 8217 | | **405** | Method Not Allowed | No Content | |
| 8218 | +---------+----------------------------------------------------+----------------+ |
| 8219 | | **500** | Internal Server Error | No Content | |
| 8220 | +---------+----------------------------------------------------+----------------+ |
| 8221 | |
| 8222 | Consumes |
| 8223 | ~~~~~~~~ |
| 8224 | |
| 8225 | - ``application/json`` |
| 8226 | |
| 8227 | Produces |
| 8228 | ~~~~~~~~ |
| 8229 | |
| 8230 | - ``application/json`` |
| 8231 | |
| 8232 | Tags |
| 8233 | ~~~~ |
| 8234 | |
| 8235 | - User Administration |
| 8236 | |
| 8237 | delete user |
| 8238 | ----------- |
| 8239 | |
| 8240 | :: |
| 8241 | |
| 8242 | DELETE /v1/user/{userId} |
| 8243 | |
| 8244 | Description |
| 8245 | ~~~~~~~~~~~ |
| 8246 | |
| 8247 | Delete user |
| 8248 | |
| 8249 | Parameters |
| 8250 | ~~~~~~~~~~ |
| 8251 | |
| 8252 | +----------+-------------+--------------------------------------+------------------+ |
| 8253 | | Type | Name | Description | Schema | |
| 8254 | +==========+=============+======================================+==================+ |
| 8255 | | **Header | **USER\_ID* | | string | |
| 8256 | | ** | *\ *optiona | | | |
| 8257 | | | l* | | | |
| 8258 | +----------+-------------+--------------------------------------+------------------+ |
| 8259 | | **Path** | **userId**\ | userId of user to get | string | |
| 8260 | | | *required* | | | |
| 8261 | +----------+-------------+--------------------------------------+------------------+ |
| 8262 | |
| 8263 | Responses |
| 8264 | ~~~~~~~~~ |
| 8265 | |
| 8266 | +---------+----------------------------------------------------+----------------+ |
| 8267 | | HTTP | Description | Schema | |
| 8268 | | Code | | | |
| 8269 | +=========+====================================================+================+ |
| 8270 | | **200** | Update deleted OK | No Content | |
| 8271 | +---------+----------------------------------------------------+----------------+ |
| 8272 | | **400** | Invalid Content. | No Content | |
| 8273 | +---------+----------------------------------------------------+----------------+ |
| 8274 | | **403** | Missing information | No Content | |
| 8275 | +---------+----------------------------------------------------+----------------+ |
| 8276 | | **404** | User not found | No Content | |
| 8277 | +---------+----------------------------------------------------+----------------+ |
| 8278 | | **405** | Method Not Allowed | No Content | |
| 8279 | +---------+----------------------------------------------------+----------------+ |
| 8280 | | **409** | Restricted operation | No Content | |
| 8281 | +---------+----------------------------------------------------+----------------+ |
| 8282 | | **500** | Internal Server Error | No Content | |
| 8283 | +---------+----------------------------------------------------+----------------+ |
| 8284 | |
| 8285 | Consumes |
| 8286 | ~~~~~~~~ |
| 8287 | |
| 8288 | - ``application/json`` |
| 8289 | |
| 8290 | Produces |
| 8291 | ~~~~~~~~ |
| 8292 | |
| 8293 | - ``application/json`` |
| 8294 | |
| 8295 | Tags |
| 8296 | ~~~~ |
| 8297 | |
| 8298 | - User Administration |
| 8299 | |
| 8300 | update user role |
| 8301 | ---------------- |
| 8302 | |
| 8303 | :: |
| 8304 | |
| 8305 | POST /v1/user/{userId}/role |
| 8306 | |
| 8307 | Description |
| 8308 | ~~~~~~~~~~~ |
| 8309 | |
| 8310 | Update user role |
| 8311 | |
| 8312 | Parameters |
| 8313 | ~~~~~~~~~~ |
| 8314 | |
| 8315 | +----------+-------------+--------------------------------------+------------------+ |
| 8316 | | Type | Name | Description | Schema | |
| 8317 | +==========+=============+======================================+==================+ |
| 8318 | | **Header | **USER\_ID* | | string | |
| 8319 | | ** | *\ *optiona | | | |
| 8320 | | | l* | | | |
| 8321 | +----------+-------------+--------------------------------------+------------------+ |
| 8322 | | **Path** | **userId**\ | userId of user to get | string | |
| 8323 | | | *required* | | | |
| 8324 | +----------+-------------+--------------------------------------+------------------+ |
| 8325 | | **Body** | **body**\ * | json describe the update role | string | |
| 8326 | | | required* | | | |
| 8327 | +----------+-------------+--------------------------------------+------------------+ |
| 8328 | |
| 8329 | Responses |
| 8330 | ~~~~~~~~~ |
| 8331 | |
| 8332 | +---------+----------------------------------------------------+----------------+ |
| 8333 | | HTTP | Description | Schema | |
| 8334 | | Code | | | |
| 8335 | +=========+====================================================+================+ |
| 8336 | | **200** | Update user OK | No Content | |
| 8337 | +---------+----------------------------------------------------+----------------+ |
| 8338 | | **400** | Invalid Content. | No Content | |
| 8339 | +---------+----------------------------------------------------+----------------+ |
| 8340 | | **403** | Missing information/Restricted operation | No Content | |
| 8341 | +---------+----------------------------------------------------+----------------+ |
| 8342 | | **404** | User not found | No Content | |
| 8343 | +---------+----------------------------------------------------+----------------+ |
| 8344 | | **405** | Method Not Allowed | No Content | |
| 8345 | +---------+----------------------------------------------------+----------------+ |
| 8346 | | **409** | User already exists | No Content | |
| 8347 | +---------+----------------------------------------------------+----------------+ |
| 8348 | | **500** | Internal Server Error | No Content | |
| 8349 | +---------+----------------------------------------------------+----------------+ |
| 8350 | |
| 8351 | Consumes |
| 8352 | ~~~~~~~~ |
| 8353 | |
| 8354 | - ``application/json`` |
| 8355 | |
| 8356 | Produces |
| 8357 | ~~~~~~~~ |
| 8358 | |
| 8359 | - ``application/json`` |
| 8360 | |
| 8361 | Tags |
| 8362 | ~~~~ |
| 8363 | |
| 8364 | - User Administration |
| 8365 | |
| 8366 | retrieve user role |
| 8367 | ------------------ |
| 8368 | |
| 8369 | :: |
| 8370 | |
| 8371 | GET /v1/user/{userId}/role |
| 8372 | |
| 8373 | Description |
| 8374 | ~~~~~~~~~~~ |
| 8375 | |
| 8376 | Returns user role according to userId |
| 8377 | |
| 8378 | Parameters |
| 8379 | ~~~~~~~~~~ |
| 8380 | |
| 8381 | +----------+-------------+--------------------------------------+------------------+ |
| 8382 | | Type | Name | Description | Schema | |
| 8383 | +==========+=============+======================================+==================+ |
| 8384 | | **Path** | **userId**\ | userId of user to get | string | |
| 8385 | | | *required* | | | |
| 8386 | +----------+-------------+--------------------------------------+------------------+ |
| 8387 | |
| 8388 | Responses |
| 8389 | ~~~~~~~~~ |
| 8390 | |
| 8391 | +---------+----------------------------------------------------+----------------+ |
| 8392 | | HTTP | Description | Schema | |
| 8393 | | Code | | | |
| 8394 | +=========+====================================================+================+ |
| 8395 | | **200** | Returns user role Ok | No Content | |
| 8396 | +---------+----------------------------------------------------+----------------+ |
| 8397 | | **404** | User not found | No Content | |
| 8398 | +---------+----------------------------------------------------+----------------+ |
| 8399 | | **405** | Method Not Allowed | No Content | |
| 8400 | +---------+----------------------------------------------------+----------------+ |
| 8401 | | **500** | Internal Server Error | No Content | |
| 8402 | +---------+----------------------------------------------------+----------------+ |
| 8403 | |
| 8404 | Consumes |
| 8405 | ~~~~~~~~ |
| 8406 | |
| 8407 | - ``application/json`` |
| 8408 | |
| 8409 | Produces |
| 8410 | ~~~~~~~~ |
| 8411 | |
| 8412 | - ``application/json`` |
| 8413 | |
| 8414 | Tags |
| 8415 | ~~~~ |
| 8416 | |
| 8417 | - User Administration |
| 8418 | |
| 8419 | return the ASDC application version |
| 8420 | ----------------------------------- |
| 8421 | |
| 8422 | :: |
| 8423 | |
| 8424 | GET /version |
| 8425 | |
| 8426 | Description |
| 8427 | ~~~~~~~~~~~ |
| 8428 | |
| 8429 | return the ASDC application version |
| 8430 | |
| 8431 | Responses |
| 8432 | ~~~~~~~~~ |
| 8433 | |
| 8434 | +---------+----------------------------------------------------+----------------+ |
| 8435 | | HTTP | Description | Schema | |
| 8436 | | Code | | | |
| 8437 | +=========+====================================================+================+ |
| 8438 | | **200** | return ASDC version | No Content | |
| 8439 | +---------+----------------------------------------------------+----------------+ |
| 8440 | | **500** | Internal Error | No Content | |
| 8441 | +---------+----------------------------------------------------+----------------+ |
| 8442 | |
| 8443 | Consumes |
| 8444 | ~~~~~~~~ |
| 8445 | |
| 8446 | - ``application/json`` |
| 8447 | |
| 8448 | Produces |
| 8449 | ~~~~~~~~ |
| 8450 | |
| 8451 | - ``application/json`` |
| 8452 | |
| 8453 | Tags |
| 8454 | ~~~~ |
| 8455 | |
| 8456 | - BE Monitoring |
| 8457 | |
| 8458 | Definitions |
| 8459 | =========== |
| 8460 | |
| 8461 | AdditionalInfoParameterInfo |
| 8462 | --------------------------- |
| 8463 | |
| 8464 | +--------------------------------+-------------------------------------------+ |
| 8465 | | Name | Schema | |
| 8466 | +================================+===========================================+ |
| 8467 | | **key**\ *optional* | string | |
| 8468 | +--------------------------------+-------------------------------------------+ |
| 8469 | | **ownerId**\ *optional* | string | |
| 8470 | +--------------------------------+-------------------------------------------+ |
| 8471 | | **uniqueId**\ *optional* | string | |
| 8472 | +--------------------------------+-------------------------------------------+ |
| 8473 | | **value**\ *optional* | string | |
| 8474 | +--------------------------------+-------------------------------------------+ |
| 8475 | |
| 8476 | AdditionalInformationDefinition |
| 8477 | ------------------------------- |
| 8478 | |
| 8479 | +--------------------------------+-------------------------------------------+ |
| 8480 | | Name | Schema | |
| 8481 | +================================+===========================================+ |
| 8482 | | **creationTime**\ *optional* | integer (int64) | |
| 8483 | +--------------------------------+-------------------------------------------+ |
| 8484 | | **lastCreatedCounter**\ *optio | integer (int32) | |
| 8485 | | nal* | | |
| 8486 | +--------------------------------+-------------------------------------------+ |
| 8487 | | **modificationTime**\ *optiona | integer (int64) | |
| 8488 | | l* | | |
| 8489 | +--------------------------------+-------------------------------------------+ |
| 8490 | | **ownerId**\ *optional* | string | |
| 8491 | +--------------------------------+-------------------------------------------+ |
| 8492 | | **parameters**\ *optional* | < | |
| 8493 | | | `AdditionalInfoParameterInfo <#_additiona | |
| 8494 | | | linfoparameterinfo>`__ | |
| 8495 | | | > array | |
| 8496 | +--------------------------------+-------------------------------------------+ |
| 8497 | | **parentUniqueId**\ *optional* | string | |
| 8498 | +--------------------------------+-------------------------------------------+ |
| 8499 | | **uniqueId**\ *optional* | string | |
| 8500 | +--------------------------------+-------------------------------------------+ |
| 8501 | |
| 8502 | ArtifactDataDefinition |
| 8503 | ---------------------- |
| 8504 | |
| 8505 | +--------------------------------+-------------------------------------------+ |
| 8506 | | Name | Schema | |
| 8507 | +================================+===========================================+ |
| 8508 | | **apiUrl**\ *optional* | string | |
| 8509 | +--------------------------------+-------------------------------------------+ |
| 8510 | | **artifactChecksum**\ *optiona | string | |
| 8511 | | l* | | |
| 8512 | +--------------------------------+-------------------------------------------+ |
| 8513 | | **artifactCreator**\ *optional | string | |
| 8514 | | * | | |
| 8515 | +--------------------------------+-------------------------------------------+ |
| 8516 | | **artifactDisplayName**\ *opti | string | |
| 8517 | | onal* | | |
| 8518 | +--------------------------------+-------------------------------------------+ |
| 8519 | | **artifactGroupType**\ *option | enum (INFORMATIONAL, DEPLOYMENT, | |
| 8520 | | al* | LIFE\_CYCLE, SERVICE\_API, TOSCA, OTHER) | |
| 8521 | +--------------------------------+-------------------------------------------+ |
| 8522 | | **artifactLabel**\ *optional* | string | |
| 8523 | +--------------------------------+-------------------------------------------+ |
| 8524 | | **artifactName**\ *optional* | string | |
| 8525 | +--------------------------------+-------------------------------------------+ |
| 8526 | | **artifactRef**\ *optional* | string | |
| 8527 | +--------------------------------+-------------------------------------------+ |
| 8528 | | **artifactRepository**\ *optio | string | |
| 8529 | | nal* | | |
| 8530 | +--------------------------------+-------------------------------------------+ |
| 8531 | | **artifactType**\ *optional* | string | |
| 8532 | +--------------------------------+-------------------------------------------+ |
| 8533 | | **artifactUUID**\ *optional* | string | |
| 8534 | +--------------------------------+-------------------------------------------+ |
| 8535 | | **artifactVersion**\ *optional | string | |
| 8536 | | * | | |
| 8537 | +--------------------------------+-------------------------------------------+ |
| 8538 | | **creationDate**\ *optional* | integer (int64) | |
| 8539 | +--------------------------------+-------------------------------------------+ |
| 8540 | | **creatorFullName**\ *optional | string | |
| 8541 | | * | | |
| 8542 | +--------------------------------+-------------------------------------------+ |
| 8543 | | **description**\ *optional* | string | |
| 8544 | +--------------------------------+-------------------------------------------+ |
| 8545 | | **duplicated**\ *optional* | boolean | |
| 8546 | +--------------------------------+-------------------------------------------+ |
| 8547 | | **esId**\ *optional* | string | |
| 8548 | +--------------------------------+-------------------------------------------+ |
| 8549 | | **generated**\ *optional* | boolean | |
| 8550 | +--------------------------------+-------------------------------------------+ |
| 8551 | | **generatedFromId**\ *optional | string | |
| 8552 | | * | | |
| 8553 | +--------------------------------+-------------------------------------------+ |
| 8554 | | **heatParameters**\ *optional* | < | |
| 8555 | | | `HeatParameterDataDefinition <#_heatparam | |
| 8556 | | | eterdatadefinition>`__ | |
| 8557 | | | > array | |
| 8558 | +--------------------------------+-------------------------------------------+ |
| 8559 | | **heatParamsUpdateDate**\ *opt | integer (int64) | |
| 8560 | | ional* | | |
| 8561 | +--------------------------------+-------------------------------------------+ |
| 8562 | | **lastUpdateDate**\ *optional* | integer (int64) | |
| 8563 | +--------------------------------+-------------------------------------------+ |
| 8564 | | **mandatory**\ *optional* | boolean | |
| 8565 | +--------------------------------+-------------------------------------------+ |
| 8566 | | **ownerId**\ *optional* | string | |
| 8567 | +--------------------------------+-------------------------------------------+ |
| 8568 | | **payloadUpdateDate**\ *option | integer (int64) | |
| 8569 | | al* | | |
| 8570 | +--------------------------------+-------------------------------------------+ |
| 8571 | | **requiredArtifacts**\ *option | < string > array | |
| 8572 | | al* | | |
| 8573 | +--------------------------------+-------------------------------------------+ |
| 8574 | | **serviceApi**\ *optional* | boolean | |
| 8575 | +--------------------------------+-------------------------------------------+ |
| 8576 | | **timeout**\ *optional* | integer (int32) | |
| 8577 | +--------------------------------+-------------------------------------------+ |
| 8578 | | **uniqueId**\ *optional* | string | |
| 8579 | +--------------------------------+-------------------------------------------+ |
| 8580 | | **updaterFullName**\ *optional | string | |
| 8581 | | * | | |
| 8582 | +--------------------------------+-------------------------------------------+ |
| 8583 | | **userIdCreator**\ *optional* | string | |
| 8584 | +--------------------------------+-------------------------------------------+ |
| 8585 | | **userIdLastUpdater**\ *option | string | |
| 8586 | | al* | | |
| 8587 | +--------------------------------+-------------------------------------------+ |
| 8588 | |
| 8589 | ArtifactDefinition |
| 8590 | ------------------ |
| 8591 | |
| 8592 | +--------------------------------+-------------------------------------------+ |
| 8593 | | Name | Schema | |
| 8594 | +================================+===========================================+ |
| 8595 | | **apiUrl**\ *optional* | string | |
| 8596 | +--------------------------------+-------------------------------------------+ |
| 8597 | | **artifactChecksum**\ *optiona | string | |
| 8598 | | l* | | |
| 8599 | +--------------------------------+-------------------------------------------+ |
| 8600 | | **artifactCreator**\ *optional | string | |
| 8601 | | * | | |
| 8602 | +--------------------------------+-------------------------------------------+ |
| 8603 | | **artifactDisplayName**\ *opti | string | |
| 8604 | | onal* | | |
| 8605 | +--------------------------------+-------------------------------------------+ |
| 8606 | | **artifactGroupType**\ *option | enum (INFORMATIONAL, DEPLOYMENT, | |
| 8607 | | al* | LIFE\_CYCLE, SERVICE\_API, TOSCA, OTHER) | |
| 8608 | +--------------------------------+-------------------------------------------+ |
| 8609 | | **artifactLabel**\ *optional* | string | |
| 8610 | +--------------------------------+-------------------------------------------+ |
| 8611 | | **artifactName**\ *optional* | string | |
| 8612 | +--------------------------------+-------------------------------------------+ |
| 8613 | | **artifactRef**\ *optional* | string | |
| 8614 | +--------------------------------+-------------------------------------------+ |
| 8615 | | **artifactRepository**\ *optio | string | |
| 8616 | | nal* | | |
| 8617 | +--------------------------------+-------------------------------------------+ |
| 8618 | | **artifactType**\ *optional* | string | |
| 8619 | +--------------------------------+-------------------------------------------+ |
| 8620 | | **artifactUUID**\ *optional* | string | |
| 8621 | +--------------------------------+-------------------------------------------+ |
| 8622 | | **artifactVersion**\ *optional | string | |
| 8623 | | * | | |
| 8624 | +--------------------------------+-------------------------------------------+ |
| 8625 | | **creationDate**\ *optional* | integer (int64) | |
| 8626 | +--------------------------------+-------------------------------------------+ |
| 8627 | | **creatorFullName**\ *optional | string | |
| 8628 | | * | | |
| 8629 | +--------------------------------+-------------------------------------------+ |
| 8630 | | **description**\ *optional* | string | |
| 8631 | +--------------------------------+-------------------------------------------+ |
| 8632 | | **duplicated**\ *optional* | boolean | |
| 8633 | +--------------------------------+-------------------------------------------+ |
| 8634 | | **esId**\ *optional* | string | |
| 8635 | +--------------------------------+-------------------------------------------+ |
| 8636 | | **generated**\ *optional* | boolean | |
| 8637 | +--------------------------------+-------------------------------------------+ |
| 8638 | | **generatedFromId**\ *optional | string | |
| 8639 | | * | | |
| 8640 | +--------------------------------+-------------------------------------------+ |
| 8641 | | **heatParameters**\ *optional* | < | |
| 8642 | | | `HeatParameterDataDefinition <#_heatparam | |
| 8643 | | | eterdatadefinition>`__ | |
| 8644 | | | > array | |
| 8645 | +--------------------------------+-------------------------------------------+ |
| 8646 | | **heatParamsUpdateDate**\ *opt | integer (int64) | |
| 8647 | | ional* | | |
| 8648 | +--------------------------------+-------------------------------------------+ |
| 8649 | | **lastUpdateDate**\ *optional* | integer (int64) | |
| 8650 | +--------------------------------+-------------------------------------------+ |
| 8651 | | **listHeatParameters**\ *optio | < | |
| 8652 | | nal* | `HeatParameterDefinition <#_heatparameter | |
| 8653 | | | definition>`__ | |
| 8654 | | | > array | |
| 8655 | +--------------------------------+-------------------------------------------+ |
| 8656 | | **mandatory**\ *optional* | boolean | |
| 8657 | +--------------------------------+-------------------------------------------+ |
| 8658 | | **ownerId**\ *optional* | string | |
| 8659 | +--------------------------------+-------------------------------------------+ |
| 8660 | | **payloadData**\ *optional* | < string (byte) > array | |
| 8661 | +--------------------------------+-------------------------------------------+ |
| 8662 | | **payloadUpdateDate**\ *option | integer (int64) | |
| 8663 | | al* | | |
| 8664 | +--------------------------------+-------------------------------------------+ |
| 8665 | | **requiredArtifacts**\ *option | < string > array | |
| 8666 | | al* | | |
| 8667 | +--------------------------------+-------------------------------------------+ |
| 8668 | | **serviceApi**\ *optional* | boolean | |
| 8669 | +--------------------------------+-------------------------------------------+ |
| 8670 | | **timeout**\ *optional* | integer (int32) | |
| 8671 | +--------------------------------+-------------------------------------------+ |
| 8672 | | **uniqueId**\ *optional* | string | |
| 8673 | +--------------------------------+-------------------------------------------+ |
| 8674 | | **updaterFullName**\ *optional | string | |
| 8675 | | * | | |
| 8676 | +--------------------------------+-------------------------------------------+ |
| 8677 | | **userIdCreator**\ *optional* | string | |
| 8678 | +--------------------------------+-------------------------------------------+ |
| 8679 | | **userIdLastUpdater**\ *option | string | |
| 8680 | | al* | | |
| 8681 | +--------------------------------+-------------------------------------------+ |
| 8682 | |
| 8683 | CapabilityDefinition |
| 8684 | -------------------- |
| 8685 | |
| 8686 | +--------------------------------+-------------------------------------------+ |
| 8687 | | Name | Schema | |
| 8688 | +================================+===========================================+ |
| 8689 | | **capabilitySources**\ *option | < string > array | |
| 8690 | | al* | | |
| 8691 | +--------------------------------+-------------------------------------------+ |
| 8692 | | **description**\ *optional* | string | |
| 8693 | +--------------------------------+-------------------------------------------+ |
| 8694 | | **leftOccurrences**\ *optional | string | |
| 8695 | | * | | |
| 8696 | +--------------------------------+-------------------------------------------+ |
| 8697 | | **maxOccurrences**\ *optional* | string | |
| 8698 | +--------------------------------+-------------------------------------------+ |
| 8699 | | **minOccurrences**\ *optional* | string | |
| 8700 | +--------------------------------+-------------------------------------------+ |
| 8701 | | **name**\ *optional* | string | |
| 8702 | +--------------------------------+-------------------------------------------+ |
| 8703 | | **ownerId**\ *optional* | string | |
| 8704 | +--------------------------------+-------------------------------------------+ |
| 8705 | | **ownerName**\ *optional* | string | |
| 8706 | +--------------------------------+-------------------------------------------+ |
| 8707 | | **parentName**\ *optional* | string | |
| 8708 | +--------------------------------+-------------------------------------------+ |
| 8709 | | **path**\ *optional* | < string > array | |
| 8710 | +--------------------------------+-------------------------------------------+ |
| 8711 | | **properties**\ *optional* | < | |
| 8712 | | | `ComponentInstanceProperty <#_componentin | |
| 8713 | | | stanceproperty>`__ | |
| 8714 | | | > array | |
| 8715 | +--------------------------------+-------------------------------------------+ |
| 8716 | | **source**\ *optional* | string | |
| 8717 | +--------------------------------+-------------------------------------------+ |
| 8718 | | **type**\ *optional* | string | |
| 8719 | +--------------------------------+-------------------------------------------+ |
| 8720 | | **uniqueId**\ *optional* | string | |
| 8721 | +--------------------------------+-------------------------------------------+ |
| 8722 | | **validSourceTypes**\ *optiona | < string > array | |
| 8723 | | l* | | |
| 8724 | +--------------------------------+-------------------------------------------+ |
| 8725 | |
| 8726 | Category |
| 8727 | -------- |
| 8728 | |
| 8729 | +--------------------------------+-------------------------------------------+ |
| 8730 | | Name | Schema | |
| 8731 | +================================+===========================================+ |
| 8732 | | **name**\ *optional* | string | |
| 8733 | +--------------------------------+-------------------------------------------+ |
| 8734 | |
| 8735 | CategoryDefinition |
| 8736 | ------------------ |
| 8737 | |
| 8738 | +--------------------------------+-------------------------------------------+ |
| 8739 | | Name | Schema | |
| 8740 | +================================+===========================================+ |
| 8741 | | **icons**\ *optional* | < string > array | |
| 8742 | +--------------------------------+-------------------------------------------+ |
| 8743 | | **name**\ *optional* | string | |
| 8744 | +--------------------------------+-------------------------------------------+ |
| 8745 | | **normalizedName**\ *optional* | string | |
| 8746 | +--------------------------------+-------------------------------------------+ |
| 8747 | | **ownerId**\ *optional* | string | |
| 8748 | +--------------------------------+-------------------------------------------+ |
| 8749 | | **subcategories**\ *optional* | < | |
| 8750 | | | `SubCategoryDefinition <#_subcategorydefi | |
| 8751 | | | nition>`__ | |
| 8752 | | | > array | |
| 8753 | +--------------------------------+-------------------------------------------+ |
| 8754 | | **uniqueId**\ *optional* | string | |
| 8755 | +--------------------------------+-------------------------------------------+ |
| 8756 | |
| 8757 | ComponentInstance |
| 8758 | ----------------- |
| 8759 | |
| 8760 | +--------------------------------+-------------------------------------------+ |
| 8761 | | Name | Schema | |
| 8762 | +================================+===========================================+ |
| 8763 | | **artifacts**\ *optional* | < string, | |
| 8764 | | | `ArtifactDefinition <#_artifactdefinition | |
| 8765 | | | >`__ | |
| 8766 | | | > map | |
| 8767 | +--------------------------------+-------------------------------------------+ |
| 8768 | | **attributeValueCounter**\ *op | integer (int32) | |
| 8769 | | tional* | | |
| 8770 | +--------------------------------+-------------------------------------------+ |
| 8771 | | **capabilities**\ *optional* | < string, < | |
| 8772 | | | `CapabilityDefinition <#_capabilitydefini | |
| 8773 | | | tion>`__ | |
| 8774 | | | > array > map | |
| 8775 | +--------------------------------+-------------------------------------------+ |
| 8776 | | **componentName**\ *optional* | string | |
| 8777 | +--------------------------------+-------------------------------------------+ |
| 8778 | | **componentUid**\ *optional* | string | |
| 8779 | +--------------------------------+-------------------------------------------+ |
| 8780 | | **componentVersion**\ *optiona | string | |
| 8781 | | l* | | |
| 8782 | +--------------------------------+-------------------------------------------+ |
| 8783 | | **creationTime**\ *optional* | integer (int64) | |
| 8784 | +--------------------------------+-------------------------------------------+ |
| 8785 | | **customizationUUID**\ *option | string | |
| 8786 | | al* | | |
| 8787 | +--------------------------------+-------------------------------------------+ |
| 8788 | | **deploymentArtifacts**\ *opti | < string, | |
| 8789 | | onal* | `ArtifactDefinition <#_artifactdefinition | |
| 8790 | | | >`__ | |
| 8791 | | | > map | |
| 8792 | +--------------------------------+-------------------------------------------+ |
| 8793 | | **description**\ *optional* | string | |
| 8794 | +--------------------------------+-------------------------------------------+ |
| 8795 | | **groupInstances**\ *optional* | < `GroupInstance <#_groupinstance>`__ > | |
| 8796 | | | array | |
| 8797 | +--------------------------------+-------------------------------------------+ |
| 8798 | | **icon**\ *optional* | string | |
| 8799 | +--------------------------------+-------------------------------------------+ |
| 8800 | | **inputValueCounter**\ *option | integer (int32) | |
| 8801 | | al* | | |
| 8802 | +--------------------------------+-------------------------------------------+ |
| 8803 | | **invariantName**\ *optional* | string | |
| 8804 | +--------------------------------+-------------------------------------------+ |
| 8805 | | **modificationTime**\ *optiona | integer (int64) | |
| 8806 | | l* | | |
| 8807 | +--------------------------------+-------------------------------------------+ |
| 8808 | | **name**\ *optional* | string | |
| 8809 | +--------------------------------+-------------------------------------------+ |
| 8810 | | **normalizedName**\ *optional* | string | |
| 8811 | +--------------------------------+-------------------------------------------+ |
| 8812 | | **originType**\ *optional* | enum (PRODUCT, SERVICE, VF, VFC, CP, VL, | |
| 8813 | | | VFCMT, CVFC, PNF) | |
| 8814 | +--------------------------------+-------------------------------------------+ |
| 8815 | | **ownerId**\ *optional* | string | |
| 8816 | +--------------------------------+-------------------------------------------+ |
| 8817 | | **posX**\ *optional* | string | |
| 8818 | +--------------------------------+-------------------------------------------+ |
| 8819 | | **posY**\ *optional* | string | |
| 8820 | +--------------------------------+-------------------------------------------+ |
| 8821 | | **propertyValueCounter**\ *opt | integer (int32) | |
| 8822 | | ional* | | |
| 8823 | +--------------------------------+-------------------------------------------+ |
| 8824 | | **requirements**\ *optional* | < string, < | |
| 8825 | | | `RequirementDefinition <#_requirementdefi | |
| 8826 | | | nition>`__ | |
| 8827 | | | > array > map | |
| 8828 | +--------------------------------+-------------------------------------------+ |
| 8829 | | **toscaComponentName**\ *optio | string | |
| 8830 | | nal* | | |
| 8831 | +--------------------------------+-------------------------------------------+ |
| 8832 | | **uniqueId**\ *optional* | string | |
| 8833 | +--------------------------------+-------------------------------------------+ |
| 8834 | |
| 8835 | ComponentInstanceInput |
| 8836 | ---------------------- |
| 8837 | |
| 8838 | +--------------------------------+-------------------------------------------+ |
| 8839 | | Name | Schema | |
| 8840 | +================================+===========================================+ |
| 8841 | | **componentInstanceId**\ *opti | string | |
| 8842 | | onal* | | |
| 8843 | +--------------------------------+-------------------------------------------+ |
| 8844 | | **componentInstanceName**\ *op | string | |
| 8845 | | tional* | | |
| 8846 | +--------------------------------+-------------------------------------------+ |
| 8847 | | **constraints**\ *optional* | < | |
| 8848 | | | `PropertyConstraint <#_propertyconstraint | |
| 8849 | | | >`__ | |
| 8850 | | | > array | |
| 8851 | +--------------------------------+-------------------------------------------+ |
| 8852 | | **defaultValue**\ *optional* | string | |
| 8853 | +--------------------------------+-------------------------------------------+ |
| 8854 | | **definition**\ *optional* | boolean | |
| 8855 | +--------------------------------+-------------------------------------------+ |
| 8856 | | **description**\ *optional* | string | |
| 8857 | +--------------------------------+-------------------------------------------+ |
| 8858 | | **getInputValues**\ *optional* | < | |
| 8859 | | | `GetInputValueDataDefinition <#_getinputv | |
| 8860 | | | aluedatadefinition>`__ | |
| 8861 | | | > array | |
| 8862 | +--------------------------------+-------------------------------------------+ |
| 8863 | | **hidden**\ *optional* | boolean | |
| 8864 | +--------------------------------+-------------------------------------------+ |
| 8865 | | **immutable**\ *optional* | boolean | |
| 8866 | +--------------------------------+-------------------------------------------+ |
| 8867 | | **inputId**\ *optional* | string | |
| 8868 | +--------------------------------+-------------------------------------------+ |
| 8869 | | **inputPath**\ *optional* | string | |
| 8870 | +--------------------------------+-------------------------------------------+ |
| 8871 | | **inputs**\ *optional* | < | |
| 8872 | | | `ComponentInstanceInput <#_componentinsta | |
| 8873 | | | nceinput>`__ | |
| 8874 | | | > array | |
| 8875 | +--------------------------------+-------------------------------------------+ |
| 8876 | | **instanceUniqueId**\ *optiona | string | |
| 8877 | | l* | | |
| 8878 | +--------------------------------+-------------------------------------------+ |
| 8879 | | **label**\ *optional* | string | |
| 8880 | +--------------------------------+-------------------------------------------+ |
| 8881 | | **name**\ *optional* | string | |
| 8882 | +--------------------------------+-------------------------------------------+ |
| 8883 | | **ownerId**\ *optional* | string | |
| 8884 | +--------------------------------+-------------------------------------------+ |
| 8885 | | **parentUniqueId**\ *optional* | string | |
| 8886 | +--------------------------------+-------------------------------------------+ |
| 8887 | | **password**\ *optional* | boolean | |
| 8888 | +--------------------------------+-------------------------------------------+ |
| 8889 | | **path**\ *optional* | < string > array | |
| 8890 | +--------------------------------+-------------------------------------------+ |
| 8891 | | **properties**\ *optional* | < | |
| 8892 | | | `ComponentInstanceProperty <#_componentin | |
| 8893 | | | stanceproperty>`__ | |
| 8894 | | | > array | |
| 8895 | +--------------------------------+-------------------------------------------+ |
| 8896 | | **propertyId**\ *optional* | string | |
| 8897 | +--------------------------------+-------------------------------------------+ |
| 8898 | | **required**\ *optional* | boolean | |
| 8899 | +--------------------------------+-------------------------------------------+ |
| 8900 | | **rules**\ *optional* | < `PropertyRule <#_propertyrule>`__ > | |
| 8901 | | | array | |
| 8902 | +--------------------------------+-------------------------------------------+ |
| 8903 | | **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ | |
| 8904 | +--------------------------------+-------------------------------------------+ |
| 8905 | | **status**\ *optional* | string | |
| 8906 | +--------------------------------+-------------------------------------------+ |
| 8907 | | **type**\ *optional* | string | |
| 8908 | +--------------------------------+-------------------------------------------+ |
| 8909 | | **uniqueId**\ *optional* | string | |
| 8910 | +--------------------------------+-------------------------------------------+ |
| 8911 | | **value**\ *optional* | string | |
| 8912 | +--------------------------------+-------------------------------------------+ |
| 8913 | | **valueUniqueUid**\ *optional* | string | |
| 8914 | +--------------------------------+-------------------------------------------+ |
| 8915 | |
| 8916 | ComponentInstanceProperty |
| 8917 | ------------------------- |
| 8918 | |
| 8919 | +--------------------------------+-------------------------------------------+ |
| 8920 | | Name | Schema | |
| 8921 | +================================+===========================================+ |
| 8922 | | **componentInstanceId**\ *opti | string | |
| 8923 | | onal* | | |
| 8924 | +--------------------------------+-------------------------------------------+ |
| 8925 | | **componentInstanceName**\ *op | string | |
| 8926 | | tional* | | |
| 8927 | +--------------------------------+-------------------------------------------+ |
| 8928 | | **constraints**\ *optional* | < | |
| 8929 | | | `PropertyConstraint <#_propertyconstraint | |
| 8930 | | | >`__ | |
| 8931 | | | > array | |
| 8932 | +--------------------------------+-------------------------------------------+ |
| 8933 | | **defaultValue**\ *optional* | string | |
| 8934 | +--------------------------------+-------------------------------------------+ |
| 8935 | | **definition**\ *optional* | boolean | |
| 8936 | +--------------------------------+-------------------------------------------+ |
| 8937 | | **description**\ *optional* | string | |
| 8938 | +--------------------------------+-------------------------------------------+ |
| 8939 | | **getInputValues**\ *optional* | < | |
| 8940 | | | `GetInputValueDataDefinition <#_getinputv | |
| 8941 | | | aluedatadefinition>`__ | |
| 8942 | | | > array | |
| 8943 | +--------------------------------+-------------------------------------------+ |
| 8944 | | **hidden**\ *optional* | boolean | |
| 8945 | +--------------------------------+-------------------------------------------+ |
| 8946 | | **immutable**\ *optional* | boolean | |
| 8947 | +--------------------------------+-------------------------------------------+ |
| 8948 | | **inputId**\ *optional* | string | |
| 8949 | +--------------------------------+-------------------------------------------+ |
| 8950 | | **inputPath**\ *optional* | string | |
| 8951 | +--------------------------------+-------------------------------------------+ |
| 8952 | | **instanceUniqueId**\ *optiona | string | |
| 8953 | | l* | | |
| 8954 | +--------------------------------+-------------------------------------------+ |
| 8955 | | **label**\ *optional* | string | |
| 8956 | +--------------------------------+-------------------------------------------+ |
| 8957 | | **name**\ *optional* | string | |
| 8958 | +--------------------------------+-------------------------------------------+ |
| 8959 | | **ownerId**\ *optional* | string | |
| 8960 | +--------------------------------+-------------------------------------------+ |
| 8961 | | **parentUniqueId**\ *optional* | string | |
| 8962 | +--------------------------------+-------------------------------------------+ |
| 8963 | | **password**\ *optional* | boolean | |
| 8964 | +--------------------------------+-------------------------------------------+ |
| 8965 | | **path**\ *optional* | < string > array | |
| 8966 | +--------------------------------+-------------------------------------------+ |
| 8967 | | **propertyId**\ *optional* | string | |
| 8968 | +--------------------------------+-------------------------------------------+ |
| 8969 | | **required**\ *optional* | boolean | |
| 8970 | +--------------------------------+-------------------------------------------+ |
| 8971 | | **rules**\ *optional* | < `PropertyRule <#_propertyrule>`__ > | |
| 8972 | | | array | |
| 8973 | +--------------------------------+-------------------------------------------+ |
| 8974 | | **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ | |
| 8975 | +--------------------------------+-------------------------------------------+ |
| 8976 | | **status**\ *optional* | string | |
| 8977 | +--------------------------------+-------------------------------------------+ |
| 8978 | | **type**\ *optional* | string | |
| 8979 | +--------------------------------+-------------------------------------------+ |
| 8980 | | **uniqueId**\ *optional* | string | |
| 8981 | +--------------------------------+-------------------------------------------+ |
| 8982 | | **value**\ *optional* | string | |
| 8983 | +--------------------------------+-------------------------------------------+ |
| 8984 | | **valueUniqueUid**\ *optional* | string | |
| 8985 | +--------------------------------+-------------------------------------------+ |
| 8986 | |
| 8987 | ComponentMetadataDataDefinition |
| 8988 | ------------------------------- |
| 8989 | |
| 8990 | +--------------------------------+-------------------------------------------+ |
| 8991 | | Name | Schema | |
| 8992 | +================================+===========================================+ |
| 8993 | | **allVersions**\ *optional* | < string, string > map | |
| 8994 | +--------------------------------+-------------------------------------------+ |
| 8995 | | **componentType**\ *optional* | enum (RESOURCE, SERVICE, | |
| 8996 | | | RESOURCE\_INSTANCE, PRODUCT, | |
| 8997 | | | SERVICE\_INSTANCE) | |
| 8998 | +--------------------------------+-------------------------------------------+ |
| 8999 | | **conformanceLevel**\ *optiona | string | |
| 9000 | | l* | | |
| 9001 | +--------------------------------+-------------------------------------------+ |
| 9002 | | **contactId**\ *optional* | string | |
| 9003 | +--------------------------------+-------------------------------------------+ |
| 9004 | | **creationDate**\ *optional* | integer (int64) | |
| 9005 | +--------------------------------+-------------------------------------------+ |
| 9006 | | **creatorFullName**\ *optional | string | |
| 9007 | | * | | |
| 9008 | +--------------------------------+-------------------------------------------+ |
| 9009 | | **creatorUserId**\ *optional* | string | |
| 9010 | +--------------------------------+-------------------------------------------+ |
| 9011 | | **csarUUID**\ *optional* | string | |
| 9012 | +--------------------------------+-------------------------------------------+ |
| 9013 | | **csarVersion**\ *optional* | string | |
| 9014 | +--------------------------------+-------------------------------------------+ |
| 9015 | | **deleted**\ *optional* | boolean | |
| 9016 | +--------------------------------+-------------------------------------------+ |
| 9017 | | **description**\ *optional* | string | |
| 9018 | +--------------------------------+-------------------------------------------+ |
| 9019 | | **highestVersion**\ *optional* | boolean | |
| 9020 | +--------------------------------+-------------------------------------------+ |
| 9021 | | **icon**\ *optional* | string | |
| 9022 | +--------------------------------+-------------------------------------------+ |
| 9023 | | **importedToscaChecksum**\ *op | string | |
| 9024 | | tional* | | |
| 9025 | +--------------------------------+-------------------------------------------+ |
| 9026 | | **invariantUUID**\ *optional* | string | |
| 9027 | +--------------------------------+-------------------------------------------+ |
| 9028 | | **isDeleted**\ *optional* | boolean | |
| 9029 | +--------------------------------+-------------------------------------------+ |
| 9030 | | **isHighestVersion**\ *optiona | boolean | |
| 9031 | | l* | | |
| 9032 | +--------------------------------+-------------------------------------------+ |
| 9033 | | **lastUpdateDate**\ *optional* | integer (int64) | |
| 9034 | +--------------------------------+-------------------------------------------+ |
| 9035 | | **lastUpdaterFullName**\ *opti | string | |
| 9036 | | onal* | | |
| 9037 | +--------------------------------+-------------------------------------------+ |
| 9038 | | **lastUpdaterUserId**\ *option | string | |
| 9039 | | al* | | |
| 9040 | +--------------------------------+-------------------------------------------+ |
| 9041 | | **lifecycleState**\ *optional* | string | |
| 9042 | +--------------------------------+-------------------------------------------+ |
| 9043 | | **name**\ *optional* | string | |
| 9044 | +--------------------------------+-------------------------------------------+ |
| 9045 | | **normalizedName**\ *optional* | string | |
| 9046 | +--------------------------------+-------------------------------------------+ |
| 9047 | | **ownerId**\ *optional* | string | |
| 9048 | +--------------------------------+-------------------------------------------+ |
| 9049 | | **projectCode**\ *optional* | string | |
| 9050 | +--------------------------------+-------------------------------------------+ |
| 9051 | | **state**\ *optional* | string | |
| 9052 | +--------------------------------+-------------------------------------------+ |
| 9053 | | **systemName**\ *optional* | string | |
| 9054 | +--------------------------------+-------------------------------------------+ |
| 9055 | | **tags**\ *optional* | < string > array | |
| 9056 | +--------------------------------+-------------------------------------------+ |
| 9057 | | **uniqueId**\ *optional* | string | |
| 9058 | +--------------------------------+-------------------------------------------+ |
| 9059 | | **uuid**\ *optional* | string | |
| 9060 | +--------------------------------+-------------------------------------------+ |
| 9061 | | **version**\ *optional* | string | |
| 9062 | +--------------------------------+-------------------------------------------+ |
| 9063 | |
| 9064 | ComponentMetadataDefinition |
| 9065 | --------------------------- |
| 9066 | |
| 9067 | +--------------------------------+-------------------------------------------+ |
| 9068 | | Name | Schema | |
| 9069 | +================================+===========================================+ |
| 9070 | | **metadataDataDefinition**\ *o | `ComponentMetadataDataDefinition <#_compo | |
| 9071 | | ptional* | nentmetadatadatadefinition>`__ | |
| 9072 | +--------------------------------+-------------------------------------------+ |
| 9073 | |
| 9074 | ConsumerDefinition |
| 9075 | ------------------ |
| 9076 | |
| 9077 | +--------------------------------+-------------------------------------------+ |
| 9078 | | Name | Schema | |
| 9079 | +================================+===========================================+ |
| 9080 | | **consumerDetailsLastupdatedti | integer (int64) | |
| 9081 | | me**\ *optional* | | |
| 9082 | +--------------------------------+-------------------------------------------+ |
| 9083 | | **consumerLastAuthenticationTi | integer (int64) | |
| 9084 | | me**\ *optional* | | |
| 9085 | +--------------------------------+-------------------------------------------+ |
| 9086 | | **consumerName**\ *optional* | string | |
| 9087 | +--------------------------------+-------------------------------------------+ |
| 9088 | | **consumerPassword**\ *optiona | string | |
| 9089 | | l* | | |
| 9090 | +--------------------------------+-------------------------------------------+ |
| 9091 | | **consumerSalt**\ *optional* | string | |
| 9092 | +--------------------------------+-------------------------------------------+ |
| 9093 | | **lastModfierAtuid**\ *optiona | string | |
| 9094 | | l* | | |
| 9095 | +--------------------------------+-------------------------------------------+ |
| 9096 | | **ownerId**\ *optional* | string | |
| 9097 | +--------------------------------+-------------------------------------------+ |
| 9098 | |
| 9099 | DistributionStatusInfo |
| 9100 | ---------------------- |
| 9101 | |
| 9102 | +--------------------------------+-------------------------------------------+ |
| 9103 | | Name | Schema | |
| 9104 | +================================+===========================================+ |
| 9105 | | **errorReason**\ *optional* | string | |
| 9106 | +--------------------------------+-------------------------------------------+ |
| 9107 | | **omfComponentID**\ *optional* | string | |
| 9108 | +--------------------------------+-------------------------------------------+ |
| 9109 | | **status**\ *optional* | string | |
| 9110 | +--------------------------------+-------------------------------------------+ |
| 9111 | | **timestamp**\ *optional* | string | |
| 9112 | +--------------------------------+-------------------------------------------+ |
| 9113 | | **url**\ *optional* | string | |
| 9114 | +--------------------------------+-------------------------------------------+ |
| 9115 | |
| 9116 | DistributionStatusListResponse |
| 9117 | ------------------------------ |
| 9118 | |
| 9119 | +--------------------------------+-------------------------------------------+ |
| 9120 | | Name | Schema | |
| 9121 | +================================+===========================================+ |
| 9122 | | **distributionStatusList**\ *o | < | |
| 9123 | | ptional* | `DistributionStatusInfo <#_distributionst | |
| 9124 | | | atusinfo>`__ | |
| 9125 | | | > array | |
| 9126 | +--------------------------------+-------------------------------------------+ |
| 9127 | |
| 9128 | GetInputValueDataDefinition |
| 9129 | --------------------------- |
| 9130 | |
| 9131 | +--------------------------------+-------------------------------------------+ |
| 9132 | | Name | Schema | |
| 9133 | +================================+===========================================+ |
| 9134 | | **getInputIndex**\ *optional* | `GetInputValueDataDefinition <#_getinputv | |
| 9135 | | | aluedatadefinition>`__ | |
| 9136 | +--------------------------------+-------------------------------------------+ |
| 9137 | | **indexValue**\ *optional* | integer (int32) | |
| 9138 | +--------------------------------+-------------------------------------------+ |
| 9139 | | **inputId**\ *optional* | string | |
| 9140 | +--------------------------------+-------------------------------------------+ |
| 9141 | | **inputName**\ *optional* | string | |
| 9142 | +--------------------------------+-------------------------------------------+ |
| 9143 | | **list**\ *optional* | boolean | |
| 9144 | +--------------------------------+-------------------------------------------+ |
| 9145 | | **ownerId**\ *optional* | string | |
| 9146 | +--------------------------------+-------------------------------------------+ |
| 9147 | | **propName**\ *optional* | string | |
| 9148 | +--------------------------------+-------------------------------------------+ |
| 9149 | |
| 9150 | GroupDefinition |
| 9151 | --------------- |
| 9152 | |
| 9153 | +--------------------------------+-------------------------------------------+ |
| 9154 | | Name | Schema | |
| 9155 | +================================+===========================================+ |
| 9156 | | **artifacts**\ *optional* | < string > array | |
| 9157 | +--------------------------------+-------------------------------------------+ |
| 9158 | | **artifactsUuid**\ *optional* | < string > array | |
| 9159 | +--------------------------------+-------------------------------------------+ |
| 9160 | | **description**\ *optional* | string | |
| 9161 | +--------------------------------+-------------------------------------------+ |
| 9162 | | **groupUUID**\ *optional* | string | |
| 9163 | +--------------------------------+-------------------------------------------+ |
| 9164 | | **invariantUUID**\ *optional* | string | |
| 9165 | +--------------------------------+-------------------------------------------+ |
| 9166 | | **members**\ *optional* | < string, string > map | |
| 9167 | +--------------------------------+-------------------------------------------+ |
| 9168 | | **name**\ *optional* | string | |
| 9169 | +--------------------------------+-------------------------------------------+ |
| 9170 | | **ownerId**\ *optional* | string | |
| 9171 | +--------------------------------+-------------------------------------------+ |
| 9172 | | **properties**\ *optional* | < | |
| 9173 | | | `PropertyDataDefinition <#_propertydatade | |
| 9174 | | | finition>`__ | |
| 9175 | | | > array | |
| 9176 | +--------------------------------+-------------------------------------------+ |
| 9177 | | **propertyValueCounter**\ *opt | integer (int32) | |
| 9178 | | ional* | | |
| 9179 | +--------------------------------+-------------------------------------------+ |
| 9180 | | **type**\ *optional* | string | |
| 9181 | +--------------------------------+-------------------------------------------+ |
| 9182 | | **typeUid**\ *optional* | string | |
| 9183 | +--------------------------------+-------------------------------------------+ |
| 9184 | | **uniqueId**\ *optional* | string | |
| 9185 | +--------------------------------+-------------------------------------------+ |
| 9186 | | **version**\ *optional* | string | |
| 9187 | +--------------------------------+-------------------------------------------+ |
| 9188 | |
| 9189 | GroupInstance |
| 9190 | ------------- |
| 9191 | |
| 9192 | +--------------------------------+-------------------------------------------+ |
| 9193 | | Name | Schema | |
| 9194 | +================================+===========================================+ |
| 9195 | | **artifacts**\ *optional* | < string > array | |
| 9196 | +--------------------------------+-------------------------------------------+ |
| 9197 | | **artifactsUuid**\ *optional* | < string > array | |
| 9198 | +--------------------------------+-------------------------------------------+ |
| 9199 | | **creationTime**\ *optional* | integer (int64) | |
| 9200 | +--------------------------------+-------------------------------------------+ |
| 9201 | | **customizationUUID**\ *option | string | |
| 9202 | | al* | | |
| 9203 | +--------------------------------+-------------------------------------------+ |
| 9204 | | **description**\ *optional* | string | |
| 9205 | +--------------------------------+-------------------------------------------+ |
| 9206 | | **groupInstanceArtifacts**\ *o | < string > array | |
| 9207 | | ptional* | | |
| 9208 | +--------------------------------+-------------------------------------------+ |
| 9209 | | **groupInstanceArtifactsUuid** | < string > array | |
| 9210 | | \ *optional* | | |
| 9211 | +--------------------------------+-------------------------------------------+ |
| 9212 | | **groupName**\ *optional* | string | |
| 9213 | +--------------------------------+-------------------------------------------+ |
| 9214 | | **groupUUID**\ *optional* | string | |
| 9215 | +--------------------------------+-------------------------------------------+ |
| 9216 | | **groupUid**\ *optional* | string | |
| 9217 | +--------------------------------+-------------------------------------------+ |
| 9218 | | **invariantUUID**\ *optional* | string | |
| 9219 | +--------------------------------+-------------------------------------------+ |
| 9220 | | **modificationTime**\ *optiona | integer (int64) | |
| 9221 | | l* | | |
| 9222 | +--------------------------------+-------------------------------------------+ |
| 9223 | | **name**\ *optional* | string | |
| 9224 | +--------------------------------+-------------------------------------------+ |
| 9225 | | **normalizedName**\ *optional* | string | |
| 9226 | +--------------------------------+-------------------------------------------+ |
| 9227 | | **ownerId**\ *optional* | string | |
| 9228 | +--------------------------------+-------------------------------------------+ |
| 9229 | | **posX**\ *optional* | string | |
| 9230 | +--------------------------------+-------------------------------------------+ |
| 9231 | | **posY**\ *optional* | string | |
| 9232 | +--------------------------------+-------------------------------------------+ |
| 9233 | | **properties**\ *optional* | < | |
| 9234 | | | `PropertyDataDefinition <#_propertydatade | |
| 9235 | | | finition>`__ | |
| 9236 | | | > array | |
| 9237 | +--------------------------------+-------------------------------------------+ |
| 9238 | | **propertyValueCounter**\ *opt | integer (int32) | |
| 9239 | | ional* | | |
| 9240 | +--------------------------------+-------------------------------------------+ |
| 9241 | | **type**\ *optional* | string | |
| 9242 | +--------------------------------+-------------------------------------------+ |
| 9243 | | **uniqueId**\ *optional* | string | |
| 9244 | +--------------------------------+-------------------------------------------+ |
| 9245 | | **version**\ *optional* | string | |
| 9246 | +--------------------------------+-------------------------------------------+ |
| 9247 | |
| 9248 | GroupingDefinition |
| 9249 | ------------------ |
| 9250 | |
| 9251 | +--------------------------------+-------------------------------------------+ |
| 9252 | | Name | Schema | |
| 9253 | +================================+===========================================+ |
| 9254 | | **name**\ *optional* | string | |
| 9255 | +--------------------------------+-------------------------------------------+ |
| 9256 | | **normalizedName**\ *optional* | string | |
| 9257 | +--------------------------------+-------------------------------------------+ |
| 9258 | | **ownerId**\ *optional* | string | |
| 9259 | +--------------------------------+-------------------------------------------+ |
| 9260 | | **uniqueId**\ *optional* | string | |
| 9261 | +--------------------------------+-------------------------------------------+ |
| 9262 | |
| 9263 | HeatParameterDataDefinition |
| 9264 | --------------------------- |
| 9265 | |
| 9266 | +--------------------------------+-------------------------------------------+ |
| 9267 | | Name | Schema | |
| 9268 | +================================+===========================================+ |
| 9269 | | **currentValue**\ *optional* | string | |
| 9270 | +--------------------------------+-------------------------------------------+ |
| 9271 | | **defaultValue**\ *optional* | string | |
| 9272 | +--------------------------------+-------------------------------------------+ |
| 9273 | | **description**\ *optional* | string | |
| 9274 | +--------------------------------+-------------------------------------------+ |
| 9275 | | **name**\ *optional* | string | |
| 9276 | +--------------------------------+-------------------------------------------+ |
| 9277 | | **ownerId**\ *optional* | string | |
| 9278 | +--------------------------------+-------------------------------------------+ |
| 9279 | | **type**\ *optional* | string | |
| 9280 | +--------------------------------+-------------------------------------------+ |
| 9281 | | **uniqueId**\ *optional* | string | |
| 9282 | +--------------------------------+-------------------------------------------+ |
| 9283 | |
| 9284 | HeatParameterDefinition |
| 9285 | ----------------------- |
| 9286 | |
| 9287 | +--------------------------------+-------------------------------------------+ |
| 9288 | | Name | Schema | |
| 9289 | +================================+===========================================+ |
| 9290 | | **currentValue**\ *optional* | string | |
| 9291 | +--------------------------------+-------------------------------------------+ |
| 9292 | | **defaultValue**\ *optional* | string | |
| 9293 | +--------------------------------+-------------------------------------------+ |
| 9294 | | **description**\ *optional* | string | |
| 9295 | +--------------------------------+-------------------------------------------+ |
| 9296 | | **name**\ *optional* | string | |
| 9297 | +--------------------------------+-------------------------------------------+ |
| 9298 | | **ownerId**\ *optional* | string | |
| 9299 | +--------------------------------+-------------------------------------------+ |
| 9300 | | **type**\ *optional* | string | |
| 9301 | +--------------------------------+-------------------------------------------+ |
| 9302 | | **uniqueId**\ *optional* | string | |
| 9303 | +--------------------------------+-------------------------------------------+ |
| 9304 | |
| 9305 | InputDefinition |
| 9306 | --------------- |
| 9307 | |
| 9308 | +--------------------------------+-------------------------------------------+ |
| 9309 | | Name | Schema | |
| 9310 | +================================+===========================================+ |
| 9311 | | **constraints**\ *optional* | < | |
| 9312 | | | `PropertyConstraint <#_propertyconstraint | |
| 9313 | | | >`__ | |
| 9314 | | | > array | |
| 9315 | +--------------------------------+-------------------------------------------+ |
| 9316 | | **defaultValue**\ *optional* | string | |
| 9317 | +--------------------------------+-------------------------------------------+ |
| 9318 | | **definition**\ *optional* | boolean | |
| 9319 | +--------------------------------+-------------------------------------------+ |
| 9320 | | **description**\ *optional* | string | |
| 9321 | +--------------------------------+-------------------------------------------+ |
| 9322 | | **getInputValues**\ *optional* | < | |
| 9323 | | | `GetInputValueDataDefinition <#_getinputv | |
| 9324 | | | aluedatadefinition>`__ | |
| 9325 | | | > array | |
| 9326 | +--------------------------------+-------------------------------------------+ |
| 9327 | | **hidden**\ *optional* | boolean | |
| 9328 | +--------------------------------+-------------------------------------------+ |
| 9329 | | **immutable**\ *optional* | boolean | |
| 9330 | +--------------------------------+-------------------------------------------+ |
| 9331 | | **inputId**\ *optional* | string | |
| 9332 | +--------------------------------+-------------------------------------------+ |
| 9333 | | **inputPath**\ *optional* | string | |
| 9334 | +--------------------------------+-------------------------------------------+ |
| 9335 | | **inputs**\ *optional* | < | |
| 9336 | | | `ComponentInstanceInput <#_componentinsta | |
| 9337 | | | nceinput>`__ | |
| 9338 | | | > array | |
| 9339 | +--------------------------------+-------------------------------------------+ |
| 9340 | | **instanceUniqueId**\ *optiona | string | |
| 9341 | | l* | | |
| 9342 | +--------------------------------+-------------------------------------------+ |
| 9343 | | **label**\ *optional* | string | |
| 9344 | +--------------------------------+-------------------------------------------+ |
| 9345 | | **name**\ *optional* | string | |
| 9346 | +--------------------------------+-------------------------------------------+ |
| 9347 | | **ownerId**\ *optional* | string | |
| 9348 | +--------------------------------+-------------------------------------------+ |
| 9349 | | **parentUniqueId**\ *optional* | string | |
| 9350 | +--------------------------------+-------------------------------------------+ |
| 9351 | | **password**\ *optional* | boolean | |
| 9352 | +--------------------------------+-------------------------------------------+ |
| 9353 | | **properties**\ *optional* | < | |
| 9354 | | | `ComponentInstanceProperty <#_componentin | |
| 9355 | | | stanceproperty>`__ | |
| 9356 | | | > array | |
| 9357 | +--------------------------------+-------------------------------------------+ |
| 9358 | | **propertyId**\ *optional* | string | |
| 9359 | +--------------------------------+-------------------------------------------+ |
| 9360 | | **required**\ *optional* | boolean | |
| 9361 | +--------------------------------+-------------------------------------------+ |
| 9362 | | **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ | |
| 9363 | +--------------------------------+-------------------------------------------+ |
| 9364 | | **status**\ *optional* | string | |
| 9365 | +--------------------------------+-------------------------------------------+ |
| 9366 | | **type**\ *optional* | string | |
| 9367 | +--------------------------------+-------------------------------------------+ |
| 9368 | | **uniqueId**\ *optional* | string | |
| 9369 | +--------------------------------+-------------------------------------------+ |
| 9370 | | **value**\ *optional* | string | |
| 9371 | +--------------------------------+-------------------------------------------+ |
| 9372 | |
| 9373 | InterfaceDefinition |
| 9374 | ------------------- |
| 9375 | |
| 9376 | +--------------------------------+-------------------------------------------+ |
| 9377 | | Name | Schema | |
| 9378 | +================================+===========================================+ |
| 9379 | | **creationDate**\ *optional* | integer (int64) | |
| 9380 | +--------------------------------+-------------------------------------------+ |
| 9381 | | **definition**\ *optional* | boolean | |
| 9382 | +--------------------------------+-------------------------------------------+ |
| 9383 | | **description**\ *optional* | string | |
| 9384 | +--------------------------------+-------------------------------------------+ |
| 9385 | | **lastUpdateDate**\ *optional* | integer (int64) | |
| 9386 | +--------------------------------+-------------------------------------------+ |
| 9387 | | **operations**\ *optional* | < string, | |
| 9388 | | | `OperationDataDefinition <#_operationdata | |
| 9389 | | | definition>`__ | |
| 9390 | | | > map | |
| 9391 | +--------------------------------+-------------------------------------------+ |
| 9392 | | **operationsMap**\ *optional* | < string, `Operation <#_operation>`__ > | |
| 9393 | | | map | |
| 9394 | +--------------------------------+-------------------------------------------+ |
| 9395 | | **ownerId**\ *optional* | string | |
| 9396 | +--------------------------------+-------------------------------------------+ |
| 9397 | | **type**\ *optional* | string | |
| 9398 | +--------------------------------+-------------------------------------------+ |
| 9399 | | **uniqueId**\ *optional* | string | |
| 9400 | +--------------------------------+-------------------------------------------+ |
| 9401 | |
| 9402 | LifecycleChangeInfoWithAction |
| 9403 | ----------------------------- |
| 9404 | |
| 9405 | +--------------------------------+-------------------------------------------+ |
| 9406 | | Name | Schema | |
| 9407 | +================================+===========================================+ |
| 9408 | | **action**\ *optional* | enum (CREATE\_FROM\_CSAR, | |
| 9409 | | | UPDATE\_FROM\_EXTERNAL\_API) | |
| 9410 | +--------------------------------+-------------------------------------------+ |
| 9411 | | **userRemarks**\ *optional* | string | |
| 9412 | +--------------------------------+-------------------------------------------+ |
| 9413 | |
| 9414 | Operation |
| 9415 | --------- |
| 9416 | |
| 9417 | +--------------------------------+-------------------------------------------+ |
| 9418 | | Name | Schema | |
| 9419 | +================================+===========================================+ |
| 9420 | | **creationDate**\ *optional* | integer (int64) | |
| 9421 | +--------------------------------+-------------------------------------------+ |
| 9422 | | **definition**\ *optional* | boolean | |
| 9423 | +--------------------------------+-------------------------------------------+ |
| 9424 | | **description**\ *optional* | string | |
| 9425 | +--------------------------------+-------------------------------------------+ |
| 9426 | | **implementation**\ *optional* | `ArtifactDataDefinition <#_artifactdatade | |
| 9427 | | | finition>`__ | |
| 9428 | +--------------------------------+-------------------------------------------+ |
| 9429 | | **implementationArtifact**\ *o | `ArtifactDefinition <#_artifactdefinition | |
| 9430 | | ptional* | >`__ | |
| 9431 | +--------------------------------+-------------------------------------------+ |
| 9432 | | **inputs**\ *optional* | < string, | |
| 9433 | | | `PropertyDataDefinition <#_propertydatade | |
| 9434 | | | finition>`__ | |
| 9435 | | | > map | |
| 9436 | +--------------------------------+-------------------------------------------+ |
| 9437 | | **lastUpdateDate**\ *optional* | integer (int64) | |
| 9438 | +--------------------------------+-------------------------------------------+ |
| 9439 | | **ownerId**\ *optional* | string | |
| 9440 | +--------------------------------+-------------------------------------------+ |
| 9441 | | **uniqueId**\ *optional* | string | |
| 9442 | +--------------------------------+-------------------------------------------+ |
| 9443 | |
| 9444 | OperationDataDefinition |
| 9445 | ----------------------- |
| 9446 | |
| 9447 | +--------------------------------+-------------------------------------------+ |
| 9448 | | Name | Schema | |
| 9449 | +================================+===========================================+ |
| 9450 | | **creationDate**\ *optional* | integer (int64) | |
| 9451 | +--------------------------------+-------------------------------------------+ |
| 9452 | | **description**\ *optional* | string | |
| 9453 | +--------------------------------+-------------------------------------------+ |
| 9454 | | **implementation**\ *optional* | `ArtifactDataDefinition <#_artifactdatade | |
| 9455 | | | finition>`__ | |
| 9456 | +--------------------------------+-------------------------------------------+ |
| 9457 | | **inputs**\ *optional* | < string, | |
| 9458 | | | `PropertyDataDefinition <#_propertydatade | |
| 9459 | | | finition>`__ | |
| 9460 | | | > map | |
| 9461 | +--------------------------------+-------------------------------------------+ |
| 9462 | | **lastUpdateDate**\ *optional* | integer (int64) | |
| 9463 | +--------------------------------+-------------------------------------------+ |
| 9464 | | **ownerId**\ *optional* | string | |
| 9465 | +--------------------------------+-------------------------------------------+ |
| 9466 | | **uniqueId**\ *optional* | string | |
| 9467 | +--------------------------------+-------------------------------------------+ |
| 9468 | |
| 9469 | Product |
| 9470 | ------- |
| 9471 | |
| 9472 | +--------------------------------+-------------------------------------------+ |
| 9473 | | Name | Schema | |
| 9474 | +================================+===========================================+ |
| 9475 | | **additionalInformation**\ *op | < | |
| 9476 | | tional* | `AdditionalInformationDefinition <#_addit | |
| 9477 | | | ionalinformationdefinition>`__ | |
| 9478 | | | > array | |
| 9479 | +--------------------------------+-------------------------------------------+ |
| 9480 | | **allArtifacts**\ *optional* | < string, | |
| 9481 | | | `ArtifactDefinition <#_artifactdefinition | |
| 9482 | | | >`__ | |
| 9483 | | | > map | |
| 9484 | +--------------------------------+-------------------------------------------+ |
| 9485 | | **allVersions**\ *optional* | < string, string > map | |
| 9486 | +--------------------------------+-------------------------------------------+ |
| 9487 | | **artifacts**\ *optional* | < string, | |
| 9488 | | | `ArtifactDefinition <#_artifactdefinition | |
| 9489 | | | >`__ | |
| 9490 | | | > map | |
| 9491 | +--------------------------------+-------------------------------------------+ |
| 9492 | | **capabilities**\ *optional* | < string, < | |
| 9493 | | | `CapabilityDefinition <#_capabilitydefini | |
| 9494 | | | tion>`__ | |
| 9495 | | | > array > map | |
| 9496 | +--------------------------------+-------------------------------------------+ |
| 9497 | | **categories**\ *optional* | < | |
| 9498 | | | `CategoryDefinition <#_categorydefinition | |
| 9499 | | | >`__ | |
| 9500 | | | > array | |
| 9501 | +--------------------------------+-------------------------------------------+ |
| 9502 | | **componentInstances**\ *optio | < | |
| 9503 | | nal* | `ComponentInstance <#_componentinstance>` | |
| 9504 | | | __ | |
| 9505 | | | > array | |
| 9506 | +--------------------------------+-------------------------------------------+ |
| 9507 | | **componentInstancesAttributes | < string, < | |
| 9508 | | **\ *optional* | `ComponentInstanceProperty <#_componentin | |
| 9509 | | | stanceproperty>`__ | |
| 9510 | | | > array > map | |
| 9511 | +--------------------------------+-------------------------------------------+ |
| 9512 | | **componentInstancesInputs**\ | < string, < | |
| 9513 | | *optional* | `ComponentInstanceInput <#_componentinsta | |
| 9514 | | | nceinput>`__ | |
| 9515 | | | > array > map | |
| 9516 | +--------------------------------+-------------------------------------------+ |
| 9517 | | **componentInstancesProperties | < string, < | |
| 9518 | | **\ *optional* | `ComponentInstanceProperty <#_componentin | |
| 9519 | | | stanceproperty>`__ | |
| 9520 | | | > array > map | |
| 9521 | +--------------------------------+-------------------------------------------+ |
| 9522 | | **componentInstancesRelations* | < | |
| 9523 | | *\ *optional* | `RequirementCapabilityRelDef <#_requireme | |
| 9524 | | | ntcapabilityreldef>`__ | |
| 9525 | | | > array | |
| 9526 | +--------------------------------+-------------------------------------------+ |
| 9527 | | **componentMetadataDefinition* | `ComponentMetadataDefinition <#_component | |
| 9528 | | *\ *optional* | metadatadefinition>`__ | |
| 9529 | +--------------------------------+-------------------------------------------+ |
| 9530 | | **componentType**\ *optional* | enum (RESOURCE, SERVICE, | |
| 9531 | | | RESOURCE\_INSTANCE, PRODUCT, | |
| 9532 | | | SERVICE\_INSTANCE) | |
| 9533 | +--------------------------------+-------------------------------------------+ |
| 9534 | | **conformanceLevel**\ *optiona | string | |
| 9535 | | l* | | |
| 9536 | +--------------------------------+-------------------------------------------+ |
| 9537 | | **contactId**\ *optional* | string | |
| 9538 | +--------------------------------+-------------------------------------------+ |
| 9539 | | **contacts**\ *optional* | < string > array | |
| 9540 | +--------------------------------+-------------------------------------------+ |
| 9541 | | **creationDate**\ *optional* | integer (int64) | |
| 9542 | +--------------------------------+-------------------------------------------+ |
| 9543 | | **creatorFullName**\ *optional | string | |
| 9544 | | * | | |
| 9545 | +--------------------------------+-------------------------------------------+ |
| 9546 | | **creatorUserId**\ *optional* | string | |
| 9547 | +--------------------------------+-------------------------------------------+ |
| 9548 | | **csarUUID**\ *optional* | string | |
| 9549 | +--------------------------------+-------------------------------------------+ |
| 9550 | | **csarVersion**\ *optional* | string | |
| 9551 | +--------------------------------+-------------------------------------------+ |
| 9552 | | **deploymentArtifacts**\ *opti | < string, | |
| 9553 | | onal* | `ArtifactDefinition <#_artifactdefinition | |
| 9554 | | | >`__ | |
| 9555 | | | > map | |
| 9556 | +--------------------------------+-------------------------------------------+ |
| 9557 | | **derivedFromGenericType**\ *o | string | |
| 9558 | | ptional* | | |
| 9559 | +--------------------------------+-------------------------------------------+ |
| 9560 | | **derivedFromGenericVersion**\ | string | |
| 9561 | | *optional* | | |
| 9562 | +--------------------------------+-------------------------------------------+ |
| 9563 | | **description**\ *optional* | string | |
| 9564 | +--------------------------------+-------------------------------------------+ |
| 9565 | | **fullName**\ *optional* | string | |
| 9566 | +--------------------------------+-------------------------------------------+ |
| 9567 | | **groups**\ *optional* | < `GroupDefinition <#_groupdefinition>`__ | |
| 9568 | | | > array | |
| 9569 | +--------------------------------+-------------------------------------------+ |
| 9570 | | **highestVersion**\ *optional* | boolean | |
| 9571 | +--------------------------------+-------------------------------------------+ |
| 9572 | | **icon**\ *optional* | string | |
| 9573 | +--------------------------------+-------------------------------------------+ |
| 9574 | | **importedToscaChecksum**\ *op | string | |
| 9575 | | tional* | | |
| 9576 | +--------------------------------+-------------------------------------------+ |
| 9577 | | **inputs**\ *optional* | < `InputDefinition <#_inputdefinition>`__ | |
| 9578 | | | > array | |
| 9579 | +--------------------------------+-------------------------------------------+ |
| 9580 | | **invariantUUID**\ *optional* | string | |
| 9581 | +--------------------------------+-------------------------------------------+ |
| 9582 | | **isActive**\ *optional* | boolean | |
| 9583 | +--------------------------------+-------------------------------------------+ |
| 9584 | | **isDeleted**\ *optional* | boolean | |
| 9585 | +--------------------------------+-------------------------------------------+ |
| 9586 | | **lastUpdateDate**\ *optional* | integer (int64) | |
| 9587 | +--------------------------------+-------------------------------------------+ |
| 9588 | | **lastUpdaterFullName**\ *opti | string | |
| 9589 | | onal* | | |
| 9590 | +--------------------------------+-------------------------------------------+ |
| 9591 | | **lastUpdaterUserId**\ *option | string | |
| 9592 | | al* | | |
| 9593 | +--------------------------------+-------------------------------------------+ |
| 9594 | | **lifecycleState**\ *optional* | enum (READY\_FOR\_CERTIFICATION, | |
| 9595 | | | CERTIFICATION\_IN\_PROGRESS, CERTIFIED, | |
| 9596 | | | NOT\_CERTIFIED\_CHECKIN, | |
| 9597 | | | NOT\_CERTIFIED\_CHECKOUT) | |
| 9598 | +--------------------------------+-------------------------------------------+ |
| 9599 | | **name**\ *optional* | string | |
| 9600 | +--------------------------------+-------------------------------------------+ |
| 9601 | | **normalizedName**\ *optional* | string | |
| 9602 | +--------------------------------+-------------------------------------------+ |
| 9603 | | **projectCode**\ *optional* | string | |
| 9604 | +--------------------------------+-------------------------------------------+ |
| 9605 | | **requirements**\ *optional* | < string, < | |
| 9606 | | | `RequirementDefinition <#_requirementdefi | |
| 9607 | | | nition>`__ | |
| 9608 | | | > array > map | |
| 9609 | +--------------------------------+-------------------------------------------+ |
| 9610 | | **systemName**\ *optional* | string | |
| 9611 | +--------------------------------+-------------------------------------------+ |
| 9612 | | **tags**\ *optional* | < string > array | |
| 9613 | +--------------------------------+-------------------------------------------+ |
| 9614 | | **toscaArtifacts**\ *optional* | < string, | |
| 9615 | | | `ArtifactDefinition <#_artifactdefinition | |
| 9616 | | | >`__ | |
| 9617 | | | > map | |
| 9618 | +--------------------------------+-------------------------------------------+ |
| 9619 | | **toscaType**\ *optional* | string | |
| 9620 | +--------------------------------+-------------------------------------------+ |
| 9621 | | **uniqueId**\ *optional* | string | |
| 9622 | +--------------------------------+-------------------------------------------+ |
| 9623 | | **uuid**\ *optional* | string | |
| 9624 | +--------------------------------+-------------------------------------------+ |
| 9625 | | **version**\ *optional* | string | |
| 9626 | +--------------------------------+-------------------------------------------+ |
| 9627 | |
| 9628 | PropertyConstraint |
| 9629 | ------------------ |
| 9630 | |
| 9631 | *Type* : object |
| 9632 | |
| 9633 | PropertyDataDefinition |
| 9634 | ---------------------- |
| 9635 | |
| 9636 | +--------------------------------+-------------------------------------------+ |
| 9637 | | Name | Schema | |
| 9638 | +================================+===========================================+ |
| 9639 | | **defaultValue**\ *optional* | string | |
| 9640 | +--------------------------------+-------------------------------------------+ |
| 9641 | | **definition**\ *optional* | boolean | |
| 9642 | +--------------------------------+-------------------------------------------+ |
| 9643 | | **description**\ *optional* | string | |
| 9644 | +--------------------------------+-------------------------------------------+ |
| 9645 | | **getInputValues**\ *optional* | < | |
| 9646 | | | `GetInputValueDataDefinition <#_getinputv | |
| 9647 | | | aluedatadefinition>`__ | |
| 9648 | | | > array | |
| 9649 | +--------------------------------+-------------------------------------------+ |
| 9650 | | **hidden**\ *optional* | boolean | |
| 9651 | +--------------------------------+-------------------------------------------+ |
| 9652 | | **immutable**\ *optional* | boolean | |
| 9653 | +--------------------------------+-------------------------------------------+ |
| 9654 | | **inputId**\ *optional* | string | |
| 9655 | +--------------------------------+-------------------------------------------+ |
| 9656 | | **inputPath**\ *optional* | string | |
| 9657 | +--------------------------------+-------------------------------------------+ |
| 9658 | | **instanceUniqueId**\ *optiona | string | |
| 9659 | | l* | | |
| 9660 | +--------------------------------+-------------------------------------------+ |
| 9661 | | **label**\ *optional* | string | |
| 9662 | +--------------------------------+-------------------------------------------+ |
| 9663 | | **name**\ *optional* | string | |
| 9664 | +--------------------------------+-------------------------------------------+ |
| 9665 | | **ownerId**\ *optional* | string | |
| 9666 | +--------------------------------+-------------------------------------------+ |
| 9667 | | **parentUniqueId**\ *optional* | string | |
| 9668 | +--------------------------------+-------------------------------------------+ |
| 9669 | | **password**\ *optional* | boolean | |
| 9670 | +--------------------------------+-------------------------------------------+ |
| 9671 | | **propertyId**\ *optional* | string | |
| 9672 | +--------------------------------+-------------------------------------------+ |
| 9673 | | **required**\ *optional* | boolean | |
| 9674 | +--------------------------------+-------------------------------------------+ |
| 9675 | | **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ | |
| 9676 | +--------------------------------+-------------------------------------------+ |
| 9677 | | **status**\ *optional* | string | |
| 9678 | +--------------------------------+-------------------------------------------+ |
| 9679 | | **type**\ *optional* | string | |
| 9680 | +--------------------------------+-------------------------------------------+ |
| 9681 | | **uniqueId**\ *optional* | string | |
| 9682 | +--------------------------------+-------------------------------------------+ |
| 9683 | | **value**\ *optional* | string | |
| 9684 | +--------------------------------+-------------------------------------------+ |
| 9685 | |
| 9686 | PropertyDefinition |
| 9687 | ------------------ |
| 9688 | |
| 9689 | +--------------------------------+-------------------------------------------+ |
| 9690 | | Name | Schema | |
| 9691 | +================================+===========================================+ |
| 9692 | | **constraints**\ *optional* | < | |
| 9693 | | | `PropertyConstraint <#_propertyconstraint | |
| 9694 | | | >`__ | |
| 9695 | | | > array | |
| 9696 | +--------------------------------+-------------------------------------------+ |
| 9697 | | **defaultValue**\ *optional* | string | |
| 9698 | +--------------------------------+-------------------------------------------+ |
| 9699 | | **definition**\ *optional* | boolean | |
| 9700 | +--------------------------------+-------------------------------------------+ |
| 9701 | | **description**\ *optional* | string | |
| 9702 | +--------------------------------+-------------------------------------------+ |
| 9703 | | **getInputValues**\ *optional* | < | |
| 9704 | | | `GetInputValueDataDefinition <#_getinputv | |
| 9705 | | | aluedatadefinition>`__ | |
| 9706 | | | > array | |
| 9707 | +--------------------------------+-------------------------------------------+ |
| 9708 | | **hidden**\ *optional* | boolean | |
| 9709 | +--------------------------------+-------------------------------------------+ |
| 9710 | | **immutable**\ *optional* | boolean | |
| 9711 | +--------------------------------+-------------------------------------------+ |
| 9712 | | **inputId**\ *optional* | string | |
| 9713 | +--------------------------------+-------------------------------------------+ |
| 9714 | | **inputPath**\ *optional* | string | |
| 9715 | +--------------------------------+-------------------------------------------+ |
| 9716 | | **instanceUniqueId**\ *optiona | string | |
| 9717 | | l* | | |
| 9718 | +--------------------------------+-------------------------------------------+ |
| 9719 | | **label**\ *optional* | string | |
| 9720 | +--------------------------------+-------------------------------------------+ |
| 9721 | | **name**\ *optional* | string | |
| 9722 | +--------------------------------+-------------------------------------------+ |
| 9723 | | **ownerId**\ *optional* | string | |
| 9724 | +--------------------------------+-------------------------------------------+ |
| 9725 | | **parentUniqueId**\ *optional* | string | |
| 9726 | +--------------------------------+-------------------------------------------+ |
| 9727 | | **password**\ *optional* | boolean | |
| 9728 | +--------------------------------+-------------------------------------------+ |
| 9729 | | **propertyId**\ *optional* | string | |
| 9730 | +--------------------------------+-------------------------------------------+ |
| 9731 | | **required**\ *optional* | boolean | |
| 9732 | +--------------------------------+-------------------------------------------+ |
| 9733 | | **schema**\ *optional* | `SchemaDefinition <#_schemadefinition>`__ | |
| 9734 | +--------------------------------+-------------------------------------------+ |
| 9735 | | **status**\ *optional* | string | |
| 9736 | +--------------------------------+-------------------------------------------+ |
| 9737 | | **type**\ *optional* | string | |
| 9738 | +--------------------------------+-------------------------------------------+ |
| 9739 | | **uniqueId**\ *optional* | string | |
| 9740 | +--------------------------------+-------------------------------------------+ |
| 9741 | | **value**\ *optional* | string | |
| 9742 | +--------------------------------+-------------------------------------------+ |
| 9743 | |
| 9744 | PropertyRule |
| 9745 | ------------ |
| 9746 | |
| 9747 | +--------------------------------+-------------------------------------------+ |
| 9748 | | Name | Schema | |
| 9749 | +================================+===========================================+ |
| 9750 | | **firstToken**\ *optional* | string | |
| 9751 | +--------------------------------+-------------------------------------------+ |
| 9752 | | **ownerId**\ *optional* | string | |
| 9753 | +--------------------------------+-------------------------------------------+ |
| 9754 | | **rule**\ *optional* | < string > array | |
| 9755 | +--------------------------------+-------------------------------------------+ |
| 9756 | | **ruleSize**\ *optional* | integer (int32) | |
| 9757 | +--------------------------------+-------------------------------------------+ |
| 9758 | | **value**\ *optional* | string | |
| 9759 | +--------------------------------+-------------------------------------------+ |
| 9760 | |
| 9761 | RelationshipImpl |
| 9762 | ---------------- |
| 9763 | |
| 9764 | +--------------------------------+-------------------------------------------+ |
| 9765 | | Name | Schema | |
| 9766 | +================================+===========================================+ |
| 9767 | | **type**\ *optional* | string | |
| 9768 | +--------------------------------+-------------------------------------------+ |
| 9769 | |
| 9770 | RequirementAndRelationshipPair |
| 9771 | ------------------------------ |
| 9772 | |
| 9773 | +--------------------------------+-------------------------------------------+ |
| 9774 | | Name | Schema | |
| 9775 | +================================+===========================================+ |
| 9776 | | **capability**\ *optional* | string | |
| 9777 | +--------------------------------+-------------------------------------------+ |
| 9778 | | **capabilityOwnerId**\ *option | string | |
| 9779 | | al* | | |
| 9780 | +--------------------------------+-------------------------------------------+ |
| 9781 | | **capabilityUid**\ *optional* | string | |
| 9782 | +--------------------------------+-------------------------------------------+ |
| 9783 | | **id**\ *optional* | string | |
| 9784 | +--------------------------------+-------------------------------------------+ |
| 9785 | | **relationship**\ *optional* | `RelationshipImpl <#_relationshipimpl>`__ | |
| 9786 | +--------------------------------+-------------------------------------------+ |
| 9787 | | **requirement**\ *optional* | string | |
| 9788 | +--------------------------------+-------------------------------------------+ |
| 9789 | | **requirementOwnerId**\ *optio | string | |
| 9790 | | nal* | | |
| 9791 | +--------------------------------+-------------------------------------------+ |
| 9792 | | **requirementUid**\ *optional* | string | |
| 9793 | +--------------------------------+-------------------------------------------+ |
| 9794 | |
| 9795 | RequirementCapabilityRelDef |
| 9796 | --------------------------- |
| 9797 | |
| 9798 | +--------------------------------+-------------------------------------------+ |
| 9799 | | Name | Schema | |
| 9800 | +================================+===========================================+ |
| 9801 | | **fromNode**\ *optional* | string | |
| 9802 | +--------------------------------+-------------------------------------------+ |
| 9803 | | **relationships**\ *optional* | < | |
| 9804 | | | `RequirementAndRelationshipPair <#_requir | |
| 9805 | | | ementandrelationshippair>`__ | |
| 9806 | | | > array | |
| 9807 | +--------------------------------+-------------------------------------------+ |
| 9808 | | **toNode**\ *optional* | string | |
| 9809 | +--------------------------------+-------------------------------------------+ |
| 9810 | | **uid**\ *optional* | string | |
| 9811 | +--------------------------------+-------------------------------------------+ |
| 9812 | |
| 9813 | RequirementDefinition |
| 9814 | --------------------- |
| 9815 | |
| 9816 | +--------------------------------+-------------------------------------------+ |
| 9817 | | Name | Schema | |
| 9818 | +================================+===========================================+ |
| 9819 | | **capability**\ *optional* | string | |
| 9820 | +--------------------------------+-------------------------------------------+ |
| 9821 | | **leftOccurrences**\ *optional | string | |
| 9822 | | * | | |
| 9823 | +--------------------------------+-------------------------------------------+ |
| 9824 | | **maxOccurrences**\ *optional* | string | |
| 9825 | +--------------------------------+-------------------------------------------+ |
| 9826 | | **minOccurrences**\ *optional* | string | |
| 9827 | +--------------------------------+-------------------------------------------+ |
| 9828 | | **name**\ *optional* | string | |
| 9829 | +--------------------------------+-------------------------------------------+ |
| 9830 | | **node**\ *optional* | string | |
| 9831 | +--------------------------------+-------------------------------------------+ |
| 9832 | | **ownerId**\ *optional* | string | |
| 9833 | +--------------------------------+-------------------------------------------+ |
| 9834 | | **ownerName**\ *optional* | string | |
| 9835 | +--------------------------------+-------------------------------------------+ |
| 9836 | | **parentName**\ *optional* | string | |
| 9837 | +--------------------------------+-------------------------------------------+ |
| 9838 | | **path**\ *optional* | < string > array | |
| 9839 | +--------------------------------+-------------------------------------------+ |
| 9840 | | **relationship**\ *optional* | string | |
| 9841 | +--------------------------------+-------------------------------------------+ |
| 9842 | | **source**\ *optional* | string | |
| 9843 | +--------------------------------+-------------------------------------------+ |
| 9844 | | **uniqueId**\ *optional* | string | |
| 9845 | +--------------------------------+-------------------------------------------+ |
| 9846 | |
| 9847 | Resource |
| 9848 | -------- |
| 9849 | |
| 9850 | +--------------------------------+-------------------------------------------+ |
| 9851 | | Name | Schema | |
| 9852 | +================================+===========================================+ |
| 9853 | | **abstract**\ *optional* | boolean | |
| 9854 | +--------------------------------+-------------------------------------------+ |
| 9855 | | **additionalInformation**\ *op | < | |
| 9856 | | tional* | `AdditionalInformationDefinition <#_addit | |
| 9857 | | | ionalinformationdefinition>`__ | |
| 9858 | | | > array | |
| 9859 | +--------------------------------+-------------------------------------------+ |
| 9860 | | **allArtifacts**\ *optional* | < string, | |
| 9861 | | | `ArtifactDefinition <#_artifactdefinition | |
| 9862 | | | >`__ | |
| 9863 | | | > map | |
| 9864 | +--------------------------------+-------------------------------------------+ |
| 9865 | | **allVersions**\ *optional* | < string, string > map | |
| 9866 | +--------------------------------+-------------------------------------------+ |
| 9867 | | **artifacts**\ *optional* | < string, | |
| 9868 | | | `ArtifactDefinition <#_artifactdefinition | |
| 9869 | | | >`__ | |
| 9870 | | | > map | |
| 9871 | +--------------------------------+-------------------------------------------+ |
| 9872 | | **attributes**\ *optional* | < | |
| 9873 | | | `PropertyDefinition <#_propertydefinition | |
| 9874 | | | >`__ | |
| 9875 | | | > array | |
| 9876 | +--------------------------------+-------------------------------------------+ |
| 9877 | | **capabilities**\ *optional* | < string, < | |
| 9878 | | | `CapabilityDefinition <#_capabilitydefini | |
| 9879 | | | tion>`__ | |
| 9880 | | | > array > map | |
| 9881 | +--------------------------------+-------------------------------------------+ |
| 9882 | | **categories**\ *optional* | < | |
| 9883 | | | `CategoryDefinition <#_categorydefinition | |
| 9884 | | | >`__ | |
| 9885 | | | > array | |
| 9886 | +--------------------------------+-------------------------------------------+ |
| 9887 | | **componentInstances**\ *optio | < | |
| 9888 | | nal* | `ComponentInstance <#_componentinstance>` | |
| 9889 | | | __ | |
| 9890 | | | > array | |
| 9891 | +--------------------------------+-------------------------------------------+ |
| 9892 | | **componentInstancesAttributes | < string, < | |
| 9893 | | **\ *optional* | `ComponentInstanceProperty <#_componentin | |
| 9894 | | | stanceproperty>`__ | |
| 9895 | | | > array > map | |
| 9896 | +--------------------------------+-------------------------------------------+ |
| 9897 | | **componentInstancesInputs**\ | < string, < | |
| 9898 | | *optional* | `ComponentInstanceInput <#_componentinsta | |
| 9899 | | | nceinput>`__ | |
| 9900 | | | > array > map | |
| 9901 | +--------------------------------+-------------------------------------------+ |
| 9902 | | **componentInstancesProperties | < string, < | |
| 9903 | | **\ *optional* | `ComponentInstanceProperty <#_componentin | |
| 9904 | | | stanceproperty>`__ | |
| 9905 | | | > array > map | |
| 9906 | +--------------------------------+-------------------------------------------+ |
| 9907 | | **componentInstancesRelations* | < | |
| 9908 | | *\ *optional* | `RequirementCapabilityRelDef <#_requireme | |
| 9909 | | | ntcapabilityreldef>`__ | |
| 9910 | | | > array | |
| 9911 | +--------------------------------+-------------------------------------------+ |
| 9912 | | **componentMetadataDefinition* | `ComponentMetadataDefinition <#_component | |
| 9913 | | *\ *optional* | metadatadefinition>`__ | |
| 9914 | +--------------------------------+-------------------------------------------+ |
| 9915 | | **componentType**\ *optional* | enum (RESOURCE, SERVICE, | |
| 9916 | | | RESOURCE\_INSTANCE, PRODUCT, | |
| 9917 | | | SERVICE\_INSTANCE) | |
| 9918 | +--------------------------------+-------------------------------------------+ |
| 9919 | | **conformanceLevel**\ *optiona | string | |
| 9920 | | l* | | |
| 9921 | +--------------------------------+-------------------------------------------+ |
| 9922 | | **contactId**\ *optional* | string | |
| 9923 | +--------------------------------+-------------------------------------------+ |
| 9924 | | **cost**\ *optional* | string | |
| 9925 | +--------------------------------+-------------------------------------------+ |
| 9926 | | **creationDate**\ *optional* | integer (int64) | |
| 9927 | +--------------------------------+-------------------------------------------+ |
| 9928 | | **creatorFullName**\ *optional | string | |
| 9929 | | * | | |
| 9930 | +--------------------------------+-------------------------------------------+ |
| 9931 | | **creatorUserId**\ *optional* | string | |
| 9932 | +--------------------------------+-------------------------------------------+ |
| 9933 | | **csarUUID**\ *optional* | string | |
| 9934 | +--------------------------------+-------------------------------------------+ |
| 9935 | | **csarVersion**\ *optional* | string | |
| 9936 | +--------------------------------+-------------------------------------------+ |
| 9937 | | **defaultCapabilities**\ *opti | < string > array | |
| 9938 | | onal* | | |
| 9939 | +--------------------------------+-------------------------------------------+ |
| 9940 | | **deploymentArtifacts**\ *opti | < string, | |
| 9941 | | onal* | `ArtifactDefinition <#_artifactdefinition | |
| 9942 | | | >`__ | |
| 9943 | | | > map | |
| 9944 | +--------------------------------+-------------------------------------------+ |
| 9945 | | **derivedFrom**\ *optional* | < string > array | |
| 9946 | +--------------------------------+-------------------------------------------+ |
| 9947 | | **derivedFromGenericType**\ *o | string | |
| 9948 | | ptional* | | |
| 9949 | +--------------------------------+-------------------------------------------+ |
| 9950 | | **derivedFromGenericVersion**\ | string | |
| 9951 | | *optional* | | |
| 9952 | +--------------------------------+-------------------------------------------+ |
| 9953 | | **derivedList**\ *optional* | < string > array | |
| 9954 | +--------------------------------+-------------------------------------------+ |
| 9955 | | **description**\ *optional* | string | |
| 9956 | +--------------------------------+-------------------------------------------+ |
| 9957 | | **groups**\ *optional* | < `GroupDefinition <#_groupdefinition>`__ | |
| 9958 | | | > array | |
| 9959 | +--------------------------------+-------------------------------------------+ |
| 9960 | | **highestVersion**\ *optional* | boolean | |
| 9961 | +--------------------------------+-------------------------------------------+ |
| 9962 | | **icon**\ *optional* | string | |
| 9963 | +--------------------------------+-------------------------------------------+ |
| 9964 | | **importedToscaChecksum**\ *op | string | |
| 9965 | | tional* | | |
| 9966 | +--------------------------------+-------------------------------------------+ |
| 9967 | | **inputs**\ *optional* | < `InputDefinition <#_inputdefinition>`__ | |
| 9968 | | | > array | |
| 9969 | +--------------------------------+-------------------------------------------+ |
| 9970 | | **interfaces**\ *optional* | < string, | |
| 9971 | | | `InterfaceDefinition <#_interfacedefiniti | |
| 9972 | | | on>`__ | |
| 9973 | | | > map | |
| 9974 | +--------------------------------+-------------------------------------------+ |
| 9975 | | **invariantUUID**\ *optional* | string | |
| 9976 | +--------------------------------+-------------------------------------------+ |
| 9977 | | **isDeleted**\ *optional* | boolean | |
| 9978 | +--------------------------------+-------------------------------------------+ |
| 9979 | | **lastUpdateDate**\ *optional* | integer (int64) | |
| 9980 | +--------------------------------+-------------------------------------------+ |
| 9981 | | **lastUpdaterFullName**\ *opti | string | |
| 9982 | | onal* | | |
| 9983 | +--------------------------------+-------------------------------------------+ |
| 9984 | | **lastUpdaterUserId**\ *option | string | |
| 9985 | | al* | | |
| 9986 | +--------------------------------+-------------------------------------------+ |
| 9987 | | **licenseType**\ *optional* | string | |
| 9988 | +--------------------------------+-------------------------------------------+ |
| 9989 | | **lifecycleState**\ *optional* | enum (READY\_FOR\_CERTIFICATION, | |
| 9990 | | | CERTIFICATION\_IN\_PROGRESS, CERTIFIED, | |
| 9991 | | | NOT\_CERTIFIED\_CHECKIN, | |
| 9992 | | | NOT\_CERTIFIED\_CHECKOUT) | |
| 9993 | +--------------------------------+-------------------------------------------+ |
| 9994 | | **name**\ *optional* | string | |
| 9995 | +--------------------------------+-------------------------------------------+ |
| 9996 | | **normalizedName**\ *optional* | string | |
| 9997 | +--------------------------------+-------------------------------------------+ |
| 9998 | | **projectCode**\ *optional* | string | |
| 9999 | +--------------------------------+-------------------------------------------+ |
| 10000 | | **properties**\ *optional* | < | |
| 10001 | | | `PropertyDefinition <#_propertydefinition | |
| 10002 | | | >`__ | |
| 10003 | | | > array | |
| 10004 | +--------------------------------+-------------------------------------------+ |
| 10005 | | **requirements**\ *optional* | < string, < | |
| 10006 | | | `RequirementDefinition <#_requirementdefi | |
| 10007 | | | nition>`__ | |
| 10008 | | | > array > map | |
| 10009 | +--------------------------------+-------------------------------------------+ |
| 10010 | | **resourceType**\ *optional* | enum (VFC, VF, CP, PNF, CVFC, VL, VFCMT, | |
| 10011 | | | ABSTRACT) | |
| 10012 | +--------------------------------+-------------------------------------------+ |
| 10013 | | **resourceVendorModelNumber**\ | string | |
| 10014 | | *optional* | | |
| 10015 | +--------------------------------+-------------------------------------------+ |
| 10016 | | **systemName**\ *optional* | string | |
| 10017 | +--------------------------------+-------------------------------------------+ |
| 10018 | | **tags**\ *optional* | < string > array | |
| 10019 | +--------------------------------+-------------------------------------------+ |
| 10020 | | **toscaArtifacts**\ *optional* | < string, | |
| 10021 | | | `ArtifactDefinition <#_artifactdefinition | |
| 10022 | | | >`__ | |
| 10023 | | | > map | |
| 10024 | +--------------------------------+-------------------------------------------+ |
| 10025 | | **toscaResourceName**\ *option | string | |
| 10026 | | al* | | |
| 10027 | +--------------------------------+-------------------------------------------+ |
| 10028 | | **toscaType**\ *optional* | string | |
| 10029 | +--------------------------------+-------------------------------------------+ |
| 10030 | | **uniqueId**\ *optional* | string | |
| 10031 | +--------------------------------+-------------------------------------------+ |
| 10032 | | **uuid**\ *optional* | string | |
| 10033 | +--------------------------------+-------------------------------------------+ |
| 10034 | | **vendorName**\ *optional* | string | |
| 10035 | +--------------------------------+-------------------------------------------+ |
| 10036 | | **vendorRelease**\ *optional* | string | |
| 10037 | +--------------------------------+-------------------------------------------+ |
| 10038 | | **version**\ *optional* | string | |
| 10039 | +--------------------------------+-------------------------------------------+ |
| 10040 | |
| 10041 | SchemaDefinition |
| 10042 | ---------------- |
| 10043 | |
| 10044 | +--------------------------------+-------------------------------------------+ |
| 10045 | | Name | Schema | |
| 10046 | +================================+===========================================+ |
| 10047 | | **constraints**\ *optional* | < string > array | |
| 10048 | +--------------------------------+-------------------------------------------+ |
| 10049 | | **derivedFrom**\ *optional* | string | |
| 10050 | +--------------------------------+-------------------------------------------+ |
| 10051 | | **ownerId**\ *optional* | string | |
| 10052 | +--------------------------------+-------------------------------------------+ |
| 10053 | | **properties**\ *optional* | < string, | |
| 10054 | | | `PropertyDataDefinition <#_propertydatade | |
| 10055 | | | finition>`__ | |
| 10056 | | | > map | |
| 10057 | +--------------------------------+-------------------------------------------+ |
| 10058 | | **property**\ *optional* | `PropertyDataDefinition <#_propertydatade | |
| 10059 | | | finition>`__ | |
| 10060 | +--------------------------------+-------------------------------------------+ |
| 10061 | |
| 10062 | Service |
| 10063 | ------- |
| 10064 | |
| 10065 | +--------------------------------+-------------------------------------------+ |
| 10066 | | Name | Schema | |
| 10067 | +================================+===========================================+ |
| 10068 | | **additionalInformation**\ *op | < | |
| 10069 | | tional* | `AdditionalInformationDefinition <#_addit | |
| 10070 | | | ionalinformationdefinition>`__ | |
| 10071 | | | > array | |
| 10072 | +--------------------------------+-------------------------------------------+ |
| 10073 | | **allArtifacts**\ *optional* | < string, | |
| 10074 | | | `ArtifactDefinition <#_artifactdefinition | |
| 10075 | | | >`__ | |
| 10076 | | | > map | |
| 10077 | +--------------------------------+-------------------------------------------+ |
| 10078 | | **allVersions**\ *optional* | < string, string > map | |
| 10079 | +--------------------------------+-------------------------------------------+ |
| 10080 | | **artifacts**\ *optional* | < string, | |
| 10081 | | | `ArtifactDefinition <#_artifactdefinition | |
| 10082 | | | >`__ | |
| 10083 | | | > map | |
| 10084 | +--------------------------------+-------------------------------------------+ |
| 10085 | | **capabilities**\ *optional* | < string, < | |
| 10086 | | | `CapabilityDefinition <#_capabilitydefini | |
| 10087 | | | tion>`__ | |
| 10088 | | | > array > map | |
| 10089 | +--------------------------------+-------------------------------------------+ |
| 10090 | | **categories**\ *optional* | < | |
| 10091 | | | `CategoryDefinition <#_categorydefinition | |
| 10092 | | | >`__ | |
| 10093 | | | > array | |
| 10094 | +--------------------------------+-------------------------------------------+ |
| 10095 | | **componentInstances**\ *optio | < | |
| 10096 | | nal* | `ComponentInstance <#_componentinstance>` | |
| 10097 | | | __ | |
| 10098 | | | > array | |
| 10099 | +--------------------------------+-------------------------------------------+ |
| 10100 | | **componentInstancesAttributes | < string, < | |
| 10101 | | **\ *optional* | `ComponentInstanceProperty <#_componentin | |
| 10102 | | | stanceproperty>`__ | |
| 10103 | | | > array > map | |
| 10104 | +--------------------------------+-------------------------------------------+ |
| 10105 | | **componentInstancesInputs**\ | < string, < | |
| 10106 | | *optional* | `ComponentInstanceInput <#_componentinsta | |
| 10107 | | | nceinput>`__ | |
| 10108 | | | > array > map | |
| 10109 | +--------------------------------+-------------------------------------------+ |
| 10110 | | **componentInstancesProperties | < string, < | |
| 10111 | | **\ *optional* | `ComponentInstanceProperty <#_componentin | |
| 10112 | | | stanceproperty>`__ | |
| 10113 | | | > array > map | |
| 10114 | +--------------------------------+-------------------------------------------+ |
| 10115 | | **componentInstancesRelations* | < | |
| 10116 | | *\ *optional* | `RequirementCapabilityRelDef <#_requireme | |
| 10117 | | | ntcapabilityreldef>`__ | |
| 10118 | | | > array | |
| 10119 | +--------------------------------+-------------------------------------------+ |
| 10120 | | **componentMetadataDefinition* | `ComponentMetadataDefinition <#_component | |
| 10121 | | *\ *optional* | metadatadefinition>`__ | |
| 10122 | +--------------------------------+-------------------------------------------+ |
| 10123 | | **componentType**\ *optional* | enum (RESOURCE, SERVICE, | |
| 10124 | | | RESOURCE\_INSTANCE, PRODUCT, | |
| 10125 | | | SERVICE\_INSTANCE) | |
| 10126 | +--------------------------------+-------------------------------------------+ |
| 10127 | | **conformanceLevel**\ *optiona | string | |
| 10128 | | l* | | |
| 10129 | +--------------------------------+-------------------------------------------+ |
| 10130 | | **contactId**\ *optional* | string | |
| 10131 | +--------------------------------+-------------------------------------------+ |
| 10132 | | **creationDate**\ *optional* | integer (int64) | |
| 10133 | +--------------------------------+-------------------------------------------+ |
| 10134 | | **creatorFullName**\ *optional | string | |
| 10135 | | * | | |
| 10136 | +--------------------------------+-------------------------------------------+ |
| 10137 | | **creatorUserId**\ *optional* | string | |
| 10138 | +--------------------------------+-------------------------------------------+ |
| 10139 | | **csarUUID**\ *optional* | string | |
| 10140 | +--------------------------------+-------------------------------------------+ |
| 10141 | | **csarVersion**\ *optional* | string | |
| 10142 | +--------------------------------+-------------------------------------------+ |
| 10143 | | **deploymentArtifacts**\ *opti | < string, | |
| 10144 | | onal* | `ArtifactDefinition <#_artifactdefinition | |
| 10145 | | | >`__ | |
| 10146 | | | > map | |
| 10147 | +--------------------------------+-------------------------------------------+ |
| 10148 | | **derivedFromGenericType**\ *o | string | |
| 10149 | | ptional* | | |
| 10150 | +--------------------------------+-------------------------------------------+ |
| 10151 | | **derivedFromGenericVersion**\ | string | |
| 10152 | | *optional* | | |
| 10153 | +--------------------------------+-------------------------------------------+ |
| 10154 | | **description**\ *optional* | string | |
| 10155 | +--------------------------------+-------------------------------------------+ |
| 10156 | | **distributionStatus**\ *optio | enum (DISTRIBUTION\_NOT\_APPROVED, | |
| 10157 | | nal* | DISTRIBUTION\_APPROVED, DISTRIBUTED, | |
| 10158 | | | DISTRIBUTION\_REJECTED) | |
| 10159 | +--------------------------------+-------------------------------------------+ |
| 10160 | | **ecompGeneratedNaming**\ *opt | boolean | |
| 10161 | | ional* | | |
| 10162 | +--------------------------------+-------------------------------------------+ |
| 10163 | | **groups**\ *optional* | < `GroupDefinition <#_groupdefinition>`__ | |
| 10164 | | | > array | |
| 10165 | +--------------------------------+-------------------------------------------+ |
| 10166 | | **highestVersion**\ *optional* | boolean | |
| 10167 | +--------------------------------+-------------------------------------------+ |
| 10168 | | **icon**\ *optional* | string | |
| 10169 | +--------------------------------+-------------------------------------------+ |
| 10170 | | **importedToscaChecksum**\ *op | string | |
| 10171 | | tional* | | |
| 10172 | +--------------------------------+-------------------------------------------+ |
| 10173 | | **inputs**\ *optional* | < `InputDefinition <#_inputdefinition>`__ | |
| 10174 | | | > array | |
| 10175 | +--------------------------------+-------------------------------------------+ |
| 10176 | | **invariantUUID**\ *optional* | string | |
| 10177 | +--------------------------------+-------------------------------------------+ |
| 10178 | | **isDeleted**\ *optional* | boolean | |
| 10179 | +--------------------------------+-------------------------------------------+ |
| 10180 | | **lastUpdateDate**\ *optional* | integer (int64) | |
| 10181 | +--------------------------------+-------------------------------------------+ |
| 10182 | | **lastUpdaterFullName**\ *opti | string | |
| 10183 | | onal* | | |
| 10184 | +--------------------------------+-------------------------------------------+ |
| 10185 | | **lastUpdaterUserId**\ *option | string | |
| 10186 | | al* | | |
| 10187 | +--------------------------------+-------------------------------------------+ |
| 10188 | | **lifecycleState**\ *optional* | enum (READY\_FOR\_CERTIFICATION, | |
| 10189 | | | CERTIFICATION\_IN\_PROGRESS, CERTIFIED, | |
| 10190 | | | NOT\_CERTIFIED\_CHECKIN, | |
| 10191 | | | NOT\_CERTIFIED\_CHECKOUT) | |
| 10192 | +--------------------------------+-------------------------------------------+ |
| 10193 | | **name**\ *optional* | string | |
| 10194 | +--------------------------------+-------------------------------------------+ |
| 10195 | | **namingPolicy**\ *optional* | string | |
| 10196 | +--------------------------------+-------------------------------------------+ |
| 10197 | | **normalizedName**\ *optional* | string | |
| 10198 | +--------------------------------+-------------------------------------------+ |
| 10199 | | **projectCode**\ *optional* | string | |
| 10200 | +--------------------------------+-------------------------------------------+ |
| 10201 | | **requirements**\ *optional* | < string, < | |
| 10202 | | | `RequirementDefinition <#_requirementdefi | |
| 10203 | | | nition>`__ | |
| 10204 | | | > array > map | |
| 10205 | +--------------------------------+-------------------------------------------+ |
| 10206 | | **serviceApiArtifacts**\ *opti | < string, | |
| 10207 | | onal* | `ArtifactDefinition <#_artifactdefinition | |
| 10208 | | | >`__ | |
| 10209 | | | > map | |
| 10210 | +--------------------------------+-------------------------------------------+ |
| 10211 | | **serviceRole**\ *optional* | string | |
| 10212 | +--------------------------------+-------------------------------------------+ |
| 10213 | | **serviceType**\ *optional* | string | |
| 10214 | +--------------------------------+-------------------------------------------+ |
| 10215 | | **systemName**\ *optional* | string | |
| 10216 | +--------------------------------+-------------------------------------------+ |
| 10217 | | **tags**\ *optional* | < string > array | |
| 10218 | +--------------------------------+-------------------------------------------+ |
| 10219 | | **toscaArtifacts**\ *optional* | < string, | |
| 10220 | | | `ArtifactDefinition <#_artifactdefinition | |
| 10221 | | | >`__ | |
| 10222 | | | > map | |
| 10223 | +--------------------------------+-------------------------------------------+ |
| 10224 | | **toscaType**\ *optional* | string | |
| 10225 | +--------------------------------+-------------------------------------------+ |
| 10226 | | **uniqueId**\ *optional* | string | |
| 10227 | +--------------------------------+-------------------------------------------+ |
| 10228 | | **uuid**\ *optional* | string | |
| 10229 | +--------------------------------+-------------------------------------------+ |
| 10230 | | **version**\ *optional* | string | |
| 10231 | +--------------------------------+-------------------------------------------+ |
| 10232 | |
| 10233 | SubCategoryDefinition |
| 10234 | --------------------- |
| 10235 | |
| 10236 | +--------------------------------+-------------------------------------------+ |
| 10237 | | Name | Schema | |
| 10238 | +================================+===========================================+ |
| 10239 | | **groupings**\ *optional* | < | |
| 10240 | | | `GroupingDefinition <#_groupingdefinition | |
| 10241 | | | >`__ | |
| 10242 | | | > array | |
| 10243 | +--------------------------------+-------------------------------------------+ |
| 10244 | | **icons**\ *optional* | < string > array | |
| 10245 | +--------------------------------+-------------------------------------------+ |
| 10246 | | **name**\ *optional* | string | |
| 10247 | +--------------------------------+-------------------------------------------+ |
| 10248 | | **normalizedName**\ *optional* | string | |
| 10249 | +--------------------------------+-------------------------------------------+ |
| 10250 | | **ownerId**\ *optional* | string | |
| 10251 | +--------------------------------+-------------------------------------------+ |
| 10252 | | **uniqueId**\ *optional* | string | |
| 10253 | +--------------------------------+-------------------------------------------+ |
| 10254 | |
| 10255 | User |
| 10256 | ---- |
| 10257 | |
| 10258 | +--------------------------------+-------------------------------------------+ |
| 10259 | | Name | Schema | |
| 10260 | +================================+===========================================+ |
| 10261 | | **email**\ *optional* | string | |
| 10262 | +--------------------------------+-------------------------------------------+ |
| 10263 | | **firstName**\ *optional* | string | |
| 10264 | +--------------------------------+-------------------------------------------+ |
| 10265 | | **fullName**\ *optional* | string | |
| 10266 | +--------------------------------+-------------------------------------------+ |
| 10267 | | **lastLoginTime**\ *optional* | integer (int64) | |
| 10268 | +--------------------------------+-------------------------------------------+ |
| 10269 | | **lastName**\ *optional* | string | |
| 10270 | +--------------------------------+-------------------------------------------+ |
| 10271 | | **role**\ *optional* | string | |
| 10272 | +--------------------------------+-------------------------------------------+ |
| 10273 | | **status**\ *optional* | enum (ACTIVE, INACTIVE) | |
| 10274 | +--------------------------------+-------------------------------------------+ |
| 10275 | | **userId**\ *optional* | string | |
| 10276 | +--------------------------------+-------------------------------------------+ |