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-2022 Wind River Systems, Inc.
   4
   5 INF O2 Services API 1.0.0
   6 =========================
   7
   8 .. toctree::
   9     :maxdepth: 3
  10
  11
  12 Description
  13 ~~~~~~~~~~~
  14
  15 Swagger OpenAPI document for the INF 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/v1/{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/v1/{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/v1/{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/v1/{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/v1/{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/v1/{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/v1/{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/v1/{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/v1/{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/v1/{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/v1/{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         profile | query | No | string |  |  | DMS profile: value supports "sol018"
 881         deploymentManagerID | path | Yes | string |  |  | ID of the deployment manager
 882
 883
 884 Request
 885 +++++++
 886
 887
 888 Headers
 889 ^^^^^^^
 890
 891 .. code-block:: javascript
 892
 893     X-Fields: An optional fields mask
 894
 895
 896 Responses
 897 +++++++++
 898
 899 **200**
 900 ^^^^^^^
 901
 902 Success
 903
 904
 905 Type: :ref:`DeploymentManagerGetDto <d_e936cc219a004ab92ac027b2690bdd5e>`
 906
 907 **Example:**
 908
 909 .. code-block:: javascript
 910
 911     {
 912         "capabilities": "somestring",
 913         "capacity": "somestring",
 914         "deploymentManagementServiceEndpoint": "somestring",
 915         "deploymentManagerId": "somestring",
 916         "description": "somestring",
 917         "name": "somestring",
 918         "profileData": {
 919             "admin_client_cert": "somestring",
 920             "admin_client_key": "somestring",
 921             "admin_user": "somestring",
 922             "cluster_api_endpoint": "somestring",
 923             "cluster_ca_cert": "somestring"
 924         },
 925         "profileName": "somestring",
 926         "supportedLocations": "somestring"
 927     }
 928
 929 **404**
 930 ^^^^^^^
 931
 932 Deployment manager not found
 933
 934
 935
 936
 937
 938
 939 GET ``/o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}``
 940 -----------------------------------------------------------------------------------------------
 941
 942
 943
 944
 945 Parameters
 946 ++++++++++
 947
 948 .. csv-table::
 949     :delim: |
 950     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
 951     :widths: 20, 15, 10, 10, 10, 20, 30
 952
 953         resourceID | path | Yes | string |  |  | ID of the resource
 954         resourcePoolID | path | Yes | string |  |  | ID of the resource pool
 955
 956
 957 Request
 958 +++++++
 959
 960
 961 Headers
 962 ^^^^^^^
 963
 964 .. code-block:: javascript
 965
 966     X-Fields: An optional fields mask
 967
 968
 969 Responses
 970 +++++++++
 971
 972 **200**
 973 ^^^^^^^
 974
 975 Success
 976
 977
 978 Type: :ref:`ResourceGetDto2 <d_958dd46196a624722ba9ea3ea4d27e38>`
 979
 980 **Example:**
 981
 982 .. code-block:: javascript
 983
 984     {
 985         "children": [
 986             {
 987                 "children": [
 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                 "description": "somestring",
1008                 "elements": "somestring",
1009                 "name": "somestring",
1010                 "parentId": "somestring",
1011                 "resourceId": "somestring",
1012                 "resourcePoolId": "somestring",
1013                 "resourceTypeId": "somestring"
1014             },
1015             {
1016                 "children": [
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         "description": "somestring",
1046         "elements": "somestring",
1047         "name": "somestring",
1048         "parentId": "somestring",
1049         "resourceId": "somestring",
1050         "resourcePoolId": "somestring",
1051         "resourceTypeId": "somestring"
1052     }
1053
1054 **404**
1055 ^^^^^^^
1056
1057 Resource not found
1058
1059
1060
1061
1062
1063
1064 GET ``/o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}``
1065 ------------------------------------------------------------------------
1066
1067
1068
1069
1070 Parameters
1071 ++++++++++
1072
1073 .. csv-table::
1074     :delim: |
1075     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1076     :widths: 20, 15, 10, 10, 10, 20, 30
1077
1078         resourcePoolID | path | Yes | string |  |  | ID of the resource pool
1079
1080
1081 Request
1082 +++++++
1083
1084
1085 Headers
1086 ^^^^^^^
1087
1088 .. code-block:: javascript
1089
1090     X-Fields: An optional fields mask
1091
1092
1093 Responses
1094 +++++++++
1095
1096 **200**
1097 ^^^^^^^
1098
1099 Success
1100
1101
1102 Type: :ref:`ResourcePoolGetDto <d_296e5d50362a85c0b8843dfe38965ce9>`
1103
1104 **Example:**
1105
1106 .. code-block:: javascript
1107
1108     {
1109         "description": "somestring",
1110         "globalLocationId": "somestring",
1111         "location": "somestring",
1112         "name": "somestring",
1113         "resourcePoolId": "somestring"
1114     }
1115
1116 **404**
1117 ^^^^^^^
1118
1119 Resource pool not found
1120
1121
1122
1123
1124
1125
1126 GET ``/o2ims_infrastructureInventory/v1/resourceTypes/{resourceTypeID}``
1127 ------------------------------------------------------------------------
1128
1129
1130
1131
1132 Parameters
1133 ++++++++++
1134
1135 .. csv-table::
1136     :delim: |
1137     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1138     :widths: 20, 15, 10, 10, 10, 20, 30
1139
1140         resourceTypeID | path | Yes | string |  |  | ID of the resource type
1141
1142
1143 Request
1144 +++++++
1145
1146
1147 Headers
1148 ^^^^^^^
1149
1150 .. code-block:: javascript
1151
1152     X-Fields: An optional fields mask
1153
1154
1155 Responses
1156 +++++++++
1157
1158 **200**
1159 ^^^^^^^
1160
1161 Success
1162
1163
1164 Type: :ref:`ResourceTypeGetDto <d_fb92075f954e3895d1435d4e523666fa>`
1165
1166 **Example:**
1167
1168 .. code-block:: javascript
1169
1170     {
1171         "description": "somestring",
1172         "name": "somestring",
1173         "resourceTypeId": "somestring",
1174         "vendor": "somestring",
1175         "version": "somestring"
1176     }
1177
1178 **404**
1179 ^^^^^^^
1180
1181 Resource type not found
1182
1183
1184
1185
1186
1187
1188 GET ``/o2ims_infrastructureInventory/v1/subscriptions/{subscriptionID}``
1189 ------------------------------------------------------------------------
1190
1191
1192
1193
1194 Parameters
1195 ++++++++++
1196
1197 .. csv-table::
1198     :delim: |
1199     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1200     :widths: 20, 15, 10, 10, 10, 20, 30
1201
1202         subscriptionID | path | Yes | string |  |  | ID of the subscription
1203
1204
1205 Request
1206 +++++++
1207
1208
1209 Headers
1210 ^^^^^^^
1211
1212 .. code-block:: javascript
1213
1214     X-Fields: An optional fields mask
1215
1216
1217 Responses
1218 +++++++++
1219
1220 **200**
1221 ^^^^^^^
1222
1223 Success
1224
1225
1226 Type: :ref:`SubscriptionGetDto <d_90e532f740e7ec8e9d71fad08513c388>`
1227
1228 **Example:**
1229
1230 .. code-block:: javascript
1231
1232     {
1233         "callback": "somestring",
1234         "consumerSubscriptionId": "somestring",
1235         "filter": "somestring",
1236         "subscriptionId": "somestring"
1237     }
1238
1239 **404**
1240 ^^^^^^^
1241
1242 Subscription not found
1243
1244
1245
1246
1247
1248
1249 GET ``/o2ims_infrastructureInventory/v1/subscriptions``
1250 -------------------------------------------------------
1251
1252
1253
1254
1255
1256 Request
1257 +++++++
1258
1259
1260 Headers
1261 ^^^^^^^
1262
1263 .. code-block:: javascript
1264
1265     X-Fields: An optional fields mask
1266
1267
1268 Responses
1269 +++++++++
1270
1271 **200**
1272 ^^^^^^^
1273
1274 Success
1275
1276
1277 Type: array of :ref:`SubscriptionGetDto <d_90e532f740e7ec8e9d71fad08513c388>`
1278
1279
1280 **Example:**
1281
1282 .. code-block:: javascript
1283
1284     [
1285         {
1286             "callback": "somestring",
1287             "consumerSubscriptionId": "somestring",
1288             "filter": "somestring",
1289             "subscriptionId": "somestring"
1290         },
1291         {
1292             "callback": "somestring",
1293             "consumerSubscriptionId": "somestring",
1294             "filter": "somestring",
1295             "subscriptionId": "somestring"
1296         }
1297     ]
1298
1299
1300
1301
1302
1303 GET ``/o2ims_infrastructureInventory/v1/deploymentManagers``
1304 ------------------------------------------------------------
1305
1306
1307
1308
1309
1310 Request
1311 +++++++
1312
1313
1314 Headers
1315 ^^^^^^^
1316
1317 .. code-block:: javascript
1318
1319     X-Fields: An optional fields mask
1320
1321
1322 Responses
1323 +++++++++
1324
1325 **200**
1326 ^^^^^^^
1327
1328 Success
1329
1330
1331 Type: array of :ref:`DeploymentManagerListDto <d_b50b514bc3afc99684dcf3a7c2fc8b60>`
1332
1333
1334 **Example:**
1335
1336 .. code-block:: javascript
1337
1338     [
1339         {
1340             "capabilities": "somestring",
1341             "capacity": "somestring",
1342             "deploymentManagementServiceEndpoint": "somestring",
1343             "deploymentManagerId": "somestring",
1344             "description": "somestring",
1345             "name": "somestring",
1346             "profileSupportList": [
1347                 "somestring",
1348                 "somestring"
1349             ],
1350             "supportedLocations": "somestring"
1351         },
1352         {
1353             "capabilities": "somestring",
1354             "capacity": "somestring",
1355             "deploymentManagementServiceEndpoint": "somestring",
1356             "deploymentManagerId": "somestring",
1357             "description": "somestring",
1358             "name": "somestring",
1359             "profileSupportList": [
1360                 "somestring",
1361                 "somestring"
1362             ],
1363             "supportedLocations": "somestring"
1364         }
1365     ]
1366
1367
1368
1369
1370
1371 GET ``/o2ims_infrastructureInventory/v1/``
1372 ------------------------------------------
1373
1374
1375
1376
1377
1378 Request
1379 +++++++
1380
1381
1382 Headers
1383 ^^^^^^^
1384
1385 .. code-block:: javascript
1386
1387     X-Fields: An optional fields mask
1388
1389
1390 Responses
1391 +++++++++
1392
1393 **200**
1394 ^^^^^^^
1395
1396 Success
1397
1398
1399 Type: :ref:`OcloudDto <d_24d46c2729680edc54e60b2dfbea8ebf>`
1400
1401 **Example:**
1402
1403 .. code-block:: javascript
1404
1405     {
1406         "description": "somestring",
1407         "globalCloudId": "somestring",
1408         "infrastructureManagementServiceEndpoint": "somestring",
1409         "name": "somestring",
1410         "oCloudId": "somestring"
1411     }
1412
1413 **404**
1414 ^^^^^^^
1415
1416 oCloud not found
1417
1418
1419
1420
1421
1422
1423 GET ``/o2ims_infrastructureInventory/v1/resourcePools``
1424 -------------------------------------------------------
1425
1426
1427
1428
1429
1430 Request
1431 +++++++
1432
1433
1434 Headers
1435 ^^^^^^^
1436
1437 .. code-block:: javascript
1438
1439     X-Fields: An optional fields mask
1440
1441
1442 Responses
1443 +++++++++
1444
1445 **200**
1446 ^^^^^^^
1447
1448 Success
1449
1450
1451 Type: array of :ref:`ResourcePoolGetDto <d_296e5d50362a85c0b8843dfe38965ce9>`
1452
1453
1454 **Example:**
1455
1456 .. code-block:: javascript
1457
1458     [
1459         {
1460             "description": "somestring",
1461             "globalLocationId": "somestring",
1462             "location": "somestring",
1463             "name": "somestring",
1464             "resourcePoolId": "somestring"
1465         },
1466         {
1467             "description": "somestring",
1468             "globalLocationId": "somestring",
1469             "location": "somestring",
1470             "name": "somestring",
1471             "resourcePoolId": "somestring"
1472         }
1473     ]
1474
1475
1476
1477
1478
1479 GET ``/o2ims_infrastructureInventory/v1/resourceTypes``
1480 -------------------------------------------------------
1481
1482
1483
1484
1485
1486 Request
1487 +++++++
1488
1489
1490 Headers
1491 ^^^^^^^
1492
1493 .. code-block:: javascript
1494
1495     X-Fields: An optional fields mask
1496
1497
1498 Responses
1499 +++++++++
1500
1501 **200**
1502 ^^^^^^^
1503
1504 Success
1505
1506
1507 Type: array of :ref:`ResourceTypeGetDto <d_fb92075f954e3895d1435d4e523666fa>`
1508
1509
1510 **Example:**
1511
1512 .. code-block:: javascript
1513
1514     [
1515         {
1516             "description": "somestring",
1517             "name": "somestring",
1518             "resourceTypeId": "somestring",
1519             "vendor": "somestring",
1520             "version": "somestring"
1521         },
1522         {
1523             "description": "somestring",
1524             "name": "somestring",
1525             "resourceTypeId": "somestring",
1526             "vendor": "somestring",
1527             "version": "somestring"
1528         }
1529     ]
1530
1531
1532
1533
1534
1535 GET ``/o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources``
1536 ----------------------------------------------------------------------------------
1537
1538
1539
1540
1541 Parameters
1542 ++++++++++
1543
1544 .. csv-table::
1545     :delim: |
1546     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1547     :widths: 20, 15, 10, 10, 10, 20, 30
1548
1549         parentId | query | No | string |  |  | filter parentId
1550         resourceTypeName | query | No | string |  |  | filter resource type
1551         resourcePoolID | path | Yes | string |  |  | ID of the resource pool
1552
1553
1554 Request
1555 +++++++
1556
1557
1558 Headers
1559 ^^^^^^^
1560
1561 .. code-block:: javascript
1562
1563     X-Fields: An optional fields mask
1564
1565
1566 Responses
1567 +++++++++
1568
1569 **200**
1570 ^^^^^^^
1571
1572 Success
1573
1574
1575 Type: array of :ref:`ResourceListDto <d_942ff02bfe350c7d2a7f3faabf5d77d1>`
1576
1577
1578 **Example:**
1579
1580 .. code-block:: javascript
1581
1582     [
1583         {
1584             "description": "somestring",
1585             "name": "somestring",
1586             "parentId": "somestring",
1587             "resourceId": "somestring",
1588             "resourcePoolId": "somestring",
1589             "resourceTypeId": "somestring"
1590         },
1591         {
1592             "description": "somestring",
1593             "name": "somestring",
1594             "parentId": "somestring",
1595             "resourceId": "somestring",
1596             "resourcePoolId": "somestring",
1597             "resourceTypeId": "somestring"
1598         }
1599     ]
1600
1601
1602
1603
1604 PROVISION
1605 ~~~~~~~~~
1606
1607
1608 Provision related operations.
1609
1610
1611
1612
1613
1614 POST ``/provision/v1/smo-endpoint``
1615 -----------------------------------
1616
1617
1618
1619
1620
1621 Request
1622 +++++++
1623
1624
1625 Headers
1626 ^^^^^^^
1627
1628 .. code-block:: javascript
1629
1630     X-Fields: An optional fields mask
1631
1632
1633
1634 .. _d_18b723a8578a1c0bdb13e962c902ad94:
1635
1636 Body
1637 ^^^^
1638
1639 .. csv-table::
1640     :delim: |
1641     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1642     :widths: 20, 10, 15, 15, 30, 25
1643
1644         endpoint | Yes | string |  |  | Configuration SMO callback address
1645
1646 .. code-block:: javascript
1647
1648     {
1649         "endpoint": "somestring"
1650     }
1651
1652 Responses
1653 +++++++++
1654
1655 **201**
1656 ^^^^^^^
1657
1658 Success
1659
1660
1661 Type: :ref:`SmoEndpointCreatedRespDto <d_36a34be9221cecc9bf82d276b9266961>`
1662
1663 **Example:**
1664
1665 .. code-block:: javascript
1666
1667     {
1668         "id": "somestring"
1669     }
1670
1671
1672
1673
1674
1675 DELETE ``/provision/v1/smo-endpoint/{configurationID}``
1676 -------------------------------------------------------
1677
1678
1679
1680
1681 Parameters
1682 ++++++++++
1683
1684 .. csv-table::
1685     :delim: |
1686     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1687     :widths: 20, 15, 10, 10, 10, 20, 30
1688
1689         configurationID | path | Yes | string |  |  | ID of the SMO endpoint configuration
1690
1691
1692 Request
1693 +++++++
1694
1695
1696 Responses
1697 +++++++++
1698
1699 **204**
1700 ^^^^^^^
1701
1702 Configuration deleted
1703
1704
1705 **404**
1706 ^^^^^^^
1707
1708 SMO Endpoint configuration not found
1709
1710
1711
1712
1713
1714
1715 GET ``/provision/v1/smo-endpoint/{configurationID}``
1716 ----------------------------------------------------
1717
1718
1719
1720
1721 Parameters
1722 ++++++++++
1723
1724 .. csv-table::
1725     :delim: |
1726     :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1727     :widths: 20, 15, 10, 10, 10, 20, 30
1728
1729         configurationID | path | Yes | string |  |  | ID of the SMO endpoint configuration
1730
1731
1732 Request
1733 +++++++
1734
1735
1736 Headers
1737 ^^^^^^^
1738
1739 .. code-block:: javascript
1740
1741     X-Fields: An optional fields mask
1742
1743
1744 Responses
1745 +++++++++
1746
1747 **200**
1748 ^^^^^^^
1749
1750 Success
1751
1752
1753 Type: :ref:`SmoEndpointGetDto <d_a6b61d9695be919cc22b2e700eeb7e27>`
1754
1755 **Example:**
1756
1757 .. code-block:: javascript
1758
1759     {
1760         "comments": "somestring",
1761         "endpoint": "somestring",
1762         "id": "somestring",
1763         "status": "somestring"
1764     }
1765
1766 **404**
1767 ^^^^^^^
1768
1769 SMO Endpoint configuration not found
1770
1771
1772
1773
1774
1775
1776 GET ``/provision/v1/smo-endpoint``
1777 ----------------------------------
1778
1779
1780
1781
1782
1783 Request
1784 +++++++
1785
1786
1787 Headers
1788 ^^^^^^^
1789
1790 .. code-block:: javascript
1791
1792     X-Fields: An optional fields mask
1793
1794
1795 Responses
1796 +++++++++
1797
1798 **200**
1799 ^^^^^^^
1800
1801 Success
1802
1803
1804 Type: array of :ref:`SmoEndpointGetDto <d_a6b61d9695be919cc22b2e700eeb7e27>`
1805
1806
1807 **Example:**
1808
1809 .. code-block:: javascript
1810
1811     [
1812         {
1813             "comments": "somestring",
1814             "endpoint": "somestring",
1815             "id": "somestring",
1816             "status": "somestring"
1817         },
1818         {
1819             "comments": "somestring",
1820             "endpoint": "somestring",
1821             "id": "somestring",
1822             "status": "somestring"
1823         }
1824     ]
1825
1826
1827
1828
1829 Data Structures
1830 ~~~~~~~~~~~~~~~
1831
1832 .. _d_e936cc219a004ab92ac027b2690bdd5e:
1833
1834 DeploymentManagerGetDto Model Structure
1835 ---------------------------------------
1836
1837 .. csv-table::
1838     :delim: |
1839     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1840     :widths: 20, 10, 15, 15, 30, 25
1841
1842         capabilities | No | string |  |  |
1843         capacity | No | string |  |  |
1844         deploymentManagementServiceEndpoint | No | string |  |  |
1845         deploymentManagerId | Yes | string |  |  | Deployment manager ID
1846         description | No | string |  |  |
1847         name | No | string |  |  |
1848         profileData | No | :ref:`DeploymentManagerGetDtoProfile <d_51fed249638cf054f9cc4c7832c7cbe4>` |  |  |
1849         profileName | No | string |  |  |
1850         supportedLocations | No | string |  |  |
1851
1852 .. _d_51fed249638cf054f9cc4c7832c7cbe4:
1853
1854 DeploymentManagerGetDtoProfile Model Structure
1855 ----------------------------------------------
1856
1857 .. csv-table::
1858     :delim: |
1859     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1860     :widths: 20, 10, 15, 15, 30, 25
1861
1862         admin_client_cert | No | string |  |  |
1863         admin_client_key | No | string |  |  |
1864         admin_user | No | string |  |  |
1865         cluster_api_endpoint | No | string |  |  |
1866         cluster_ca_cert | No | string |  |  |
1867
1868 .. _d_b50b514bc3afc99684dcf3a7c2fc8b60:
1869
1870 DeploymentManagerListDto Model Structure
1871 ----------------------------------------
1872
1873 .. csv-table::
1874     :delim: |
1875     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1876     :widths: 20, 10, 15, 15, 30, 25
1877
1878         capabilities | No | string |  |  |
1879         capacity | No | string |  |  |
1880         deploymentManagementServiceEndpoint | No | string |  |  |
1881         deploymentManagerId | Yes | string |  |  | Deployment manager ID
1882         description | No | string |  |  |
1883         name | No | string |  |  |
1884         profileSupportList | No | array of string |  |  | Profile support list, use default for the return                      endpoint
1885         supportedLocations | No | string |  |  |
1886
1887 .. _d_086ee84f2c2cf010478bfc73a87b5e80:
1888
1889 DmsGetDto Model Structure
1890 -------------------------
1891
1892 .. csv-table::
1893     :delim: |
1894     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1895     :widths: 20, 10, 15, 15, 30, 25
1896
1897         capabilities | No | string |  |  |
1898         capacity | No | string |  |  |
1899         deploymentManagerId | Yes | string |  |  | Deployment manager ID
1900         description | No | string |  |  |
1901         name | No | string |  |  |
1902         supportedLocations | No | string |  |  |
1903
1904 .. _d_1cdf8e618b9847878bed90d4897e6b4a:
1905
1906 NfDeploymentCreateDto 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         description | No | string |  |  |
1915         descriptorId | No | string |  |  |
1916         name | No | string |  |  |
1917         parentDeploymentId | No | string |  |  |
1918
1919 .. _d_c00d46ffd3e149e2989d2a5264585581:
1920
1921 NfDeploymentCreateRespDto Model Structure
1922 -----------------------------------------
1923
1924 .. csv-table::
1925     :delim: |
1926     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1927     :widths: 20, 10, 15, 15, 30, 25
1928
1929         id | Yes | string |  |  | NfDeployment ID
1930
1931 .. _d_1583b74cb6544a428fadd82cb4ff4b4b:
1932
1933 NfDeploymentDescriptorCreateDto Model Structure
1934 -----------------------------------------------
1935
1936 .. csv-table::
1937     :delim: |
1938     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1939     :widths: 20, 10, 15, 15, 30, 25
1940
1941         artifactName | No | string |  |  |
1942         artifactRepoUrl | No | string |  |  |
1943         description | No | string |  |  |
1944         inputParams | No | string |  |  |
1945         name | No | string |  |  |
1946         outputParams | No | string |  |  |
1947
1948 .. _d_67c3fe14b244e803ad34a57f27b4bb4e:
1949
1950 NfDeploymentDescriptorCreateRespDto Model Structure
1951 ---------------------------------------------------
1952
1953 .. csv-table::
1954     :delim: |
1955     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1956     :widths: 20, 10, 15, 15, 30, 25
1957
1958         id | Yes | string |  |  | NfDeploymentDescriptor ID
1959
1960 .. _d_5bdce8ac307530aa532cc25654cd5b07:
1961
1962 NfDeploymentDescriptorGetDto Model Structure
1963 --------------------------------------------
1964
1965 .. csv-table::
1966     :delim: |
1967     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1968     :widths: 20, 10, 15, 15, 30, 25
1969
1970         artifactName | No | string |  |  |
1971         artifactRepoUrl | No | string |  |  |
1972         description | No | string |  |  |
1973         id | Yes | string |  |  | NfDeploymentDescriptor ID
1974         inputParams | No | string |  |  |
1975         name | No | string |  |  |
1976         outputParams | No | string |  |  |
1977
1978 .. _d_5a6ee319c7ac35eac173da7d57136a99:
1979
1980 NfDeploymentDescriptorUpdateDto Model Structure
1981 -----------------------------------------------
1982
1983 .. csv-table::
1984     :delim: |
1985     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1986     :widths: 20, 10, 15, 15, 30, 25
1987
1988         artifactName | No | string |  |  |
1989         artifactRepoUrl | No | string |  |  |
1990         description | No | string |  |  |
1991         inputParams | No | string |  |  |
1992         name | No | string |  |  |
1993         outputParams | No | string |  |  |
1994
1995 .. _d_e28dc7c38126e125615678304c7a9508:
1996
1997 NfDeploymentGetDto Model Structure
1998 ----------------------------------
1999
2000 .. csv-table::
2001     :delim: |
2002     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2003     :widths: 20, 10, 15, 15, 30, 25
2004
2005         description | No | string |  |  |
2006         descriptorId | No | string |  |  |
2007         id | Yes | string |  |  | NfDeployment ID
2008         name | No | string |  |  |
2009         parentDeploymentId | No | string |  |  |
2010         status | No | integer |  |  |
2011
2012 .. _d_1a0e59d24d7db279637f186c203d884d:
2013
2014 NfDeploymentUpdateDto Model Structure
2015 -------------------------------------
2016
2017 .. csv-table::
2018     :delim: |
2019     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2020     :widths: 20, 10, 15, 15, 30, 25
2021
2022         description | No | string |  |  |
2023         name | No | string |  |  |
2024         parentDeploymentId | No | string |  |  |
2025
2026 .. _d_24d46c2729680edc54e60b2dfbea8ebf:
2027
2028 OcloudDto Model Structure
2029 -------------------------
2030
2031 .. csv-table::
2032     :delim: |
2033     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2034     :widths: 20, 10, 15, 15, 30, 25
2035
2036         description | No | string |  |  |
2037         globalCloudId | No | string |  |  |
2038         infrastructureManagementServiceEndpoint | No | string |  |  |
2039         name | No | string |  |  |
2040         oCloudId | Yes | string |  |  |
2041
2042 .. _d_6d49595cea3e0fa957a06fb11bda4897:
2043
2044 ResourceGetDto0 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         elements | No | string |  |  |
2054         name | No | string |  |  |
2055         parentId | No | string |  |  |
2056         resourceId | Yes | string |  |  | Resource ID
2057         resourcePoolId | No | string |  |  |
2058         resourceTypeId | No | string |  |  |
2059
2060 .. _d_bb8426c45d4d19dc6128fbb298c7bb4d:
2061
2062 ResourceGetDto1 Model Structure
2063 -------------------------------
2064
2065 .. csv-table::
2066     :delim: |
2067     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2068     :widths: 20, 10, 15, 15, 30, 25
2069
2070         children | No | array of :ref:`ResourceGetDto0 <d_6d49595cea3e0fa957a06fb11bda4897>` |  |  |
2071         description | No | string |  |  |
2072         elements | No | string |  |  |
2073         name | No | string |  |  |
2074         parentId | No | string |  |  |
2075         resourceId | Yes | string |  |  | Resource ID
2076         resourcePoolId | No | string |  |  |
2077         resourceTypeId | No | string |  |  |
2078
2079 .. _d_958dd46196a624722ba9ea3ea4d27e38:
2080
2081 ResourceGetDto2 Model Structure
2082 -------------------------------
2083
2084 .. csv-table::
2085     :delim: |
2086     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2087     :widths: 20, 10, 15, 15, 30, 25
2088
2089         children | No | array of :ref:`ResourceGetDto1 <d_bb8426c45d4d19dc6128fbb298c7bb4d>` |  |  |
2090         description | No | string |  |  |
2091         elements | No | string |  |  |
2092         name | No | string |  |  |
2093         parentId | No | string |  |  |
2094         resourceId | Yes | string |  |  | Resource ID
2095         resourcePoolId | No | string |  |  |
2096         resourceTypeId | No | string |  |  |
2097
2098 .. _d_942ff02bfe350c7d2a7f3faabf5d77d1:
2099
2100 ResourceListDto Model Structure
2101 -------------------------------
2102
2103 .. csv-table::
2104     :delim: |
2105     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2106     :widths: 20, 10, 15, 15, 30, 25
2107
2108         description | No | string |  |  |
2109         name | No | string |  |  |
2110         parentId | No | string |  |  |
2111         resourceId | Yes | string |  |  | Resource ID
2112         resourcePoolId | No | string |  |  |
2113         resourceTypeId | No | string |  |  |
2114
2115 .. _d_296e5d50362a85c0b8843dfe38965ce9:
2116
2117 ResourcePoolGetDto 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         description | No | string |  |  |
2126         globalLocationId | No | string |  |  |
2127         location | No | string |  |  |
2128         name | No | string |  |  |
2129         resourcePoolId | Yes | string |  |  | Resource pool ID
2130
2131 .. _d_fb92075f954e3895d1435d4e523666fa:
2132
2133 ResourceTypeGetDto Model Structure
2134 ----------------------------------
2135
2136 .. csv-table::
2137     :delim: |
2138     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2139     :widths: 20, 10, 15, 15, 30, 25
2140
2141         description | No | string |  |  |
2142         name | No | string |  |  |
2143         resourceTypeId | Yes | string |  |  | Resource type ID
2144         vendor | No | string |  |  |
2145         version | No | string |  |  |
2146
2147 .. _d_18b723a8578a1c0bdb13e962c902ad95:
2148
2149 SmoEndpointCreateDto Model Structure
2150 ------------------------------------
2151
2152 .. csv-table::
2153     :delim: |
2154     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2155     :widths: 20, 10, 15, 15, 30, 25
2156
2157         endpoint | Yes | string |  |  | Configuration SMO callback address
2158
2159 .. _d_36a34be9221cecc9bf82d276b9266961:
2160
2161 SmoEndpointCreatedRespDto Model Structure
2162 -----------------------------------------
2163
2164 .. csv-table::
2165     :delim: |
2166     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2167     :widths: 20, 10, 15, 15, 30, 25
2168
2169         id | Yes | string |  |  | SMO Endpoint Configuration ID
2170
2171 .. _d_a6b61d9695be919cc22b2e700eeb7e27:
2172
2173 SmoEndpointGetDto Model Structure
2174 ---------------------------------
2175
2176 .. csv-table::
2177     :delim: |
2178     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2179     :widths: 20, 10, 15, 15, 30, 25
2180
2181         comments | No | string |  |  |
2182         endpoint | No | string |  |  |
2183         id | Yes | string |  |  | SMO Endpoint Configuration ID
2184         status | No | string |  |  |
2185
2186 .. _d_0fff8519707c32c34f86d6ac19fad343:
2187
2188 SubscriptionCreateDto Model Structure
2189 -------------------------------------
2190
2191 .. csv-table::
2192     :delim: |
2193     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2194     :widths: 20, 10, 15, 15, 30, 25
2195
2196         callback | Yes | string |  |  | Subscription callback address
2197         consumerSubscriptionId | No | string |  |  |
2198         filter | No | string |  |  |
2199
2200 .. _d_4397329931bf78862bc91387dbdb86c4:
2201
2202 SubscriptionCreatedRespDto Model Structure
2203 ------------------------------------------
2204
2205 .. csv-table::
2206     :delim: |
2207     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2208     :widths: 20, 10, 15, 15, 30, 25
2209
2210         subscriptionId | Yes | string |  |  | Subscription ID
2211
2212 .. _d_90e532f740e7ec8e9d71fad08513c388:
2213
2214 SubscriptionGetDto Model Structure
2215 ----------------------------------
2216
2217 .. csv-table::
2218     :delim: |
2219     :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2220     :widths: 20, 10, 15, 15, 30, 25
2221
2222         callback | No | string |  |  |
2223         consumerSubscriptionId | No | string |  |  |
2224         filter | No | string |  |  |
2225         subscriptionId | Yes | string |  |  | Subscription ID
2226