docs/sections/apis/inventory.rst

   1 DCAE Inventory API 2.1.0
   2 ========================
   3
   4 .. toctree::
   5     :maxdepth: 3
   6
   7
   8 Description
   9 ~~~~~~~~~~~
  10
  11 DCAE Inventory is a web service that provides the following:
  12
  13 1. Real-time data on all DCAE services and their components
  14 2. Comprehensive details on available DCAE service types
  15
  16
  17
  18
  19 Contact Information
  20 ~~~~~~~~~~~~~~~~~~~
  21
  22
  23
  24 dcae@lists.openecomp.org
  25
  26
  27
  28
  29
  30
  31 DEFAULT
  32 ~~~~~~~
  33
  34
  35
  36
  37 GET ``/dcae-service-types``
  38 ---------------------------
  39
  40
  41
  42 Description
  43 +++++++++++
  44
  45 .. raw:: html
  46
  47     Get a list of `DCAEServiceType` objects.
  48
  49 Parameters
  50 ++++++++++
  51
  52 .. csv-table::
  53     :delim: |
  54     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
  55     :widths: 20, 15, 10, 10, 10, 20, 30
  56
  57         typeName | query | No | string |  |  | Filter by service type name
  58         onlyLatest | query | No | boolean |  | {"default": true} | If set to true, query returns just the latest versions of DCAE service types. If set to false, then all versions are returned. Default is true
  59         onlyActive | query | No | boolean |  | {"default": true} | If set to true, query returns only *active* DCAE service types. If set to false, then all DCAE service types are returned. Default is true
  60         vnfType | query | No | string |  |  | Filter by associated vnf type. No wildcards, matches are explicit. This field is treated case insensitive.
  61         serviceId | query | No | string |  |  | Filter by assocaited service id. Instances with service id null or empty is always returned.
  62         serviceLocation | query | No | string |  |  | Filter by associated service location. Instances with service location null or empty is always returned.
  63         asdcServiceId | query | No | string |  |  | Filter by associated asdc design service id. Setting this to `NONE` will return instances that have asdc service id set to null
  64         asdcResourceId | query | No | string |  |  | Filter by associated asdc design resource id. Setting this to `NONE` will return instances that have asdc resource id set to null
  65         offset | query | No | integer | int32 |  | Query resultset offset used for pagination (zero-based)
  66
  67
  68 Request
  69 +++++++
  70
  71
  72 Responses
  73 +++++++++
  74
  75 **200**
  76 ^^^^^^^
  77
  78 List of `DCAEServiceType` objects
  79
  80
  81 Type: :ref:`InlineResponse200 <d_b1ccd4187d31690b8e704c0aa01b2c59>`
  82
  83 **Example:**
  84
  85 .. code-block:: javascript
  86
  87     {
  88         "items": [
  89             {
  90                 "asdcResourceId": "somestring",
  91                 "asdcServiceId": "somestring",
  92                 "asdcServiceURL": "somestring",
  93                 "blueprintTemplate": "somestring",
  94                 "created": "2015-01-01T15:00:00.000Z",
  95                 "deactivated": "2015-01-01T15:00:00.000Z",
  96                 "owner": "somestring",
  97                 "selfLink": {
  98                     "params": {},
  99                     "rel": "somestring",
 100                     "rels": [
 101                         "somestring",
 102                         "somestring"
 103                     ],
 104                     "title": "somestring",
 105                     "type": "somestring",
 106                     "uri": "somestring",
 107                     "uriBuilder": {}
 108                 },
 109                 "serviceIds": [
 110                     "somestring",
 111                     "somestring"
 112                 ],
 113                 "serviceLocations": [
 114                     "somestring",
 115                     "somestring"
 116                 ],
 117                 "typeId": "somestring",
 118                 "typeName": "somestring",
 119                 "typeVersion": 1,
 120                 "vnfTypes": [
 121                     "somestring",
 122                     "somestring"
 123                 ]
 124             },
 125             {
 126                 "asdcResourceId": "somestring",
 127                 "asdcServiceId": "somestring",
 128                 "asdcServiceURL": "somestring",
 129                 "blueprintTemplate": "somestring",
 130                 "created": "2015-01-01T15:00:00.000Z",
 131                 "deactivated": "2015-01-01T15:00:00.000Z",
 132                 "owner": "somestring",
 133                 "selfLink": {
 134                     "params": {},
 135                     "rel": "somestring",
 136                     "rels": [
 137                         "somestring",
 138                         "somestring"
 139                     ],
 140                     "title": "somestring",
 141                     "type": "somestring",
 142                     "uri": "somestring",
 143                     "uriBuilder": {}
 144                 },
 145                 "serviceIds": [
 146                     "somestring",
 147                     "somestring"
 148                 ],
 149                 "serviceLocations": [
 150                     "somestring",
 151                     "somestring"
 152                 ],
 153                 "typeId": "somestring",
 154                 "typeName": "somestring",
 155                 "typeVersion": 1,
 156                 "vnfTypes": [
 157                     "somestring",
 158                     "somestring"
 159                 ]
 160             }
 161         ],
 162         "links": {
 163             "nextLink": {
 164                 "params": {},
 165                 "rel": "somestring",
 166                 "rels": [
 167                     "somestring",
 168                     "somestring"
 169                 ],
 170                 "title": "somestring",
 171                 "type": "somestring",
 172                 "uri": "somestring",
 173                 "uriBuilder": {}
 174             },
 175             "previousLink": {
 176                 "params": {},
 177                 "rel": "somestring",
 178                 "rels": [
 179                     "somestring",
 180                     "somestring"
 181                 ],
 182                 "title": "somestring",
 183                 "type": "somestring",
 184                 "uri": "somestring",
 185                 "uriBuilder": {}
 186             }
 187         },
 188         "totalCount": 1
 189     }
 190
 191
 192
 193
 194
 195 DELETE ``/dcae-service-types/{typeId}``
 196 ---------------------------------------
 197
 198
 199
 200 Description
 201 +++++++++++
 202
 203 .. raw:: html
 204
 205     Deactivates existing `DCAEServiceType` instances
 206
 207 Parameters
 208 ++++++++++
 209
 210 .. csv-table::
 211     :delim: |
 212     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 213     :widths: 20, 15, 10, 10, 10, 20, 30
 214
 215         typeId | path | Yes | string |  |  |
 216
 217
 218 Request
 219 +++++++
 220
 221
 222 Responses
 223 +++++++++
 224
 225 **200**
 226 ^^^^^^^
 227
 228 `DCAEServiceType` has been deactivated
 229
 230
 231 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
 232
 233 **Example:**
 234
 235 .. code-block:: javascript
 236
 237     {
 238         "code": 1,
 239         "message": "somestring",
 240         "type": "somestring"
 241     }
 242
 243 **404**
 244 ^^^^^^^
 245
 246 `DCAEServiceType` not found
 247
 248
 249 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
 250
 251 **Example:**
 252
 253 .. code-block:: javascript
 254
 255     {
 256         "code": 1,
 257         "message": "somestring",
 258         "type": "somestring"
 259     }
 260
 261 **410**
 262 ^^^^^^^
 263
 264 `DCAEServiceType` already gone
 265
 266
 267 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
 268
 269 **Example:**
 270
 271 .. code-block:: javascript
 272
 273     {
 274         "code": 1,
 275         "message": "somestring",
 276         "type": "somestring"
 277     }
 278
 279
 280
 281
 282
 283 GET ``/dcae-service-types/{typeId}``
 284 ------------------------------------
 285
 286
 287
 288 Description
 289 +++++++++++
 290
 291 .. raw:: html
 292
 293     Get a `DCAEServiceType` object.
 294
 295 Parameters
 296 ++++++++++
 297
 298 .. csv-table::
 299     :delim: |
 300     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 301     :widths: 20, 15, 10, 10, 10, 20, 30
 302
 303         typeId | path | Yes | string |  |  |
 304
 305
 306 Request
 307 +++++++
 308
 309
 310 Responses
 311 +++++++++
 312
 313 **200**
 314 ^^^^^^^
 315
 316 Single `DCAEServiceType` object
 317
 318
 319 Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>`
 320
 321 **Example:**
 322
 323 .. code-block:: javascript
 324
 325     {
 326         "asdcResourceId": "somestring",
 327         "asdcServiceId": "somestring",
 328         "asdcServiceURL": "somestring",
 329         "blueprintTemplate": "somestring",
 330         "created": "2015-01-01T15:00:00.000Z",
 331         "deactivated": "2015-01-01T15:00:00.000Z",
 332         "owner": "somestring",
 333         "selfLink": {
 334             "params": {},
 335             "rel": "somestring",
 336             "rels": [
 337                 "somestring",
 338                 "somestring"
 339             ],
 340             "title": "somestring",
 341             "type": "somestring",
 342             "uri": "somestring",
 343             "uriBuilder": {}
 344         },
 345         "serviceIds": [
 346             "somestring",
 347             "somestring"
 348         ],
 349         "serviceLocations": [
 350             "somestring",
 351             "somestring"
 352         ],
 353         "typeId": "somestring",
 354         "typeName": "somestring",
 355         "typeVersion": 1,
 356         "vnfTypes": [
 357             "somestring",
 358             "somestring"
 359         ]
 360     }
 361
 362 **404**
 363 ^^^^^^^
 364
 365 Resource not found
 366
 367
 368 Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>`
 369
 370 **Example:**
 371
 372 .. code-block:: javascript
 373
 374     {
 375         "asdcResourceId": "somestring",
 376         "asdcServiceId": "somestring",
 377         "asdcServiceURL": "somestring",
 378         "blueprintTemplate": "somestring",
 379         "created": "2015-01-01T15:00:00.000Z",
 380         "deactivated": "2015-01-01T15:00:00.000Z",
 381         "owner": "somestring",
 382         "selfLink": {
 383             "params": {},
 384             "rel": "somestring",
 385             "rels": [
 386                 "somestring",
 387                 "somestring"
 388             ],
 389             "title": "somestring",
 390             "type": "somestring",
 391             "uri": "somestring",
 392             "uriBuilder": {}
 393         },
 394         "serviceIds": [
 395             "somestring",
 396             "somestring"
 397         ],
 398         "serviceLocations": [
 399             "somestring",
 400             "somestring"
 401         ],
 402         "typeId": "somestring",
 403         "typeName": "somestring",
 404         "typeVersion": 1,
 405         "vnfTypes": [
 406             "somestring",
 407             "somestring"
 408         ]
 409     }
 410
 411
 412
 413
 414
 415 POST ``/dcae-service-types``
 416 ----------------------------
 417
 418
 419
 420 Description
 421 +++++++++++
 422
 423 .. raw:: html
 424
 425     Inserts a new `DCAEServiceType` or updates an existing instance. Updates are only allowed iff there are no running DCAE services of the requested type,
 426
 427
 428 Request
 429 +++++++
 430
 431
 432
 433 .. _d_57dc24aa38507ded2f27eec90206336e:
 434
 435 Body
 436 ^^^^
 437
 438 .. csv-table::
 439     :delim: |
 440     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
 441     :widths: 20, 10, 15, 15, 30, 25
 442
 443         asdcResourceId | No | string |  |  | Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`.
 444         asdcServiceId | No | string |  |  | Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`.
 445         asdcServiceURL | No | string |  |  | URL to the ASDC service model
 446         blueprintTemplate | Yes | string |  |  | String representation of a Cloudify blueprint with unbound variables
 447         owner | Yes | string |  |  |
 448         serviceIds | No | array of string |  |  | List of service ids that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service id.
 449         serviceLocations | No | array of string |  |  | List of service locations that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service location.
 450         typeName | Yes | string |  |  | Descriptive name for this DCAE service type
 451         typeVersion | Yes | integer | int32 |  | Version number for this DCAE service type
 452         vnfTypes | No | array of string |  |  |
 453
 454 .. code-block:: javascript
 455
 456     {
 457         "asdcResourceId": "somestring",
 458         "asdcServiceId": "somestring",
 459         "asdcServiceURL": "somestring",
 460         "blueprintTemplate": "somestring",
 461         "owner": "somestring",
 462         "serviceIds": [
 463             "somestring",
 464             "somestring"
 465         ],
 466         "serviceLocations": [
 467             "somestring",
 468             "somestring"
 469         ],
 470         "typeName": "somestring",
 471         "typeVersion": 1,
 472         "vnfTypes": [
 473             "somestring",
 474             "somestring"
 475         ]
 476     }
 477
 478 Responses
 479 +++++++++
 480
 481 **200**
 482 ^^^^^^^
 483
 484 Single `DCAEServiceType` object.
 485
 486
 487 Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>`
 488
 489 **Example:**
 490
 491 .. code-block:: javascript
 492
 493     {
 494         "asdcResourceId": "somestring",
 495         "asdcServiceId": "somestring",
 496         "asdcServiceURL": "somestring",
 497         "blueprintTemplate": "somestring",
 498         "created": "2015-01-01T15:00:00.000Z",
 499         "deactivated": "2015-01-01T15:00:00.000Z",
 500         "owner": "somestring",
 501         "selfLink": {
 502             "params": {},
 503             "rel": "somestring",
 504             "rels": [
 505                 "somestring",
 506                 "somestring"
 507             ],
 508             "title": "somestring",
 509             "type": "somestring",
 510             "uri": "somestring",
 511             "uriBuilder": {}
 512         },
 513         "serviceIds": [
 514             "somestring",
 515             "somestring"
 516         ],
 517         "serviceLocations": [
 518             "somestring",
 519             "somestring"
 520         ],
 521         "typeId": "somestring",
 522         "typeName": "somestring",
 523         "typeVersion": 1,
 524         "vnfTypes": [
 525             "somestring",
 526             "somestring"
 527         ]
 528     }
 529
 530 **400**
 531 ^^^^^^^
 532
 533 Bad request provided.
 534
 535
 536 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
 537
 538 **Example:**
 539
 540 .. code-block:: javascript
 541
 542     {
 543         "code": 1,
 544         "message": "somestring",
 545         "type": "somestring"
 546     }
 547
 548 **409**
 549 ^^^^^^^
 550
 551 Failed to update because there are still DCAE services of the requested type running.
 552
 553
 554 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
 555
 556 **Example:**
 557
 558 .. code-block:: javascript
 559
 560     {
 561         "code": 1,
 562         "message": "somestring",
 563         "type": "somestring"
 564     }
 565
 566
 567
 568
 569
 570 GET ``/dcae-services``
 571 ----------------------
 572
 573
 574
 575 Description
 576 +++++++++++
 577
 578 .. raw:: html
 579
 580     Get a list of `DCAEService` objects.
 581
 582 Parameters
 583 ++++++++++
 584
 585 .. csv-table::
 586     :delim: |
 587     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 588     :widths: 20, 15, 10, 10, 10, 20, 30
 589
 590         typeId | query | No | string |  |  | DCAE service type name
 591         vnfId | query | No | string |  |  |
 592         vnfType | query | No | string |  |  | Filter by associated vnf type. This field is treated case insensitive.
 593         vnfLocation | query | No | string |  |  |
 594         componentType | query | No | string |  |  | Use to filter by a specific DCAE service component type
 595         shareable | query | No | boolean |  |  | Use to filter by DCAE services that have shareable components or not
 596         created | query | No | string |  |  | Use to filter by created time
 597         offset | query | No | integer | int32 |  | Query resultset offset used for pagination (zero-based)
 598
 599
 600 Request
 601 +++++++
 602
 603
 604 Responses
 605 +++++++++
 606
 607 **200**
 608 ^^^^^^^
 609
 610 List of `DCAEService` objects
 611
 612
 613 Type: :ref:`InlineResponse2001 <d_31bb361a8900a0bed20df49b94f1e33b>`
 614
 615 **Example:**
 616
 617 .. code-block:: javascript
 618
 619     {
 620         "items": [
 621             {
 622                 "components": [
 623                     {
 624                         "componentId": "somestring",
 625                         "componentLink": {
 626                             "params": {},
 627                             "rel": "somestring",
 628                             "rels": [
 629                                 "somestring",
 630                                 "somestring"
 631                             ],
 632                             "title": "somestring",
 633                             "type": "somestring",
 634                             "uri": "somestring",
 635                             "uriBuilder": {}
 636                         },
 637                         "componentSource": "DCAEController",
 638                         "componentType": "somestring",
 639                         "created": "2015-01-01T15:00:00.000Z",
 640                         "location": "somestring",
 641                         "modified": "2015-01-01T15:00:00.000Z",
 642                         "shareable": 1,
 643                         "status": "somestring"
 644                     },
 645                     {
 646                         "componentId": "somestring",
 647                         "componentLink": {
 648                             "params": {},
 649                             "rel": "somestring",
 650                             "rels": [
 651                                 "somestring",
 652                                 "somestring"
 653                             ],
 654                             "title": "somestring",
 655                             "type": "somestring",
 656                             "uri": "somestring",
 657                             "uriBuilder": {}
 658                         },
 659                         "componentSource": "DCAEController",
 660                         "componentType": "somestring",
 661                         "created": "2015-01-01T15:00:00.000Z",
 662                         "location": "somestring",
 663                         "modified": "2015-01-01T15:00:00.000Z",
 664                         "shareable": 1,
 665                         "status": "somestring"
 666                     }
 667                 ],
 668                 "created": "2015-01-01T15:00:00.000Z",
 669                 "deploymentRef": "somestring",
 670                 "modified": "2015-01-01T15:00:00.000Z",
 671                 "selfLink": {
 672                     "params": {},
 673                     "rel": "somestring",
 674                     "rels": [
 675                         "somestring",
 676                         "somestring"
 677                     ],
 678                     "title": "somestring",
 679                     "type": "somestring",
 680                     "uri": "somestring",
 681                     "uriBuilder": {}
 682                 },
 683                 "serviceId": "somestring",
 684                 "typeLink": {
 685                     "params": {},
 686                     "rel": "somestring",
 687                     "rels": [
 688                         "somestring",
 689                         "somestring"
 690                     ],
 691                     "title": "somestring",
 692                     "type": "somestring",
 693                     "uri": "somestring",
 694                     "uriBuilder": {}
 695                 },
 696                 "vnfId": "somestring",
 697                 "vnfLink": {
 698                     "params": {},
 699                     "rel": "somestring",
 700                     "rels": [
 701                         "somestring",
 702                         "somestring"
 703                     ],
 704                     "title": "somestring",
 705                     "type": "somestring",
 706                     "uri": "somestring",
 707                     "uriBuilder": {}
 708                 },
 709                 "vnfLocation": "somestring",
 710                 "vnfType": "somestring"
 711             },
 712             {
 713                 "components": [
 714                     {
 715                         "componentId": "somestring",
 716                         "componentLink": {
 717                             "params": {},
 718                             "rel": "somestring",
 719                             "rels": [
 720                                 "somestring",
 721                                 "somestring"
 722                             ],
 723                             "title": "somestring",
 724                             "type": "somestring",
 725                             "uri": "somestring",
 726                             "uriBuilder": {}
 727                         },
 728                         "componentSource": "DCAEController",
 729                         "componentType": "somestring",
 730                         "created": "2015-01-01T15:00:00.000Z",
 731                         "location": "somestring",
 732                         "modified": "2015-01-01T15:00:00.000Z",
 733                         "shareable": 1,
 734                         "status": "somestring"
 735                     },
 736                     {
 737                         "componentId": "somestring",
 738                         "componentLink": {
 739                             "params": {},
 740                             "rel": "somestring",
 741                             "rels": [
 742                                 "somestring",
 743                                 "somestring"
 744                             ],
 745                             "title": "somestring",
 746                             "type": "somestring",
 747                             "uri": "somestring",
 748                             "uriBuilder": {}
 749                         },
 750                         "componentSource": "DCAEController",
 751                         "componentType": "somestring",
 752                         "created": "2015-01-01T15:00:00.000Z",
 753                         "location": "somestring",
 754                         "modified": "2015-01-01T15:00:00.000Z",
 755                         "shareable": 1,
 756                         "status": "somestring"
 757                     }
 758                 ],
 759                 "created": "2015-01-01T15:00:00.000Z",
 760                 "deploymentRef": "somestring",
 761                 "modified": "2015-01-01T15:00:00.000Z",
 762                 "selfLink": {
 763                     "params": {},
 764                     "rel": "somestring",
 765                     "rels": [
 766                         "somestring",
 767                         "somestring"
 768                     ],
 769                     "title": "somestring",
 770                     "type": "somestring",
 771                     "uri": "somestring",
 772                     "uriBuilder": {}
 773                 },
 774                 "serviceId": "somestring",
 775                 "typeLink": {
 776                     "params": {},
 777                     "rel": "somestring",
 778                     "rels": [
 779                         "somestring",
 780                         "somestring"
 781                     ],
 782                     "title": "somestring",
 783                     "type": "somestring",
 784                     "uri": "somestring",
 785                     "uriBuilder": {}
 786                 },
 787                 "vnfId": "somestring",
 788                 "vnfLink": {
 789                     "params": {},
 790                     "rel": "somestring",
 791                     "rels": [
 792                         "somestring",
 793                         "somestring"
 794                     ],
 795                     "title": "somestring",
 796                     "type": "somestring",
 797                     "uri": "somestring",
 798                     "uriBuilder": {}
 799                 },
 800                 "vnfLocation": "somestring",
 801                 "vnfType": "somestring"
 802             }
 803         ],
 804         "links": {
 805             "nextLink": {
 806                 "params": {},
 807                 "rel": "somestring",
 808                 "rels": [
 809                     "somestring",
 810                     "somestring"
 811                 ],
 812                 "title": "somestring",
 813                 "type": "somestring",
 814                 "uri": "somestring",
 815                 "uriBuilder": {}
 816             },
 817             "previousLink": {
 818                 "params": {},
 819                 "rel": "somestring",
 820                 "rels": [
 821                     "somestring",
 822                     "somestring"
 823                 ],
 824                 "title": "somestring",
 825                 "type": "somestring",
 826                 "uri": "somestring",
 827                 "uriBuilder": {}
 828             }
 829         },
 830         "totalCount": 1
 831     }
 832
 833 **502**
 834 ^^^^^^^
 835
 836 Bad response from DCAE controller
 837
 838
 839 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
 840
 841 **Example:**
 842
 843 .. code-block:: javascript
 844
 845     {
 846         "code": 1,
 847         "message": "somestring",
 848         "type": "somestring"
 849     }
 850
 851 **504**
 852 ^^^^^^^
 853
 854 Failed to connect with DCAE controller
 855
 856
 857 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
 858
 859 **Example:**
 860
 861 .. code-block:: javascript
 862
 863     {
 864         "code": 1,
 865         "message": "somestring",
 866         "type": "somestring"
 867     }
 868
 869
 870
 871
 872
 873 GET ``/dcae-services-groupby/{propertyName}``
 874 ---------------------------------------------
 875
 876
 877
 878 Description
 879 +++++++++++
 880
 881 .. raw:: html
 882
 883     Get a list of unique values for the given `propertyName`
 884
 885 Parameters
 886 ++++++++++
 887
 888 .. csv-table::
 889     :delim: |
 890     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 891     :widths: 20, 15, 10, 10, 10, 20, 30
 892
 893         propertyName | path | Yes | string |  |  | Property to find unique values. Restricted to `type`, `vnfType`, `vnfLocation`
 894
 895
 896 Request
 897 +++++++
 898
 899
 900 Responses
 901 +++++++++
 902
 903 **200**
 904 ^^^^^^^
 905
 906 List of unique property values
 907
 908
 909 Type: :ref:`DCAEServiceGroupByResults <d_a6dc4f986873bc126fc916189ffa5e91>`
 910
 911 **Example:**
 912
 913 .. code-block:: javascript
 914
 915     {
 916         "propertyName": "somestring",
 917         "propertyValues": [
 918             {
 919                 "count": 1,
 920                 "dcaeServiceQueryLink": {
 921                     "params": {},
 922                     "rel": "somestring",
 923                     "rels": [
 924                         "somestring",
 925                         "somestring"
 926                     ],
 927                     "title": "somestring",
 928                     "type": "somestring",
 929                     "uri": "somestring",
 930                     "uriBuilder": {}
 931                 },
 932                 "propertyValue": "somestring"
 933             },
 934             {
 935                 "count": 1,
 936                 "dcaeServiceQueryLink": {
 937                     "params": {},
 938                     "rel": "somestring",
 939                     "rels": [
 940                         "somestring",
 941                         "somestring"
 942                     ],
 943                     "title": "somestring",
 944                     "type": "somestring",
 945                     "uri": "somestring",
 946                     "uriBuilder": {}
 947                 },
 948                 "propertyValue": "somestring"
 949             }
 950         ]
 951     }
 952
 953
 954
 955
 956
 957 DELETE ``/dcae-services/{serviceId}``
 958 -------------------------------------
 959
 960
 961
 962 Description
 963 +++++++++++
 964
 965 .. raw:: html
 966
 967     Remove an existing `DCAEService` object.
 968
 969 Parameters
 970 ++++++++++
 971
 972 .. csv-table::
 973     :delim: |
 974     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 975     :widths: 20, 15, 10, 10, 10, 20, 30
 976
 977         serviceId | path | Yes | string |  |  |
 978
 979
 980 Request
 981 +++++++
 982
 983
 984 Responses
 985 +++++++++
 986
 987 **200**
 988 ^^^^^^^
 989
 990 DCAE service has been removed
 991
 992
 993 **404**
 994 ^^^^^^^
 995
 996 Unknown DCAE service
 997
 998
 999 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1000
1001 **Example:**
1002
1003 .. code-block:: javascript
1004
1005     {
1006         "code": 1,
1007         "message": "somestring",
1008         "type": "somestring"
1009     }
1010
1011
1012
1013
1014
1015 GET ``/dcae-services/{serviceId}``
1016 ----------------------------------
1017
1018
1019
1020 Description
1021 +++++++++++
1022
1023 .. raw:: html
1024
1025     Get a `DCAEService` object.
1026
1027 Parameters
1028 ++++++++++
1029
1030 .. csv-table::
1031     :delim: |
1032     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1033     :widths: 20, 15, 10, 10, 10, 20, 30
1034
1035         serviceId | path | Yes | string |  |  |
1036
1037
1038 Request
1039 +++++++
1040
1041
1042 Responses
1043 +++++++++
1044
1045 **200**
1046 ^^^^^^^
1047
1048 Single `DCAEService` object
1049
1050
1051 Type: :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>`
1052
1053 **Example:**
1054
1055 .. code-block:: javascript
1056
1057     {
1058         "components": [
1059             {
1060                 "componentId": "somestring",
1061                 "componentLink": {
1062                     "params": {},
1063                     "rel": "somestring",
1064                     "rels": [
1065                         "somestring",
1066                         "somestring"
1067                     ],
1068                     "title": "somestring",
1069                     "type": "somestring",
1070                     "uri": "somestring",
1071                     "uriBuilder": {}
1072                 },
1073                 "componentSource": "DCAEController",
1074                 "componentType": "somestring",
1075                 "created": "2015-01-01T15:00:00.000Z",
1076                 "location": "somestring",
1077                 "modified": "2015-01-01T15:00:00.000Z",
1078                 "shareable": 1,
1079                 "status": "somestring"
1080             },
1081             {
1082                 "componentId": "somestring",
1083                 "componentLink": {
1084                     "params": {},
1085                     "rel": "somestring",
1086                     "rels": [
1087                         "somestring",
1088                         "somestring"
1089                     ],
1090                     "title": "somestring",
1091                     "type": "somestring",
1092                     "uri": "somestring",
1093                     "uriBuilder": {}
1094                 },
1095                 "componentSource": "DCAEController",
1096                 "componentType": "somestring",
1097                 "created": "2015-01-01T15:00:00.000Z",
1098                 "location": "somestring",
1099                 "modified": "2015-01-01T15:00:00.000Z",
1100                 "shareable": 1,
1101                 "status": "somestring"
1102             }
1103         ],
1104         "created": "2015-01-01T15:00:00.000Z",
1105         "deploymentRef": "somestring",
1106         "modified": "2015-01-01T15:00:00.000Z",
1107         "selfLink": {
1108             "params": {},
1109             "rel": "somestring",
1110             "rels": [
1111                 "somestring",
1112                 "somestring"
1113             ],
1114             "title": "somestring",
1115             "type": "somestring",
1116             "uri": "somestring",
1117             "uriBuilder": {}
1118         },
1119         "serviceId": "somestring",
1120         "typeLink": {
1121             "params": {},
1122             "rel": "somestring",
1123             "rels": [
1124                 "somestring",
1125                 "somestring"
1126             ],
1127             "title": "somestring",
1128             "type": "somestring",
1129             "uri": "somestring",
1130             "uriBuilder": {}
1131         },
1132         "vnfId": "somestring",
1133         "vnfLink": {
1134             "params": {},
1135             "rel": "somestring",
1136             "rels": [
1137                 "somestring",
1138                 "somestring"
1139             ],
1140             "title": "somestring",
1141             "type": "somestring",
1142             "uri": "somestring",
1143             "uriBuilder": {}
1144         },
1145         "vnfLocation": "somestring",
1146         "vnfType": "somestring"
1147     }
1148
1149 **404**
1150 ^^^^^^^
1151
1152 DCAE service not found
1153
1154
1155 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1156
1157 **Example:**
1158
1159 .. code-block:: javascript
1160
1161     {
1162         "code": 1,
1163         "message": "somestring",
1164         "type": "somestring"
1165     }
1166
1167 **502**
1168 ^^^^^^^
1169
1170 Bad response from DCAE controller
1171
1172
1173 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1174
1175 **Example:**
1176
1177 .. code-block:: javascript
1178
1179     {
1180         "code": 1,
1181         "message": "somestring",
1182         "type": "somestring"
1183     }
1184
1185 **504**
1186 ^^^^^^^
1187
1188 Failed to connect with DCAE controller
1189
1190
1191 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1192
1193 **Example:**
1194
1195 .. code-block:: javascript
1196
1197     {
1198         "code": 1,
1199         "message": "somestring",
1200         "type": "somestring"
1201     }
1202
1203
1204
1205
1206
1207 PUT ``/dcae-services/{serviceId}``
1208 ----------------------------------
1209
1210
1211
1212 Description
1213 +++++++++++
1214
1215 .. raw:: html
1216
1217     Put a new or update an existing `DCAEService` object.
1218
1219 Parameters
1220 ++++++++++
1221
1222 .. csv-table::
1223     :delim: |
1224     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1225     :widths: 20, 15, 10, 10, 10, 20, 30
1226
1227         serviceId | path | Yes | string |  |  |
1228
1229
1230 Request
1231 +++++++
1232
1233
1234
1235 .. _d_81c18e0dd7a3af8fb1ba658e72907e7b:
1236
1237 Body
1238 ^^^^
1239
1240 .. csv-table::
1241     :delim: |
1242     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1243     :widths: 20, 10, 15, 15, 30, 25
1244
1245         components | Yes | array of :ref:`DCAEServiceComponentRequest <d_55af22c43245c290d643f75be1f4f254>` |  |  | List of DCAE service components that this service is composed of
1246         deploymentRef | No | string |  |  | Reference to a Cloudify deployment
1247         typeId | Yes | string |  |  | Id of the associated DCAE service type
1248         vnfId | Yes | string |  |  | Id of the associated VNF that this service is monitoring
1249         vnfLocation | Yes | string |  |  | Location identifier of the associated VNF that this service is monitoring
1250         vnfType | Yes | string |  |  | The type of the associated VNF that this service is monitoring
1251
1252 .. code-block:: javascript
1253
1254     {
1255         "components": [
1256             {
1257                 "componentId": "somestring",
1258                 "componentSource": "DCAEController",
1259                 "componentType": "somestring",
1260                 "shareable": 1
1261             },
1262             {
1263                 "componentId": "somestring",
1264                 "componentSource": "DCAEController",
1265                 "componentType": "somestring",
1266                 "shareable": 1
1267             }
1268         ],
1269         "deploymentRef": "somestring",
1270         "typeId": "somestring",
1271         "vnfId": "somestring",
1272         "vnfLocation": "somestring",
1273         "vnfType": "somestring"
1274     }
1275
1276 Responses
1277 +++++++++
1278
1279 **200**
1280 ^^^^^^^
1281
1282 Single `DCAEService` object
1283
1284
1285 Type: :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>`
1286
1287 **Example:**
1288
1289 .. code-block:: javascript
1290
1291     {
1292         "components": [
1293             {
1294                 "componentId": "somestring",
1295                 "componentLink": {
1296                     "params": {},
1297                     "rel": "somestring",
1298                     "rels": [
1299                         "somestring",
1300                         "somestring"
1301                     ],
1302                     "title": "somestring",
1303                     "type": "somestring",
1304                     "uri": "somestring",
1305                     "uriBuilder": {}
1306                 },
1307                 "componentSource": "DCAEController",
1308                 "componentType": "somestring",
1309                 "created": "2015-01-01T15:00:00.000Z",
1310                 "location": "somestring",
1311                 "modified": "2015-01-01T15:00:00.000Z",
1312                 "shareable": 1,
1313                 "status": "somestring"
1314             },
1315             {
1316                 "componentId": "somestring",
1317                 "componentLink": {
1318                     "params": {},
1319                     "rel": "somestring",
1320                     "rels": [
1321                         "somestring",
1322                         "somestring"
1323                     ],
1324                     "title": "somestring",
1325                     "type": "somestring",
1326                     "uri": "somestring",
1327                     "uriBuilder": {}
1328                 },
1329                 "componentSource": "DCAEController",
1330                 "componentType": "somestring",
1331                 "created": "2015-01-01T15:00:00.000Z",
1332                 "location": "somestring",
1333                 "modified": "2015-01-01T15:00:00.000Z",
1334                 "shareable": 1,
1335                 "status": "somestring"
1336             }
1337         ],
1338         "created": "2015-01-01T15:00:00.000Z",
1339         "deploymentRef": "somestring",
1340         "modified": "2015-01-01T15:00:00.000Z",
1341         "selfLink": {
1342             "params": {},
1343             "rel": "somestring",
1344             "rels": [
1345                 "somestring",
1346                 "somestring"
1347             ],
1348             "title": "somestring",
1349             "type": "somestring",
1350             "uri": "somestring",
1351             "uriBuilder": {}
1352         },
1353         "serviceId": "somestring",
1354         "typeLink": {
1355             "params": {},
1356             "rel": "somestring",
1357             "rels": [
1358                 "somestring",
1359                 "somestring"
1360             ],
1361             "title": "somestring",
1362             "type": "somestring",
1363             "uri": "somestring",
1364             "uriBuilder": {}
1365         },
1366         "vnfId": "somestring",
1367         "vnfLink": {
1368             "params": {},
1369             "rel": "somestring",
1370             "rels": [
1371                 "somestring",
1372                 "somestring"
1373             ],
1374             "title": "somestring",
1375             "type": "somestring",
1376             "uri": "somestring",
1377             "uriBuilder": {}
1378         },
1379         "vnfLocation": "somestring",
1380         "vnfType": "somestring"
1381     }
1382
1383 **422**
1384 ^^^^^^^
1385
1386 Bad request provided
1387
1388
1389 Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>`
1390
1391 **Example:**
1392
1393 .. code-block:: javascript
1394
1395     {
1396         "code": 1,
1397         "message": "somestring",
1398         "type": "somestring"
1399     }
1400
1401
1402
1403
1404 Data Structures
1405 ~~~~~~~~~~~~~~~
1406
1407 .. _d_8a94f348f7df00259702f8d9b7d2ea84:
1408
1409 ApiResponseMessage Model Structure
1410 ----------------------------------
1411
1412 .. csv-table::
1413     :delim: |
1414     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1415     :widths: 20, 10, 15, 15, 30, 25
1416
1417         code | No | integer | int32 |  |
1418         message | No | string |  |  |
1419         type | No | string |  |  |
1420
1421 .. _d_ae85cd292c2b4046e1ea1bbb02c7ea63:
1422
1423 DCAEService Model Structure
1424 ---------------------------
1425
1426 .. csv-table::
1427     :delim: |
1428     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1429     :widths: 20, 10, 15, 15, 30, 25
1430
1431         components | No | array of :ref:`DCAEServiceComponent <d_51674dafcc623be79f21ecea545c345d>` |  |  |
1432         created | No | string | date-time |  |
1433         deploymentRef | No | string |  |  | Reference to a Cloudify deployment
1434         modified | No | string | date-time |  |
1435         selfLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` |  |  | Link.title is serviceId
1436         serviceId | No | string |  |  |
1437         typeLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` |  |  | Link.title is typeId
1438         vnfId | No | string |  |  |
1439         vnfLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` |  |  | Link.title is vnfId
1440         vnfLocation | No | string |  |  | Location information of the associated VNF
1441         vnfType | No | string |  |  |
1442
1443 .. _d_51674dafcc623be79f21ecea545c345d:
1444
1445 DCAEServiceComponent Model Structure
1446 ------------------------------------
1447
1448 .. csv-table::
1449     :delim: |
1450     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1451     :widths: 20, 10, 15, 15, 30, 25
1452
1453         componentId | Yes | string |  |  | The id format is unique to the source
1454         componentLink | Yes | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` |  |  | Link to the underlying resource of this component
1455         componentSource | Yes | string |  | {'enum': ['DCAEController', 'DMaaPController']} | Specifies the name of the underying source service that is responsible for this components
1456         componentType | Yes | string |  |  |
1457         created | Yes | string | date-time |  |
1458         location | No | string |  |  | Location information of the component
1459         modified | Yes | string | date-time |  |
1460         shareable | Yes | integer | int32 |  | Used to determine if this component can be shared amongst different DCAE services
1461         status | No | string |  |  |
1462
1463 .. _d_55af22c43245c290d643f75be1f4f254:
1464
1465 DCAEServiceComponentRequest Model Structure
1466 -------------------------------------------
1467
1468 .. csv-table::
1469     :delim: |
1470     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1471     :widths: 20, 10, 15, 15, 30, 25
1472
1473         componentId | Yes | string |  |  | The id format is unique to the source
1474         componentSource | Yes | string |  | {'enum': ['DCAEController', 'DMaaPController']} | Specifies the name of the underying source service that is responsible for this components
1475         componentType | Yes | string |  |  |
1476         shareable | Yes | integer | int32 |  | Used to determine if this component can be shared amongst different DCAE services
1477
1478 .. _d_a6dc4f986873bc126fc916189ffa5e91:
1479
1480 DCAEServiceGroupByResults Model Structure
1481 -----------------------------------------
1482
1483 .. csv-table::
1484     :delim: |
1485     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1486     :widths: 20, 10, 15, 15, 30, 25
1487
1488         propertyName | No | string |  |  | Property name of DCAE service that the group by operation was performed on
1489         propertyValues | No | array of :ref:`DCAEServiceGroupByResultsPropertyValues <d_0119caa52e274e5e2311b367df38d686>` |  |  |
1490
1491 .. _d_0119caa52e274e5e2311b367df38d686:
1492
1493 DCAEServiceGroupByResultsPropertyValues Model Structure
1494 -------------------------------------------------------
1495
1496 .. csv-table::
1497     :delim: |
1498     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1499     :widths: 20, 10, 15, 15, 30, 25
1500
1501         count | No | integer | int32 |  |
1502         dcaeServiceQueryLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` |  |  | Link.title is the DCAE service property value. Following this link will provide a list of DCAE services that all have this property value.
1503         propertyValue | No | string |  |  |
1504
1505
1506 DCAEServiceRequest Model Structure
1507 ----------------------------------
1508
1509 .. csv-table::
1510     :delim: |
1511     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1512     :widths: 20, 10, 15, 15, 30, 25
1513
1514         components | Yes | array of :ref:`DCAEServiceComponentRequest <d_55af22c43245c290d643f75be1f4f254>` |  |  | List of DCAE service components that this service is composed of
1515         deploymentRef | No | string |  |  | Reference to a Cloudify deployment
1516         typeId | Yes | string |  |  | Id of the associated DCAE service type
1517         vnfId | Yes | string |  |  | Id of the associated VNF that this service is monitoring
1518         vnfLocation | Yes | string |  |  | Location identifier of the associated VNF that this service is monitoring
1519         vnfType | Yes | string |  |  | The type of the associated VNF that this service is monitoring
1520
1521 .. _d_b0cb5f12dbde8c0c42487c089983687e:
1522
1523 DCAEServiceType Model Structure
1524 -------------------------------
1525
1526 .. csv-table::
1527     :delim: |
1528     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1529     :widths: 20, 10, 15, 15, 30, 25
1530
1531         asdcResourceId | No | string |  |  | Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`.
1532         asdcServiceId | No | string |  |  | Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`.
1533         asdcServiceURL | No | string |  |  | URL to the ASDC service model
1534         blueprintTemplate | Yes | string |  |  | String representation of a Cloudify blueprint with unbound variables
1535         created | Yes | string | date-time |  | Created timestamp for this DCAE service type in epoch time
1536         deactivated | No | string | date-time |  | Deactivated timestamp for this DCAE service type in epoch time
1537         owner | Yes | string |  |  |
1538         selfLink | Yes | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` |  |  | Link to self where the Link.title is typeName
1539         serviceIds | No | array of string |  |  | List of service ids that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service id.
1540         serviceLocations | No | array of string |  |  | List of service locations that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service location.
1541         typeId | Yes | string |  |  | Unique identifier for this DCAE service type
1542         typeName | Yes | string |  |  | Descriptive name for this DCAE service type
1543         typeVersion | Yes | integer | int32 |  | Version number for this DCAE service type
1544         vnfTypes | No | array of string |  |  |
1545
1546
1547 DCAEServiceTypeRequest Model Structure
1548 --------------------------------------
1549
1550 .. csv-table::
1551     :delim: |
1552     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1553     :widths: 20, 10, 15, 15, 30, 25
1554
1555         asdcResourceId | No | string |  |  | Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`.
1556         asdcServiceId | No | string |  |  | Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`.
1557         asdcServiceURL | No | string |  |  | URL to the ASDC service model
1558         blueprintTemplate | Yes | string |  |  | String representation of a Cloudify blueprint with unbound variables
1559         owner | Yes | string |  |  |
1560         serviceIds | No | array of string |  |  | List of service ids that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service id.
1561         serviceLocations | No | array of string |  |  | List of service locations that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service location.
1562         typeName | Yes | string |  |  | Descriptive name for this DCAE service type
1563         typeVersion | Yes | integer | int32 |  | Version number for this DCAE service type
1564         vnfTypes | No | array of string |  |  |
1565
1566 .. _d_b1ccd4187d31690b8e704c0aa01b2c59:
1567
1568 InlineResponse200 Model Structure
1569 ---------------------------------
1570
1571 .. csv-table::
1572     :delim: |
1573     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1574     :widths: 20, 10, 15, 15, 30, 25
1575
1576         items | No | array of :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` |  |  |
1577         links | No | :ref:`InlineResponse200Links <d_e52a59e574408d4d622b3f1f61619b1c>` |  |  |
1578         totalCount | No | integer | int32 |  |
1579
1580 .. _d_31bb361a8900a0bed20df49b94f1e33b:
1581
1582 InlineResponse2001 Model Structure
1583 ----------------------------------
1584
1585 .. csv-table::
1586     :delim: |
1587     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1588     :widths: 20, 10, 15, 15, 30, 25
1589
1590         items | No | array of :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` |  |  |
1591         links | No | :ref:`InlineResponse200Links <d_e52a59e574408d4d622b3f1f61619b1c>` |  |  |
1592         totalCount | No | integer | int32 |  |
1593
1594 .. _d_e52a59e574408d4d622b3f1f61619b1c:
1595
1596 InlineResponse200Links Model Structure
1597 --------------------------------------
1598
1599 Pagination links
1600
1601 .. csv-table::
1602     :delim: |
1603     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1604     :widths: 20, 10, 15, 15, 30, 25
1605
1606         nextLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` |  |  |
1607         previousLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` |  |  |
1608
1609 .. _d_add3c3fd2e145f9e5a78be6e7b208ebb:
1610
1611 Link Model Structure
1612 --------------------
1613
1614 .. csv-table::
1615     :delim: |
1616     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1617     :widths: 20, 10, 15, 15, 30, 25
1618
1619         params | No | :ref:`params <i_f76783e4d75c137d1fc68696fcfdb72c>` |  |  |
1620         rel | No | string |  |  |
1621         rels | No | array of string |  |  |
1622         title | No | string |  |  |
1623         type | No | string |  |  |
1624         uri | No | string | uri |  |
1625         uriBuilder | No | :ref:`UriBuilder <d_a7b6b5c694147ea9dcfb5a5a6cbef017>` |  |  |
1626
1627 .. _i_f76783e4d75c137d1fc68696fcfdb72c:
1628
1629 **Params schema:**
1630
1631
1632 Map of {"key":"string"}
1633
1634 .. _d_a7b6b5c694147ea9dcfb5a5a6cbef017:
1635
1636 UriBuilder Model Structure
1637 --------------------------
1638
1639
1640