docs/api.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2021 Wind River Systems, Inc.
   4
   5 O-Cloud O2 Services API 1.0.0
   6 =============================
   7
   8 .. toctree::
   9     :maxdepth: 3
  10
  11
  12 Description
  13 ~~~~~~~~~~~
  14
  15 Swagger OpenAPI document for O-Cloud O2 Services
  16
  17
  18
  19
  20
  21 Base URL
  22 ~~~~~~~~
  23
  24 http(s)://<OAM IP>:30205/
  25
  26 O2DMS_LCM
  27 ~~~~~~~~~
  28
  29
  30 DMS LCM related operations.
  31
  32
  33
  34
  35
  36 POST ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment``
  37 ----------------------------------------------------------------------------
  38
  39
  40
  41
  42 Parameters
  43 ++++++++++
  44
  45 .. csv-table::
  46     :delim: |
  47     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
  48     :widths: 20, 15, 10, 10, 10, 20, 30
  49
  50         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
  51
  52
  53 Request
  54 +++++++
  55
  56
  57 Headers
  58 ^^^^^^^
  59
  60 .. code-block:: javascript
  61
  62     X-Fields: An optional fields mask
  63
  64
  65
  66 .. _d_1cdf8e618b9847878bed90d4897e6b3a:
  67
  68 Body
  69 ^^^^
  70
  71 .. csv-table::
  72     :delim: |
  73     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
  74     :widths: 20, 10, 15, 15, 30, 25
  75
  76         description | No | string |  |  |
  77         descriptorId | No | string |  |  |
  78         name | No | string |  |  |
  79         parentDeploymentId | No | string |  |  |
  80
  81 .. code-block:: javascript
  82
  83     {
  84         "description": "somestring",
  85         "descriptorId": "somestring",
  86         "name": "somestring",
  87         "parentDeploymentId": "somestring"
  88     }
  89
  90 Responses
  91 +++++++++
  92
  93 **201**
  94 ^^^^^^^
  95
  96 Success
  97
  98
  99 Type: :ref:`NfDeploymentCreateRespDto <d_c00d46ffd3e149e2989d2a5264585581>`
 100
 101 **Example:**
 102
 103 .. code-block:: javascript
 104
 105     {
 106         "id": "somestring"
 107     }
 108
 109 **404**
 110 ^^^^^^^
 111
 112 DMS LCM not found
 113
 114
 115
 116
 117
 118
 119 POST ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor``
 120 --------------------------------------------------------------------------------------
 121
 122
 123
 124
 125 Parameters
 126 ++++++++++
 127
 128 .. csv-table::
 129     :delim: |
 130     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 131     :widths: 20, 15, 10, 10, 10, 20, 30
 132
 133         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
 134
 135
 136 Request
 137 +++++++
 138
 139
 140 Headers
 141 ^^^^^^^
 142
 143 .. code-block:: javascript
 144
 145     X-Fields: An optional fields mask
 146
 147
 148
 149 .. _d_1583b74cb6544a428fadd82cb4ff4b3b:
 150
 151 Body
 152 ^^^^
 153
 154 .. csv-table::
 155     :delim: |
 156     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
 157     :widths: 20, 10, 15, 15, 30, 25
 158
 159         artifactName | No | string |  |  |
 160         artifactRepoUrl | No | string |  |  |
 161         description | No | string |  |  |
 162         inputParams | No | string |  |  |
 163         name | No | string |  |  |
 164         outputParams | No | string |  |  |
 165
 166 .. code-block:: javascript
 167
 168     {
 169         "artifactName": "somestring",
 170         "artifactRepoUrl": "somestring",
 171         "description": "somestring",
 172         "inputParams": "somestring",
 173         "name": "somestring",
 174         "outputParams": "somestring"
 175     }
 176
 177 Responses
 178 +++++++++
 179
 180 **201**
 181 ^^^^^^^
 182
 183 Success
 184
 185
 186 Type: :ref:`NfDeploymentDescriptorCreateRespDto <d_67c3fe14b244e803ad34a57f27b4bb4e>`
 187
 188 **Example:**
 189
 190 .. code-block:: javascript
 191
 192     {
 193         "id": "somestring"
 194     }
 195
 196 **404**
 197 ^^^^^^^
 198
 199 DMS LCM not found
 200
 201
 202
 203
 204
 205
 206 DELETE ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}``
 207 -----------------------------------------------------------------------------------------------
 208
 209
 210
 211
 212 Parameters
 213 ++++++++++
 214
 215 .. csv-table::
 216     :delim: |
 217     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 218     :widths: 20, 15, 10, 10, 10, 20, 30
 219
 220         nfDeploymentId | path | Yes | string |  |  | ID of the NfDeployment
 221         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
 222
 223
 224 Request
 225 +++++++
 226
 227
 228 Responses
 229 +++++++++
 230
 231 **204**
 232 ^^^^^^^
 233
 234 NfDeployment deleted
 235
 236
 237 **404**
 238 ^^^^^^^
 239
 240 DMS LCM not found
 241
 242
 243
 244
 245
 246
 247 DELETE ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}``
 248 -------------------------------------------------------------------------------------------------------------------
 249
 250
 251
 252
 253 Parameters
 254 ++++++++++
 255
 256 .. csv-table::
 257     :delim: |
 258     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 259     :widths: 20, 15, 10, 10, 10, 20, 30
 260
 261         nfDeploymentDescriptorId | path | Yes | string |  |  | ID of the NfDeploymentDescriptor
 262         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
 263
 264
 265 Request
 266 +++++++
 267
 268
 269 Responses
 270 +++++++++
 271
 272 **204**
 273 ^^^^^^^
 274
 275 NfDeploymentDescriptor deleted
 276
 277
 278 **404**
 279 ^^^^^^^
 280
 281 DMS LCM not found
 282
 283
 284
 285
 286
 287
 288 GET ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}``
 289 --------------------------------------------------------------------------------------------
 290
 291
 292
 293
 294 Parameters
 295 ++++++++++
 296
 297 .. csv-table::
 298     :delim: |
 299     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 300     :widths: 20, 15, 10, 10, 10, 20, 30
 301
 302         nfDeploymentId | path | Yes | string |  |  | ID of the NfDeployment
 303         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
 304
 305
 306 Request
 307 +++++++
 308
 309
 310 Headers
 311 ^^^^^^^
 312
 313 .. code-block:: javascript
 314
 315     X-Fields: An optional fields mask
 316
 317
 318 Responses
 319 +++++++++
 320
 321 **200**
 322 ^^^^^^^
 323
 324 Success
 325
 326
 327 Type: :ref:`NfDeploymentGetDto <d_e28dc7c38126e125615678304c7a9508>`
 328
 329 **Example:**
 330
 331 .. code-block:: javascript
 332
 333     {
 334         "description": "somestring",
 335         "descriptorId": "somestring",
 336         "id": "somestring",
 337         "name": "somestring",
 338         "parentDeploymentId": "somestring",
 339         "status": 1
 340     }
 341
 342 **404**
 343 ^^^^^^^
 344
 345 DMS LCM not found
 346
 347
 348
 349
 350
 351
 352 GET ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}``
 353 ----------------------------------------------------------------------------------------------------------------
 354
 355
 356
 357
 358 Parameters
 359 ++++++++++
 360
 361 .. csv-table::
 362     :delim: |
 363     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 364     :widths: 20, 15, 10, 10, 10, 20, 30
 365
 366         nfDeploymentDescriptorId | path | Yes | string |  |  | ID of the NfDeploymentDescriptor
 367         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
 368
 369
 370 Request
 371 +++++++
 372
 373
 374 Headers
 375 ^^^^^^^
 376
 377 .. code-block:: javascript
 378
 379     X-Fields: An optional fields mask
 380
 381
 382 Responses
 383 +++++++++
 384
 385 **200**
 386 ^^^^^^^
 387
 388 Success
 389
 390
 391 Type: :ref:`NfDeploymentDescriptorGetDto <d_5bdce8ac307530aa532cc25654cd5b07>`
 392
 393 **Example:**
 394
 395 .. code-block:: javascript
 396
 397     {
 398         "artifactName": "somestring",
 399         "artifactRepoUrl": "somestring",
 400         "description": "somestring",
 401         "id": "somestring",
 402         "inputParams": "somestring",
 403         "name": "somestring",
 404         "outputParams": "somestring"
 405     }
 406
 407 **404**
 408 ^^^^^^^
 409
 410 DMS LCM not found
 411
 412
 413
 414
 415
 416
 417 GET ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment``
 418 ---------------------------------------------------------------------------
 419
 420
 421
 422
 423 Parameters
 424 ++++++++++
 425
 426 .. csv-table::
 427     :delim: |
 428     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 429     :widths: 20, 15, 10, 10, 10, 20, 30
 430
 431         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
 432
 433
 434 Request
 435 +++++++
 436
 437
 438 Headers
 439 ^^^^^^^
 440
 441 .. code-block:: javascript
 442
 443     X-Fields: An optional fields mask
 444
 445
 446 Responses
 447 +++++++++
 448
 449 **200**
 450 ^^^^^^^
 451
 452 Success
 453
 454
 455 Type: array of :ref:`NfDeploymentGetDto <d_e28dc7c38126e125615678304c7a9508>`
 456
 457
 458 **Example:**
 459
 460 .. code-block:: javascript
 461
 462     [
 463         {
 464             "description": "somestring",
 465             "descriptorId": "somestring",
 466             "id": "somestring",
 467             "name": "somestring",
 468             "parentDeploymentId": "somestring",
 469             "status": 1
 470         },
 471         {
 472             "description": "somestring",
 473             "descriptorId": "somestring",
 474             "id": "somestring",
 475             "name": "somestring",
 476             "parentDeploymentId": "somestring",
 477             "status": 1
 478         }
 479     ]
 480
 481 **404**
 482 ^^^^^^^
 483
 484 DMS LCM not found
 485
 486
 487
 488
 489
 490
 491 GET ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor``
 492 -------------------------------------------------------------------------------------
 493
 494
 495
 496
 497 Parameters
 498 ++++++++++
 499
 500 .. csv-table::
 501     :delim: |
 502     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 503     :widths: 20, 15, 10, 10, 10, 20, 30
 504
 505         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
 506
 507
 508 Request
 509 +++++++
 510
 511
 512 Headers
 513 ^^^^^^^
 514
 515 .. code-block:: javascript
 516
 517     X-Fields: An optional fields mask
 518
 519
 520 Responses
 521 +++++++++
 522
 523 **200**
 524 ^^^^^^^
 525
 526 Success
 527
 528
 529 Type: array of :ref:`NfDeploymentDescriptorGetDto <d_5bdce8ac307530aa532cc25654cd5b07>`
 530
 531
 532 **Example:**
 533
 534 .. code-block:: javascript
 535
 536     [
 537         {
 538             "artifactName": "somestring",
 539             "artifactRepoUrl": "somestring",
 540             "description": "somestring",
 541             "id": "somestring",
 542             "inputParams": "somestring",
 543             "name": "somestring",
 544             "outputParams": "somestring"
 545         },
 546         {
 547             "artifactName": "somestring",
 548             "artifactRepoUrl": "somestring",
 549             "description": "somestring",
 550             "id": "somestring",
 551             "inputParams": "somestring",
 552             "name": "somestring",
 553             "outputParams": "somestring"
 554         }
 555     ]
 556
 557 **404**
 558 ^^^^^^^
 559
 560 DMS LCM not found
 561
 562
 563
 564
 565
 566
 567 GET ``/o2dms/{deploymentManagerID}``
 568 ------------------------------------
 569
 570
 571
 572
 573 Parameters
 574 ++++++++++
 575
 576 .. csv-table::
 577     :delim: |
 578     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 579     :widths: 20, 15, 10, 10, 10, 20, 30
 580
 581         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
 582
 583
 584 Request
 585 +++++++
 586
 587
 588 Headers
 589 ^^^^^^^
 590
 591 .. code-block:: javascript
 592
 593     X-Fields: An optional fields mask
 594
 595
 596 Responses
 597 +++++++++
 598
 599 **200**
 600 ^^^^^^^
 601
 602 Success
 603
 604
 605 Type: :ref:`DmsGetDto <d_086ee84f2c2cf010478bfc73a87b5e80>`
 606
 607 **Example:**
 608
 609 .. code-block:: javascript
 610
 611     {
 612         "capabilities": "somestring",
 613         "capacity": "somestring",
 614         "deploymentManagerId": "somestring",
 615         "description": "somestring",
 616         "name": "somestring",
 617         "supportedLocations": "somestring"
 618     }
 619
 620 **404**
 621 ^^^^^^^
 622
 623 Deployment manager not found
 624
 625
 626
 627
 628
 629
 630 PUT ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}``
 631 --------------------------------------------------------------------------------------------
 632
 633
 634
 635
 636 Parameters
 637 ++++++++++
 638
 639 .. csv-table::
 640     :delim: |
 641     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 642     :widths: 20, 15, 10, 10, 10, 20, 30
 643
 644         nfDeploymentId | path | Yes | string |  |  | ID of the NfDeployment
 645         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
 646
 647
 648 Request
 649 +++++++
 650
 651
 652
 653 .. _d_1a0e59d24d7db279637f186c203d883d:
 654
 655 Body
 656 ^^^^
 657
 658 .. csv-table::
 659     :delim: |
 660     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
 661     :widths: 20, 10, 15, 15, 30, 25
 662
 663         description | No | string |  |  |
 664         name | No | string |  |  |
 665         parentDeploymentId | No | string |  |  |
 666
 667 .. code-block:: javascript
 668
 669     {
 670         "description": "somestring",
 671         "name": "somestring",
 672         "parentDeploymentId": "somestring"
 673     }
 674
 675 Responses
 676 +++++++++
 677
 678 **404**
 679 ^^^^^^^
 680
 681 DMS LCM not found
 682
 683
 684
 685
 686
 687
 688 PUT ``/o2dms/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}``
 689 ----------------------------------------------------------------------------------------------------------------
 690
 691
 692
 693
 694 Parameters
 695 ++++++++++
 696
 697 .. csv-table::
 698     :delim: |
 699     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 700     :widths: 20, 15, 10, 10, 10, 20, 30
 701
 702         nfDeploymentDescriptorId | path | Yes | string |  |  | ID of the NfDeploymentDescriptor
 703         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
 704
 705
 706 Request
 707 +++++++
 708
 709
 710
 711 .. _d_5a6ee319c7ac35eac173da7d57136a98:
 712
 713 Body
 714 ^^^^
 715
 716 .. csv-table::
 717     :delim: |
 718     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
 719     :widths: 20, 10, 15, 15, 30, 25
 720
 721         artifactName | No | string |  |  |
 722         artifactRepoUrl | No | string |  |  |
 723         description | No | string |  |  |
 724         inputParams | No | string |  |  |
 725         name | No | string |  |  |
 726         outputParams | No | string |  |  |
 727
 728 .. code-block:: javascript
 729
 730     {
 731         "artifactName": "somestring",
 732         "artifactRepoUrl": "somestring",
 733         "description": "somestring",
 734         "inputParams": "somestring",
 735         "name": "somestring",
 736         "outputParams": "somestring"
 737     }
 738
 739 Responses
 740 +++++++++
 741
 742 **404**
 743 ^^^^^^^
 744
 745 DMS LCM not found
 746
 747
 748
 749
 750
 751 O2IMS_INVENTORY
 752 ~~~~~~~~~~~~~~~
 753
 754
 755 IMS Inventory related operations.
 756
 757
 758
 759
 760
 761 POST ``/o2ims_infrastructureInventory/v1/subscriptions``
 762 --------------------------------------------------------
 763
 764
 765
 766
 767
 768 Request
 769 +++++++
 770
 771
 772 Headers
 773 ^^^^^^^
 774
 775 .. code-block:: javascript
 776
 777     X-Fields: An optional fields mask
 778
 779
 780
 781 .. _d_0fff8519707c32c34f86d6ac19fad342:
 782
 783 Body
 784 ^^^^
 785
 786 .. csv-table::
 787     :delim: |
 788     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
 789     :widths: 20, 10, 15, 15, 30, 25
 790
 791         callback | Yes | string |  |  | Subscription callback address
 792         consumerSubscriptionId | No | string |  |  |
 793         filter | No | string |  |  |
 794
 795 .. code-block:: javascript
 796
 797     {
 798         "callback": "somestring",
 799         "consumerSubscriptionId": "somestring",
 800         "filter": "somestring"
 801     }
 802
 803 Responses
 804 +++++++++
 805
 806 **201**
 807 ^^^^^^^
 808
 809 Success
 810
 811
 812 Type: :ref:`SubscriptionCreatedRespDto <d_4397329931bf78862bc91387dbdb86c4>`
 813
 814 **Example:**
 815
 816 .. code-block:: javascript
 817
 818     {
 819         "subscriptionId": "somestring"
 820     }
 821
 822
 823
 824
 825
 826 DELETE ``/o2ims_infrastructureInventory/v1/subscriptions/{subscriptionID}``
 827 ---------------------------------------------------------------------------
 828
 829
 830
 831
 832 Parameters
 833 ++++++++++
 834
 835 .. csv-table::
 836     :delim: |
 837     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 838     :widths: 20, 15, 10, 10, 10, 20, 30
 839
 840         subscriptionID | path | Yes | string |  |  | ID of the subscription
 841
 842
 843 Request
 844 +++++++
 845
 846
 847 Responses
 848 +++++++++
 849
 850 **204**
 851 ^^^^^^^
 852
 853 Subscription deleted
 854
 855
 856 **404**
 857 ^^^^^^^
 858
 859 Subscription not found
 860
 861
 862
 863
 864
 865
 866 GET ``/o2ims_infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}``
 867 ----------------------------------------------------------------------------------
 868
 869
 870
 871
 872 Parameters
 873 ++++++++++
 874
 875 .. csv-table::
 876     :delim: |
 877     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 878     :widths: 20, 15, 10, 10, 10, 20, 30
 879
 880         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
 881
 882
 883 Request
 884 +++++++
 885
 886
 887 Headers
 888 ^^^^^^^
 889
 890 .. code-block:: javascript
 891
 892     X-Fields: An optional fields mask
 893
 894
 895 Responses
 896 +++++++++
 897
 898 **200**
 899 ^^^^^^^
 900
 901 Success
 902
 903
 904 Type: :ref:`DeploymentManagerGetDto <d_e936cc219a004ab92ac027b2690bdd5e>`
 905
 906 **Example:**
 907
 908 .. code-block:: javascript
 909
 910     {
 911         "capabilities": "somestring",
 912         "capacity": "somestring",
 913         "deploymentManagementServiceEndpoint": "somestring",
 914         "deploymentManagerId": "somestring",
 915         "description": "somestring",
 916         "name": "somestring",
 917         "supportedLocations": "somestring"
 918     }
 919
 920 **404**
 921 ^^^^^^^
 922
 923 Deployment manager not found
 924
 925
 926
 927
 928
 929
 930 GET ``/o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}``
 931 -----------------------------------------------------------------------------------------------
 932
 933
 934
 935
 936 Parameters
 937 ++++++++++
 938
 939 .. csv-table::
 940     :delim: |
 941     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 942     :widths: 20, 15, 10, 10, 10, 20, 30
 943
 944         resourceID | path | Yes | string |  |  | ID of the resource
 945         resourcePoolID | path | Yes | string |  |  | ID of the resource pool
 946
 947
 948 Request
 949 +++++++
 950
 951
 952 Headers
 953 ^^^^^^^
 954
 955 .. code-block:: javascript
 956
 957     X-Fields: An optional fields mask
 958
 959
 960 Responses
 961 +++++++++
 962
 963 **200**
 964 ^^^^^^^
 965
 966 Success
 967
 968
 969 Type: :ref:`ResourceGetDto2 <d_958dd46196a624722ba9ea3ea4d27e38>`
 970
 971 **Example:**
 972
 973 .. code-block:: javascript
 974
 975     {
 976         "children": [
 977             {
 978                 "children": [
 979                     {
 980                         "description": "somestring",
 981                         "elements": "somestring",
 982                         "name": "somestring",
 983                         "parentId": "somestring",
 984                         "resourceId": "somestring",
 985                         "resourcePoolId": "somestring",
 986                         "resourceTypeId": "somestring"
 987                     },
 988                     {
 989                         "description": "somestring",
 990                         "elements": "somestring",
 991                         "name": "somestring",
 992                         "parentId": "somestring",
 993                         "resourceId": "somestring",
 994                         "resourcePoolId": "somestring",
 995                         "resourceTypeId": "somestring"
 996                     }
 997                 ],
 998                 "description": "somestring",
 999                 "elements": "somestring",
1000                 "name": "somestring",
1001                 "parentId": "somestring",
1002                 "resourceId": "somestring",
1003                 "resourcePoolId": "somestring",
1004                 "resourceTypeId": "somestring"
1005             },
1006             {
1007                 "children": [
1008                     {
1009                         "description": "somestring",
1010                         "elements": "somestring",
1011                         "name": "somestring",
1012                         "parentId": "somestring",
1013                         "resourceId": "somestring",
1014                         "resourcePoolId": "somestring",
1015                         "resourceTypeId": "somestring"
1016                     },
1017                     {
1018                         "description": "somestring",
1019                         "elements": "somestring",
1020                         "name": "somestring",
1021                         "parentId": "somestring",
1022                         "resourceId": "somestring",
1023                         "resourcePoolId": "somestring",
1024                         "resourceTypeId": "somestring"
1025                     }
1026                 ],
1027                 "description": "somestring",
1028                 "elements": "somestring",
1029                 "name": "somestring",
1030                 "parentId": "somestring",
1031                 "resourceId": "somestring",
1032                 "resourcePoolId": "somestring",
1033                 "resourceTypeId": "somestring"
1034             }
1035         ],
1036         "description": "somestring",
1037         "elements": "somestring",
1038         "name": "somestring",
1039         "parentId": "somestring",
1040         "resourceId": "somestring",
1041         "resourcePoolId": "somestring",
1042         "resourceTypeId": "somestring"
1043     }
1044
1045 **404**
1046 ^^^^^^^
1047
1048 Resource not found
1049
1050
1051
1052
1053
1054
1055 GET ``/o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}``
1056 ------------------------------------------------------------------------
1057
1058
1059
1060
1061 Parameters
1062 ++++++++++
1063
1064 .. csv-table::
1065     :delim: |
1066     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1067     :widths: 20, 15, 10, 10, 10, 20, 30
1068
1069         resourcePoolID | path | Yes | string |  |  | ID of the resource pool
1070
1071
1072 Request
1073 +++++++
1074
1075
1076 Headers
1077 ^^^^^^^
1078
1079 .. code-block:: javascript
1080
1081     X-Fields: An optional fields mask
1082
1083
1084 Responses
1085 +++++++++
1086
1087 **200**
1088 ^^^^^^^
1089
1090 Success
1091
1092
1093 Type: :ref:`ResourcePoolGetDto <d_296e5d50362a85c0b8843dfe38965ce9>`
1094
1095 **Example:**
1096
1097 .. code-block:: javascript
1098
1099     {
1100         "description": "somestring",
1101         "globalLocationId": "somestring",
1102         "location": "somestring",
1103         "name": "somestring",
1104         "resourcePoolId": "somestring"
1105     }
1106
1107 **404**
1108 ^^^^^^^
1109
1110 Resource pool not found
1111
1112
1113
1114
1115
1116
1117 GET ``/o2ims_infrastructureInventory/v1/resourceTypes/{resourceTypeID}``
1118 ------------------------------------------------------------------------
1119
1120
1121
1122
1123 Parameters
1124 ++++++++++
1125
1126 .. csv-table::
1127     :delim: |
1128     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1129     :widths: 20, 15, 10, 10, 10, 20, 30
1130
1131         resourceTypeID | path | Yes | string |  |  | ID of the resource type
1132
1133
1134 Request
1135 +++++++
1136
1137
1138 Headers
1139 ^^^^^^^
1140
1141 .. code-block:: javascript
1142
1143     X-Fields: An optional fields mask
1144
1145
1146 Responses
1147 +++++++++
1148
1149 **200**
1150 ^^^^^^^
1151
1152 Success
1153
1154
1155 Type: :ref:`ResourceTypeGetDto <d_fb92075f954e3895d1435d4e523666fa>`
1156
1157 **Example:**
1158
1159 .. code-block:: javascript
1160
1161     {
1162         "description": "somestring",
1163         "name": "somestring",
1164         "resourceTypeId": "somestring",
1165         "vendor": "somestring",
1166         "version": "somestring"
1167     }
1168
1169 **404**
1170 ^^^^^^^
1171
1172 Resource type not found
1173
1174
1175
1176
1177
1178
1179 GET ``/o2ims_infrastructureInventory/v1/subscriptions/{subscriptionID}``
1180 ------------------------------------------------------------------------
1181
1182
1183
1184
1185 Parameters
1186 ++++++++++
1187
1188 .. csv-table::
1189     :delim: |
1190     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1191     :widths: 20, 15, 10, 10, 10, 20, 30
1192
1193         subscriptionID | path | Yes | string |  |  | ID of the subscription
1194
1195
1196 Request
1197 +++++++
1198
1199
1200 Headers
1201 ^^^^^^^
1202
1203 .. code-block:: javascript
1204
1205     X-Fields: An optional fields mask
1206
1207
1208 Responses
1209 +++++++++
1210
1211 **200**
1212 ^^^^^^^
1213
1214 Success
1215
1216
1217 Type: :ref:`SubscriptionGetDto <d_90e532f740e7ec8e9d71fad08513c388>`
1218
1219 **Example:**
1220
1221 .. code-block:: javascript
1222
1223     {
1224         "callback": "somestring",
1225         "consumerSubscriptionId": "somestring",
1226         "filter": "somestring",
1227         "subscriptionId": "somestring"
1228     }
1229
1230 **404**
1231 ^^^^^^^
1232
1233 Subscription not found
1234
1235
1236
1237
1238
1239
1240 GET ``/o2ims_infrastructureInventory/v1/subscriptions``
1241 -------------------------------------------------------
1242
1243
1244
1245
1246
1247 Request
1248 +++++++
1249
1250
1251 Headers
1252 ^^^^^^^
1253
1254 .. code-block:: javascript
1255
1256     X-Fields: An optional fields mask
1257
1258
1259 Responses
1260 +++++++++
1261
1262 **200**
1263 ^^^^^^^
1264
1265 Success
1266
1267
1268 Type: array of :ref:`SubscriptionGetDto <d_90e532f740e7ec8e9d71fad08513c388>`
1269
1270
1271 **Example:**
1272
1273 .. code-block:: javascript
1274
1275     [
1276         {
1277             "callback": "somestring",
1278             "consumerSubscriptionId": "somestring",
1279             "filter": "somestring",
1280             "subscriptionId": "somestring"
1281         },
1282         {
1283             "callback": "somestring",
1284             "consumerSubscriptionId": "somestring",
1285             "filter": "somestring",
1286             "subscriptionId": "somestring"
1287         }
1288     ]
1289
1290
1291
1292
1293
1294 GET ``/o2ims_infrastructureInventory/v1/deploymentManagers``
1295 ------------------------------------------------------------
1296
1297
1298
1299
1300
1301 Request
1302 +++++++
1303
1304
1305 Headers
1306 ^^^^^^^
1307
1308 .. code-block:: javascript
1309
1310     X-Fields: An optional fields mask
1311
1312
1313 Responses
1314 +++++++++
1315
1316 **200**
1317 ^^^^^^^
1318
1319 Success
1320
1321
1322 Type: array of :ref:`DeploymentManagerGetDto <d_e936cc219a004ab92ac027b2690bdd5e>`
1323
1324
1325 **Example:**
1326
1327 .. code-block:: javascript
1328
1329     [
1330         {
1331             "capabilities": "somestring",
1332             "capacity": "somestring",
1333             "deploymentManagementServiceEndpoint": "somestring",
1334             "deploymentManagerId": "somestring",
1335             "description": "somestring",
1336             "name": "somestring",
1337             "supportedLocations": "somestring"
1338         },
1339         {
1340             "capabilities": "somestring",
1341             "capacity": "somestring",
1342             "deploymentManagementServiceEndpoint": "somestring",
1343             "deploymentManagerId": "somestring",
1344             "description": "somestring",
1345             "name": "somestring",
1346             "supportedLocations": "somestring"
1347         }
1348     ]
1349
1350
1351
1352
1353
1354 GET ``/o2ims_infrastructureInventory/v1/``
1355 ------------------------------------------
1356
1357
1358
1359
1360
1361 Request
1362 +++++++
1363
1364
1365 Headers
1366 ^^^^^^^
1367
1368 .. code-block:: javascript
1369
1370     X-Fields: An optional fields mask
1371
1372
1373 Responses
1374 +++++++++
1375
1376 **200**
1377 ^^^^^^^
1378
1379 Success
1380
1381
1382 Type: :ref:`OcloudDto <d_24d46c2729680edc54e60b2dfbea8ebf>`
1383
1384 **Example:**
1385
1386 .. code-block:: javascript
1387
1388     {
1389         "description": "somestring",
1390         "globalCloudId": "somestring",
1391         "infrastructureManagementServiceEndpoint": "somestring",
1392         "name": "somestring",
1393         "oCloudId": "somestring"
1394     }
1395
1396 **404**
1397 ^^^^^^^
1398
1399 oCloud not found
1400
1401
1402
1403
1404
1405
1406 GET ``/o2ims_infrastructureInventory/v1/resourcePools``
1407 -------------------------------------------------------
1408
1409
1410
1411
1412
1413 Request
1414 +++++++
1415
1416
1417 Headers
1418 ^^^^^^^
1419
1420 .. code-block:: javascript
1421
1422     X-Fields: An optional fields mask
1423
1424
1425 Responses
1426 +++++++++
1427
1428 **200**
1429 ^^^^^^^
1430
1431 Success
1432
1433
1434 Type: array of :ref:`ResourcePoolGetDto <d_296e5d50362a85c0b8843dfe38965ce9>`
1435
1436
1437 **Example:**
1438
1439 .. code-block:: javascript
1440
1441     [
1442         {
1443             "description": "somestring",
1444             "globalLocationId": "somestring",
1445             "location": "somestring",
1446             "name": "somestring",
1447             "resourcePoolId": "somestring"
1448         },
1449         {
1450             "description": "somestring",
1451             "globalLocationId": "somestring",
1452             "location": "somestring",
1453             "name": "somestring",
1454             "resourcePoolId": "somestring"
1455         }
1456     ]
1457
1458
1459
1460
1461
1462 GET ``/o2ims_infrastructureInventory/v1/resourceTypes``
1463 -------------------------------------------------------
1464
1465
1466
1467
1468
1469 Request
1470 +++++++
1471
1472
1473 Headers
1474 ^^^^^^^
1475
1476 .. code-block:: javascript
1477
1478     X-Fields: An optional fields mask
1479
1480
1481 Responses
1482 +++++++++
1483
1484 **200**
1485 ^^^^^^^
1486
1487 Success
1488
1489
1490 Type: array of :ref:`ResourceTypeGetDto <d_fb92075f954e3895d1435d4e523666fa>`
1491
1492
1493 **Example:**
1494
1495 .. code-block:: javascript
1496
1497     [
1498         {
1499             "description": "somestring",
1500             "name": "somestring",
1501             "resourceTypeId": "somestring",
1502             "vendor": "somestring",
1503             "version": "somestring"
1504         },
1505         {
1506             "description": "somestring",
1507             "name": "somestring",
1508             "resourceTypeId": "somestring",
1509             "vendor": "somestring",
1510             "version": "somestring"
1511         }
1512     ]
1513
1514
1515
1516
1517
1518 GET ``/o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources``
1519 ----------------------------------------------------------------------------------
1520
1521
1522
1523
1524 Parameters
1525 ++++++++++
1526
1527 .. csv-table::
1528     :delim: |
1529     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1530     :widths: 20, 15, 10, 10, 10, 20, 30
1531
1532         resourcePoolID | path | Yes | string |  |  | ID of the resource pool
1533
1534
1535 Request
1536 +++++++
1537
1538
1539 Headers
1540 ^^^^^^^
1541
1542 .. code-block:: javascript
1543
1544     X-Fields: An optional fields mask
1545
1546
1547 Responses
1548 +++++++++
1549
1550 **200**
1551 ^^^^^^^
1552
1553 Success
1554
1555
1556 Type: array of :ref:`ResourceListDto <d_942ff02bfe350c7d2a7f3faabf5d77d1>`
1557
1558
1559 **Example:**
1560
1561 .. code-block:: javascript
1562
1563     [
1564         {
1565             "description": "somestring",
1566             "name": "somestring",
1567             "parentId": "somestring",
1568             "resourceId": "somestring",
1569             "resourcePoolId": "somestring",
1570             "resourceTypeId": "somestring"
1571         },
1572         {
1573             "description": "somestring",
1574             "name": "somestring",
1575             "parentId": "somestring",
1576             "resourceId": "somestring",
1577             "resourcePoolId": "somestring",
1578             "resourceTypeId": "somestring"
1579         }
1580     ]
1581
1582
1583
1584
1585 PROVISION
1586 ~~~~~~~~~
1587
1588
1589 Provision related operations.
1590
1591
1592
1593
1594
1595 POST ``/provision/v1/smo-endpoint``
1596 -----------------------------------
1597
1598
1599
1600
1601
1602 Request
1603 +++++++
1604
1605
1606 Headers
1607 ^^^^^^^
1608
1609 .. code-block:: javascript
1610
1611     X-Fields: An optional fields mask
1612
1613
1614
1615 .. _d_18b723a8578a1c0bdb13e962c902ad94:
1616
1617 Body
1618 ^^^^
1619
1620 .. csv-table::
1621     :delim: |
1622     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1623     :widths: 20, 10, 15, 15, 30, 25
1624
1625         endpoint | Yes | string |  |  | Configuration SMO callback address
1626
1627 .. code-block:: javascript
1628
1629     {
1630         "endpoint": "somestring"
1631     }
1632
1633 Responses
1634 +++++++++
1635
1636 **201**
1637 ^^^^^^^
1638
1639 Success
1640
1641
1642 Type: :ref:`SmoEndpointCreatedRespDto <d_36a34be9221cecc9bf82d276b9266961>`
1643
1644 **Example:**
1645
1646 .. code-block:: javascript
1647
1648     {
1649         "id": "somestring"
1650     }
1651
1652
1653
1654
1655
1656 DELETE ``/provision/v1/smo-endpoint/{configurationID}``
1657 -------------------------------------------------------
1658
1659
1660
1661
1662 Parameters
1663 ++++++++++
1664
1665 .. csv-table::
1666     :delim: |
1667     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1668     :widths: 20, 15, 10, 10, 10, 20, 30
1669
1670         configurationID | path | Yes | string |  |  | ID of the SMO endpoint configuration
1671
1672
1673 Request
1674 +++++++
1675
1676
1677 Responses
1678 +++++++++
1679
1680 **204**
1681 ^^^^^^^
1682
1683 Configuration deleted
1684
1685
1686 **404**
1687 ^^^^^^^
1688
1689 SMO Endpoint configuration not found
1690
1691
1692
1693
1694
1695
1696 GET ``/provision/v1/smo-endpoint/{configurationID}``
1697 ----------------------------------------------------
1698
1699
1700
1701
1702 Parameters
1703 ++++++++++
1704
1705 .. csv-table::
1706     :delim: |
1707     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1708     :widths: 20, 15, 10, 10, 10, 20, 30
1709
1710         configurationID | path | Yes | string |  |  | ID of the SMO endpoint configuration
1711
1712
1713 Request
1714 +++++++
1715
1716
1717 Headers
1718 ^^^^^^^
1719
1720 .. code-block:: javascript
1721
1722     X-Fields: An optional fields mask
1723
1724
1725 Responses
1726 +++++++++
1727
1728 **200**
1729 ^^^^^^^
1730
1731 Success
1732
1733
1734 Type: :ref:`SmoEndpointGetDto <d_a6b61d9695be919cc22b2e700eeb7e27>`
1735
1736 **Example:**
1737
1738 .. code-block:: javascript
1739
1740     {
1741         "comments": "somestring",
1742         "endpoint": "somestring",
1743         "id": "somestring",
1744         "status": "somestring"
1745     }
1746
1747 **404**
1748 ^^^^^^^
1749
1750 SMO Endpoint configuration not found
1751
1752
1753
1754
1755
1756
1757 GET ``/provision/v1/smo-endpoint``
1758 ----------------------------------
1759
1760
1761
1762
1763
1764 Request
1765 +++++++
1766
1767
1768 Headers
1769 ^^^^^^^
1770
1771 .. code-block:: javascript
1772
1773     X-Fields: An optional fields mask
1774
1775
1776 Responses
1777 +++++++++
1778
1779 **200**
1780 ^^^^^^^
1781
1782 Success
1783
1784
1785 Type: array of :ref:`SmoEndpointGetDto <d_a6b61d9695be919cc22b2e700eeb7e27>`
1786
1787
1788 **Example:**
1789
1790 .. code-block:: javascript
1791
1792     [
1793         {
1794             "comments": "somestring",
1795             "endpoint": "somestring",
1796             "id": "somestring",
1797             "status": "somestring"
1798         },
1799         {
1800             "comments": "somestring",
1801             "endpoint": "somestring",
1802             "id": "somestring",
1803             "status": "somestring"
1804         }
1805     ]
1806
1807
1808
1809
1810 Data Structures
1811 ~~~~~~~~~~~~~~~
1812
1813 .. _d_e936cc219a004ab92ac027b2690bdd5e:
1814
1815 DeploymentManagerGetDto Model Structure
1816 ---------------------------------------
1817
1818 .. csv-table::
1819     :delim: |
1820     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1821     :widths: 20, 10, 15, 15, 30, 25
1822
1823         capabilities | No | string |  |  |
1824         capacity | No | string |  |  |
1825         deploymentManagementServiceEndpoint | No | string |  |  |
1826         deploymentManagerId | Yes | string |  |  | Deployment manager ID
1827         description | No | string |  |  |
1828         name | No | string |  |  |
1829         supportedLocations | No | string |  |  |
1830
1831 .. _d_086ee84f2c2cf010478bfc73a87b5e80:
1832
1833 DmsGetDto Model Structure
1834 -------------------------
1835
1836 .. csv-table::
1837     :delim: |
1838     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1839     :widths: 20, 10, 15, 15, 30, 25
1840
1841         capabilities | No | string |  |  |
1842         capacity | No | string |  |  |
1843         deploymentManagerId | Yes | string |  |  | Deployment manager ID
1844         description | No | string |  |  |
1845         name | No | string |  |  |
1846         supportedLocations | No | string |  |  |
1847
1848 .. _d_1cdf8e618b9847878bed90d4897e6b4a:
1849
1850 NfDeploymentCreateDto Model Structure
1851 -------------------------------------
1852
1853 .. csv-table::
1854     :delim: |
1855     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1856     :widths: 20, 10, 15, 15, 30, 25
1857
1858         description | No | string |  |  |
1859         descriptorId | No | string |  |  |
1860         name | No | string |  |  |
1861         parentDeploymentId | No | string |  |  |
1862
1863 .. _d_c00d46ffd3e149e2989d2a5264585581:
1864
1865 NfDeploymentCreateRespDto Model Structure
1866 -----------------------------------------
1867
1868 .. csv-table::
1869     :delim: |
1870     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1871     :widths: 20, 10, 15, 15, 30, 25
1872
1873         id | Yes | string |  |  | NfDeployment ID
1874
1875 .. _d_1583b74cb6544a428fadd82cb4ff4b4b:
1876
1877 NfDeploymentDescriptorCreateDto Model Structure
1878 -----------------------------------------------
1879
1880 .. csv-table::
1881     :delim: |
1882     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1883     :widths: 20, 10, 15, 15, 30, 25
1884
1885         artifactName | No | string |  |  |
1886         artifactRepoUrl | No | string |  |  |
1887         description | No | string |  |  |
1888         inputParams | No | string |  |  |
1889         name | No | string |  |  |
1890         outputParams | No | string |  |  |
1891
1892 .. _d_67c3fe14b244e803ad34a57f27b4bb4e:
1893
1894 NfDeploymentDescriptorCreateRespDto Model Structure
1895 ---------------------------------------------------
1896
1897 .. csv-table::
1898     :delim: |
1899     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1900     :widths: 20, 10, 15, 15, 30, 25
1901
1902         id | Yes | string |  |  | NfDeploymentDescriptor ID
1903
1904 .. _d_5bdce8ac307530aa532cc25654cd5b07:
1905
1906 NfDeploymentDescriptorGetDto Model Structure
1907 --------------------------------------------
1908
1909 .. csv-table::
1910     :delim: |
1911     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1912     :widths: 20, 10, 15, 15, 30, 25
1913
1914         artifactName | No | string |  |  |
1915         artifactRepoUrl | No | string |  |  |
1916         description | No | string |  |  |
1917         id | Yes | string |  |  | NfDeploymentDescriptor ID
1918         inputParams | No | string |  |  |
1919         name | No | string |  |  |
1920         outputParams | No | string |  |  |
1921
1922 .. _d_5a6ee319c7ac35eac173da7d57136a99:
1923
1924 NfDeploymentDescriptorUpdateDto Model Structure
1925 -----------------------------------------------
1926
1927 .. csv-table::
1928     :delim: |
1929     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1930     :widths: 20, 10, 15, 15, 30, 25
1931
1932         artifactName | No | string |  |  |
1933         artifactRepoUrl | No | string |  |  |
1934         description | No | string |  |  |
1935         inputParams | No | string |  |  |
1936         name | No | string |  |  |
1937         outputParams | No | string |  |  |
1938
1939 .. _d_e28dc7c38126e125615678304c7a9508:
1940
1941 NfDeploymentGetDto Model Structure
1942 ----------------------------------
1943
1944 .. csv-table::
1945     :delim: |
1946     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1947     :widths: 20, 10, 15, 15, 30, 25
1948
1949         description | No | string |  |  |
1950         descriptorId | No | string |  |  |
1951         id | Yes | string |  |  | NfDeployment ID
1952         name | No | string |  |  |
1953         parentDeploymentId | No | string |  |  |
1954         status | No | integer |  |  |
1955
1956 .. _d_1a0e59d24d7db279637f186c203d884d:
1957
1958 NfDeploymentUpdateDto Model Structure
1959 -------------------------------------
1960
1961 .. csv-table::
1962     :delim: |
1963     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1964     :widths: 20, 10, 15, 15, 30, 25
1965
1966         description | No | string |  |  |
1967         name | No | string |  |  |
1968         parentDeploymentId | No | string |  |  |
1969
1970 .. _d_24d46c2729680edc54e60b2dfbea8ebf:
1971
1972 OcloudDto Model Structure
1973 -------------------------
1974
1975 .. csv-table::
1976     :delim: |
1977     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1978     :widths: 20, 10, 15, 15, 30, 25
1979
1980         description | No | string |  |  |
1981         globalCloudId | No | string |  |  |
1982         infrastructureManagementServiceEndpoint | No | string |  |  |
1983         name | No | string |  |  |
1984         oCloudId | Yes | string |  |  |
1985
1986 .. _d_6d49595cea3e0fa957a06fb11bda4897:
1987
1988 ResourceGetDto0 Model Structure
1989 -------------------------------
1990
1991 .. csv-table::
1992     :delim: |
1993     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1994     :widths: 20, 10, 15, 15, 30, 25
1995
1996         description | No | string |  |  |
1997         elements | No | string |  |  |
1998         name | No | string |  |  |
1999         parentId | No | string |  |  |
2000         resourceId | Yes | string |  |  | Resource ID
2001         resourcePoolId | No | string |  |  |
2002         resourceTypeId | No | string |  |  |
2003
2004 .. _d_bb8426c45d4d19dc6128fbb298c7bb4d:
2005
2006 ResourceGetDto1 Model Structure
2007 -------------------------------
2008
2009 .. csv-table::
2010     :delim: |
2011     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2012     :widths: 20, 10, 15, 15, 30, 25
2013
2014         children | No | array of :ref:`ResourceGetDto0 <d_6d49595cea3e0fa957a06fb11bda4897>` |  |  |
2015         description | No | string |  |  |
2016         elements | No | string |  |  |
2017         name | No | string |  |  |
2018         parentId | No | string |  |  |
2019         resourceId | Yes | string |  |  | Resource ID
2020         resourcePoolId | No | string |  |  |
2021         resourceTypeId | No | string |  |  |
2022
2023 .. _d_958dd46196a624722ba9ea3ea4d27e38:
2024
2025 ResourceGetDto2 Model Structure
2026 -------------------------------
2027
2028 .. csv-table::
2029     :delim: |
2030     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2031     :widths: 20, 10, 15, 15, 30, 25
2032
2033         children | No | array of :ref:`ResourceGetDto1 <d_bb8426c45d4d19dc6128fbb298c7bb4d>` |  |  |
2034         description | No | string |  |  |
2035         elements | No | string |  |  |
2036         name | No | string |  |  |
2037         parentId | No | string |  |  |
2038         resourceId | Yes | string |  |  | Resource ID
2039         resourcePoolId | No | string |  |  |
2040         resourceTypeId | No | string |  |  |
2041
2042 .. _d_942ff02bfe350c7d2a7f3faabf5d77d1:
2043
2044 ResourceListDto Model Structure
2045 -------------------------------
2046
2047 .. csv-table::
2048     :delim: |
2049     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2050     :widths: 20, 10, 15, 15, 30, 25
2051
2052         description | No | string |  |  |
2053         name | No | string |  |  |
2054         parentId | No | string |  |  |
2055         resourceId | Yes | string |  |  | Resource ID
2056         resourcePoolId | No | string |  |  |
2057         resourceTypeId | No | string |  |  |
2058
2059 .. _d_296e5d50362a85c0b8843dfe38965ce9:
2060
2061 ResourcePoolGetDto Model Structure
2062 ----------------------------------
2063
2064 .. csv-table::
2065     :delim: |
2066     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2067     :widths: 20, 10, 15, 15, 30, 25
2068
2069         description | No | string |  |  |
2070         globalLocationId | No | string |  |  |
2071         location | No | string |  |  |
2072         name | No | string |  |  |
2073         resourcePoolId | Yes | string |  |  | Resource pool ID
2074
2075 .. _d_fb92075f954e3895d1435d4e523666fa:
2076
2077 ResourceTypeGetDto Model Structure
2078 ----------------------------------
2079
2080 .. csv-table::
2081     :delim: |
2082     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2083     :widths: 20, 10, 15, 15, 30, 25
2084
2085         description | No | string |  |  |
2086         name | No | string |  |  |
2087         resourceTypeId | Yes | string |  |  | Resource type ID
2088         vendor | No | string |  |  |
2089         version | No | string |  |  |
2090
2091 .. _d_18b723a8578a1c0bdb13e962c902ad95:
2092
2093 SmoEndpointCreateDto Model Structure
2094 ------------------------------------
2095
2096 .. csv-table::
2097     :delim: |
2098     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2099     :widths: 20, 10, 15, 15, 30, 25
2100
2101         endpoint | Yes | string |  |  | Configuration SMO callback address
2102
2103 .. _d_36a34be9221cecc9bf82d276b9266961:
2104
2105 SmoEndpointCreatedRespDto Model Structure
2106 -----------------------------------------
2107
2108 .. csv-table::
2109     :delim: |
2110     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2111     :widths: 20, 10, 15, 15, 30, 25
2112
2113         id | Yes | string |  |  | SMO Endpoint Configuration ID
2114
2115 .. _d_a6b61d9695be919cc22b2e700eeb7e27:
2116
2117 SmoEndpointGetDto Model Structure
2118 ---------------------------------
2119
2120 .. csv-table::
2121     :delim: |
2122     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2123     :widths: 20, 10, 15, 15, 30, 25
2124
2125         comments | No | string |  |  |
2126         endpoint | No | string |  |  |
2127         id | Yes | string |  |  | SMO Endpoint Configuration ID
2128         status | No | string |  |  |
2129
2130 .. _d_0fff8519707c32c34f86d6ac19fad343:
2131
2132 SubscriptionCreateDto Model Structure
2133 -------------------------------------
2134
2135 .. csv-table::
2136     :delim: |
2137     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2138     :widths: 20, 10, 15, 15, 30, 25
2139
2140         callback | Yes | string |  |  | Subscription callback address
2141         consumerSubscriptionId | No | string |  |  |
2142         filter | No | string |  |  |
2143
2144 .. _d_4397329931bf78862bc91387dbdb86c4:
2145
2146 SubscriptionCreatedRespDto Model Structure
2147 ------------------------------------------
2148
2149 .. csv-table::
2150     :delim: |
2151     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2152     :widths: 20, 10, 15, 15, 30, 25
2153
2154         subscriptionId | Yes | string |  |  | Subscription ID
2155
2156 .. _d_90e532f740e7ec8e9d71fad08513c388:
2157
2158 SubscriptionGetDto Model Structure
2159 ----------------------------------
2160
2161 .. csv-table::
2162     :delim: |
2163     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2164     :widths: 20, 10, 15, 15, 30, 25
2165
2166         callback | No | string |  |  |
2167         consumerSubscriptionId | No | string |  |  |
2168         filter | No | string |  |  |
2169         subscriptionId | Yes | string |  |  | Subscription ID
2170