aai-schema/src/main/resources/aai_swagger_yaml/aai_swagger_v12.yaml

   1 swagger: "2.0"
   2 info:
   3   description: |
   4
   5     [Differences versus the previous schema version](apidocs/aai_swagger_v12.diff)
   6
   7     Copyright &copy; 2017 AT&amp;T Intellectual Property. All rights reserved.
   8
   9     Licensed under the Creative Commons License, Attribution 4.0 Intl. (the &quot;License&quot;); you may not use this documentation except in compliance with the License.
  10
  11     You may obtain a copy of the License at
  12
  13     (https://creativecommons.org/licenses/by/4.0/)
  14
  15     Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
  16
  17     ECOMP and OpenECOMP are trademarks and service marks of AT&amp;T Intellectual Property.
  18
  19     This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.
  20   version: "v12"
  21   title: Active and Available Inventory REST API
  22   license:
  23     name: Apache 2.0
  24     url: http://www.apache.org/licenses/LICENSE-2.0.html
  25   contact:
  26     name:
  27     url:
  28     email:
  29 host:
  30 basePath: /aai/v12
  31 schemes:
  32   - https
  33 paths:
  34   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship:
  35     put:
  36       tags:
  37         - CloudInfrastructure
  38       summary: see node definition for valid relationships
  39       operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
  40       consumes:
  41         - application/json
  42         - application/xml
  43       produces:
  44         - application/json
  45         - application/xml
  46       responses:
  47         "default":
  48           description: Response codes found in [response codes](https://wiki.onap.org/).
  49       parameters:
  50         - name: physical-location-id
  51           in: path
  52           description: Unique identifier for physical location, e.g., CLLI
  53           required: true
  54           type: string
  55           example: __PHYSICAL-LOCATION-ID__
  56         - name: target-pe
  57           in: path
  58           description: The Target provider edge router
  59           required: true
  60           type: string
  61           example: __TARGET-PE__
  62         - name: availability-zone-name
  63           in: path
  64           description: Name of the availability zone
  65           required: true
  66           type: string
  67           example: __AVAILABILITY-ZONE-NAME__
  68         - name: body
  69           in: body
  70           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
  71           required: true
  72           schema:
  73             $ref: "#/definitions/relationship"
  74     delete:
  75       tags:
  76         - CloudInfrastructure
  77       summary: delete an existing relationship
  78       description: delete an existing relationship
  79       operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPoolRelationshipListRelationship
  80       consumes:
  81         - application/json
  82         - application/xml
  83       produces:
  84         - application/json
  85         - application/xml
  86       responses:
  87         "default":
  88           description: Response codes found in [response codes](https://wiki.onap.org/).
  89       parameters:
  90         - name: physical-location-id
  91           in: path
  92           description: Unique identifier for physical location, e.g., CLLI
  93           required: true
  94           type: string
  95           example: __PHYSICAL-LOCATION-ID__
  96         - name: target-pe
  97           in: path
  98           description: The Target provider edge router
  99           required: true
 100           type: string
 101           example: __TARGET-PE__
 102         - name: availability-zone-name
 103           in: path
 104           description: Name of the availability zone
 105           required: true
 106           type: string
 107           example: __AVAILABILITY-ZONE-NAME__
 108   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}:
 109     get:
 110       tags:
 111         - CloudInfrastructure
 112       summary: returns ctag-pool
 113       description: returns ctag-pool
 114       operationId: getCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 115       produces:
 116         - application/json
 117         - application/xml
 118       responses:
 119         "200":
 120           description: successful operation
 121           schema:
 122               $ref: "#/getDefinitions/ctag-pool"
 123         "default":
 124           description: Response codes found in [response codes](https://wiki.onap.org/).
 125       parameters:
 126         - name: physical-location-id
 127           in: path
 128           description: Unique identifier for physical location, e.g., CLLI
 129           required: true
 130           type: string
 131           example: __PHYSICAL-LOCATION-ID__
 132         - name: target-pe
 133           in: path
 134           description: The Target provider edge router
 135           required: true
 136           type: string
 137           example: __TARGET-PE__
 138         - name: availability-zone-name
 139           in: path
 140           description: Name of the availability zone
 141           required: true
 142           type: string
 143           example: __AVAILABILITY-ZONE-NAME__
 144     put:
 145       tags:
 146         - CloudInfrastructure
 147       summary: create or update an existing ctag-pool
 148       description: |
 149         Create or update an existing ctag-pool.
 150         #
 151         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 152       operationId: createOrUpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 153       consumes:
 154         - application/json
 155         - application/xml
 156       produces:
 157         - application/json
 158         - application/xml
 159       responses:
 160         "default":
 161           description: Response codes found in [response codes](https://wiki.onap.org/).
 162       parameters:
 163         - name: physical-location-id
 164           in: path
 165           description: Unique identifier for physical location, e.g., CLLI
 166           required: true
 167           type: string
 168           example: __PHYSICAL-LOCATION-ID__
 169         - name: target-pe
 170           in: path
 171           description: The Target provider edge router
 172           required: true
 173           type: string
 174           example: __TARGET-PE__
 175         - name: availability-zone-name
 176           in: path
 177           description: Name of the availability zone
 178           required: true
 179           type: string
 180           example: __AVAILABILITY-ZONE-NAME__
 181         - name: body
 182           in: body
 183           description: ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)
 184           required: true
 185           schema:
 186             $ref: "#/definitions/ctag-pool"
 187     patch:
 188       tags:
 189         - CloudInfrastructure
 190       summary: update an existing ctag-pool
 191       description: |
 192         Update an existing ctag-pool
 193         #
 194         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 195         The PUT operation will entirely replace an existing object.
 196         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
 197         #
 198         Other differences between PUT and PATCH are:
 199         #
 200         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 201         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 202         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 203       operationId: UpdateCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 204       consumes:
 205         - application/json
 206         - application/xml
 207       produces:
 208         - application/json
 209         - application/xml
 210       responses:
 211         "default":
 212           description: Response codes found in [response codes](https://wiki.onap.org/).
 213       parameters:
 214         - name: physical-location-id
 215           in: path
 216           description: Unique identifier for physical location, e.g., CLLI
 217           required: true
 218           type: string
 219           example: __PHYSICAL-LOCATION-ID__
 220         - name: target-pe
 221           in: path
 222           description: The Target provider edge router
 223           required: true
 224           type: string
 225           example: __TARGET-PE__
 226         - name: availability-zone-name
 227           in: path
 228           description: Name of the availability zone
 229           required: true
 230           type: string
 231           example: __AVAILABILITY-ZONE-NAME__
 232         - name: body
 233           in: body
 234           description: ctag-pool object that needs to be updated.
 235           required: true
 236           schema:
 237             $ref: "#/patchDefinitions/ctag-pool"
 238     delete:
 239       tags:
 240         - CloudInfrastructure
 241       summary: delete an existing ctag-pool
 242       description: delete an existing ctag-pool
 243       operationId: deleteCloudInfrastructureComplexesComplexCtagPoolsCtagPool
 244       consumes:
 245         - application/json
 246         - application/xml
 247       produces:
 248         - application/json
 249         - application/xml
 250       responses:
 251         "default":
 252           description: Response codes found in [response codes](https://wiki.onap.org/).
 253       parameters:
 254         - name: physical-location-id
 255           in: path
 256           description: Unique identifier for physical location, e.g., CLLI
 257           required: true
 258           type: string
 259           example: __PHYSICAL-LOCATION-ID__
 260         - name: target-pe
 261           in: path
 262           description: The Target provider edge router
 263           required: true
 264           type: string
 265           example: __TARGET-PE__
 266         - name: availability-zone-name
 267           in: path
 268           description: Name of the availability zone
 269           required: true
 270           type: string
 271           example: __AVAILABILITY-ZONE-NAME__
 272         - name: resource-version
 273           in: query
 274           description: resource-version for concurrency
 275           required: true
 276           type: string
 277   /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools:
 278     get:
 279       tags:
 280         - CloudInfrastructure
 281       summary: returns ctag-pools
 282       description: returns ctag-pools
 283       operationId: getCloudInfrastructureComplexesComplexCtagPools
 284       produces:
 285         - application/json
 286         - application/xml
 287       responses:
 288         "200":
 289           description: successful operation
 290           schema:
 291               $ref: "#/getDefinitions/ctag-pools"
 292         "default":
 293           description: Response codes found in [response codes](https://wiki.onap.org/).
 294       parameters:
 295         - name: physical-location-id
 296           in: path
 297           description: Unique identifier for physical location, e.g., CLLI
 298           required: true
 299           type: string
 300           example: __PHYSICAL-LOCATION-ID__
 301         - name: availability-zone-name
 302           in: query
 303           description:
 304           required: false
 305           type: string
 306   /cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship:
 307     put:
 308       tags:
 309         - CloudInfrastructure
 310       summary: see node definition for valid relationships
 311       operationId: createOrUpdateCloudInfrastructureComplexesComplexRelationshipListRelationship
 312       consumes:
 313         - application/json
 314         - application/xml
 315       produces:
 316         - application/json
 317         - application/xml
 318       responses:
 319         "default":
 320           description: Response codes found in [response codes](https://wiki.onap.org/).
 321       parameters:
 322         - name: physical-location-id
 323           in: path
 324           description: Unique identifier for physical location, e.g., CLLI
 325           required: true
 326           type: string
 327           example: __PHYSICAL-LOCATION-ID__
 328         - name: body
 329           in: body
 330           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureComplexesComplex.json)
 331           required: true
 332           schema:
 333             $ref: "#/definitions/relationship"
 334     delete:
 335       tags:
 336         - CloudInfrastructure
 337       summary: delete an existing relationship
 338       description: delete an existing relationship
 339       operationId: deleteCloudInfrastructureComplexesComplexRelationshipListRelationship
 340       consumes:
 341         - application/json
 342         - application/xml
 343       produces:
 344         - application/json
 345         - application/xml
 346       responses:
 347         "default":
 348           description: Response codes found in [response codes](https://wiki.onap.org/).
 349       parameters:
 350         - name: physical-location-id
 351           in: path
 352           description: Unique identifier for physical location, e.g., CLLI
 353           required: true
 354           type: string
 355           example: __PHYSICAL-LOCATION-ID__
 356   /cloud-infrastructure/complexes/complex/{physical-location-id}:
 357     get:
 358       tags:
 359         - CloudInfrastructure
 360       summary: returns complex
 361       description: returns complex
 362       operationId: getCloudInfrastructureComplexesComplex
 363       produces:
 364         - application/json
 365         - application/xml
 366       responses:
 367         "200":
 368           description: successful operation
 369           schema:
 370               $ref: "#/getDefinitions/complex"
 371         "default":
 372           description: Response codes found in [response codes](https://wiki.onap.org/).
 373       parameters:
 374         - name: physical-location-id
 375           in: path
 376           description: Unique identifier for physical location, e.g., CLLI
 377           required: true
 378           type: string
 379           example: __PHYSICAL-LOCATION-ID__
 380     put:
 381       tags:
 382         - CloudInfrastructure
 383       summary: create or update an existing complex
 384       description: |
 385         Create or update an existing complex.
 386         #
 387         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 388       operationId: createOrUpdateCloudInfrastructureComplexesComplex
 389       consumes:
 390         - application/json
 391         - application/xml
 392       produces:
 393         - application/json
 394         - application/xml
 395       responses:
 396         "default":
 397           description: Response codes found in [response codes](https://wiki.onap.org/).
 398       parameters:
 399         - name: physical-location-id
 400           in: path
 401           description: Unique identifier for physical location, e.g., CLLI
 402           required: true
 403           type: string
 404           example: __PHYSICAL-LOCATION-ID__
 405         - name: body
 406           in: body
 407           description: complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureComplexesComplex.json)
 408           required: true
 409           schema:
 410             $ref: "#/definitions/complex"
 411     patch:
 412       tags:
 413         - CloudInfrastructure
 414       summary: update an existing complex
 415       description: |
 416         Update an existing complex
 417         #
 418         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 419         The PUT operation will entirely replace an existing object.
 420         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
 421         #
 422         Other differences between PUT and PATCH are:
 423         #
 424         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 425         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 426         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 427       operationId: UpdateCloudInfrastructureComplexesComplex
 428       consumes:
 429         - application/json
 430         - application/xml
 431       produces:
 432         - application/json
 433         - application/xml
 434       responses:
 435         "default":
 436           description: Response codes found in [response codes](https://wiki.onap.org/).
 437       parameters:
 438         - name: physical-location-id
 439           in: path
 440           description: Unique identifier for physical location, e.g., CLLI
 441           required: true
 442           type: string
 443           example: __PHYSICAL-LOCATION-ID__
 444         - name: body
 445           in: body
 446           description: complex object that needs to be updated.
 447           required: true
 448           schema:
 449             $ref: "#/patchDefinitions/complex"
 450     delete:
 451       tags:
 452         - CloudInfrastructure
 453       summary: delete an existing complex
 454       description: delete an existing complex
 455       operationId: deleteCloudInfrastructureComplexesComplex
 456       consumes:
 457         - application/json
 458         - application/xml
 459       produces:
 460         - application/json
 461         - application/xml
 462       responses:
 463         "default":
 464           description: Response codes found in [response codes](https://wiki.onap.org/).
 465       parameters:
 466         - name: physical-location-id
 467           in: path
 468           description: Unique identifier for physical location, e.g., CLLI
 469           required: true
 470           type: string
 471           example: __PHYSICAL-LOCATION-ID__
 472         - name: resource-version
 473           in: query
 474           description: resource-version for concurrency
 475           required: true
 476           type: string
 477   /cloud-infrastructure/complexes:
 478     get:
 479       tags:
 480         - CloudInfrastructure
 481       summary: returns complexes
 482       description: returns complexes
 483       operationId: getCloudInfrastructureComplexes
 484       produces:
 485         - application/json
 486         - application/xml
 487       responses:
 488         "200":
 489           description: successful operation
 490           schema:
 491               $ref: "#/getDefinitions/complexes"
 492         "default":
 493           description: Response codes found in [response codes](https://wiki.onap.org/).
 494       parameters:
 495         - name: physical-location-id
 496           in: query
 497           description:
 498           required: false
 499           type: string
 500         - name: data-center-code
 501           in: query
 502           description:
 503           required: false
 504           type: string
 505         - name: complex-name
 506           in: query
 507           description:
 508           required: false
 509           type: string
 510         - name: identity-url
 511           in: query
 512           description:
 513           required: false
 514           type: string
 515   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship:
 516     put:
 517       tags:
 518         - CloudInfrastructure
 519       summary: see node definition for valid relationships
 520       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
 521       consumes:
 522         - application/json
 523         - application/xml
 524       produces:
 525         - application/json
 526         - application/xml
 527       responses:
 528         "default":
 529           description: Response codes found in [response codes](https://wiki.onap.org/).
 530       parameters:
 531         - name: cloud-owner
 532           in: path
 533           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 534           required: true
 535           type: string
 536           example: __CLOUD-OWNER__
 537         - name: cloud-region-id
 538           in: path
 539           description: Identifier used by the vendor for the region. Second part of composite key
 540           required: true
 541           type: string
 542           example: __CLOUD-REGION-ID__
 543         - name: volume-group-id
 544           in: path
 545           description: Unique ID of volume-group.
 546           required: true
 547           type: string
 548           example: __VOLUME-GROUP-ID__
 549         - name: body
 550           in: body
 551           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
 552           required: true
 553           schema:
 554             $ref: "#/definitions/relationship"
 555     delete:
 556       tags:
 557         - CloudInfrastructure
 558       summary: delete an existing relationship
 559       description: delete an existing relationship
 560       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
 561       consumes:
 562         - application/json
 563         - application/xml
 564       produces:
 565         - application/json
 566         - application/xml
 567       responses:
 568         "default":
 569           description: Response codes found in [response codes](https://wiki.onap.org/).
 570       parameters:
 571         - name: cloud-owner
 572           in: path
 573           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 574           required: true
 575           type: string
 576           example: __CLOUD-OWNER__
 577         - name: cloud-region-id
 578           in: path
 579           description: Identifier used by the vendor for the region. Second part of composite key
 580           required: true
 581           type: string
 582           example: __CLOUD-REGION-ID__
 583         - name: volume-group-id
 584           in: path
 585           description: Unique ID of volume-group.
 586           required: true
 587           type: string
 588           example: __VOLUME-GROUP-ID__
 589   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}:
 590     get:
 591       tags:
 592         - CloudInfrastructure
 593       summary: returns volume-group
 594       description: returns volume-group
 595       operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 596       produces:
 597         - application/json
 598         - application/xml
 599       responses:
 600         "200":
 601           description: successful operation
 602           schema:
 603               $ref: "#/getDefinitions/volume-group"
 604         "default":
 605           description: Response codes found in [response codes](https://wiki.onap.org/).
 606       parameters:
 607         - name: cloud-owner
 608           in: path
 609           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 610           required: true
 611           type: string
 612           example: __CLOUD-OWNER__
 613         - name: cloud-region-id
 614           in: path
 615           description: Identifier used by the vendor for the region. Second part of composite key
 616           required: true
 617           type: string
 618           example: __CLOUD-REGION-ID__
 619         - name: volume-group-id
 620           in: path
 621           description: Unique ID of volume-group.
 622           required: true
 623           type: string
 624           example: __VOLUME-GROUP-ID__
 625     put:
 626       tags:
 627         - CloudInfrastructure
 628       summary: create or update an existing volume-group
 629       description: |
 630         Create or update an existing volume-group.
 631         #
 632         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 633       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 634       consumes:
 635         - application/json
 636         - application/xml
 637       produces:
 638         - application/json
 639         - application/xml
 640       responses:
 641         "default":
 642           description: Response codes found in [response codes](https://wiki.onap.org/).
 643       parameters:
 644         - name: cloud-owner
 645           in: path
 646           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 647           required: true
 648           type: string
 649           example: __CLOUD-OWNER__
 650         - name: cloud-region-id
 651           in: path
 652           description: Identifier used by the vendor for the region. Second part of composite key
 653           required: true
 654           type: string
 655           example: __CLOUD-REGION-ID__
 656         - name: volume-group-id
 657           in: path
 658           description: Unique ID of volume-group.
 659           required: true
 660           type: string
 661           example: __VOLUME-GROUP-ID__
 662         - name: body
 663           in: body
 664           description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
 665           required: true
 666           schema:
 667             $ref: "#/definitions/volume-group"
 668     patch:
 669       tags:
 670         - CloudInfrastructure
 671       summary: update an existing volume-group
 672       description: |
 673         Update an existing volume-group
 674         #
 675         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
 676         The PUT operation will entirely replace an existing object.
 677         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
 678         #
 679         Other differences between PUT and PATCH are:
 680         #
 681         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
 682         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
 683         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
 684       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 685       consumes:
 686         - application/json
 687         - application/xml
 688       produces:
 689         - application/json
 690         - application/xml
 691       responses:
 692         "default":
 693           description: Response codes found in [response codes](https://wiki.onap.org/).
 694       parameters:
 695         - name: cloud-owner
 696           in: path
 697           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 698           required: true
 699           type: string
 700           example: __CLOUD-OWNER__
 701         - name: cloud-region-id
 702           in: path
 703           description: Identifier used by the vendor for the region. Second part of composite key
 704           required: true
 705           type: string
 706           example: __CLOUD-REGION-ID__
 707         - name: volume-group-id
 708           in: path
 709           description: Unique ID of volume-group.
 710           required: true
 711           type: string
 712           example: __VOLUME-GROUP-ID__
 713         - name: body
 714           in: body
 715           description: volume-group object that needs to be updated.
 716           required: true
 717           schema:
 718             $ref: "#/patchDefinitions/volume-group"
 719     delete:
 720       tags:
 721         - CloudInfrastructure
 722       summary: delete an existing volume-group
 723       description: delete an existing volume-group
 724       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 725       consumes:
 726         - application/json
 727         - application/xml
 728       produces:
 729         - application/json
 730         - application/xml
 731       responses:
 732         "default":
 733           description: Response codes found in [response codes](https://wiki.onap.org/).
 734       parameters:
 735         - name: cloud-owner
 736           in: path
 737           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 738           required: true
 739           type: string
 740           example: __CLOUD-OWNER__
 741         - name: cloud-region-id
 742           in: path
 743           description: Identifier used by the vendor for the region. Second part of composite key
 744           required: true
 745           type: string
 746           example: __CLOUD-REGION-ID__
 747         - name: volume-group-id
 748           in: path
 749           description: Unique ID of volume-group.
 750           required: true
 751           type: string
 752           example: __VOLUME-GROUP-ID__
 753         - name: resource-version
 754           in: query
 755           description: resource-version for concurrency
 756           required: true
 757           type: string
 758   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups:
 759     get:
 760       tags:
 761         - CloudInfrastructure
 762       summary: returns volume-groups
 763       description: returns volume-groups
 764       operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroups
 765       produces:
 766         - application/json
 767         - application/xml
 768       responses:
 769         "200":
 770           description: successful operation
 771           schema:
 772               $ref: "#/getDefinitions/volume-groups"
 773         "default":
 774           description: Response codes found in [response codes](https://wiki.onap.org/).
 775       parameters:
 776         - name: cloud-owner
 777           in: path
 778           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 779           required: true
 780           type: string
 781           example: __CLOUD-OWNER__
 782         - name: cloud-region-id
 783           in: path
 784           description: Identifier used by the vendor for the region. Second part of composite key
 785           required: true
 786           type: string
 787           example: __CLOUD-REGION-ID__
 788         - name: volume-group-id
 789           in: query
 790           description:
 791           required: false
 792           type: string
 793         - name: volume-group-name
 794           in: query
 795           description:
 796           required: false
 797           type: string
 798         - name: heat-stack-id
 799           in: query
 800           description:
 801           required: false
 802           type: string
 803         - name: vnf-type
 804           in: query
 805           description:
 806           required: false
 807           type: string
 808   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship:
 809     put:
 810       tags:
 811         - CloudInfrastructure
 812       summary: see node definition for valid relationships
 813       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
 814       consumes:
 815         - application/json
 816         - application/xml
 817       produces:
 818         - application/json
 819         - application/xml
 820       responses:
 821         "default":
 822           description: Response codes found in [response codes](https://wiki.onap.org/).
 823       parameters:
 824         - name: cloud-owner
 825           in: path
 826           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 827           required: true
 828           type: string
 829           example: __CLOUD-OWNER__
 830         - name: cloud-region-id
 831           in: path
 832           description: Identifier used by the vendor for the region. Second part of composite key
 833           required: true
 834           type: string
 835           example: __CLOUD-REGION-ID__
 836         - name: tenant-id
 837           in: path
 838           description: Unique id relative to the cloud-region.
 839           required: true
 840           type: string
 841           example: __TENANT-ID__
 842         - name: vserver-id
 843           in: path
 844           description: Unique identifier for this vserver relative to its tenant
 845           required: true
 846           type: string
 847           example: __VSERVER-ID__
 848         - name: volume-id
 849           in: path
 850           description: Unique ID of block storage volume relative to the vserver.
 851           required: true
 852           type: string
 853           example: __VOLUME-ID__
 854         - name: body
 855           in: body
 856           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
 857           required: true
 858           schema:
 859             $ref: "#/definitions/relationship"
 860     delete:
 861       tags:
 862         - CloudInfrastructure
 863       summary: delete an existing relationship
 864       description: delete an existing relationship
 865       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolumeRelationshipListRelationship
 866       consumes:
 867         - application/json
 868         - application/xml
 869       produces:
 870         - application/json
 871         - application/xml
 872       responses:
 873         "default":
 874           description: Response codes found in [response codes](https://wiki.onap.org/).
 875       parameters:
 876         - name: cloud-owner
 877           in: path
 878           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 879           required: true
 880           type: string
 881           example: __CLOUD-OWNER__
 882         - name: cloud-region-id
 883           in: path
 884           description: Identifier used by the vendor for the region. Second part of composite key
 885           required: true
 886           type: string
 887           example: __CLOUD-REGION-ID__
 888         - name: tenant-id
 889           in: path
 890           description: Unique id relative to the cloud-region.
 891           required: true
 892           type: string
 893           example: __TENANT-ID__
 894         - name: vserver-id
 895           in: path
 896           description: Unique identifier for this vserver relative to its tenant
 897           required: true
 898           type: string
 899           example: __VSERVER-ID__
 900         - name: volume-id
 901           in: path
 902           description: Unique ID of block storage volume relative to the vserver.
 903           required: true
 904           type: string
 905           example: __VOLUME-ID__
 906   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}:
 907     get:
 908       tags:
 909         - CloudInfrastructure
 910       summary: returns volume
 911       description: returns volume
 912       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
 913       produces:
 914         - application/json
 915         - application/xml
 916       responses:
 917         "200":
 918           description: successful operation
 919           schema:
 920               $ref: "#/getDefinitions/volume"
 921         "default":
 922           description: Response codes found in [response codes](https://wiki.onap.org/).
 923       parameters:
 924         - name: cloud-owner
 925           in: path
 926           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 927           required: true
 928           type: string
 929           example: __CLOUD-OWNER__
 930         - name: cloud-region-id
 931           in: path
 932           description: Identifier used by the vendor for the region. Second part of composite key
 933           required: true
 934           type: string
 935           example: __CLOUD-REGION-ID__
 936         - name: tenant-id
 937           in: path
 938           description: Unique id relative to the cloud-region.
 939           required: true
 940           type: string
 941           example: __TENANT-ID__
 942         - name: vserver-id
 943           in: path
 944           description: Unique identifier for this vserver relative to its tenant
 945           required: true
 946           type: string
 947           example: __VSERVER-ID__
 948         - name: volume-id
 949           in: path
 950           description: Unique ID of block storage volume relative to the vserver.
 951           required: true
 952           type: string
 953           example: __VOLUME-ID__
 954     put:
 955       tags:
 956         - CloudInfrastructure
 957       summary: create or update an existing volume
 958       description: |
 959         Create or update an existing volume.
 960         #
 961         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 962       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
 963       consumes:
 964         - application/json
 965         - application/xml
 966       produces:
 967         - application/json
 968         - application/xml
 969       responses:
 970         "default":
 971           description: Response codes found in [response codes](https://wiki.onap.org/).
 972       parameters:
 973         - name: cloud-owner
 974           in: path
 975           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 976           required: true
 977           type: string
 978           example: __CLOUD-OWNER__
 979         - name: cloud-region-id
 980           in: path
 981           description: Identifier used by the vendor for the region. Second part of composite key
 982           required: true
 983           type: string
 984           example: __CLOUD-REGION-ID__
 985         - name: tenant-id
 986           in: path
 987           description: Unique id relative to the cloud-region.
 988           required: true
 989           type: string
 990           example: __TENANT-ID__
 991         - name: vserver-id
 992           in: path
 993           description: Unique identifier for this vserver relative to its tenant
 994           required: true
 995           type: string
 996           example: __VSERVER-ID__
 997         - name: volume-id
 998           in: path
 999           description: Unique ID of block storage volume relative to the vserver.
1000           required: true
1001           type: string
1002           example: __VOLUME-ID__
1003         - name: body
1004           in: body
1005           description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
1006           required: true
1007           schema:
1008             $ref: "#/definitions/volume"
1009     patch:
1010       tags:
1011         - CloudInfrastructure
1012       summary: update an existing volume
1013       description: |
1014         Update an existing volume
1015         #
1016         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1017         The PUT operation will entirely replace an existing object.
1018         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
1019         #
1020         Other differences between PUT and PATCH are:
1021         #
1022         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
1023         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1024         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1025       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1026       consumes:
1027         - application/json
1028         - application/xml
1029       produces:
1030         - application/json
1031         - application/xml
1032       responses:
1033         "default":
1034           description: Response codes found in [response codes](https://wiki.onap.org/).
1035       parameters:
1036         - name: cloud-owner
1037           in: path
1038           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1039           required: true
1040           type: string
1041           example: __CLOUD-OWNER__
1042         - name: cloud-region-id
1043           in: path
1044           description: Identifier used by the vendor for the region. Second part of composite key
1045           required: true
1046           type: string
1047           example: __CLOUD-REGION-ID__
1048         - name: tenant-id
1049           in: path
1050           description: Unique id relative to the cloud-region.
1051           required: true
1052           type: string
1053           example: __TENANT-ID__
1054         - name: vserver-id
1055           in: path
1056           description: Unique identifier for this vserver relative to its tenant
1057           required: true
1058           type: string
1059           example: __VSERVER-ID__
1060         - name: volume-id
1061           in: path
1062           description: Unique ID of block storage volume relative to the vserver.
1063           required: true
1064           type: string
1065           example: __VOLUME-ID__
1066         - name: body
1067           in: body
1068           description: volume object that needs to be updated.
1069           required: true
1070           schema:
1071             $ref: "#/patchDefinitions/volume"
1072     delete:
1073       tags:
1074         - CloudInfrastructure
1075       summary: delete an existing volume
1076       description: delete an existing volume
1077       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1078       consumes:
1079         - application/json
1080         - application/xml
1081       produces:
1082         - application/json
1083         - application/xml
1084       responses:
1085         "default":
1086           description: Response codes found in [response codes](https://wiki.onap.org/).
1087       parameters:
1088         - name: cloud-owner
1089           in: path
1090           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1091           required: true
1092           type: string
1093           example: __CLOUD-OWNER__
1094         - name: cloud-region-id
1095           in: path
1096           description: Identifier used by the vendor for the region. Second part of composite key
1097           required: true
1098           type: string
1099           example: __CLOUD-REGION-ID__
1100         - name: tenant-id
1101           in: path
1102           description: Unique id relative to the cloud-region.
1103           required: true
1104           type: string
1105           example: __TENANT-ID__
1106         - name: vserver-id
1107           in: path
1108           description: Unique identifier for this vserver relative to its tenant
1109           required: true
1110           type: string
1111           example: __VSERVER-ID__
1112         - name: volume-id
1113           in: path
1114           description: Unique ID of block storage volume relative to the vserver.
1115           required: true
1116           type: string
1117           example: __VOLUME-ID__
1118         - name: resource-version
1119           in: query
1120           description: resource-version for concurrency
1121           required: true
1122           type: string
1123   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes:
1124     get:
1125       tags:
1126         - CloudInfrastructure
1127       summary: returns volumes
1128       description: returns volumes
1129       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes
1130       produces:
1131         - application/json
1132         - application/xml
1133       responses:
1134         "200":
1135           description: successful operation
1136           schema:
1137               $ref: "#/getDefinitions/volumes"
1138         "default":
1139           description: Response codes found in [response codes](https://wiki.onap.org/).
1140       parameters:
1141         - name: cloud-owner
1142           in: path
1143           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1144           required: true
1145           type: string
1146           example: __CLOUD-OWNER__
1147         - name: cloud-region-id
1148           in: path
1149           description: Identifier used by the vendor for the region. Second part of composite key
1150           required: true
1151           type: string
1152           example: __CLOUD-REGION-ID__
1153         - name: tenant-id
1154           in: path
1155           description: Unique id relative to the cloud-region.
1156           required: true
1157           type: string
1158           example: __TENANT-ID__
1159         - name: vserver-id
1160           in: path
1161           description: Unique identifier for this vserver relative to its tenant
1162           required: true
1163           type: string
1164           example: __VSERVER-ID__
1165         - name: volume-id
1166           in: query
1167           description:
1168           required: false
1169           type: string
1170   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
1171     put:
1172       tags:
1173         - CloudInfrastructure
1174       summary: see node definition for valid relationships
1175       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1176       consumes:
1177         - application/json
1178         - application/xml
1179       produces:
1180         - application/json
1181         - application/xml
1182       responses:
1183         "default":
1184           description: Response codes found in [response codes](https://wiki.onap.org/).
1185       parameters:
1186         - name: cloud-owner
1187           in: path
1188           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1189           required: true
1190           type: string
1191           example: __CLOUD-OWNER__
1192         - name: cloud-region-id
1193           in: path
1194           description: Identifier used by the vendor for the region. Second part of composite key
1195           required: true
1196           type: string
1197           example: __CLOUD-REGION-ID__
1198         - name: tenant-id
1199           in: path
1200           description: Unique id relative to the cloud-region.
1201           required: true
1202           type: string
1203           example: __TENANT-ID__
1204         - name: vserver-id
1205           in: path
1206           description: Unique identifier for this vserver relative to its tenant
1207           required: true
1208           type: string
1209           example: __VSERVER-ID__
1210         - name: body
1211           in: body
1212           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
1213           required: true
1214           schema:
1215             $ref: "#/definitions/relationship"
1216     delete:
1217       tags:
1218         - CloudInfrastructure
1219       summary: delete an existing relationship
1220       description: delete an existing relationship
1221       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1222       consumes:
1223         - application/json
1224         - application/xml
1225       produces:
1226         - application/json
1227         - application/xml
1228       responses:
1229         "default":
1230           description: Response codes found in [response codes](https://wiki.onap.org/).
1231       parameters:
1232         - name: cloud-owner
1233           in: path
1234           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1235           required: true
1236           type: string
1237           example: __CLOUD-OWNER__
1238         - name: cloud-region-id
1239           in: path
1240           description: Identifier used by the vendor for the region. Second part of composite key
1241           required: true
1242           type: string
1243           example: __CLOUD-REGION-ID__
1244         - name: tenant-id
1245           in: path
1246           description: Unique id relative to the cloud-region.
1247           required: true
1248           type: string
1249           example: __TENANT-ID__
1250         - name: vserver-id
1251           in: path
1252           description: Unique identifier for this vserver relative to its tenant
1253           required: true
1254           type: string
1255           example: __VSERVER-ID__
1256   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
1257     put:
1258       tags:
1259         - CloudInfrastructure
1260       summary: see node definition for valid relationships
1261       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1262       consumes:
1263         - application/json
1264         - application/xml
1265       produces:
1266         - application/json
1267         - application/xml
1268       responses:
1269         "default":
1270           description: Response codes found in [response codes](https://wiki.onap.org/).
1271       parameters:
1272         - name: cloud-owner
1273           in: path
1274           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1275           required: true
1276           type: string
1277           example: __CLOUD-OWNER__
1278         - name: cloud-region-id
1279           in: path
1280           description: Identifier used by the vendor for the region. Second part of composite key
1281           required: true
1282           type: string
1283           example: __CLOUD-REGION-ID__
1284         - name: tenant-id
1285           in: path
1286           description: Unique id relative to the cloud-region.
1287           required: true
1288           type: string
1289           example: __TENANT-ID__
1290         - name: vserver-id
1291           in: path
1292           description: Unique identifier for this vserver relative to its tenant
1293           required: true
1294           type: string
1295           example: __VSERVER-ID__
1296         - name: interface-name
1297           in: path
1298           description: Name given to the interface
1299           required: true
1300           type: string
1301           example: __INTERFACE-NAME__
1302         - name: vlan-interface
1303           in: path
1304           description: String that identifies the interface
1305           required: true
1306           type: string
1307           example: __VLAN-INTERFACE__
1308         - name: body
1309           in: body
1310           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
1311           required: true
1312           schema:
1313             $ref: "#/definitions/relationship"
1314     delete:
1315       tags:
1316         - CloudInfrastructure
1317       summary: delete an existing relationship
1318       description: delete an existing relationship
1319       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1320       consumes:
1321         - application/json
1322         - application/xml
1323       produces:
1324         - application/json
1325         - application/xml
1326       responses:
1327         "default":
1328           description: Response codes found in [response codes](https://wiki.onap.org/).
1329       parameters:
1330         - name: cloud-owner
1331           in: path
1332           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1333           required: true
1334           type: string
1335           example: __CLOUD-OWNER__
1336         - name: cloud-region-id
1337           in: path
1338           description: Identifier used by the vendor for the region. Second part of composite key
1339           required: true
1340           type: string
1341           example: __CLOUD-REGION-ID__
1342         - name: tenant-id
1343           in: path
1344           description: Unique id relative to the cloud-region.
1345           required: true
1346           type: string
1347           example: __TENANT-ID__
1348         - name: vserver-id
1349           in: path
1350           description: Unique identifier for this vserver relative to its tenant
1351           required: true
1352           type: string
1353           example: __VSERVER-ID__
1354         - name: interface-name
1355           in: path
1356           description: Name given to the interface
1357           required: true
1358           type: string
1359           example: __INTERFACE-NAME__
1360         - name: vlan-interface
1361           in: path
1362           description: String that identifies the interface
1363           required: true
1364           type: string
1365           example: __VLAN-INTERFACE__
1366   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
1367     put:
1368       tags:
1369         - CloudInfrastructure
1370       summary: see node definition for valid relationships
1371       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1372       consumes:
1373         - application/json
1374         - application/xml
1375       produces:
1376         - application/json
1377         - application/xml
1378       responses:
1379         "default":
1380           description: Response codes found in [response codes](https://wiki.onap.org/).
1381       parameters:
1382         - name: cloud-owner
1383           in: path
1384           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1385           required: true
1386           type: string
1387           example: __CLOUD-OWNER__
1388         - name: cloud-region-id
1389           in: path
1390           description: Identifier used by the vendor for the region. Second part of composite key
1391           required: true
1392           type: string
1393           example: __CLOUD-REGION-ID__
1394         - name: tenant-id
1395           in: path
1396           description: Unique id relative to the cloud-region.
1397           required: true
1398           type: string
1399           example: __TENANT-ID__
1400         - name: vserver-id
1401           in: path
1402           description: Unique identifier for this vserver relative to its tenant
1403           required: true
1404           type: string
1405           example: __VSERVER-ID__
1406         - name: interface-name
1407           in: path
1408           description: Name given to the interface
1409           required: true
1410           type: string
1411           example: __INTERFACE-NAME__
1412         - name: vlan-interface
1413           in: path
1414           description: String that identifies the interface
1415           required: true
1416           type: string
1417           example: __VLAN-INTERFACE__
1418         - name: l3-interface-ipv4-address
1419           in: path
1420           description: IP address
1421           required: true
1422           type: string
1423           example: __L3-INTERFACE-IPV4-ADDRESS__
1424         - name: body
1425           in: body
1426           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1427           required: true
1428           schema:
1429             $ref: "#/definitions/relationship"
1430     delete:
1431       tags:
1432         - CloudInfrastructure
1433       summary: delete an existing relationship
1434       description: delete an existing relationship
1435       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1436       consumes:
1437         - application/json
1438         - application/xml
1439       produces:
1440         - application/json
1441         - application/xml
1442       responses:
1443         "default":
1444           description: Response codes found in [response codes](https://wiki.onap.org/).
1445       parameters:
1446         - name: cloud-owner
1447           in: path
1448           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1449           required: true
1450           type: string
1451           example: __CLOUD-OWNER__
1452         - name: cloud-region-id
1453           in: path
1454           description: Identifier used by the vendor for the region. Second part of composite key
1455           required: true
1456           type: string
1457           example: __CLOUD-REGION-ID__
1458         - name: tenant-id
1459           in: path
1460           description: Unique id relative to the cloud-region.
1461           required: true
1462           type: string
1463           example: __TENANT-ID__
1464         - name: vserver-id
1465           in: path
1466           description: Unique identifier for this vserver relative to its tenant
1467           required: true
1468           type: string
1469           example: __VSERVER-ID__
1470         - name: interface-name
1471           in: path
1472           description: Name given to the interface
1473           required: true
1474           type: string
1475           example: __INTERFACE-NAME__
1476         - name: vlan-interface
1477           in: path
1478           description: String that identifies the interface
1479           required: true
1480           type: string
1481           example: __VLAN-INTERFACE__
1482         - name: l3-interface-ipv4-address
1483           in: path
1484           description: IP address
1485           required: true
1486           type: string
1487           example: __L3-INTERFACE-IPV4-ADDRESS__
1488   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
1489     get:
1490       tags:
1491         - CloudInfrastructure
1492       summary: returns l3-interface-ipv4-address-list
1493       description: returns l3-interface-ipv4-address-list
1494       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1495       produces:
1496         - application/json
1497         - application/xml
1498       responses:
1499         "200":
1500           description: successful operation
1501           schema:
1502               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
1503         "default":
1504           description: Response codes found in [response codes](https://wiki.onap.org/).
1505       parameters:
1506         - name: cloud-owner
1507           in: path
1508           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1509           required: true
1510           type: string
1511           example: __CLOUD-OWNER__
1512         - name: cloud-region-id
1513           in: path
1514           description: Identifier used by the vendor for the region. Second part of composite key
1515           required: true
1516           type: string
1517           example: __CLOUD-REGION-ID__
1518         - name: tenant-id
1519           in: path
1520           description: Unique id relative to the cloud-region.
1521           required: true
1522           type: string
1523           example: __TENANT-ID__
1524         - name: vserver-id
1525           in: path
1526           description: Unique identifier for this vserver relative to its tenant
1527           required: true
1528           type: string
1529           example: __VSERVER-ID__
1530         - name: interface-name
1531           in: path
1532           description: Name given to the interface
1533           required: true
1534           type: string
1535           example: __INTERFACE-NAME__
1536         - name: vlan-interface
1537           in: path
1538           description: String that identifies the interface
1539           required: true
1540           type: string
1541           example: __VLAN-INTERFACE__
1542         - name: l3-interface-ipv4-address
1543           in: path
1544           description: IP address
1545           required: true
1546           type: string
1547           example: __L3-INTERFACE-IPV4-ADDRESS__
1548     put:
1549       tags:
1550         - CloudInfrastructure
1551       summary: create or update an existing l3-interface-ipv4-address-list
1552       description: |
1553         Create or update an existing l3-interface-ipv4-address-list.
1554         #
1555         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
1556       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1557       consumes:
1558         - application/json
1559         - application/xml
1560       produces:
1561         - application/json
1562         - application/xml
1563       responses:
1564         "default":
1565           description: Response codes found in [response codes](https://wiki.onap.org/).
1566       parameters:
1567         - name: cloud-owner
1568           in: path
1569           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1570           required: true
1571           type: string
1572           example: __CLOUD-OWNER__
1573         - name: cloud-region-id
1574           in: path
1575           description: Identifier used by the vendor for the region. Second part of composite key
1576           required: true
1577           type: string
1578           example: __CLOUD-REGION-ID__
1579         - name: tenant-id
1580           in: path
1581           description: Unique id relative to the cloud-region.
1582           required: true
1583           type: string
1584           example: __TENANT-ID__
1585         - name: vserver-id
1586           in: path
1587           description: Unique identifier for this vserver relative to its tenant
1588           required: true
1589           type: string
1590           example: __VSERVER-ID__
1591         - name: interface-name
1592           in: path
1593           description: Name given to the interface
1594           required: true
1595           type: string
1596           example: __INTERFACE-NAME__
1597         - name: vlan-interface
1598           in: path
1599           description: String that identifies the interface
1600           required: true
1601           type: string
1602           example: __VLAN-INTERFACE__
1603         - name: l3-interface-ipv4-address
1604           in: path
1605           description: IP address
1606           required: true
1607           type: string
1608           example: __L3-INTERFACE-IPV4-ADDRESS__
1609         - name: body
1610           in: body
1611           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1612           required: true
1613           schema:
1614             $ref: "#/definitions/l3-interface-ipv4-address-list"
1615     patch:
1616       tags:
1617         - CloudInfrastructure
1618       summary: update an existing l3-interface-ipv4-address-list
1619       description: |
1620         Update an existing l3-interface-ipv4-address-list
1621         #
1622         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1623         The PUT operation will entirely replace an existing object.
1624         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
1625         #
1626         Other differences between PUT and PATCH are:
1627         #
1628         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
1629         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1630         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1631       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1632       consumes:
1633         - application/json
1634         - application/xml
1635       produces:
1636         - application/json
1637         - application/xml
1638       responses:
1639         "default":
1640           description: Response codes found in [response codes](https://wiki.onap.org/).
1641       parameters:
1642         - name: cloud-owner
1643           in: path
1644           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1645           required: true
1646           type: string
1647           example: __CLOUD-OWNER__
1648         - name: cloud-region-id
1649           in: path
1650           description: Identifier used by the vendor for the region. Second part of composite key
1651           required: true
1652           type: string
1653           example: __CLOUD-REGION-ID__
1654         - name: tenant-id
1655           in: path
1656           description: Unique id relative to the cloud-region.
1657           required: true
1658           type: string
1659           example: __TENANT-ID__
1660         - name: vserver-id
1661           in: path
1662           description: Unique identifier for this vserver relative to its tenant
1663           required: true
1664           type: string
1665           example: __VSERVER-ID__
1666         - name: interface-name
1667           in: path
1668           description: Name given to the interface
1669           required: true
1670           type: string
1671           example: __INTERFACE-NAME__
1672         - name: vlan-interface
1673           in: path
1674           description: String that identifies the interface
1675           required: true
1676           type: string
1677           example: __VLAN-INTERFACE__
1678         - name: l3-interface-ipv4-address
1679           in: path
1680           description: IP address
1681           required: true
1682           type: string
1683           example: __L3-INTERFACE-IPV4-ADDRESS__
1684         - name: body
1685           in: body
1686           description: l3-interface-ipv4-address-list object that needs to be updated.
1687           required: true
1688           schema:
1689             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
1690     delete:
1691       tags:
1692         - CloudInfrastructure
1693       summary: delete an existing l3-interface-ipv4-address-list
1694       description: delete an existing l3-interface-ipv4-address-list
1695       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1696       consumes:
1697         - application/json
1698         - application/xml
1699       produces:
1700         - application/json
1701         - application/xml
1702       responses:
1703         "default":
1704           description: Response codes found in [response codes](https://wiki.onap.org/).
1705       parameters:
1706         - name: cloud-owner
1707           in: path
1708           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1709           required: true
1710           type: string
1711           example: __CLOUD-OWNER__
1712         - name: cloud-region-id
1713           in: path
1714           description: Identifier used by the vendor for the region. Second part of composite key
1715           required: true
1716           type: string
1717           example: __CLOUD-REGION-ID__
1718         - name: tenant-id
1719           in: path
1720           description: Unique id relative to the cloud-region.
1721           required: true
1722           type: string
1723           example: __TENANT-ID__
1724         - name: vserver-id
1725           in: path
1726           description: Unique identifier for this vserver relative to its tenant
1727           required: true
1728           type: string
1729           example: __VSERVER-ID__
1730         - name: interface-name
1731           in: path
1732           description: Name given to the interface
1733           required: true
1734           type: string
1735           example: __INTERFACE-NAME__
1736         - name: vlan-interface
1737           in: path
1738           description: String that identifies the interface
1739           required: true
1740           type: string
1741           example: __VLAN-INTERFACE__
1742         - name: l3-interface-ipv4-address
1743           in: path
1744           description: IP address
1745           required: true
1746           type: string
1747           example: __L3-INTERFACE-IPV4-ADDRESS__
1748         - name: resource-version
1749           in: query
1750           description: resource-version for concurrency
1751           required: true
1752           type: string
1753   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
1754     put:
1755       tags:
1756         - CloudInfrastructure
1757       summary: see node definition for valid relationships
1758       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1759       consumes:
1760         - application/json
1761         - application/xml
1762       produces:
1763         - application/json
1764         - application/xml
1765       responses:
1766         "default":
1767           description: Response codes found in [response codes](https://wiki.onap.org/).
1768       parameters:
1769         - name: cloud-owner
1770           in: path
1771           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1772           required: true
1773           type: string
1774           example: __CLOUD-OWNER__
1775         - name: cloud-region-id
1776           in: path
1777           description: Identifier used by the vendor for the region. Second part of composite key
1778           required: true
1779           type: string
1780           example: __CLOUD-REGION-ID__
1781         - name: tenant-id
1782           in: path
1783           description: Unique id relative to the cloud-region.
1784           required: true
1785           type: string
1786           example: __TENANT-ID__
1787         - name: vserver-id
1788           in: path
1789           description: Unique identifier for this vserver relative to its tenant
1790           required: true
1791           type: string
1792           example: __VSERVER-ID__
1793         - name: interface-name
1794           in: path
1795           description: Name given to the interface
1796           required: true
1797           type: string
1798           example: __INTERFACE-NAME__
1799         - name: vlan-interface
1800           in: path
1801           description: String that identifies the interface
1802           required: true
1803           type: string
1804           example: __VLAN-INTERFACE__
1805         - name: l3-interface-ipv6-address
1806           in: path
1807           description: IP address
1808           required: true
1809           type: string
1810           example: __L3-INTERFACE-IPV6-ADDRESS__
1811         - name: body
1812           in: body
1813           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
1814           required: true
1815           schema:
1816             $ref: "#/definitions/relationship"
1817     delete:
1818       tags:
1819         - CloudInfrastructure
1820       summary: delete an existing relationship
1821       description: delete an existing relationship
1822       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1823       consumes:
1824         - application/json
1825         - application/xml
1826       produces:
1827         - application/json
1828         - application/xml
1829       responses:
1830         "default":
1831           description: Response codes found in [response codes](https://wiki.onap.org/).
1832       parameters:
1833         - name: cloud-owner
1834           in: path
1835           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1836           required: true
1837           type: string
1838           example: __CLOUD-OWNER__
1839         - name: cloud-region-id
1840           in: path
1841           description: Identifier used by the vendor for the region. Second part of composite key
1842           required: true
1843           type: string
1844           example: __CLOUD-REGION-ID__
1845         - name: tenant-id
1846           in: path
1847           description: Unique id relative to the cloud-region.
1848           required: true
1849           type: string
1850           example: __TENANT-ID__
1851         - name: vserver-id
1852           in: path
1853           description: Unique identifier for this vserver relative to its tenant
1854           required: true
1855           type: string
1856           example: __VSERVER-ID__
1857         - name: interface-name
1858           in: path
1859           description: Name given to the interface
1860           required: true
1861           type: string
1862           example: __INTERFACE-NAME__
1863         - name: vlan-interface
1864           in: path
1865           description: String that identifies the interface
1866           required: true
1867           type: string
1868           example: __VLAN-INTERFACE__
1869         - name: l3-interface-ipv6-address
1870           in: path
1871           description: IP address
1872           required: true
1873           type: string
1874           example: __L3-INTERFACE-IPV6-ADDRESS__
1875   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
1876     get:
1877       tags:
1878         - CloudInfrastructure
1879       summary: returns l3-interface-ipv6-address-list
1880       description: returns l3-interface-ipv6-address-list
1881       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
1882       produces:
1883         - application/json
1884         - application/xml
1885       responses:
1886         "200":
1887           description: successful operation
1888           schema:
1889               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
1890         "default":
1891           description: Response codes found in [response codes](https://wiki.onap.org/).
1892       parameters:
1893         - name: cloud-owner
1894           in: path
1895           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1896           required: true
1897           type: string
1898           example: __CLOUD-OWNER__
1899         - name: cloud-region-id
1900           in: path
1901           description: Identifier used by the vendor for the region. Second part of composite key
1902           required: true
1903           type: string
1904           example: __CLOUD-REGION-ID__
1905         - name: tenant-id
1906           in: path
1907           description: Unique id relative to the cloud-region.
1908           required: true
1909           type: string
1910           example: __TENANT-ID__
1911         - name: vserver-id
1912           in: path
1913           description: Unique identifier for this vserver relative to its tenant
1914           required: true
1915           type: string
1916           example: __VSERVER-ID__
1917         - name: interface-name
1918           in: path
1919           description: Name given to the interface
1920           required: true
1921           type: string
1922           example: __INTERFACE-NAME__
1923         - name: vlan-interface
1924           in: path
1925           description: String that identifies the interface
1926           required: true
1927           type: string
1928           example: __VLAN-INTERFACE__
1929         - name: l3-interface-ipv6-address
1930           in: path
1931           description: IP address
1932           required: true
1933           type: string
1934           example: __L3-INTERFACE-IPV6-ADDRESS__
1935     put:
1936       tags:
1937         - CloudInfrastructure
1938       summary: create or update an existing l3-interface-ipv6-address-list
1939       description: |
1940         Create or update an existing l3-interface-ipv6-address-list.
1941         #
1942         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
1943       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
1944       consumes:
1945         - application/json
1946         - application/xml
1947       produces:
1948         - application/json
1949         - application/xml
1950       responses:
1951         "default":
1952           description: Response codes found in [response codes](https://wiki.onap.org/).
1953       parameters:
1954         - name: cloud-owner
1955           in: path
1956           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1957           required: true
1958           type: string
1959           example: __CLOUD-OWNER__
1960         - name: cloud-region-id
1961           in: path
1962           description: Identifier used by the vendor for the region. Second part of composite key
1963           required: true
1964           type: string
1965           example: __CLOUD-REGION-ID__
1966         - name: tenant-id
1967           in: path
1968           description: Unique id relative to the cloud-region.
1969           required: true
1970           type: string
1971           example: __TENANT-ID__
1972         - name: vserver-id
1973           in: path
1974           description: Unique identifier for this vserver relative to its tenant
1975           required: true
1976           type: string
1977           example: __VSERVER-ID__
1978         - name: interface-name
1979           in: path
1980           description: Name given to the interface
1981           required: true
1982           type: string
1983           example: __INTERFACE-NAME__
1984         - name: vlan-interface
1985           in: path
1986           description: String that identifies the interface
1987           required: true
1988           type: string
1989           example: __VLAN-INTERFACE__
1990         - name: l3-interface-ipv6-address
1991           in: path
1992           description: IP address
1993           required: true
1994           type: string
1995           example: __L3-INTERFACE-IPV6-ADDRESS__
1996         - name: body
1997           in: body
1998           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
1999           required: true
2000           schema:
2001             $ref: "#/definitions/l3-interface-ipv6-address-list"
2002     patch:
2003       tags:
2004         - CloudInfrastructure
2005       summary: update an existing l3-interface-ipv6-address-list
2006       description: |
2007         Update an existing l3-interface-ipv6-address-list
2008         #
2009         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2010         The PUT operation will entirely replace an existing object.
2011         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2012         #
2013         Other differences between PUT and PATCH are:
2014         #
2015         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2016         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2017         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2018       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2019       consumes:
2020         - application/json
2021         - application/xml
2022       produces:
2023         - application/json
2024         - application/xml
2025       responses:
2026         "default":
2027           description: Response codes found in [response codes](https://wiki.onap.org/).
2028       parameters:
2029         - name: cloud-owner
2030           in: path
2031           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2032           required: true
2033           type: string
2034           example: __CLOUD-OWNER__
2035         - name: cloud-region-id
2036           in: path
2037           description: Identifier used by the vendor for the region. Second part of composite key
2038           required: true
2039           type: string
2040           example: __CLOUD-REGION-ID__
2041         - name: tenant-id
2042           in: path
2043           description: Unique id relative to the cloud-region.
2044           required: true
2045           type: string
2046           example: __TENANT-ID__
2047         - name: vserver-id
2048           in: path
2049           description: Unique identifier for this vserver relative to its tenant
2050           required: true
2051           type: string
2052           example: __VSERVER-ID__
2053         - name: interface-name
2054           in: path
2055           description: Name given to the interface
2056           required: true
2057           type: string
2058           example: __INTERFACE-NAME__
2059         - name: vlan-interface
2060           in: path
2061           description: String that identifies the interface
2062           required: true
2063           type: string
2064           example: __VLAN-INTERFACE__
2065         - name: l3-interface-ipv6-address
2066           in: path
2067           description: IP address
2068           required: true
2069           type: string
2070           example: __L3-INTERFACE-IPV6-ADDRESS__
2071         - name: body
2072           in: body
2073           description: l3-interface-ipv6-address-list object that needs to be updated.
2074           required: true
2075           schema:
2076             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
2077     delete:
2078       tags:
2079         - CloudInfrastructure
2080       summary: delete an existing l3-interface-ipv6-address-list
2081       description: delete an existing l3-interface-ipv6-address-list
2082       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2083       consumes:
2084         - application/json
2085         - application/xml
2086       produces:
2087         - application/json
2088         - application/xml
2089       responses:
2090         "default":
2091           description: Response codes found in [response codes](https://wiki.onap.org/).
2092       parameters:
2093         - name: cloud-owner
2094           in: path
2095           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2096           required: true
2097           type: string
2098           example: __CLOUD-OWNER__
2099         - name: cloud-region-id
2100           in: path
2101           description: Identifier used by the vendor for the region. Second part of composite key
2102           required: true
2103           type: string
2104           example: __CLOUD-REGION-ID__
2105         - name: tenant-id
2106           in: path
2107           description: Unique id relative to the cloud-region.
2108           required: true
2109           type: string
2110           example: __TENANT-ID__
2111         - name: vserver-id
2112           in: path
2113           description: Unique identifier for this vserver relative to its tenant
2114           required: true
2115           type: string
2116           example: __VSERVER-ID__
2117         - name: interface-name
2118           in: path
2119           description: Name given to the interface
2120           required: true
2121           type: string
2122           example: __INTERFACE-NAME__
2123         - name: vlan-interface
2124           in: path
2125           description: String that identifies the interface
2126           required: true
2127           type: string
2128           example: __VLAN-INTERFACE__
2129         - name: l3-interface-ipv6-address
2130           in: path
2131           description: IP address
2132           required: true
2133           type: string
2134           example: __L3-INTERFACE-IPV6-ADDRESS__
2135         - name: resource-version
2136           in: query
2137           description: resource-version for concurrency
2138           required: true
2139           type: string
2140   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
2141     get:
2142       tags:
2143         - CloudInfrastructure
2144       summary: returns vlan
2145       description: returns vlan
2146       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2147       produces:
2148         - application/json
2149         - application/xml
2150       responses:
2151         "200":
2152           description: successful operation
2153           schema:
2154               $ref: "#/getDefinitions/vlan"
2155         "default":
2156           description: Response codes found in [response codes](https://wiki.onap.org/).
2157       parameters:
2158         - name: cloud-owner
2159           in: path
2160           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2161           required: true
2162           type: string
2163           example: __CLOUD-OWNER__
2164         - name: cloud-region-id
2165           in: path
2166           description: Identifier used by the vendor for the region. Second part of composite key
2167           required: true
2168           type: string
2169           example: __CLOUD-REGION-ID__
2170         - name: tenant-id
2171           in: path
2172           description: Unique id relative to the cloud-region.
2173           required: true
2174           type: string
2175           example: __TENANT-ID__
2176         - name: vserver-id
2177           in: path
2178           description: Unique identifier for this vserver relative to its tenant
2179           required: true
2180           type: string
2181           example: __VSERVER-ID__
2182         - name: interface-name
2183           in: path
2184           description: Name given to the interface
2185           required: true
2186           type: string
2187           example: __INTERFACE-NAME__
2188         - name: vlan-interface
2189           in: path
2190           description: String that identifies the interface
2191           required: true
2192           type: string
2193           example: __VLAN-INTERFACE__
2194     put:
2195       tags:
2196         - CloudInfrastructure
2197       summary: create or update an existing vlan
2198       description: |
2199         Create or update an existing vlan.
2200         #
2201         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
2202       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2203       consumes:
2204         - application/json
2205         - application/xml
2206       produces:
2207         - application/json
2208         - application/xml
2209       responses:
2210         "default":
2211           description: Response codes found in [response codes](https://wiki.onap.org/).
2212       parameters:
2213         - name: cloud-owner
2214           in: path
2215           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2216           required: true
2217           type: string
2218           example: __CLOUD-OWNER__
2219         - name: cloud-region-id
2220           in: path
2221           description: Identifier used by the vendor for the region. Second part of composite key
2222           required: true
2223           type: string
2224           example: __CLOUD-REGION-ID__
2225         - name: tenant-id
2226           in: path
2227           description: Unique id relative to the cloud-region.
2228           required: true
2229           type: string
2230           example: __TENANT-ID__
2231         - name: vserver-id
2232           in: path
2233           description: Unique identifier for this vserver relative to its tenant
2234           required: true
2235           type: string
2236           example: __VSERVER-ID__
2237         - name: interface-name
2238           in: path
2239           description: Name given to the interface
2240           required: true
2241           type: string
2242           example: __INTERFACE-NAME__
2243         - name: vlan-interface
2244           in: path
2245           description: String that identifies the interface
2246           required: true
2247           type: string
2248           example: __VLAN-INTERFACE__
2249         - name: body
2250           in: body
2251           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
2252           required: true
2253           schema:
2254             $ref: "#/definitions/vlan"
2255     patch:
2256       tags:
2257         - CloudInfrastructure
2258       summary: update an existing vlan
2259       description: |
2260         Update an existing vlan
2261         #
2262         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2263         The PUT operation will entirely replace an existing object.
2264         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2265         #
2266         Other differences between PUT and PATCH are:
2267         #
2268         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2269         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2270         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2271       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2272       consumes:
2273         - application/json
2274         - application/xml
2275       produces:
2276         - application/json
2277         - application/xml
2278       responses:
2279         "default":
2280           description: Response codes found in [response codes](https://wiki.onap.org/).
2281       parameters:
2282         - name: cloud-owner
2283           in: path
2284           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2285           required: true
2286           type: string
2287           example: __CLOUD-OWNER__
2288         - name: cloud-region-id
2289           in: path
2290           description: Identifier used by the vendor for the region. Second part of composite key
2291           required: true
2292           type: string
2293           example: __CLOUD-REGION-ID__
2294         - name: tenant-id
2295           in: path
2296           description: Unique id relative to the cloud-region.
2297           required: true
2298           type: string
2299           example: __TENANT-ID__
2300         - name: vserver-id
2301           in: path
2302           description: Unique identifier for this vserver relative to its tenant
2303           required: true
2304           type: string
2305           example: __VSERVER-ID__
2306         - name: interface-name
2307           in: path
2308           description: Name given to the interface
2309           required: true
2310           type: string
2311           example: __INTERFACE-NAME__
2312         - name: vlan-interface
2313           in: path
2314           description: String that identifies the interface
2315           required: true
2316           type: string
2317           example: __VLAN-INTERFACE__
2318         - name: body
2319           in: body
2320           description: vlan object that needs to be updated.
2321           required: true
2322           schema:
2323             $ref: "#/patchDefinitions/vlan"
2324     delete:
2325       tags:
2326         - CloudInfrastructure
2327       summary: delete an existing vlan
2328       description: delete an existing vlan
2329       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2330       consumes:
2331         - application/json
2332         - application/xml
2333       produces:
2334         - application/json
2335         - application/xml
2336       responses:
2337         "default":
2338           description: Response codes found in [response codes](https://wiki.onap.org/).
2339       parameters:
2340         - name: cloud-owner
2341           in: path
2342           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2343           required: true
2344           type: string
2345           example: __CLOUD-OWNER__
2346         - name: cloud-region-id
2347           in: path
2348           description: Identifier used by the vendor for the region. Second part of composite key
2349           required: true
2350           type: string
2351           example: __CLOUD-REGION-ID__
2352         - name: tenant-id
2353           in: path
2354           description: Unique id relative to the cloud-region.
2355           required: true
2356           type: string
2357           example: __TENANT-ID__
2358         - name: vserver-id
2359           in: path
2360           description: Unique identifier for this vserver relative to its tenant
2361           required: true
2362           type: string
2363           example: __VSERVER-ID__
2364         - name: interface-name
2365           in: path
2366           description: Name given to the interface
2367           required: true
2368           type: string
2369           example: __INTERFACE-NAME__
2370         - name: vlan-interface
2371           in: path
2372           description: String that identifies the interface
2373           required: true
2374           type: string
2375           example: __VLAN-INTERFACE__
2376         - name: resource-version
2377           in: query
2378           description: resource-version for concurrency
2379           required: true
2380           type: string
2381   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans:
2382     get:
2383       tags:
2384         - CloudInfrastructure
2385       summary: returns vlans
2386       description: returns vlans
2387       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans
2388       produces:
2389         - application/json
2390         - application/xml
2391       responses:
2392         "200":
2393           description: successful operation
2394           schema:
2395               $ref: "#/getDefinitions/vlans"
2396         "default":
2397           description: Response codes found in [response codes](https://wiki.onap.org/).
2398       parameters:
2399         - name: cloud-owner
2400           in: path
2401           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2402           required: true
2403           type: string
2404           example: __CLOUD-OWNER__
2405         - name: cloud-region-id
2406           in: path
2407           description: Identifier used by the vendor for the region. Second part of composite key
2408           required: true
2409           type: string
2410           example: __CLOUD-REGION-ID__
2411         - name: tenant-id
2412           in: path
2413           description: Unique id relative to the cloud-region.
2414           required: true
2415           type: string
2416           example: __TENANT-ID__
2417         - name: vserver-id
2418           in: path
2419           description: Unique identifier for this vserver relative to its tenant
2420           required: true
2421           type: string
2422           example: __VSERVER-ID__
2423         - name: interface-name
2424           in: path
2425           description: Name given to the interface
2426           required: true
2427           type: string
2428           example: __INTERFACE-NAME__
2429         - name: vlan-interface
2430           in: query
2431           description:
2432           required: false
2433           type: string
2434         - name: vlan-id-inner
2435           in: query
2436           description:
2437           required: false
2438           type: integer
2439           format: int64
2440         - name: vpn-key
2441           in: query
2442           description:
2443           required: false
2444           type: string
2445   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
2446     put:
2447       tags:
2448         - CloudInfrastructure
2449       summary: see node definition for valid relationships
2450       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2451       consumes:
2452         - application/json
2453         - application/xml
2454       produces:
2455         - application/json
2456         - application/xml
2457       responses:
2458         "default":
2459           description: Response codes found in [response codes](https://wiki.onap.org/).
2460       parameters:
2461         - name: cloud-owner
2462           in: path
2463           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2464           required: true
2465           type: string
2466           example: __CLOUD-OWNER__
2467         - name: cloud-region-id
2468           in: path
2469           description: Identifier used by the vendor for the region. Second part of composite key
2470           required: true
2471           type: string
2472           example: __CLOUD-REGION-ID__
2473         - name: tenant-id
2474           in: path
2475           description: Unique id relative to the cloud-region.
2476           required: true
2477           type: string
2478           example: __TENANT-ID__
2479         - name: vserver-id
2480           in: path
2481           description: Unique identifier for this vserver relative to its tenant
2482           required: true
2483           type: string
2484           example: __VSERVER-ID__
2485         - name: interface-name
2486           in: path
2487           description: Name given to the interface
2488           required: true
2489           type: string
2490           example: __INTERFACE-NAME__
2491         - name: pci-id
2492           in: path
2493           description: PCI ID used to identify the sriov-vf
2494           required: true
2495           type: string
2496           example: __PCI-ID__
2497         - name: body
2498           in: body
2499           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
2500           required: true
2501           schema:
2502             $ref: "#/definitions/relationship"
2503     delete:
2504       tags:
2505         - CloudInfrastructure
2506       summary: delete an existing relationship
2507       description: delete an existing relationship
2508       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2509       consumes:
2510         - application/json
2511         - application/xml
2512       produces:
2513         - application/json
2514         - application/xml
2515       responses:
2516         "default":
2517           description: Response codes found in [response codes](https://wiki.onap.org/).
2518       parameters:
2519         - name: cloud-owner
2520           in: path
2521           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2522           required: true
2523           type: string
2524           example: __CLOUD-OWNER__
2525         - name: cloud-region-id
2526           in: path
2527           description: Identifier used by the vendor for the region. Second part of composite key
2528           required: true
2529           type: string
2530           example: __CLOUD-REGION-ID__
2531         - name: tenant-id
2532           in: path
2533           description: Unique id relative to the cloud-region.
2534           required: true
2535           type: string
2536           example: __TENANT-ID__
2537         - name: vserver-id
2538           in: path
2539           description: Unique identifier for this vserver relative to its tenant
2540           required: true
2541           type: string
2542           example: __VSERVER-ID__
2543         - name: interface-name
2544           in: path
2545           description: Name given to the interface
2546           required: true
2547           type: string
2548           example: __INTERFACE-NAME__
2549         - name: pci-id
2550           in: path
2551           description: PCI ID used to identify the sriov-vf
2552           required: true
2553           type: string
2554           example: __PCI-ID__
2555   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
2556     get:
2557       tags:
2558         - CloudInfrastructure
2559       summary: returns sriov-vf
2560       description: returns sriov-vf
2561       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2562       produces:
2563         - application/json
2564         - application/xml
2565       responses:
2566         "200":
2567           description: successful operation
2568           schema:
2569               $ref: "#/getDefinitions/sriov-vf"
2570         "default":
2571           description: Response codes found in [response codes](https://wiki.onap.org/).
2572       parameters:
2573         - name: cloud-owner
2574           in: path
2575           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2576           required: true
2577           type: string
2578           example: __CLOUD-OWNER__
2579         - name: cloud-region-id
2580           in: path
2581           description: Identifier used by the vendor for the region. Second part of composite key
2582           required: true
2583           type: string
2584           example: __CLOUD-REGION-ID__
2585         - name: tenant-id
2586           in: path
2587           description: Unique id relative to the cloud-region.
2588           required: true
2589           type: string
2590           example: __TENANT-ID__
2591         - name: vserver-id
2592           in: path
2593           description: Unique identifier for this vserver relative to its tenant
2594           required: true
2595           type: string
2596           example: __VSERVER-ID__
2597         - name: interface-name
2598           in: path
2599           description: Name given to the interface
2600           required: true
2601           type: string
2602           example: __INTERFACE-NAME__
2603         - name: pci-id
2604           in: path
2605           description: PCI ID used to identify the sriov-vf
2606           required: true
2607           type: string
2608           example: __PCI-ID__
2609     put:
2610       tags:
2611         - CloudInfrastructure
2612       summary: create or update an existing sriov-vf
2613       description: |
2614         Create or update an existing sriov-vf.
2615         #
2616         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
2617       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2618       consumes:
2619         - application/json
2620         - application/xml
2621       produces:
2622         - application/json
2623         - application/xml
2624       responses:
2625         "default":
2626           description: Response codes found in [response codes](https://wiki.onap.org/).
2627       parameters:
2628         - name: cloud-owner
2629           in: path
2630           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2631           required: true
2632           type: string
2633           example: __CLOUD-OWNER__
2634         - name: cloud-region-id
2635           in: path
2636           description: Identifier used by the vendor for the region. Second part of composite key
2637           required: true
2638           type: string
2639           example: __CLOUD-REGION-ID__
2640         - name: tenant-id
2641           in: path
2642           description: Unique id relative to the cloud-region.
2643           required: true
2644           type: string
2645           example: __TENANT-ID__
2646         - name: vserver-id
2647           in: path
2648           description: Unique identifier for this vserver relative to its tenant
2649           required: true
2650           type: string
2651           example: __VSERVER-ID__
2652         - name: interface-name
2653           in: path
2654           description: Name given to the interface
2655           required: true
2656           type: string
2657           example: __INTERFACE-NAME__
2658         - name: pci-id
2659           in: path
2660           description: PCI ID used to identify the sriov-vf
2661           required: true
2662           type: string
2663           example: __PCI-ID__
2664         - name: body
2665           in: body
2666           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
2667           required: true
2668           schema:
2669             $ref: "#/definitions/sriov-vf"
2670     patch:
2671       tags:
2672         - CloudInfrastructure
2673       summary: update an existing sriov-vf
2674       description: |
2675         Update an existing sriov-vf
2676         #
2677         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2678         The PUT operation will entirely replace an existing object.
2679         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2680         #
2681         Other differences between PUT and PATCH are:
2682         #
2683         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2684         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2685         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2686       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2687       consumes:
2688         - application/json
2689         - application/xml
2690       produces:
2691         - application/json
2692         - application/xml
2693       responses:
2694         "default":
2695           description: Response codes found in [response codes](https://wiki.onap.org/).
2696       parameters:
2697         - name: cloud-owner
2698           in: path
2699           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2700           required: true
2701           type: string
2702           example: __CLOUD-OWNER__
2703         - name: cloud-region-id
2704           in: path
2705           description: Identifier used by the vendor for the region. Second part of composite key
2706           required: true
2707           type: string
2708           example: __CLOUD-REGION-ID__
2709         - name: tenant-id
2710           in: path
2711           description: Unique id relative to the cloud-region.
2712           required: true
2713           type: string
2714           example: __TENANT-ID__
2715         - name: vserver-id
2716           in: path
2717           description: Unique identifier for this vserver relative to its tenant
2718           required: true
2719           type: string
2720           example: __VSERVER-ID__
2721         - name: interface-name
2722           in: path
2723           description: Name given to the interface
2724           required: true
2725           type: string
2726           example: __INTERFACE-NAME__
2727         - name: pci-id
2728           in: path
2729           description: PCI ID used to identify the sriov-vf
2730           required: true
2731           type: string
2732           example: __PCI-ID__
2733         - name: body
2734           in: body
2735           description: sriov-vf object that needs to be updated.
2736           required: true
2737           schema:
2738             $ref: "#/patchDefinitions/sriov-vf"
2739     delete:
2740       tags:
2741         - CloudInfrastructure
2742       summary: delete an existing sriov-vf
2743       description: delete an existing sriov-vf
2744       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2745       consumes:
2746         - application/json
2747         - application/xml
2748       produces:
2749         - application/json
2750         - application/xml
2751       responses:
2752         "default":
2753           description: Response codes found in [response codes](https://wiki.onap.org/).
2754       parameters:
2755         - name: cloud-owner
2756           in: path
2757           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2758           required: true
2759           type: string
2760           example: __CLOUD-OWNER__
2761         - name: cloud-region-id
2762           in: path
2763           description: Identifier used by the vendor for the region. Second part of composite key
2764           required: true
2765           type: string
2766           example: __CLOUD-REGION-ID__
2767         - name: tenant-id
2768           in: path
2769           description: Unique id relative to the cloud-region.
2770           required: true
2771           type: string
2772           example: __TENANT-ID__
2773         - name: vserver-id
2774           in: path
2775           description: Unique identifier for this vserver relative to its tenant
2776           required: true
2777           type: string
2778           example: __VSERVER-ID__
2779         - name: interface-name
2780           in: path
2781           description: Name given to the interface
2782           required: true
2783           type: string
2784           example: __INTERFACE-NAME__
2785         - name: pci-id
2786           in: path
2787           description: PCI ID used to identify the sriov-vf
2788           required: true
2789           type: string
2790           example: __PCI-ID__
2791         - name: resource-version
2792           in: query
2793           description: resource-version for concurrency
2794           required: true
2795           type: string
2796   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
2797     get:
2798       tags:
2799         - CloudInfrastructure
2800       summary: returns sriov-vfs
2801       description: returns sriov-vfs
2802       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs
2803       produces:
2804         - application/json
2805         - application/xml
2806       responses:
2807         "200":
2808           description: successful operation
2809           schema:
2810               $ref: "#/getDefinitions/sriov-vfs"
2811         "default":
2812           description: Response codes found in [response codes](https://wiki.onap.org/).
2813       parameters:
2814         - name: cloud-owner
2815           in: path
2816           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2817           required: true
2818           type: string
2819           example: __CLOUD-OWNER__
2820         - name: cloud-region-id
2821           in: path
2822           description: Identifier used by the vendor for the region. Second part of composite key
2823           required: true
2824           type: string
2825           example: __CLOUD-REGION-ID__
2826         - name: tenant-id
2827           in: path
2828           description: Unique id relative to the cloud-region.
2829           required: true
2830           type: string
2831           example: __TENANT-ID__
2832         - name: vserver-id
2833           in: path
2834           description: Unique identifier for this vserver relative to its tenant
2835           required: true
2836           type: string
2837           example: __VSERVER-ID__
2838         - name: interface-name
2839           in: path
2840           description: Name given to the interface
2841           required: true
2842           type: string
2843           example: __INTERFACE-NAME__
2844         - name: pci-id
2845           in: query
2846           description:
2847           required: false
2848           type: string
2849         - name: vf-vlan-filter
2850           in: query
2851           description:
2852           required: false
2853           type: string
2854         - name: vf-mac-filter
2855           in: query
2856           description:
2857           required: false
2858           type: string
2859         - name: vf-vlan-strip
2860           in: query
2861           description:
2862           required: false
2863           type: boolean
2864         - name: neutron-network-id
2865           in: query
2866           description:
2867           required: false
2868           type: string
2869   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
2870     put:
2871       tags:
2872         - CloudInfrastructure
2873       summary: see node definition for valid relationships
2874       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
2875       consumes:
2876         - application/json
2877         - application/xml
2878       produces:
2879         - application/json
2880         - application/xml
2881       responses:
2882         "default":
2883           description: Response codes found in [response codes](https://wiki.onap.org/).
2884       parameters:
2885         - name: cloud-owner
2886           in: path
2887           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2888           required: true
2889           type: string
2890           example: __CLOUD-OWNER__
2891         - name: cloud-region-id
2892           in: path
2893           description: Identifier used by the vendor for the region. Second part of composite key
2894           required: true
2895           type: string
2896           example: __CLOUD-REGION-ID__
2897         - name: tenant-id
2898           in: path
2899           description: Unique id relative to the cloud-region.
2900           required: true
2901           type: string
2902           example: __TENANT-ID__
2903         - name: vserver-id
2904           in: path
2905           description: Unique identifier for this vserver relative to its tenant
2906           required: true
2907           type: string
2908           example: __VSERVER-ID__
2909         - name: interface-name
2910           in: path
2911           description: Name given to the interface
2912           required: true
2913           type: string
2914           example: __INTERFACE-NAME__
2915         - name: body
2916           in: body
2917           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
2918           required: true
2919           schema:
2920             $ref: "#/definitions/relationship"
2921     delete:
2922       tags:
2923         - CloudInfrastructure
2924       summary: delete an existing relationship
2925       description: delete an existing relationship
2926       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
2927       consumes:
2928         - application/json
2929         - application/xml
2930       produces:
2931         - application/json
2932         - application/xml
2933       responses:
2934         "default":
2935           description: Response codes found in [response codes](https://wiki.onap.org/).
2936       parameters:
2937         - name: cloud-owner
2938           in: path
2939           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2940           required: true
2941           type: string
2942           example: __CLOUD-OWNER__
2943         - name: cloud-region-id
2944           in: path
2945           description: Identifier used by the vendor for the region. Second part of composite key
2946           required: true
2947           type: string
2948           example: __CLOUD-REGION-ID__
2949         - name: tenant-id
2950           in: path
2951           description: Unique id relative to the cloud-region.
2952           required: true
2953           type: string
2954           example: __TENANT-ID__
2955         - name: vserver-id
2956           in: path
2957           description: Unique identifier for this vserver relative to its tenant
2958           required: true
2959           type: string
2960           example: __VSERVER-ID__
2961         - name: interface-name
2962           in: path
2963           description: Name given to the interface
2964           required: true
2965           type: string
2966           example: __INTERFACE-NAME__
2967   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
2968     put:
2969       tags:
2970         - CloudInfrastructure
2971       summary: see node definition for valid relationships
2972       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
2973       consumes:
2974         - application/json
2975         - application/xml
2976       produces:
2977         - application/json
2978         - application/xml
2979       responses:
2980         "default":
2981           description: Response codes found in [response codes](https://wiki.onap.org/).
2982       parameters:
2983         - name: cloud-owner
2984           in: path
2985           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2986           required: true
2987           type: string
2988           example: __CLOUD-OWNER__
2989         - name: cloud-region-id
2990           in: path
2991           description: Identifier used by the vendor for the region. Second part of composite key
2992           required: true
2993           type: string
2994           example: __CLOUD-REGION-ID__
2995         - name: tenant-id
2996           in: path
2997           description: Unique id relative to the cloud-region.
2998           required: true
2999           type: string
3000           example: __TENANT-ID__
3001         - name: vserver-id
3002           in: path
3003           description: Unique identifier for this vserver relative to its tenant
3004           required: true
3005           type: string
3006           example: __VSERVER-ID__
3007         - name: interface-name
3008           in: path
3009           description: Name given to the interface
3010           required: true
3011           type: string
3012           example: __INTERFACE-NAME__
3013         - name: l3-interface-ipv4-address
3014           in: path
3015           description: IP address
3016           required: true
3017           type: string
3018           example: __L3-INTERFACE-IPV4-ADDRESS__
3019         - name: body
3020           in: body
3021           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3022           required: true
3023           schema:
3024             $ref: "#/definitions/relationship"
3025     delete:
3026       tags:
3027         - CloudInfrastructure
3028       summary: delete an existing relationship
3029       description: delete an existing relationship
3030       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3031       consumes:
3032         - application/json
3033         - application/xml
3034       produces:
3035         - application/json
3036         - application/xml
3037       responses:
3038         "default":
3039           description: Response codes found in [response codes](https://wiki.onap.org/).
3040       parameters:
3041         - name: cloud-owner
3042           in: path
3043           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3044           required: true
3045           type: string
3046           example: __CLOUD-OWNER__
3047         - name: cloud-region-id
3048           in: path
3049           description: Identifier used by the vendor for the region. Second part of composite key
3050           required: true
3051           type: string
3052           example: __CLOUD-REGION-ID__
3053         - name: tenant-id
3054           in: path
3055           description: Unique id relative to the cloud-region.
3056           required: true
3057           type: string
3058           example: __TENANT-ID__
3059         - name: vserver-id
3060           in: path
3061           description: Unique identifier for this vserver relative to its tenant
3062           required: true
3063           type: string
3064           example: __VSERVER-ID__
3065         - name: interface-name
3066           in: path
3067           description: Name given to the interface
3068           required: true
3069           type: string
3070           example: __INTERFACE-NAME__
3071         - name: l3-interface-ipv4-address
3072           in: path
3073           description: IP address
3074           required: true
3075           type: string
3076           example: __L3-INTERFACE-IPV4-ADDRESS__
3077   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
3078     get:
3079       tags:
3080         - CloudInfrastructure
3081       summary: returns l3-interface-ipv4-address-list
3082       description: returns l3-interface-ipv4-address-list
3083       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3084       produces:
3085         - application/json
3086         - application/xml
3087       responses:
3088         "200":
3089           description: successful operation
3090           schema:
3091               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
3092         "default":
3093           description: Response codes found in [response codes](https://wiki.onap.org/).
3094       parameters:
3095         - name: cloud-owner
3096           in: path
3097           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3098           required: true
3099           type: string
3100           example: __CLOUD-OWNER__
3101         - name: cloud-region-id
3102           in: path
3103           description: Identifier used by the vendor for the region. Second part of composite key
3104           required: true
3105           type: string
3106           example: __CLOUD-REGION-ID__
3107         - name: tenant-id
3108           in: path
3109           description: Unique id relative to the cloud-region.
3110           required: true
3111           type: string
3112           example: __TENANT-ID__
3113         - name: vserver-id
3114           in: path
3115           description: Unique identifier for this vserver relative to its tenant
3116           required: true
3117           type: string
3118           example: __VSERVER-ID__
3119         - name: interface-name
3120           in: path
3121           description: Name given to the interface
3122           required: true
3123           type: string
3124           example: __INTERFACE-NAME__
3125         - name: l3-interface-ipv4-address
3126           in: path
3127           description: IP address
3128           required: true
3129           type: string
3130           example: __L3-INTERFACE-IPV4-ADDRESS__
3131     put:
3132       tags:
3133         - CloudInfrastructure
3134       summary: create or update an existing l3-interface-ipv4-address-list
3135       description: |
3136         Create or update an existing l3-interface-ipv4-address-list.
3137         #
3138         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3139       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3140       consumes:
3141         - application/json
3142         - application/xml
3143       produces:
3144         - application/json
3145         - application/xml
3146       responses:
3147         "default":
3148           description: Response codes found in [response codes](https://wiki.onap.org/).
3149       parameters:
3150         - name: cloud-owner
3151           in: path
3152           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3153           required: true
3154           type: string
3155           example: __CLOUD-OWNER__
3156         - name: cloud-region-id
3157           in: path
3158           description: Identifier used by the vendor for the region. Second part of composite key
3159           required: true
3160           type: string
3161           example: __CLOUD-REGION-ID__
3162         - name: tenant-id
3163           in: path
3164           description: Unique id relative to the cloud-region.
3165           required: true
3166           type: string
3167           example: __TENANT-ID__
3168         - name: vserver-id
3169           in: path
3170           description: Unique identifier for this vserver relative to its tenant
3171           required: true
3172           type: string
3173           example: __VSERVER-ID__
3174         - name: interface-name
3175           in: path
3176           description: Name given to the interface
3177           required: true
3178           type: string
3179           example: __INTERFACE-NAME__
3180         - name: l3-interface-ipv4-address
3181           in: path
3182           description: IP address
3183           required: true
3184           type: string
3185           example: __L3-INTERFACE-IPV4-ADDRESS__
3186         - name: body
3187           in: body
3188           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3189           required: true
3190           schema:
3191             $ref: "#/definitions/l3-interface-ipv4-address-list"
3192     patch:
3193       tags:
3194         - CloudInfrastructure
3195       summary: update an existing l3-interface-ipv4-address-list
3196       description: |
3197         Update an existing l3-interface-ipv4-address-list
3198         #
3199         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3200         The PUT operation will entirely replace an existing object.
3201         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
3202         #
3203         Other differences between PUT and PATCH are:
3204         #
3205         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3206         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3207         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3208       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3209       consumes:
3210         - application/json
3211         - application/xml
3212       produces:
3213         - application/json
3214         - application/xml
3215       responses:
3216         "default":
3217           description: Response codes found in [response codes](https://wiki.onap.org/).
3218       parameters:
3219         - name: cloud-owner
3220           in: path
3221           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3222           required: true
3223           type: string
3224           example: __CLOUD-OWNER__
3225         - name: cloud-region-id
3226           in: path
3227           description: Identifier used by the vendor for the region. Second part of composite key
3228           required: true
3229           type: string
3230           example: __CLOUD-REGION-ID__
3231         - name: tenant-id
3232           in: path
3233           description: Unique id relative to the cloud-region.
3234           required: true
3235           type: string
3236           example: __TENANT-ID__
3237         - name: vserver-id
3238           in: path
3239           description: Unique identifier for this vserver relative to its tenant
3240           required: true
3241           type: string
3242           example: __VSERVER-ID__
3243         - name: interface-name
3244           in: path
3245           description: Name given to the interface
3246           required: true
3247           type: string
3248           example: __INTERFACE-NAME__
3249         - name: l3-interface-ipv4-address
3250           in: path
3251           description: IP address
3252           required: true
3253           type: string
3254           example: __L3-INTERFACE-IPV4-ADDRESS__
3255         - name: body
3256           in: body
3257           description: l3-interface-ipv4-address-list object that needs to be updated.
3258           required: true
3259           schema:
3260             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
3261     delete:
3262       tags:
3263         - CloudInfrastructure
3264       summary: delete an existing l3-interface-ipv4-address-list
3265       description: delete an existing l3-interface-ipv4-address-list
3266       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3267       consumes:
3268         - application/json
3269         - application/xml
3270       produces:
3271         - application/json
3272         - application/xml
3273       responses:
3274         "default":
3275           description: Response codes found in [response codes](https://wiki.onap.org/).
3276       parameters:
3277         - name: cloud-owner
3278           in: path
3279           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3280           required: true
3281           type: string
3282           example: __CLOUD-OWNER__
3283         - name: cloud-region-id
3284           in: path
3285           description: Identifier used by the vendor for the region. Second part of composite key
3286           required: true
3287           type: string
3288           example: __CLOUD-REGION-ID__
3289         - name: tenant-id
3290           in: path
3291           description: Unique id relative to the cloud-region.
3292           required: true
3293           type: string
3294           example: __TENANT-ID__
3295         - name: vserver-id
3296           in: path
3297           description: Unique identifier for this vserver relative to its tenant
3298           required: true
3299           type: string
3300           example: __VSERVER-ID__
3301         - name: interface-name
3302           in: path
3303           description: Name given to the interface
3304           required: true
3305           type: string
3306           example: __INTERFACE-NAME__
3307         - name: l3-interface-ipv4-address
3308           in: path
3309           description: IP address
3310           required: true
3311           type: string
3312           example: __L3-INTERFACE-IPV4-ADDRESS__
3313         - name: resource-version
3314           in: query
3315           description: resource-version for concurrency
3316           required: true
3317           type: string
3318   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
3319     put:
3320       tags:
3321         - CloudInfrastructure
3322       summary: see node definition for valid relationships
3323       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3324       consumes:
3325         - application/json
3326         - application/xml
3327       produces:
3328         - application/json
3329         - application/xml
3330       responses:
3331         "default":
3332           description: Response codes found in [response codes](https://wiki.onap.org/).
3333       parameters:
3334         - name: cloud-owner
3335           in: path
3336           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3337           required: true
3338           type: string
3339           example: __CLOUD-OWNER__
3340         - name: cloud-region-id
3341           in: path
3342           description: Identifier used by the vendor for the region. Second part of composite key
3343           required: true
3344           type: string
3345           example: __CLOUD-REGION-ID__
3346         - name: tenant-id
3347           in: path
3348           description: Unique id relative to the cloud-region.
3349           required: true
3350           type: string
3351           example: __TENANT-ID__
3352         - name: vserver-id
3353           in: path
3354           description: Unique identifier for this vserver relative to its tenant
3355           required: true
3356           type: string
3357           example: __VSERVER-ID__
3358         - name: interface-name
3359           in: path
3360           description: Name given to the interface
3361           required: true
3362           type: string
3363           example: __INTERFACE-NAME__
3364         - name: l3-interface-ipv6-address
3365           in: path
3366           description: IP address
3367           required: true
3368           type: string
3369           example: __L3-INTERFACE-IPV6-ADDRESS__
3370         - name: body
3371           in: body
3372           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
3373           required: true
3374           schema:
3375             $ref: "#/definitions/relationship"
3376     delete:
3377       tags:
3378         - CloudInfrastructure
3379       summary: delete an existing relationship
3380       description: delete an existing relationship
3381       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3382       consumes:
3383         - application/json
3384         - application/xml
3385       produces:
3386         - application/json
3387         - application/xml
3388       responses:
3389         "default":
3390           description: Response codes found in [response codes](https://wiki.onap.org/).
3391       parameters:
3392         - name: cloud-owner
3393           in: path
3394           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3395           required: true
3396           type: string
3397           example: __CLOUD-OWNER__
3398         - name: cloud-region-id
3399           in: path
3400           description: Identifier used by the vendor for the region. Second part of composite key
3401           required: true
3402           type: string
3403           example: __CLOUD-REGION-ID__
3404         - name: tenant-id
3405           in: path
3406           description: Unique id relative to the cloud-region.
3407           required: true
3408           type: string
3409           example: __TENANT-ID__
3410         - name: vserver-id
3411           in: path
3412           description: Unique identifier for this vserver relative to its tenant
3413           required: true
3414           type: string
3415           example: __VSERVER-ID__
3416         - name: interface-name
3417           in: path
3418           description: Name given to the interface
3419           required: true
3420           type: string
3421           example: __INTERFACE-NAME__
3422         - name: l3-interface-ipv6-address
3423           in: path
3424           description: IP address
3425           required: true
3426           type: string
3427           example: __L3-INTERFACE-IPV6-ADDRESS__
3428   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
3429     get:
3430       tags:
3431         - CloudInfrastructure
3432       summary: returns l3-interface-ipv6-address-list
3433       description: returns l3-interface-ipv6-address-list
3434       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3435       produces:
3436         - application/json
3437         - application/xml
3438       responses:
3439         "200":
3440           description: successful operation
3441           schema:
3442               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
3443         "default":
3444           description: Response codes found in [response codes](https://wiki.onap.org/).
3445       parameters:
3446         - name: cloud-owner
3447           in: path
3448           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3449           required: true
3450           type: string
3451           example: __CLOUD-OWNER__
3452         - name: cloud-region-id
3453           in: path
3454           description: Identifier used by the vendor for the region. Second part of composite key
3455           required: true
3456           type: string
3457           example: __CLOUD-REGION-ID__
3458         - name: tenant-id
3459           in: path
3460           description: Unique id relative to the cloud-region.
3461           required: true
3462           type: string
3463           example: __TENANT-ID__
3464         - name: vserver-id
3465           in: path
3466           description: Unique identifier for this vserver relative to its tenant
3467           required: true
3468           type: string
3469           example: __VSERVER-ID__
3470         - name: interface-name
3471           in: path
3472           description: Name given to the interface
3473           required: true
3474           type: string
3475           example: __INTERFACE-NAME__
3476         - name: l3-interface-ipv6-address
3477           in: path
3478           description: IP address
3479           required: true
3480           type: string
3481           example: __L3-INTERFACE-IPV6-ADDRESS__
3482     put:
3483       tags:
3484         - CloudInfrastructure
3485       summary: create or update an existing l3-interface-ipv6-address-list
3486       description: |
3487         Create or update an existing l3-interface-ipv6-address-list.
3488         #
3489         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3490       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3491       consumes:
3492         - application/json
3493         - application/xml
3494       produces:
3495         - application/json
3496         - application/xml
3497       responses:
3498         "default":
3499           description: Response codes found in [response codes](https://wiki.onap.org/).
3500       parameters:
3501         - name: cloud-owner
3502           in: path
3503           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3504           required: true
3505           type: string
3506           example: __CLOUD-OWNER__
3507         - name: cloud-region-id
3508           in: path
3509           description: Identifier used by the vendor for the region. Second part of composite key
3510           required: true
3511           type: string
3512           example: __CLOUD-REGION-ID__
3513         - name: tenant-id
3514           in: path
3515           description: Unique id relative to the cloud-region.
3516           required: true
3517           type: string
3518           example: __TENANT-ID__
3519         - name: vserver-id
3520           in: path
3521           description: Unique identifier for this vserver relative to its tenant
3522           required: true
3523           type: string
3524           example: __VSERVER-ID__
3525         - name: interface-name
3526           in: path
3527           description: Name given to the interface
3528           required: true
3529           type: string
3530           example: __INTERFACE-NAME__
3531         - name: l3-interface-ipv6-address
3532           in: path
3533           description: IP address
3534           required: true
3535           type: string
3536           example: __L3-INTERFACE-IPV6-ADDRESS__
3537         - name: body
3538           in: body
3539           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
3540           required: true
3541           schema:
3542             $ref: "#/definitions/l3-interface-ipv6-address-list"
3543     patch:
3544       tags:
3545         - CloudInfrastructure
3546       summary: update an existing l3-interface-ipv6-address-list
3547       description: |
3548         Update an existing l3-interface-ipv6-address-list
3549         #
3550         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3551         The PUT operation will entirely replace an existing object.
3552         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
3553         #
3554         Other differences between PUT and PATCH are:
3555         #
3556         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3557         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3558         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3559       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3560       consumes:
3561         - application/json
3562         - application/xml
3563       produces:
3564         - application/json
3565         - application/xml
3566       responses:
3567         "default":
3568           description: Response codes found in [response codes](https://wiki.onap.org/).
3569       parameters:
3570         - name: cloud-owner
3571           in: path
3572           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3573           required: true
3574           type: string
3575           example: __CLOUD-OWNER__
3576         - name: cloud-region-id
3577           in: path
3578           description: Identifier used by the vendor for the region. Second part of composite key
3579           required: true
3580           type: string
3581           example: __CLOUD-REGION-ID__
3582         - name: tenant-id
3583           in: path
3584           description: Unique id relative to the cloud-region.
3585           required: true
3586           type: string
3587           example: __TENANT-ID__
3588         - name: vserver-id
3589           in: path
3590           description: Unique identifier for this vserver relative to its tenant
3591           required: true
3592           type: string
3593           example: __VSERVER-ID__
3594         - name: interface-name
3595           in: path
3596           description: Name given to the interface
3597           required: true
3598           type: string
3599           example: __INTERFACE-NAME__
3600         - name: l3-interface-ipv6-address
3601           in: path
3602           description: IP address
3603           required: true
3604           type: string
3605           example: __L3-INTERFACE-IPV6-ADDRESS__
3606         - name: body
3607           in: body
3608           description: l3-interface-ipv6-address-list object that needs to be updated.
3609           required: true
3610           schema:
3611             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
3612     delete:
3613       tags:
3614         - CloudInfrastructure
3615       summary: delete an existing l3-interface-ipv6-address-list
3616       description: delete an existing l3-interface-ipv6-address-list
3617       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
3618       consumes:
3619         - application/json
3620         - application/xml
3621       produces:
3622         - application/json
3623         - application/xml
3624       responses:
3625         "default":
3626           description: Response codes found in [response codes](https://wiki.onap.org/).
3627       parameters:
3628         - name: cloud-owner
3629           in: path
3630           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3631           required: true
3632           type: string
3633           example: __CLOUD-OWNER__
3634         - name: cloud-region-id
3635           in: path
3636           description: Identifier used by the vendor for the region. Second part of composite key
3637           required: true
3638           type: string
3639           example: __CLOUD-REGION-ID__
3640         - name: tenant-id
3641           in: path
3642           description: Unique id relative to the cloud-region.
3643           required: true
3644           type: string
3645           example: __TENANT-ID__
3646         - name: vserver-id
3647           in: path
3648           description: Unique identifier for this vserver relative to its tenant
3649           required: true
3650           type: string
3651           example: __VSERVER-ID__
3652         - name: interface-name
3653           in: path
3654           description: Name given to the interface
3655           required: true
3656           type: string
3657           example: __INTERFACE-NAME__
3658         - name: l3-interface-ipv6-address
3659           in: path
3660           description: IP address
3661           required: true
3662           type: string
3663           example: __L3-INTERFACE-IPV6-ADDRESS__
3664         - name: resource-version
3665           in: query
3666           description: resource-version for concurrency
3667           required: true
3668           type: string
3669   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}:
3670     get:
3671       tags:
3672         - CloudInfrastructure
3673       summary: returns l-interface
3674       description: returns l-interface
3675       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3676       produces:
3677         - application/json
3678         - application/xml
3679       responses:
3680         "200":
3681           description: successful operation
3682           schema:
3683               $ref: "#/getDefinitions/l-interface"
3684         "default":
3685           description: Response codes found in [response codes](https://wiki.onap.org/).
3686       parameters:
3687         - name: cloud-owner
3688           in: path
3689           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3690           required: true
3691           type: string
3692           example: __CLOUD-OWNER__
3693         - name: cloud-region-id
3694           in: path
3695           description: Identifier used by the vendor for the region. Second part of composite key
3696           required: true
3697           type: string
3698           example: __CLOUD-REGION-ID__
3699         - name: tenant-id
3700           in: path
3701           description: Unique id relative to the cloud-region.
3702           required: true
3703           type: string
3704           example: __TENANT-ID__
3705         - name: vserver-id
3706           in: path
3707           description: Unique identifier for this vserver relative to its tenant
3708           required: true
3709           type: string
3710           example: __VSERVER-ID__
3711         - name: interface-name
3712           in: path
3713           description: Name given to the interface
3714           required: true
3715           type: string
3716           example: __INTERFACE-NAME__
3717     put:
3718       tags:
3719         - CloudInfrastructure
3720       summary: create or update an existing l-interface
3721       description: |
3722         Create or update an existing l-interface.
3723         #
3724         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3725       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3726       consumes:
3727         - application/json
3728         - application/xml
3729       produces:
3730         - application/json
3731         - application/xml
3732       responses:
3733         "default":
3734           description: Response codes found in [response codes](https://wiki.onap.org/).
3735       parameters:
3736         - name: cloud-owner
3737           in: path
3738           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3739           required: true
3740           type: string
3741           example: __CLOUD-OWNER__
3742         - name: cloud-region-id
3743           in: path
3744           description: Identifier used by the vendor for the region. Second part of composite key
3745           required: true
3746           type: string
3747           example: __CLOUD-REGION-ID__
3748         - name: tenant-id
3749           in: path
3750           description: Unique id relative to the cloud-region.
3751           required: true
3752           type: string
3753           example: __TENANT-ID__
3754         - name: vserver-id
3755           in: path
3756           description: Unique identifier for this vserver relative to its tenant
3757           required: true
3758           type: string
3759           example: __VSERVER-ID__
3760         - name: interface-name
3761           in: path
3762           description: Name given to the interface
3763           required: true
3764           type: string
3765           example: __INTERFACE-NAME__
3766         - name: body
3767           in: body
3768           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
3769           required: true
3770           schema:
3771             $ref: "#/definitions/l-interface"
3772     patch:
3773       tags:
3774         - CloudInfrastructure
3775       summary: update an existing l-interface
3776       description: |
3777         Update an existing l-interface
3778         #
3779         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3780         The PUT operation will entirely replace an existing object.
3781         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
3782         #
3783         Other differences between PUT and PATCH are:
3784         #
3785         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3786         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3787         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3788       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3789       consumes:
3790         - application/json
3791         - application/xml
3792       produces:
3793         - application/json
3794         - application/xml
3795       responses:
3796         "default":
3797           description: Response codes found in [response codes](https://wiki.onap.org/).
3798       parameters:
3799         - name: cloud-owner
3800           in: path
3801           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3802           required: true
3803           type: string
3804           example: __CLOUD-OWNER__
3805         - name: cloud-region-id
3806           in: path
3807           description: Identifier used by the vendor for the region. Second part of composite key
3808           required: true
3809           type: string
3810           example: __CLOUD-REGION-ID__
3811         - name: tenant-id
3812           in: path
3813           description: Unique id relative to the cloud-region.
3814           required: true
3815           type: string
3816           example: __TENANT-ID__
3817         - name: vserver-id
3818           in: path
3819           description: Unique identifier for this vserver relative to its tenant
3820           required: true
3821           type: string
3822           example: __VSERVER-ID__
3823         - name: interface-name
3824           in: path
3825           description: Name given to the interface
3826           required: true
3827           type: string
3828           example: __INTERFACE-NAME__
3829         - name: body
3830           in: body
3831           description: l-interface object that needs to be updated.
3832           required: true
3833           schema:
3834             $ref: "#/patchDefinitions/l-interface"
3835     delete:
3836       tags:
3837         - CloudInfrastructure
3838       summary: delete an existing l-interface
3839       description: delete an existing l-interface
3840       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
3841       consumes:
3842         - application/json
3843         - application/xml
3844       produces:
3845         - application/json
3846         - application/xml
3847       responses:
3848         "default":
3849           description: Response codes found in [response codes](https://wiki.onap.org/).
3850       parameters:
3851         - name: cloud-owner
3852           in: path
3853           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3854           required: true
3855           type: string
3856           example: __CLOUD-OWNER__
3857         - name: cloud-region-id
3858           in: path
3859           description: Identifier used by the vendor for the region. Second part of composite key
3860           required: true
3861           type: string
3862           example: __CLOUD-REGION-ID__
3863         - name: tenant-id
3864           in: path
3865           description: Unique id relative to the cloud-region.
3866           required: true
3867           type: string
3868           example: __TENANT-ID__
3869         - name: vserver-id
3870           in: path
3871           description: Unique identifier for this vserver relative to its tenant
3872           required: true
3873           type: string
3874           example: __VSERVER-ID__
3875         - name: interface-name
3876           in: path
3877           description: Name given to the interface
3878           required: true
3879           type: string
3880           example: __INTERFACE-NAME__
3881         - name: resource-version
3882           in: query
3883           description: resource-version for concurrency
3884           required: true
3885           type: string
3886   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces:
3887     get:
3888       tags:
3889         - CloudInfrastructure
3890       summary: returns l-interfaces
3891       description: returns l-interfaces
3892       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces
3893       produces:
3894         - application/json
3895         - application/xml
3896       responses:
3897         "200":
3898           description: successful operation
3899           schema:
3900               $ref: "#/getDefinitions/l-interfaces"
3901         "default":
3902           description: Response codes found in [response codes](https://wiki.onap.org/).
3903       parameters:
3904         - name: cloud-owner
3905           in: path
3906           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3907           required: true
3908           type: string
3909           example: __CLOUD-OWNER__
3910         - name: cloud-region-id
3911           in: path
3912           description: Identifier used by the vendor for the region. Second part of composite key
3913           required: true
3914           type: string
3915           example: __CLOUD-REGION-ID__
3916         - name: tenant-id
3917           in: path
3918           description: Unique id relative to the cloud-region.
3919           required: true
3920           type: string
3921           example: __TENANT-ID__
3922         - name: vserver-id
3923           in: path
3924           description: Unique identifier for this vserver relative to its tenant
3925           required: true
3926           type: string
3927           example: __VSERVER-ID__
3928         - name: interface-name
3929           in: query
3930           description:
3931           required: false
3932           type: string
3933         - name: interface-id
3934           in: query
3935           description:
3936           required: false
3937           type: string
3938         - name: macaddr
3939           in: query
3940           description:
3941           required: false
3942           type: string
3943         - name: network-name
3944           in: query
3945           description:
3946           required: false
3947           type: string
3948   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}:
3949     get:
3950       tags:
3951         - CloudInfrastructure
3952       summary: returns vserver
3953       description: returns vserver
3954       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
3955       produces:
3956         - application/json
3957         - application/xml
3958       responses:
3959         "200":
3960           description: successful operation
3961           schema:
3962               $ref: "#/getDefinitions/vserver"
3963         "default":
3964           description: Response codes found in [response codes](https://wiki.onap.org/).
3965       parameters:
3966         - name: cloud-owner
3967           in: path
3968           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3969           required: true
3970           type: string
3971           example: __CLOUD-OWNER__
3972         - name: cloud-region-id
3973           in: path
3974           description: Identifier used by the vendor for the region. Second part of composite key
3975           required: true
3976           type: string
3977           example: __CLOUD-REGION-ID__
3978         - name: tenant-id
3979           in: path
3980           description: Unique id relative to the cloud-region.
3981           required: true
3982           type: string
3983           example: __TENANT-ID__
3984         - name: vserver-id
3985           in: path
3986           description: Unique identifier for this vserver relative to its tenant
3987           required: true
3988           type: string
3989           example: __VSERVER-ID__
3990     put:
3991       tags:
3992         - CloudInfrastructure
3993       summary: create or update an existing vserver
3994       description: |
3995         Create or update an existing vserver.
3996         #
3997         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3998       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
3999       consumes:
4000         - application/json
4001         - application/xml
4002       produces:
4003         - application/json
4004         - application/xml
4005       responses:
4006         "default":
4007           description: Response codes found in [response codes](https://wiki.onap.org/).
4008       parameters:
4009         - name: cloud-owner
4010           in: path
4011           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4012           required: true
4013           type: string
4014           example: __CLOUD-OWNER__
4015         - name: cloud-region-id
4016           in: path
4017           description: Identifier used by the vendor for the region. Second part of composite key
4018           required: true
4019           type: string
4020           example: __CLOUD-REGION-ID__
4021         - name: tenant-id
4022           in: path
4023           description: Unique id relative to the cloud-region.
4024           required: true
4025           type: string
4026           example: __TENANT-ID__
4027         - name: vserver-id
4028           in: path
4029           description: Unique identifier for this vserver relative to its tenant
4030           required: true
4031           type: string
4032           example: __VSERVER-ID__
4033         - name: body
4034           in: body
4035           description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
4036           required: true
4037           schema:
4038             $ref: "#/definitions/vserver"
4039     patch:
4040       tags:
4041         - CloudInfrastructure
4042       summary: update an existing vserver
4043       description: |
4044         Update an existing vserver
4045         #
4046         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4047         The PUT operation will entirely replace an existing object.
4048         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4049         #
4050         Other differences between PUT and PATCH are:
4051         #
4052         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4053         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4054         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4055       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4056       consumes:
4057         - application/json
4058         - application/xml
4059       produces:
4060         - application/json
4061         - application/xml
4062       responses:
4063         "default":
4064           description: Response codes found in [response codes](https://wiki.onap.org/).
4065       parameters:
4066         - name: cloud-owner
4067           in: path
4068           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4069           required: true
4070           type: string
4071           example: __CLOUD-OWNER__
4072         - name: cloud-region-id
4073           in: path
4074           description: Identifier used by the vendor for the region. Second part of composite key
4075           required: true
4076           type: string
4077           example: __CLOUD-REGION-ID__
4078         - name: tenant-id
4079           in: path
4080           description: Unique id relative to the cloud-region.
4081           required: true
4082           type: string
4083           example: __TENANT-ID__
4084         - name: vserver-id
4085           in: path
4086           description: Unique identifier for this vserver relative to its tenant
4087           required: true
4088           type: string
4089           example: __VSERVER-ID__
4090         - name: body
4091           in: body
4092           description: vserver object that needs to be updated.
4093           required: true
4094           schema:
4095             $ref: "#/patchDefinitions/vserver"
4096     delete:
4097       tags:
4098         - CloudInfrastructure
4099       summary: delete an existing vserver
4100       description: delete an existing vserver
4101       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4102       consumes:
4103         - application/json
4104         - application/xml
4105       produces:
4106         - application/json
4107         - application/xml
4108       responses:
4109         "default":
4110           description: Response codes found in [response codes](https://wiki.onap.org/).
4111       parameters:
4112         - name: cloud-owner
4113           in: path
4114           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4115           required: true
4116           type: string
4117           example: __CLOUD-OWNER__
4118         - name: cloud-region-id
4119           in: path
4120           description: Identifier used by the vendor for the region. Second part of composite key
4121           required: true
4122           type: string
4123           example: __CLOUD-REGION-ID__
4124         - name: tenant-id
4125           in: path
4126           description: Unique id relative to the cloud-region.
4127           required: true
4128           type: string
4129           example: __TENANT-ID__
4130         - name: vserver-id
4131           in: path
4132           description: Unique identifier for this vserver relative to its tenant
4133           required: true
4134           type: string
4135           example: __VSERVER-ID__
4136         - name: resource-version
4137           in: query
4138           description: resource-version for concurrency
4139           required: true
4140           type: string
4141   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers:
4142     get:
4143       tags:
4144         - CloudInfrastructure
4145       summary: returns vservers
4146       description: returns vservers
4147       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers
4148       produces:
4149         - application/json
4150         - application/xml
4151       responses:
4152         "200":
4153           description: successful operation
4154           schema:
4155               $ref: "#/getDefinitions/vservers"
4156         "default":
4157           description: Response codes found in [response codes](https://wiki.onap.org/).
4158       parameters:
4159         - name: cloud-owner
4160           in: path
4161           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4162           required: true
4163           type: string
4164           example: __CLOUD-OWNER__
4165         - name: cloud-region-id
4166           in: path
4167           description: Identifier used by the vendor for the region. Second part of composite key
4168           required: true
4169           type: string
4170           example: __CLOUD-REGION-ID__
4171         - name: tenant-id
4172           in: path
4173           description: Unique id relative to the cloud-region.
4174           required: true
4175           type: string
4176           example: __TENANT-ID__
4177         - name: vserver-id
4178           in: query
4179           description:
4180           required: false
4181           type: string
4182         - name: vserver-name
4183           in: query
4184           description:
4185           required: false
4186           type: string
4187         - name: vserver-name2
4188           in: query
4189           description:
4190           required: false
4191           type: string
4192         - name: prov-status
4193           in: query
4194           description:
4195           required: false
4196           type: string
4197         - name: in-maint
4198           in: query
4199           description:
4200           required: false
4201           type: boolean
4202         - name: is-closed-loop-disabled
4203           in: query
4204           description:
4205           required: false
4206           type: boolean
4207   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship:
4208     put:
4209       tags:
4210         - CloudInfrastructure
4211       summary: see node definition for valid relationships
4212       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4213       consumes:
4214         - application/json
4215         - application/xml
4216       produces:
4217         - application/json
4218         - application/xml
4219       responses:
4220         "default":
4221           description: Response codes found in [response codes](https://wiki.onap.org/).
4222       parameters:
4223         - name: cloud-owner
4224           in: path
4225           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4226           required: true
4227           type: string
4228           example: __CLOUD-OWNER__
4229         - name: cloud-region-id
4230           in: path
4231           description: Identifier used by the vendor for the region. Second part of composite key
4232           required: true
4233           type: string
4234           example: __CLOUD-REGION-ID__
4235         - name: tenant-id
4236           in: path
4237           description: Unique id relative to the cloud-region.
4238           required: true
4239           type: string
4240           example: __TENANT-ID__
4241         - name: body
4242           in: body
4243           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4244           required: true
4245           schema:
4246             $ref: "#/definitions/relationship"
4247     delete:
4248       tags:
4249         - CloudInfrastructure
4250       summary: delete an existing relationship
4251       description: delete an existing relationship
4252       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4253       consumes:
4254         - application/json
4255         - application/xml
4256       produces:
4257         - application/json
4258         - application/xml
4259       responses:
4260         "default":
4261           description: Response codes found in [response codes](https://wiki.onap.org/).
4262       parameters:
4263         - name: cloud-owner
4264           in: path
4265           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4266           required: true
4267           type: string
4268           example: __CLOUD-OWNER__
4269         - name: cloud-region-id
4270           in: path
4271           description: Identifier used by the vendor for the region. Second part of composite key
4272           required: true
4273           type: string
4274           example: __CLOUD-REGION-ID__
4275         - name: tenant-id
4276           in: path
4277           description: Unique id relative to the cloud-region.
4278           required: true
4279           type: string
4280           example: __TENANT-ID__
4281   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}:
4282     get:
4283       tags:
4284         - CloudInfrastructure
4285       summary: returns tenant
4286       description: returns tenant
4287       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4288       produces:
4289         - application/json
4290         - application/xml
4291       responses:
4292         "200":
4293           description: successful operation
4294           schema:
4295               $ref: "#/getDefinitions/tenant"
4296         "default":
4297           description: Response codes found in [response codes](https://wiki.onap.org/).
4298       parameters:
4299         - name: cloud-owner
4300           in: path
4301           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4302           required: true
4303           type: string
4304           example: __CLOUD-OWNER__
4305         - name: cloud-region-id
4306           in: path
4307           description: Identifier used by the vendor for the region. Second part of composite key
4308           required: true
4309           type: string
4310           example: __CLOUD-REGION-ID__
4311         - name: tenant-id
4312           in: path
4313           description: Unique id relative to the cloud-region.
4314           required: true
4315           type: string
4316           example: __TENANT-ID__
4317     put:
4318       tags:
4319         - CloudInfrastructure
4320       summary: create or update an existing tenant
4321       description: |
4322         Create or update an existing tenant.
4323         #
4324         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4325       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4326       consumes:
4327         - application/json
4328         - application/xml
4329       produces:
4330         - application/json
4331         - application/xml
4332       responses:
4333         "default":
4334           description: Response codes found in [response codes](https://wiki.onap.org/).
4335       parameters:
4336         - name: cloud-owner
4337           in: path
4338           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4339           required: true
4340           type: string
4341           example: __CLOUD-OWNER__
4342         - name: cloud-region-id
4343           in: path
4344           description: Identifier used by the vendor for the region. Second part of composite key
4345           required: true
4346           type: string
4347           example: __CLOUD-REGION-ID__
4348         - name: tenant-id
4349           in: path
4350           description: Unique id relative to the cloud-region.
4351           required: true
4352           type: string
4353           example: __TENANT-ID__
4354         - name: body
4355           in: body
4356           description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
4357           required: true
4358           schema:
4359             $ref: "#/definitions/tenant"
4360     patch:
4361       tags:
4362         - CloudInfrastructure
4363       summary: update an existing tenant
4364       description: |
4365         Update an existing tenant
4366         #
4367         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4368         The PUT operation will entirely replace an existing object.
4369         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4370         #
4371         Other differences between PUT and PATCH are:
4372         #
4373         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4374         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4375         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4376       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4377       consumes:
4378         - application/json
4379         - application/xml
4380       produces:
4381         - application/json
4382         - application/xml
4383       responses:
4384         "default":
4385           description: Response codes found in [response codes](https://wiki.onap.org/).
4386       parameters:
4387         - name: cloud-owner
4388           in: path
4389           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4390           required: true
4391           type: string
4392           example: __CLOUD-OWNER__
4393         - name: cloud-region-id
4394           in: path
4395           description: Identifier used by the vendor for the region. Second part of composite key
4396           required: true
4397           type: string
4398           example: __CLOUD-REGION-ID__
4399         - name: tenant-id
4400           in: path
4401           description: Unique id relative to the cloud-region.
4402           required: true
4403           type: string
4404           example: __TENANT-ID__
4405         - name: body
4406           in: body
4407           description: tenant object that needs to be updated.
4408           required: true
4409           schema:
4410             $ref: "#/patchDefinitions/tenant"
4411     delete:
4412       tags:
4413         - CloudInfrastructure
4414       summary: delete an existing tenant
4415       description: delete an existing tenant
4416       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
4417       consumes:
4418         - application/json
4419         - application/xml
4420       produces:
4421         - application/json
4422         - application/xml
4423       responses:
4424         "default":
4425           description: Response codes found in [response codes](https://wiki.onap.org/).
4426       parameters:
4427         - name: cloud-owner
4428           in: path
4429           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4430           required: true
4431           type: string
4432           example: __CLOUD-OWNER__
4433         - name: cloud-region-id
4434           in: path
4435           description: Identifier used by the vendor for the region. Second part of composite key
4436           required: true
4437           type: string
4438           example: __CLOUD-REGION-ID__
4439         - name: tenant-id
4440           in: path
4441           description: Unique id relative to the cloud-region.
4442           required: true
4443           type: string
4444           example: __TENANT-ID__
4445         - name: resource-version
4446           in: query
4447           description: resource-version for concurrency
4448           required: true
4449           type: string
4450   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
4451     get:
4452       tags:
4453         - CloudInfrastructure
4454       summary: returns tenants
4455       description: returns tenants
4456       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
4457       produces:
4458         - application/json
4459         - application/xml
4460       responses:
4461         "200":
4462           description: successful operation
4463           schema:
4464               $ref: "#/getDefinitions/tenants"
4465         "default":
4466           description: Response codes found in [response codes](https://wiki.onap.org/).
4467       parameters:
4468         - name: cloud-owner
4469           in: path
4470           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4471           required: true
4472           type: string
4473           example: __CLOUD-OWNER__
4474         - name: cloud-region-id
4475           in: path
4476           description: Identifier used by the vendor for the region. Second part of composite key
4477           required: true
4478           type: string
4479           example: __CLOUD-REGION-ID__
4480         - name: tenant-id
4481           in: query
4482           description:
4483           required: false
4484           type: string
4485         - name: tenant-name
4486           in: query
4487           description:
4488           required: false
4489           type: string
4490         - name: tenant-context
4491           in: query
4492           description:
4493           required: false
4494           type: string
4495   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship:
4496     put:
4497       tags:
4498         - CloudInfrastructure
4499       summary: see node definition for valid relationships
4500       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship
4501       consumes:
4502         - application/json
4503         - application/xml
4504       produces:
4505         - application/json
4506         - application/xml
4507       responses:
4508         "default":
4509           description: Response codes found in [response codes](https://wiki.onap.org/).
4510       parameters:
4511         - name: cloud-owner
4512           in: path
4513           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4514           required: true
4515           type: string
4516           example: __CLOUD-OWNER__
4517         - name: cloud-region-id
4518           in: path
4519           description: Identifier used by the vendor for the region. Second part of composite key
4520           required: true
4521           type: string
4522           example: __CLOUD-REGION-ID__
4523         - name: flavor-id
4524           in: path
4525           description: Flavor id, expected to be unique across cloud-region.
4526           required: true
4527           type: string
4528           example: __FLAVOR-ID__
4529         - name: hpa-capability-id
4530           in: path
4531           description: UUID to uniquely identify a HPA capability
4532           required: true
4533           type: string
4534           example: __HPA-CAPABILITY-ID__
4535         - name: body
4536           in: body
4537           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
4538           required: true
4539           schema:
4540             $ref: "#/definitions/relationship"
4541     delete:
4542       tags:
4543         - CloudInfrastructure
4544       summary: delete an existing relationship
4545       description: delete an existing relationship
4546       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityRelationshipListRelationship
4547       consumes:
4548         - application/json
4549         - application/xml
4550       produces:
4551         - application/json
4552         - application/xml
4553       responses:
4554         "default":
4555           description: Response codes found in [response codes](https://wiki.onap.org/).
4556       parameters:
4557         - name: cloud-owner
4558           in: path
4559           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4560           required: true
4561           type: string
4562           example: __CLOUD-OWNER__
4563         - name: cloud-region-id
4564           in: path
4565           description: Identifier used by the vendor for the region. Second part of composite key
4566           required: true
4567           type: string
4568           example: __CLOUD-REGION-ID__
4569         - name: flavor-id
4570           in: path
4571           description: Flavor id, expected to be unique across cloud-region.
4572           required: true
4573           type: string
4574           example: __FLAVOR-ID__
4575         - name: hpa-capability-id
4576           in: path
4577           description: UUID to uniquely identify a HPA capability
4578           required: true
4579           type: string
4580           example: __HPA-CAPABILITY-ID__
4581   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship:
4582     put:
4583       tags:
4584         - CloudInfrastructure
4585       summary: see node definition for valid relationships
4586       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
4587       consumes:
4588         - application/json
4589         - application/xml
4590       produces:
4591         - application/json
4592         - application/xml
4593       responses:
4594         "default":
4595           description: Response codes found in [response codes](https://wiki.onap.org/).
4596       parameters:
4597         - name: cloud-owner
4598           in: path
4599           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4600           required: true
4601           type: string
4602           example: __CLOUD-OWNER__
4603         - name: cloud-region-id
4604           in: path
4605           description: Identifier used by the vendor for the region. Second part of composite key
4606           required: true
4607           type: string
4608           example: __CLOUD-REGION-ID__
4609         - name: flavor-id
4610           in: path
4611           description: Flavor id, expected to be unique across cloud-region.
4612           required: true
4613           type: string
4614           example: __FLAVOR-ID__
4615         - name: hpa-capability-id
4616           in: path
4617           description: UUID to uniquely identify a HPA capability
4618           required: true
4619           type: string
4620           example: __HPA-CAPABILITY-ID__
4621         - name: hpa-attribute-key
4622           in: path
4623           description: name of the specific HPA attribute
4624           required: true
4625           type: string
4626           example: __HPA-ATTRIBUTE-KEY__
4627         - name: body
4628           in: body
4629           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
4630           required: true
4631           schema:
4632             $ref: "#/definitions/relationship"
4633     delete:
4634       tags:
4635         - CloudInfrastructure
4636       summary: delete an existing relationship
4637       description: delete an existing relationship
4638       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
4639       consumes:
4640         - application/json
4641         - application/xml
4642       produces:
4643         - application/json
4644         - application/xml
4645       responses:
4646         "default":
4647           description: Response codes found in [response codes](https://wiki.onap.org/).
4648       parameters:
4649         - name: cloud-owner
4650           in: path
4651           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4652           required: true
4653           type: string
4654           example: __CLOUD-OWNER__
4655         - name: cloud-region-id
4656           in: path
4657           description: Identifier used by the vendor for the region. Second part of composite key
4658           required: true
4659           type: string
4660           example: __CLOUD-REGION-ID__
4661         - name: flavor-id
4662           in: path
4663           description: Flavor id, expected to be unique across cloud-region.
4664           required: true
4665           type: string
4666           example: __FLAVOR-ID__
4667         - name: hpa-capability-id
4668           in: path
4669           description: UUID to uniquely identify a HPA capability
4670           required: true
4671           type: string
4672           example: __HPA-CAPABILITY-ID__
4673         - name: hpa-attribute-key
4674           in: path
4675           description: name of the specific HPA attribute
4676           required: true
4677           type: string
4678           example: __HPA-ATTRIBUTE-KEY__
4679   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}:
4680     get:
4681       tags:
4682         - CloudInfrastructure
4683       summary: returns hpa-feature-attributes
4684       description: returns hpa-feature-attributes
4685       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4686       produces:
4687         - application/json
4688         - application/xml
4689       responses:
4690         "200":
4691           description: successful operation
4692           schema:
4693               $ref: "#/getDefinitions/hpa-feature-attributes"
4694         "default":
4695           description: Response codes found in [response codes](https://wiki.onap.org/).
4696       parameters:
4697         - name: cloud-owner
4698           in: path
4699           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4700           required: true
4701           type: string
4702           example: __CLOUD-OWNER__
4703         - name: cloud-region-id
4704           in: path
4705           description: Identifier used by the vendor for the region. Second part of composite key
4706           required: true
4707           type: string
4708           example: __CLOUD-REGION-ID__
4709         - name: flavor-id
4710           in: path
4711           description: Flavor id, expected to be unique across cloud-region.
4712           required: true
4713           type: string
4714           example: __FLAVOR-ID__
4715         - name: hpa-capability-id
4716           in: path
4717           description: UUID to uniquely identify a HPA capability
4718           required: true
4719           type: string
4720           example: __HPA-CAPABILITY-ID__
4721         - name: hpa-attribute-key
4722           in: path
4723           description: name of the specific HPA attribute
4724           required: true
4725           type: string
4726           example: __HPA-ATTRIBUTE-KEY__
4727     put:
4728       tags:
4729         - CloudInfrastructure
4730       summary: create or update an existing hpa-feature-attributes
4731       description: |
4732         Create or update an existing hpa-feature-attributes.
4733         #
4734         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4735       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4736       consumes:
4737         - application/json
4738         - application/xml
4739       produces:
4740         - application/json
4741         - application/xml
4742       responses:
4743         "default":
4744           description: Response codes found in [response codes](https://wiki.onap.org/).
4745       parameters:
4746         - name: cloud-owner
4747           in: path
4748           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4749           required: true
4750           type: string
4751           example: __CLOUD-OWNER__
4752         - name: cloud-region-id
4753           in: path
4754           description: Identifier used by the vendor for the region. Second part of composite key
4755           required: true
4756           type: string
4757           example: __CLOUD-REGION-ID__
4758         - name: flavor-id
4759           in: path
4760           description: Flavor id, expected to be unique across cloud-region.
4761           required: true
4762           type: string
4763           example: __FLAVOR-ID__
4764         - name: hpa-capability-id
4765           in: path
4766           description: UUID to uniquely identify a HPA capability
4767           required: true
4768           type: string
4769           example: __HPA-CAPABILITY-ID__
4770         - name: hpa-attribute-key
4771           in: path
4772           description: name of the specific HPA attribute
4773           required: true
4774           type: string
4775           example: __HPA-ATTRIBUTE-KEY__
4776         - name: body
4777           in: body
4778           description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
4779           required: true
4780           schema:
4781             $ref: "#/definitions/hpa-feature-attributes"
4782     patch:
4783       tags:
4784         - CloudInfrastructure
4785       summary: update an existing hpa-feature-attributes
4786       description: |
4787         Update an existing hpa-feature-attributes
4788         #
4789         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4790         The PUT operation will entirely replace an existing object.
4791         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4792         #
4793         Other differences between PUT and PATCH are:
4794         #
4795         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4796         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4797         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4798       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4799       consumes:
4800         - application/json
4801         - application/xml
4802       produces:
4803         - application/json
4804         - application/xml
4805       responses:
4806         "default":
4807           description: Response codes found in [response codes](https://wiki.onap.org/).
4808       parameters:
4809         - name: cloud-owner
4810           in: path
4811           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4812           required: true
4813           type: string
4814           example: __CLOUD-OWNER__
4815         - name: cloud-region-id
4816           in: path
4817           description: Identifier used by the vendor for the region. Second part of composite key
4818           required: true
4819           type: string
4820           example: __CLOUD-REGION-ID__
4821         - name: flavor-id
4822           in: path
4823           description: Flavor id, expected to be unique across cloud-region.
4824           required: true
4825           type: string
4826           example: __FLAVOR-ID__
4827         - name: hpa-capability-id
4828           in: path
4829           description: UUID to uniquely identify a HPA capability
4830           required: true
4831           type: string
4832           example: __HPA-CAPABILITY-ID__
4833         - name: hpa-attribute-key
4834           in: path
4835           description: name of the specific HPA attribute
4836           required: true
4837           type: string
4838           example: __HPA-ATTRIBUTE-KEY__
4839         - name: body
4840           in: body
4841           description: hpa-feature-attributes object that needs to be updated.
4842           required: true
4843           schema:
4844             $ref: "#/patchDefinitions/hpa-feature-attributes"
4845     delete:
4846       tags:
4847         - CloudInfrastructure
4848       summary: delete an existing hpa-feature-attributes
4849       description: delete an existing hpa-feature-attributes
4850       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
4851       consumes:
4852         - application/json
4853         - application/xml
4854       produces:
4855         - application/json
4856         - application/xml
4857       responses:
4858         "default":
4859           description: Response codes found in [response codes](https://wiki.onap.org/).
4860       parameters:
4861         - name: cloud-owner
4862           in: path
4863           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4864           required: true
4865           type: string
4866           example: __CLOUD-OWNER__
4867         - name: cloud-region-id
4868           in: path
4869           description: Identifier used by the vendor for the region. Second part of composite key
4870           required: true
4871           type: string
4872           example: __CLOUD-REGION-ID__
4873         - name: flavor-id
4874           in: path
4875           description: Flavor id, expected to be unique across cloud-region.
4876           required: true
4877           type: string
4878           example: __FLAVOR-ID__
4879         - name: hpa-capability-id
4880           in: path
4881           description: UUID to uniquely identify a HPA capability
4882           required: true
4883           type: string
4884           example: __HPA-CAPABILITY-ID__
4885         - name: hpa-attribute-key
4886           in: path
4887           description: name of the specific HPA attribute
4888           required: true
4889           type: string
4890           example: __HPA-ATTRIBUTE-KEY__
4891         - name: resource-version
4892           in: query
4893           description: resource-version for concurrency
4894           required: true
4895           type: string
4896   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
4897     get:
4898       tags:
4899         - CloudInfrastructure
4900       summary: returns hpa-capability
4901       description: returns hpa-capability
4902       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
4903       produces:
4904         - application/json
4905         - application/xml
4906       responses:
4907         "200":
4908           description: successful operation
4909           schema:
4910               $ref: "#/getDefinitions/hpa-capability"
4911         "default":
4912           description: Response codes found in [response codes](https://wiki.onap.org/).
4913       parameters:
4914         - name: cloud-owner
4915           in: path
4916           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4917           required: true
4918           type: string
4919           example: __CLOUD-OWNER__
4920         - name: cloud-region-id
4921           in: path
4922           description: Identifier used by the vendor for the region. Second part of composite key
4923           required: true
4924           type: string
4925           example: __CLOUD-REGION-ID__
4926         - name: flavor-id
4927           in: path
4928           description: Flavor id, expected to be unique across cloud-region.
4929           required: true
4930           type: string
4931           example: __FLAVOR-ID__
4932         - name: hpa-capability-id
4933           in: path
4934           description: UUID to uniquely identify a HPA capability
4935           required: true
4936           type: string
4937           example: __HPA-CAPABILITY-ID__
4938     put:
4939       tags:
4940         - CloudInfrastructure
4941       summary: create or update an existing hpa-capability
4942       description: |
4943         Create or update an existing hpa-capability.
4944         #
4945         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4946       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
4947       consumes:
4948         - application/json
4949         - application/xml
4950       produces:
4951         - application/json
4952         - application/xml
4953       responses:
4954         "default":
4955           description: Response codes found in [response codes](https://wiki.onap.org/).
4956       parameters:
4957         - name: cloud-owner
4958           in: path
4959           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4960           required: true
4961           type: string
4962           example: __CLOUD-OWNER__
4963         - name: cloud-region-id
4964           in: path
4965           description: Identifier used by the vendor for the region. Second part of composite key
4966           required: true
4967           type: string
4968           example: __CLOUD-REGION-ID__
4969         - name: flavor-id
4970           in: path
4971           description: Flavor id, expected to be unique across cloud-region.
4972           required: true
4973           type: string
4974           example: __FLAVOR-ID__
4975         - name: hpa-capability-id
4976           in: path
4977           description: UUID to uniquely identify a HPA capability
4978           required: true
4979           type: string
4980           example: __HPA-CAPABILITY-ID__
4981         - name: body
4982           in: body
4983           description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)
4984           required: true
4985           schema:
4986             $ref: "#/definitions/hpa-capability"
4987     patch:
4988       tags:
4989         - CloudInfrastructure
4990       summary: update an existing hpa-capability
4991       description: |
4992         Update an existing hpa-capability
4993         #
4994         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4995         The PUT operation will entirely replace an existing object.
4996         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4997         #
4998         Other differences between PUT and PATCH are:
4999         #
5000         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5001         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5002         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5003       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5004       consumes:
5005         - application/json
5006         - application/xml
5007       produces:
5008         - application/json
5009         - application/xml
5010       responses:
5011         "default":
5012           description: Response codes found in [response codes](https://wiki.onap.org/).
5013       parameters:
5014         - name: cloud-owner
5015           in: path
5016           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5017           required: true
5018           type: string
5019           example: __CLOUD-OWNER__
5020         - name: cloud-region-id
5021           in: path
5022           description: Identifier used by the vendor for the region. Second part of composite key
5023           required: true
5024           type: string
5025           example: __CLOUD-REGION-ID__
5026         - name: flavor-id
5027           in: path
5028           description: Flavor id, expected to be unique across cloud-region.
5029           required: true
5030           type: string
5031           example: __FLAVOR-ID__
5032         - name: hpa-capability-id
5033           in: path
5034           description: UUID to uniquely identify a HPA capability
5035           required: true
5036           type: string
5037           example: __HPA-CAPABILITY-ID__
5038         - name: body
5039           in: body
5040           description: hpa-capability object that needs to be updated.
5041           required: true
5042           schema:
5043             $ref: "#/patchDefinitions/hpa-capability"
5044     delete:
5045       tags:
5046         - CloudInfrastructure
5047       summary: delete an existing hpa-capability
5048       description: delete an existing hpa-capability
5049       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability
5050       consumes:
5051         - application/json
5052         - application/xml
5053       produces:
5054         - application/json
5055         - application/xml
5056       responses:
5057         "default":
5058           description: Response codes found in [response codes](https://wiki.onap.org/).
5059       parameters:
5060         - name: cloud-owner
5061           in: path
5062           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5063           required: true
5064           type: string
5065           example: __CLOUD-OWNER__
5066         - name: cloud-region-id
5067           in: path
5068           description: Identifier used by the vendor for the region. Second part of composite key
5069           required: true
5070           type: string
5071           example: __CLOUD-REGION-ID__
5072         - name: flavor-id
5073           in: path
5074           description: Flavor id, expected to be unique across cloud-region.
5075           required: true
5076           type: string
5077           example: __FLAVOR-ID__
5078         - name: hpa-capability-id
5079           in: path
5080           description: UUID to uniquely identify a HPA capability
5081           required: true
5082           type: string
5083           example: __HPA-CAPABILITY-ID__
5084         - name: resource-version
5085           in: query
5086           description: resource-version for concurrency
5087           required: true
5088           type: string
5089   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities:
5090     get:
5091       tags:
5092         - CloudInfrastructure
5093       summary: returns hpa-capabilities
5094       description: returns hpa-capabilities
5095       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilities
5096       produces:
5097         - application/json
5098         - application/xml
5099       responses:
5100         "200":
5101           description: successful operation
5102           schema:
5103               $ref: "#/getDefinitions/hpa-capabilities"
5104         "default":
5105           description: Response codes found in [response codes](https://wiki.onap.org/).
5106       parameters:
5107         - name: cloud-owner
5108           in: path
5109           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5110           required: true
5111           type: string
5112           example: __CLOUD-OWNER__
5113         - name: cloud-region-id
5114           in: path
5115           description: Identifier used by the vendor for the region. Second part of composite key
5116           required: true
5117           type: string
5118           example: __CLOUD-REGION-ID__
5119         - name: flavor-id
5120           in: path
5121           description: Flavor id, expected to be unique across cloud-region.
5122           required: true
5123           type: string
5124           example: __FLAVOR-ID__
5125         - name: hpa-capability-id
5126           in: query
5127           description:
5128           required: false
5129           type: string
5130         - name: hpa-feature
5131           in: query
5132           description:
5133           required: false
5134           type: string
5135         - name: architecture
5136           in: query
5137           description:
5138           required: false
5139           type: string
5140   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
5141     put:
5142       tags:
5143         - CloudInfrastructure
5144       summary: see node definition for valid relationships
5145       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5146       consumes:
5147         - application/json
5148         - application/xml
5149       produces:
5150         - application/json
5151         - application/xml
5152       responses:
5153         "default":
5154           description: Response codes found in [response codes](https://wiki.onap.org/).
5155       parameters:
5156         - name: cloud-owner
5157           in: path
5158           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5159           required: true
5160           type: string
5161           example: __CLOUD-OWNER__
5162         - name: cloud-region-id
5163           in: path
5164           description: Identifier used by the vendor for the region. Second part of composite key
5165           required: true
5166           type: string
5167           example: __CLOUD-REGION-ID__
5168         - name: flavor-id
5169           in: path
5170           description: Flavor id, expected to be unique across cloud-region.
5171           required: true
5172           type: string
5173           example: __FLAVOR-ID__
5174         - name: body
5175           in: body
5176           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5177           required: true
5178           schema:
5179             $ref: "#/definitions/relationship"
5180     delete:
5181       tags:
5182         - CloudInfrastructure
5183       summary: delete an existing relationship
5184       description: delete an existing relationship
5185       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5186       consumes:
5187         - application/json
5188         - application/xml
5189       produces:
5190         - application/json
5191         - application/xml
5192       responses:
5193         "default":
5194           description: Response codes found in [response codes](https://wiki.onap.org/).
5195       parameters:
5196         - name: cloud-owner
5197           in: path
5198           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5199           required: true
5200           type: string
5201           example: __CLOUD-OWNER__
5202         - name: cloud-region-id
5203           in: path
5204           description: Identifier used by the vendor for the region. Second part of composite key
5205           required: true
5206           type: string
5207           example: __CLOUD-REGION-ID__
5208         - name: flavor-id
5209           in: path
5210           description: Flavor id, expected to be unique across cloud-region.
5211           required: true
5212           type: string
5213           example: __FLAVOR-ID__
5214   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
5215     get:
5216       tags:
5217         - CloudInfrastructure
5218       summary: returns flavor
5219       description: returns flavor
5220       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5221       produces:
5222         - application/json
5223         - application/xml
5224       responses:
5225         "200":
5226           description: successful operation
5227           schema:
5228               $ref: "#/getDefinitions/flavor"
5229         "default":
5230           description: Response codes found in [response codes](https://wiki.onap.org/).
5231       parameters:
5232         - name: cloud-owner
5233           in: path
5234           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5235           required: true
5236           type: string
5237           example: __CLOUD-OWNER__
5238         - name: cloud-region-id
5239           in: path
5240           description: Identifier used by the vendor for the region. Second part of composite key
5241           required: true
5242           type: string
5243           example: __CLOUD-REGION-ID__
5244         - name: flavor-id
5245           in: path
5246           description: Flavor id, expected to be unique across cloud-region.
5247           required: true
5248           type: string
5249           example: __FLAVOR-ID__
5250     put:
5251       tags:
5252         - CloudInfrastructure
5253       summary: create or update an existing flavor
5254       description: |
5255         Create or update an existing flavor.
5256         #
5257         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5258       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5259       consumes:
5260         - application/json
5261         - application/xml
5262       produces:
5263         - application/json
5264         - application/xml
5265       responses:
5266         "default":
5267           description: Response codes found in [response codes](https://wiki.onap.org/).
5268       parameters:
5269         - name: cloud-owner
5270           in: path
5271           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5272           required: true
5273           type: string
5274           example: __CLOUD-OWNER__
5275         - name: cloud-region-id
5276           in: path
5277           description: Identifier used by the vendor for the region. Second part of composite key
5278           required: true
5279           type: string
5280           example: __CLOUD-REGION-ID__
5281         - name: flavor-id
5282           in: path
5283           description: Flavor id, expected to be unique across cloud-region.
5284           required: true
5285           type: string
5286           example: __FLAVOR-ID__
5287         - name: body
5288           in: body
5289           description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5290           required: true
5291           schema:
5292             $ref: "#/definitions/flavor"
5293     patch:
5294       tags:
5295         - CloudInfrastructure
5296       summary: update an existing flavor
5297       description: |
5298         Update an existing flavor
5299         #
5300         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5301         The PUT operation will entirely replace an existing object.
5302         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5303         #
5304         Other differences between PUT and PATCH are:
5305         #
5306         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5307         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5308         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5309       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5310       consumes:
5311         - application/json
5312         - application/xml
5313       produces:
5314         - application/json
5315         - application/xml
5316       responses:
5317         "default":
5318           description: Response codes found in [response codes](https://wiki.onap.org/).
5319       parameters:
5320         - name: cloud-owner
5321           in: path
5322           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5323           required: true
5324           type: string
5325           example: __CLOUD-OWNER__
5326         - name: cloud-region-id
5327           in: path
5328           description: Identifier used by the vendor for the region. Second part of composite key
5329           required: true
5330           type: string
5331           example: __CLOUD-REGION-ID__
5332         - name: flavor-id
5333           in: path
5334           description: Flavor id, expected to be unique across cloud-region.
5335           required: true
5336           type: string
5337           example: __FLAVOR-ID__
5338         - name: body
5339           in: body
5340           description: flavor object that needs to be updated.
5341           required: true
5342           schema:
5343             $ref: "#/patchDefinitions/flavor"
5344     delete:
5345       tags:
5346         - CloudInfrastructure
5347       summary: delete an existing flavor
5348       description: delete an existing flavor
5349       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5350       consumes:
5351         - application/json
5352         - application/xml
5353       produces:
5354         - application/json
5355         - application/xml
5356       responses:
5357         "default":
5358           description: Response codes found in [response codes](https://wiki.onap.org/).
5359       parameters:
5360         - name: cloud-owner
5361           in: path
5362           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5363           required: true
5364           type: string
5365           example: __CLOUD-OWNER__
5366         - name: cloud-region-id
5367           in: path
5368           description: Identifier used by the vendor for the region. Second part of composite key
5369           required: true
5370           type: string
5371           example: __CLOUD-REGION-ID__
5372         - name: flavor-id
5373           in: path
5374           description: Flavor id, expected to be unique across cloud-region.
5375           required: true
5376           type: string
5377           example: __FLAVOR-ID__
5378         - name: resource-version
5379           in: query
5380           description: resource-version for concurrency
5381           required: true
5382           type: string
5383   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
5384     get:
5385       tags:
5386         - CloudInfrastructure
5387       summary: returns flavors
5388       description: returns flavors
5389       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
5390       produces:
5391         - application/json
5392         - application/xml
5393       responses:
5394         "200":
5395           description: successful operation
5396           schema:
5397               $ref: "#/getDefinitions/flavors"
5398         "default":
5399           description: Response codes found in [response codes](https://wiki.onap.org/).
5400       parameters:
5401         - name: cloud-owner
5402           in: path
5403           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5404           required: true
5405           type: string
5406           example: __CLOUD-OWNER__
5407         - name: cloud-region-id
5408           in: path
5409           description: Identifier used by the vendor for the region. Second part of composite key
5410           required: true
5411           type: string
5412           example: __CLOUD-REGION-ID__
5413         - name: flavor-id
5414           in: query
5415           description:
5416           required: false
5417           type: string
5418         - name: flavor-name
5419           in: query
5420           description:
5421           required: false
5422           type: string
5423   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
5424     put:
5425       tags:
5426         - CloudInfrastructure
5427       summary: see node definition for valid relationships
5428       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5429       consumes:
5430         - application/json
5431         - application/xml
5432       produces:
5433         - application/json
5434         - application/xml
5435       responses:
5436         "default":
5437           description: Response codes found in [response codes](https://wiki.onap.org/).
5438       parameters:
5439         - name: cloud-owner
5440           in: path
5441           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5442           required: true
5443           type: string
5444           example: __CLOUD-OWNER__
5445         - name: cloud-region-id
5446           in: path
5447           description: Identifier used by the vendor for the region. Second part of composite key
5448           required: true
5449           type: string
5450           example: __CLOUD-REGION-ID__
5451         - name: group-id
5452           in: path
5453           description: Group id, expected to be unique across cloud-region.
5454           required: true
5455           type: string
5456           example: __GROUP-ID__
5457         - name: body
5458           in: body
5459           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5460           required: true
5461           schema:
5462             $ref: "#/definitions/relationship"
5463     delete:
5464       tags:
5465         - CloudInfrastructure
5466       summary: delete an existing relationship
5467       description: delete an existing relationship
5468       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5469       consumes:
5470         - application/json
5471         - application/xml
5472       produces:
5473         - application/json
5474         - application/xml
5475       responses:
5476         "default":
5477           description: Response codes found in [response codes](https://wiki.onap.org/).
5478       parameters:
5479         - name: cloud-owner
5480           in: path
5481           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5482           required: true
5483           type: string
5484           example: __CLOUD-OWNER__
5485         - name: cloud-region-id
5486           in: path
5487           description: Identifier used by the vendor for the region. Second part of composite key
5488           required: true
5489           type: string
5490           example: __CLOUD-REGION-ID__
5491         - name: group-id
5492           in: path
5493           description: Group id, expected to be unique across cloud-region.
5494           required: true
5495           type: string
5496           example: __GROUP-ID__
5497   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
5498     get:
5499       tags:
5500         - CloudInfrastructure
5501       summary: returns group-assignment
5502       description: returns group-assignment
5503       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5504       produces:
5505         - application/json
5506         - application/xml
5507       responses:
5508         "200":
5509           description: successful operation
5510           schema:
5511               $ref: "#/getDefinitions/group-assignment"
5512         "default":
5513           description: Response codes found in [response codes](https://wiki.onap.org/).
5514       parameters:
5515         - name: cloud-owner
5516           in: path
5517           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5518           required: true
5519           type: string
5520           example: __CLOUD-OWNER__
5521         - name: cloud-region-id
5522           in: path
5523           description: Identifier used by the vendor for the region. Second part of composite key
5524           required: true
5525           type: string
5526           example: __CLOUD-REGION-ID__
5527         - name: group-id
5528           in: path
5529           description: Group id, expected to be unique across cloud-region.
5530           required: true
5531           type: string
5532           example: __GROUP-ID__
5533     put:
5534       tags:
5535         - CloudInfrastructure
5536       summary: create or update an existing group-assignment
5537       description: |
5538         Create or update an existing group-assignment.
5539         #
5540         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5541       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5542       consumes:
5543         - application/json
5544         - application/xml
5545       produces:
5546         - application/json
5547         - application/xml
5548       responses:
5549         "default":
5550           description: Response codes found in [response codes](https://wiki.onap.org/).
5551       parameters:
5552         - name: cloud-owner
5553           in: path
5554           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5555           required: true
5556           type: string
5557           example: __CLOUD-OWNER__
5558         - name: cloud-region-id
5559           in: path
5560           description: Identifier used by the vendor for the region. Second part of composite key
5561           required: true
5562           type: string
5563           example: __CLOUD-REGION-ID__
5564         - name: group-id
5565           in: path
5566           description: Group id, expected to be unique across cloud-region.
5567           required: true
5568           type: string
5569           example: __GROUP-ID__
5570         - name: body
5571           in: body
5572           description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5573           required: true
5574           schema:
5575             $ref: "#/definitions/group-assignment"
5576     patch:
5577       tags:
5578         - CloudInfrastructure
5579       summary: update an existing group-assignment
5580       description: |
5581         Update an existing group-assignment
5582         #
5583         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5584         The PUT operation will entirely replace an existing object.
5585         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5586         #
5587         Other differences between PUT and PATCH are:
5588         #
5589         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5590         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5591         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5592       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5593       consumes:
5594         - application/json
5595         - application/xml
5596       produces:
5597         - application/json
5598         - application/xml
5599       responses:
5600         "default":
5601           description: Response codes found in [response codes](https://wiki.onap.org/).
5602       parameters:
5603         - name: cloud-owner
5604           in: path
5605           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5606           required: true
5607           type: string
5608           example: __CLOUD-OWNER__
5609         - name: cloud-region-id
5610           in: path
5611           description: Identifier used by the vendor for the region. Second part of composite key
5612           required: true
5613           type: string
5614           example: __CLOUD-REGION-ID__
5615         - name: group-id
5616           in: path
5617           description: Group id, expected to be unique across cloud-region.
5618           required: true
5619           type: string
5620           example: __GROUP-ID__
5621         - name: body
5622           in: body
5623           description: group-assignment object that needs to be updated.
5624           required: true
5625           schema:
5626             $ref: "#/patchDefinitions/group-assignment"
5627     delete:
5628       tags:
5629         - CloudInfrastructure
5630       summary: delete an existing group-assignment
5631       description: delete an existing group-assignment
5632       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5633       consumes:
5634         - application/json
5635         - application/xml
5636       produces:
5637         - application/json
5638         - application/xml
5639       responses:
5640         "default":
5641           description: Response codes found in [response codes](https://wiki.onap.org/).
5642       parameters:
5643         - name: cloud-owner
5644           in: path
5645           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5646           required: true
5647           type: string
5648           example: __CLOUD-OWNER__
5649         - name: cloud-region-id
5650           in: path
5651           description: Identifier used by the vendor for the region. Second part of composite key
5652           required: true
5653           type: string
5654           example: __CLOUD-REGION-ID__
5655         - name: group-id
5656           in: path
5657           description: Group id, expected to be unique across cloud-region.
5658           required: true
5659           type: string
5660           example: __GROUP-ID__
5661         - name: resource-version
5662           in: query
5663           description: resource-version for concurrency
5664           required: true
5665           type: string
5666   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5667     get:
5668       tags:
5669         - CloudInfrastructure
5670       summary: returns group-assignments
5671       description: returns group-assignments
5672       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5673       produces:
5674         - application/json
5675         - application/xml
5676       responses:
5677         "200":
5678           description: successful operation
5679           schema:
5680               $ref: "#/getDefinitions/group-assignments"
5681         "default":
5682           description: Response codes found in [response codes](https://wiki.onap.org/).
5683       parameters:
5684         - name: cloud-owner
5685           in: path
5686           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5687           required: true
5688           type: string
5689           example: __CLOUD-OWNER__
5690         - name: cloud-region-id
5691           in: path
5692           description: Identifier used by the vendor for the region. Second part of composite key
5693           required: true
5694           type: string
5695           example: __CLOUD-REGION-ID__
5696         - name: group-id
5697           in: query
5698           description:
5699           required: false
5700           type: string
5701         - name: group-type
5702           in: query
5703           description:
5704           required: false
5705           type: string
5706         - name: group-name
5707           in: query
5708           description:
5709           required: false
5710           type: string
5711   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5712     put:
5713       tags:
5714         - CloudInfrastructure
5715       summary: see node definition for valid relationships
5716       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5717       consumes:
5718         - application/json
5719         - application/xml
5720       produces:
5721         - application/json
5722         - application/xml
5723       responses:
5724         "default":
5725           description: Response codes found in [response codes](https://wiki.onap.org/).
5726       parameters:
5727         - name: cloud-owner
5728           in: path
5729           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5730           required: true
5731           type: string
5732           example: __CLOUD-OWNER__
5733         - name: cloud-region-id
5734           in: path
5735           description: Identifier used by the vendor for the region. Second part of composite key
5736           required: true
5737           type: string
5738           example: __CLOUD-REGION-ID__
5739         - name: snapshot-id
5740           in: path
5741           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5742           required: true
5743           type: string
5744           example: __SNAPSHOT-ID__
5745         - name: body
5746           in: body
5747           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5748           required: true
5749           schema:
5750             $ref: "#/definitions/relationship"
5751     delete:
5752       tags:
5753         - CloudInfrastructure
5754       summary: delete an existing relationship
5755       description: delete an existing relationship
5756       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5757       consumes:
5758         - application/json
5759         - application/xml
5760       produces:
5761         - application/json
5762         - application/xml
5763       responses:
5764         "default":
5765           description: Response codes found in [response codes](https://wiki.onap.org/).
5766       parameters:
5767         - name: cloud-owner
5768           in: path
5769           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5770           required: true
5771           type: string
5772           example: __CLOUD-OWNER__
5773         - name: cloud-region-id
5774           in: path
5775           description: Identifier used by the vendor for the region. Second part of composite key
5776           required: true
5777           type: string
5778           example: __CLOUD-REGION-ID__
5779         - name: snapshot-id
5780           in: path
5781           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5782           required: true
5783           type: string
5784           example: __SNAPSHOT-ID__
5785   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5786     get:
5787       tags:
5788         - CloudInfrastructure
5789       summary: returns snapshot
5790       description: returns snapshot
5791       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5792       produces:
5793         - application/json
5794         - application/xml
5795       responses:
5796         "200":
5797           description: successful operation
5798           schema:
5799               $ref: "#/getDefinitions/snapshot"
5800         "default":
5801           description: Response codes found in [response codes](https://wiki.onap.org/).
5802       parameters:
5803         - name: cloud-owner
5804           in: path
5805           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5806           required: true
5807           type: string
5808           example: __CLOUD-OWNER__
5809         - name: cloud-region-id
5810           in: path
5811           description: Identifier used by the vendor for the region. Second part of composite key
5812           required: true
5813           type: string
5814           example: __CLOUD-REGION-ID__
5815         - name: snapshot-id
5816           in: path
5817           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5818           required: true
5819           type: string
5820           example: __SNAPSHOT-ID__
5821     put:
5822       tags:
5823         - CloudInfrastructure
5824       summary: create or update an existing snapshot
5825       description: |
5826         Create or update an existing snapshot.
5827         #
5828         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5829       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5830       consumes:
5831         - application/json
5832         - application/xml
5833       produces:
5834         - application/json
5835         - application/xml
5836       responses:
5837         "default":
5838           description: Response codes found in [response codes](https://wiki.onap.org/).
5839       parameters:
5840         - name: cloud-owner
5841           in: path
5842           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5843           required: true
5844           type: string
5845           example: __CLOUD-OWNER__
5846         - name: cloud-region-id
5847           in: path
5848           description: Identifier used by the vendor for the region. Second part of composite key
5849           required: true
5850           type: string
5851           example: __CLOUD-REGION-ID__
5852         - name: snapshot-id
5853           in: path
5854           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5855           required: true
5856           type: string
5857           example: __SNAPSHOT-ID__
5858         - name: body
5859           in: body
5860           description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5861           required: true
5862           schema:
5863             $ref: "#/definitions/snapshot"
5864     patch:
5865       tags:
5866         - CloudInfrastructure
5867       summary: update an existing snapshot
5868       description: |
5869         Update an existing snapshot
5870         #
5871         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5872         The PUT operation will entirely replace an existing object.
5873         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5874         #
5875         Other differences between PUT and PATCH are:
5876         #
5877         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5878         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5879         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5880       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5881       consumes:
5882         - application/json
5883         - application/xml
5884       produces:
5885         - application/json
5886         - application/xml
5887       responses:
5888         "default":
5889           description: Response codes found in [response codes](https://wiki.onap.org/).
5890       parameters:
5891         - name: cloud-owner
5892           in: path
5893           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5894           required: true
5895           type: string
5896           example: __CLOUD-OWNER__
5897         - name: cloud-region-id
5898           in: path
5899           description: Identifier used by the vendor for the region. Second part of composite key
5900           required: true
5901           type: string
5902           example: __CLOUD-REGION-ID__
5903         - name: snapshot-id
5904           in: path
5905           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5906           required: true
5907           type: string
5908           example: __SNAPSHOT-ID__
5909         - name: body
5910           in: body
5911           description: snapshot object that needs to be updated.
5912           required: true
5913           schema:
5914             $ref: "#/patchDefinitions/snapshot"
5915     delete:
5916       tags:
5917         - CloudInfrastructure
5918       summary: delete an existing snapshot
5919       description: delete an existing snapshot
5920       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5921       consumes:
5922         - application/json
5923         - application/xml
5924       produces:
5925         - application/json
5926         - application/xml
5927       responses:
5928         "default":
5929           description: Response codes found in [response codes](https://wiki.onap.org/).
5930       parameters:
5931         - name: cloud-owner
5932           in: path
5933           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5934           required: true
5935           type: string
5936           example: __CLOUD-OWNER__
5937         - name: cloud-region-id
5938           in: path
5939           description: Identifier used by the vendor for the region. Second part of composite key
5940           required: true
5941           type: string
5942           example: __CLOUD-REGION-ID__
5943         - name: snapshot-id
5944           in: path
5945           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5946           required: true
5947           type: string
5948           example: __SNAPSHOT-ID__
5949         - name: resource-version
5950           in: query
5951           description: resource-version for concurrency
5952           required: true
5953           type: string
5954   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
5955     get:
5956       tags:
5957         - CloudInfrastructure
5958       summary: returns snapshots
5959       description: returns snapshots
5960       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
5961       produces:
5962         - application/json
5963         - application/xml
5964       responses:
5965         "200":
5966           description: successful operation
5967           schema:
5968               $ref: "#/getDefinitions/snapshots"
5969         "default":
5970           description: Response codes found in [response codes](https://wiki.onap.org/).
5971       parameters:
5972         - name: cloud-owner
5973           in: path
5974           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5975           required: true
5976           type: string
5977           example: __CLOUD-OWNER__
5978         - name: cloud-region-id
5979           in: path
5980           description: Identifier used by the vendor for the region. Second part of composite key
5981           required: true
5982           type: string
5983           example: __CLOUD-REGION-ID__
5984         - name: snapshot-id
5985           in: query
5986           description:
5987           required: false
5988           type: string
5989         - name: snapshot-name
5990           in: query
5991           description:
5992           required: false
5993           type: string
5994         - name: application
5995           in: query
5996           description:
5997           required: false
5998           type: string
5999         - name: application-vendor
6000           in: query
6001           description:
6002           required: false
6003           type: string
6004         - name: application-version
6005           in: query
6006           description:
6007           required: false
6008           type: string
6009         - name: prev-snapshot-id
6010           in: query
6011           description:
6012           required: false
6013           type: string
6014   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
6015     put:
6016       tags:
6017         - CloudInfrastructure
6018       summary: see node definition for valid relationships
6019       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6020       consumes:
6021         - application/json
6022         - application/xml
6023       produces:
6024         - application/json
6025         - application/xml
6026       responses:
6027         "default":
6028           description: Response codes found in [response codes](https://wiki.onap.org/).
6029       parameters:
6030         - name: cloud-owner
6031           in: path
6032           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6033           required: true
6034           type: string
6035           example: __CLOUD-OWNER__
6036         - name: cloud-region-id
6037           in: path
6038           description: Identifier used by the vendor for the region. Second part of composite key
6039           required: true
6040           type: string
6041           example: __CLOUD-REGION-ID__
6042         - name: image-id
6043           in: path
6044           description: Image id, expected to be unique across cloud region
6045           required: true
6046           type: string
6047           example: __IMAGE-ID__
6048         - name: body
6049           in: body
6050           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6051           required: true
6052           schema:
6053             $ref: "#/definitions/relationship"
6054     delete:
6055       tags:
6056         - CloudInfrastructure
6057       summary: delete an existing relationship
6058       description: delete an existing relationship
6059       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6060       consumes:
6061         - application/json
6062         - application/xml
6063       produces:
6064         - application/json
6065         - application/xml
6066       responses:
6067         "default":
6068           description: Response codes found in [response codes](https://wiki.onap.org/).
6069       parameters:
6070         - name: cloud-owner
6071           in: path
6072           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6073           required: true
6074           type: string
6075           example: __CLOUD-OWNER__
6076         - name: cloud-region-id
6077           in: path
6078           description: Identifier used by the vendor for the region. Second part of composite key
6079           required: true
6080           type: string
6081           example: __CLOUD-REGION-ID__
6082         - name: image-id
6083           in: path
6084           description: Image id, expected to be unique across cloud region
6085           required: true
6086           type: string
6087           example: __IMAGE-ID__
6088   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
6089     get:
6090       tags:
6091         - CloudInfrastructure
6092       summary: returns metadatum
6093       description: returns metadatum
6094       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6095       produces:
6096         - application/json
6097         - application/xml
6098       responses:
6099         "200":
6100           description: successful operation
6101           schema:
6102               $ref: "#/getDefinitions/metadatum"
6103         "default":
6104           description: Response codes found in [response codes](https://wiki.onap.org/).
6105       parameters:
6106         - name: cloud-owner
6107           in: path
6108           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6109           required: true
6110           type: string
6111           example: __CLOUD-OWNER__
6112         - name: cloud-region-id
6113           in: path
6114           description: Identifier used by the vendor for the region. Second part of composite key
6115           required: true
6116           type: string
6117           example: __CLOUD-REGION-ID__
6118         - name: image-id
6119           in: path
6120           description: Image id, expected to be unique across cloud region
6121           required: true
6122           type: string
6123           example: __IMAGE-ID__
6124         - name: metaname
6125           in: path
6126           required: true
6127           type: string
6128           example: __METANAME__
6129     put:
6130       tags:
6131         - CloudInfrastructure
6132       summary: create or update an existing metadatum
6133       description: |
6134         Create or update an existing metadatum.
6135         #
6136         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6137       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6138       consumes:
6139         - application/json
6140         - application/xml
6141       produces:
6142         - application/json
6143         - application/xml
6144       responses:
6145         "default":
6146           description: Response codes found in [response codes](https://wiki.onap.org/).
6147       parameters:
6148         - name: cloud-owner
6149           in: path
6150           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6151           required: true
6152           type: string
6153           example: __CLOUD-OWNER__
6154         - name: cloud-region-id
6155           in: path
6156           description: Identifier used by the vendor for the region. Second part of composite key
6157           required: true
6158           type: string
6159           example: __CLOUD-REGION-ID__
6160         - name: image-id
6161           in: path
6162           description: Image id, expected to be unique across cloud region
6163           required: true
6164           type: string
6165           example: __IMAGE-ID__
6166         - name: metaname
6167           in: path
6168           required: true
6169           type: string
6170           example: __METANAME__
6171         - name: body
6172           in: body
6173           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
6174           required: true
6175           schema:
6176             $ref: "#/definitions/metadatum"
6177     patch:
6178       tags:
6179         - CloudInfrastructure
6180       summary: update an existing metadatum
6181       description: |
6182         Update an existing metadatum
6183         #
6184         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6185         The PUT operation will entirely replace an existing object.
6186         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6187         #
6188         Other differences between PUT and PATCH are:
6189         #
6190         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6191         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6192         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6193       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6194       consumes:
6195         - application/json
6196         - application/xml
6197       produces:
6198         - application/json
6199         - application/xml
6200       responses:
6201         "default":
6202           description: Response codes found in [response codes](https://wiki.onap.org/).
6203       parameters:
6204         - name: cloud-owner
6205           in: path
6206           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6207           required: true
6208           type: string
6209           example: __CLOUD-OWNER__
6210         - name: cloud-region-id
6211           in: path
6212           description: Identifier used by the vendor for the region. Second part of composite key
6213           required: true
6214           type: string
6215           example: __CLOUD-REGION-ID__
6216         - name: image-id
6217           in: path
6218           description: Image id, expected to be unique across cloud region
6219           required: true
6220           type: string
6221           example: __IMAGE-ID__
6222         - name: metaname
6223           in: path
6224           required: true
6225           type: string
6226           example: __METANAME__
6227         - name: body
6228           in: body
6229           description: metadatum object that needs to be updated.
6230           required: true
6231           schema:
6232             $ref: "#/patchDefinitions/metadatum"
6233     delete:
6234       tags:
6235         - CloudInfrastructure
6236       summary: delete an existing metadatum
6237       description: delete an existing metadatum
6238       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6239       consumes:
6240         - application/json
6241         - application/xml
6242       produces:
6243         - application/json
6244         - application/xml
6245       responses:
6246         "default":
6247           description: Response codes found in [response codes](https://wiki.onap.org/).
6248       parameters:
6249         - name: cloud-owner
6250           in: path
6251           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6252           required: true
6253           type: string
6254           example: __CLOUD-OWNER__
6255         - name: cloud-region-id
6256           in: path
6257           description: Identifier used by the vendor for the region. Second part of composite key
6258           required: true
6259           type: string
6260           example: __CLOUD-REGION-ID__
6261         - name: image-id
6262           in: path
6263           description: Image id, expected to be unique across cloud region
6264           required: true
6265           type: string
6266           example: __IMAGE-ID__
6267         - name: metaname
6268           in: path
6269           required: true
6270           type: string
6271           example: __METANAME__
6272         - name: resource-version
6273           in: query
6274           description: resource-version for concurrency
6275           required: true
6276           type: string
6277   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
6278     get:
6279       tags:
6280         - CloudInfrastructure
6281       summary: returns metadata
6282       description: returns metadata
6283       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
6284       produces:
6285         - application/json
6286         - application/xml
6287       responses:
6288         "200":
6289           description: successful operation
6290           schema:
6291               $ref: "#/getDefinitions/metadata"
6292         "default":
6293           description: Response codes found in [response codes](https://wiki.onap.org/).
6294       parameters:
6295         - name: cloud-owner
6296           in: path
6297           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6298           required: true
6299           type: string
6300           example: __CLOUD-OWNER__
6301         - name: cloud-region-id
6302           in: path
6303           description: Identifier used by the vendor for the region. Second part of composite key
6304           required: true
6305           type: string
6306           example: __CLOUD-REGION-ID__
6307         - name: image-id
6308           in: path
6309           description: Image id, expected to be unique across cloud region
6310           required: true
6311           type: string
6312           example: __IMAGE-ID__
6313         - name: metaname
6314           in: query
6315           description:
6316           required: false
6317           type: string
6318   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
6319     get:
6320       tags:
6321         - CloudInfrastructure
6322       summary: returns image
6323       description: returns image
6324       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
6325       produces:
6326         - application/json
6327         - application/xml
6328       responses:
6329         "200":
6330           description: successful operation
6331           schema:
6332               $ref: "#/getDefinitions/image"
6333         "default":
6334           description: Response codes found in [response codes](https://wiki.onap.org/).
6335       parameters:
6336         - name: cloud-owner
6337           in: path
6338           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6339           required: true
6340           type: string
6341           example: __CLOUD-OWNER__
6342         - name: cloud-region-id
6343           in: path
6344           description: Identifier used by the vendor for the region. Second part of composite key
6345           required: true
6346           type: string
6347           example: __CLOUD-REGION-ID__
6348         - name: image-id
6349           in: path
6350           description: Image id, expected to be unique across cloud region
6351           required: true
6352           type: string
6353           example: __IMAGE-ID__
6354     put:
6355       tags:
6356         - CloudInfrastructure
6357       summary: create or update an existing image
6358       description: |
6359         Create or update an existing image.
6360         #
6361         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6362       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6363       consumes:
6364         - application/json
6365         - application/xml
6366       produces:
6367         - application/json
6368         - application/xml
6369       responses:
6370         "default":
6371           description: Response codes found in [response codes](https://wiki.onap.org/).
6372       parameters:
6373         - name: cloud-owner
6374           in: path
6375           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6376           required: true
6377           type: string
6378           example: __CLOUD-OWNER__
6379         - name: cloud-region-id
6380           in: path
6381           description: Identifier used by the vendor for the region. Second part of composite key
6382           required: true
6383           type: string
6384           example: __CLOUD-REGION-ID__
6385         - name: image-id
6386           in: path
6387           description: Image id, expected to be unique across cloud region
6388           required: true
6389           type: string
6390           example: __IMAGE-ID__
6391         - name: body
6392           in: body
6393           description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6394           required: true
6395           schema:
6396             $ref: "#/definitions/image"
6397     patch:
6398       tags:
6399         - CloudInfrastructure
6400       summary: update an existing image
6401       description: |
6402         Update an existing image
6403         #
6404         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6405         The PUT operation will entirely replace an existing object.
6406         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6407         #
6408         Other differences between PUT and PATCH are:
6409         #
6410         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6411         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6412         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6413       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6414       consumes:
6415         - application/json
6416         - application/xml
6417       produces:
6418         - application/json
6419         - application/xml
6420       responses:
6421         "default":
6422           description: Response codes found in [response codes](https://wiki.onap.org/).
6423       parameters:
6424         - name: cloud-owner
6425           in: path
6426           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6427           required: true
6428           type: string
6429           example: __CLOUD-OWNER__
6430         - name: cloud-region-id
6431           in: path
6432           description: Identifier used by the vendor for the region. Second part of composite key
6433           required: true
6434           type: string
6435           example: __CLOUD-REGION-ID__
6436         - name: image-id
6437           in: path
6438           description: Image id, expected to be unique across cloud region
6439           required: true
6440           type: string
6441           example: __IMAGE-ID__
6442         - name: body
6443           in: body
6444           description: image object that needs to be updated.
6445           required: true
6446           schema:
6447             $ref: "#/patchDefinitions/image"
6448     delete:
6449       tags:
6450         - CloudInfrastructure
6451       summary: delete an existing image
6452       description: delete an existing image
6453       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
6454       consumes:
6455         - application/json
6456         - application/xml
6457       produces:
6458         - application/json
6459         - application/xml
6460       responses:
6461         "default":
6462           description: Response codes found in [response codes](https://wiki.onap.org/).
6463       parameters:
6464         - name: cloud-owner
6465           in: path
6466           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6467           required: true
6468           type: string
6469           example: __CLOUD-OWNER__
6470         - name: cloud-region-id
6471           in: path
6472           description: Identifier used by the vendor for the region. Second part of composite key
6473           required: true
6474           type: string
6475           example: __CLOUD-REGION-ID__
6476         - name: image-id
6477           in: path
6478           description: Image id, expected to be unique across cloud region
6479           required: true
6480           type: string
6481           example: __IMAGE-ID__
6482         - name: resource-version
6483           in: query
6484           description: resource-version for concurrency
6485           required: true
6486           type: string
6487   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
6488     get:
6489       tags:
6490         - CloudInfrastructure
6491       summary: returns images
6492       description: returns images
6493       operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
6494       produces:
6495         - application/json
6496         - application/xml
6497       responses:
6498         "200":
6499           description: successful operation
6500           schema:
6501               $ref: "#/getDefinitions/images"
6502         "default":
6503           description: Response codes found in [response codes](https://wiki.onap.org/).
6504       parameters:
6505         - name: cloud-owner
6506           in: path
6507           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6508           required: true
6509           type: string
6510           example: __CLOUD-OWNER__
6511         - name: cloud-region-id
6512           in: path
6513           description: Identifier used by the vendor for the region. Second part of composite key
6514           required: true
6515           type: string
6516           example: __CLOUD-REGION-ID__
6517         - name: image-id
6518           in: query
6519           description:
6520           required: false
6521           type: string
6522         - name: image-name
6523           in: query
6524           description:
6525           required: false
6526           type: string
6527         - name: application
6528           in: query
6529           description:
6530           required: false
6531           type: string
6532         - name: application-vendor
6533           in: query
6534           description:
6535           required: false
6536           type: string
6537         - name: application-version
6538           in: query
6539           description:
6540           required: false
6541           type: string
6542   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
6543     put:
6544       tags:
6545         - CloudInfrastructure
6546       summary: see node definition for valid relationships
6547       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6548       consumes:
6549         - application/json
6550         - application/xml
6551       produces:
6552         - application/json
6553         - application/xml
6554       responses:
6555         "default":
6556           description: Response codes found in [response codes](https://wiki.onap.org/).
6557       parameters:
6558         - name: cloud-owner
6559           in: path
6560           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6561           required: true
6562           type: string
6563           example: __CLOUD-OWNER__
6564         - name: cloud-region-id
6565           in: path
6566           description: Identifier used by the vendor for the region. Second part of composite key
6567           required: true
6568           type: string
6569           example: __CLOUD-REGION-ID__
6570         - name: switch-name
6571           in: path
6572           description: DVS switch name
6573           required: true
6574           type: string
6575           example: __SWITCH-NAME__
6576         - name: body
6577           in: body
6578           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6579           required: true
6580           schema:
6581             $ref: "#/definitions/relationship"
6582     delete:
6583       tags:
6584         - CloudInfrastructure
6585       summary: delete an existing relationship
6586       description: delete an existing relationship
6587       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6588       consumes:
6589         - application/json
6590         - application/xml
6591       produces:
6592         - application/json
6593         - application/xml
6594       responses:
6595         "default":
6596           description: Response codes found in [response codes](https://wiki.onap.org/).
6597       parameters:
6598         - name: cloud-owner
6599           in: path
6600           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6601           required: true
6602           type: string
6603           example: __CLOUD-OWNER__
6604         - name: cloud-region-id
6605           in: path
6606           description: Identifier used by the vendor for the region. Second part of composite key
6607           required: true
6608           type: string
6609           example: __CLOUD-REGION-ID__
6610         - name: switch-name
6611           in: path
6612           description: DVS switch name
6613           required: true
6614           type: string
6615           example: __SWITCH-NAME__
6616   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
6617     get:
6618       tags:
6619         - CloudInfrastructure
6620       summary: returns dvs-switch
6621       description: returns dvs-switch
6622       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6623       produces:
6624         - application/json
6625         - application/xml
6626       responses:
6627         "200":
6628           description: successful operation
6629           schema:
6630               $ref: "#/getDefinitions/dvs-switch"
6631         "default":
6632           description: Response codes found in [response codes](https://wiki.onap.org/).
6633       parameters:
6634         - name: cloud-owner
6635           in: path
6636           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6637           required: true
6638           type: string
6639           example: __CLOUD-OWNER__
6640         - name: cloud-region-id
6641           in: path
6642           description: Identifier used by the vendor for the region. Second part of composite key
6643           required: true
6644           type: string
6645           example: __CLOUD-REGION-ID__
6646         - name: switch-name
6647           in: path
6648           description: DVS switch name
6649           required: true
6650           type: string
6651           example: __SWITCH-NAME__
6652     put:
6653       tags:
6654         - CloudInfrastructure
6655       summary: create or update an existing dvs-switch
6656       description: |
6657         Create or update an existing dvs-switch.
6658         #
6659         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6660       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6661       consumes:
6662         - application/json
6663         - application/xml
6664       produces:
6665         - application/json
6666         - application/xml
6667       responses:
6668         "default":
6669           description: Response codes found in [response codes](https://wiki.onap.org/).
6670       parameters:
6671         - name: cloud-owner
6672           in: path
6673           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6674           required: true
6675           type: string
6676           example: __CLOUD-OWNER__
6677         - name: cloud-region-id
6678           in: path
6679           description: Identifier used by the vendor for the region. Second part of composite key
6680           required: true
6681           type: string
6682           example: __CLOUD-REGION-ID__
6683         - name: switch-name
6684           in: path
6685           description: DVS switch name
6686           required: true
6687           type: string
6688           example: __SWITCH-NAME__
6689         - name: body
6690           in: body
6691           description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6692           required: true
6693           schema:
6694             $ref: "#/definitions/dvs-switch"
6695     patch:
6696       tags:
6697         - CloudInfrastructure
6698       summary: update an existing dvs-switch
6699       description: |
6700         Update an existing dvs-switch
6701         #
6702         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6703         The PUT operation will entirely replace an existing object.
6704         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6705         #
6706         Other differences between PUT and PATCH are:
6707         #
6708         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6709         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6710         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6711       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6712       consumes:
6713         - application/json
6714         - application/xml
6715       produces:
6716         - application/json
6717         - application/xml
6718       responses:
6719         "default":
6720           description: Response codes found in [response codes](https://wiki.onap.org/).
6721       parameters:
6722         - name: cloud-owner
6723           in: path
6724           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6725           required: true
6726           type: string
6727           example: __CLOUD-OWNER__
6728         - name: cloud-region-id
6729           in: path
6730           description: Identifier used by the vendor for the region. Second part of composite key
6731           required: true
6732           type: string
6733           example: __CLOUD-REGION-ID__
6734         - name: switch-name
6735           in: path
6736           description: DVS switch name
6737           required: true
6738           type: string
6739           example: __SWITCH-NAME__
6740         - name: body
6741           in: body
6742           description: dvs-switch object that needs to be updated.
6743           required: true
6744           schema:
6745             $ref: "#/patchDefinitions/dvs-switch"
6746     delete:
6747       tags:
6748         - CloudInfrastructure
6749       summary: delete an existing dvs-switch
6750       description: delete an existing dvs-switch
6751       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6752       consumes:
6753         - application/json
6754         - application/xml
6755       produces:
6756         - application/json
6757         - application/xml
6758       responses:
6759         "default":
6760           description: Response codes found in [response codes](https://wiki.onap.org/).
6761       parameters:
6762         - name: cloud-owner
6763           in: path
6764           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6765           required: true
6766           type: string
6767           example: __CLOUD-OWNER__
6768         - name: cloud-region-id
6769           in: path
6770           description: Identifier used by the vendor for the region. Second part of composite key
6771           required: true
6772           type: string
6773           example: __CLOUD-REGION-ID__
6774         - name: switch-name
6775           in: path
6776           description: DVS switch name
6777           required: true
6778           type: string
6779           example: __SWITCH-NAME__
6780         - name: resource-version
6781           in: query
6782           description: resource-version for concurrency
6783           required: true
6784           type: string
6785   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
6786     get:
6787       tags:
6788         - CloudInfrastructure
6789       summary: returns dvs-switches
6790       description: returns dvs-switches
6791       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
6792       produces:
6793         - application/json
6794         - application/xml
6795       responses:
6796         "200":
6797           description: successful operation
6798           schema:
6799               $ref: "#/getDefinitions/dvs-switches"
6800         "default":
6801           description: Response codes found in [response codes](https://wiki.onap.org/).
6802       parameters:
6803         - name: cloud-owner
6804           in: path
6805           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6806           required: true
6807           type: string
6808           example: __CLOUD-OWNER__
6809         - name: cloud-region-id
6810           in: path
6811           description: Identifier used by the vendor for the region. Second part of composite key
6812           required: true
6813           type: string
6814           example: __CLOUD-REGION-ID__
6815         - name: switch-name
6816           in: query
6817           description:
6818           required: false
6819           type: string
6820         - name: vcenter-url
6821           in: query
6822           description:
6823           required: false
6824           type: string
6825   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
6826     put:
6827       tags:
6828         - CloudInfrastructure
6829       summary: see node definition for valid relationships
6830       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6831       consumes:
6832         - application/json
6833         - application/xml
6834       produces:
6835         - application/json
6836         - application/xml
6837       responses:
6838         "default":
6839           description: Response codes found in [response codes](https://wiki.onap.org/).
6840       parameters:
6841         - name: cloud-owner
6842           in: path
6843           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6844           required: true
6845           type: string
6846           example: __CLOUD-OWNER__
6847         - name: cloud-region-id
6848           in: path
6849           description: Identifier used by the vendor for the region. Second part of composite key
6850           required: true
6851           type: string
6852           example: __CLOUD-REGION-ID__
6853         - name: network-uuid
6854           in: path
6855           description: UUID of the network. Unique across a cloud-region
6856           required: true
6857           type: string
6858           example: __NETWORK-UUID__
6859         - name: body
6860           in: body
6861           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6862           required: true
6863           schema:
6864             $ref: "#/definitions/relationship"
6865     delete:
6866       tags:
6867         - CloudInfrastructure
6868       summary: delete an existing relationship
6869       description: delete an existing relationship
6870       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
6871       consumes:
6872         - application/json
6873         - application/xml
6874       produces:
6875         - application/json
6876         - application/xml
6877       responses:
6878         "default":
6879           description: Response codes found in [response codes](https://wiki.onap.org/).
6880       parameters:
6881         - name: cloud-owner
6882           in: path
6883           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6884           required: true
6885           type: string
6886           example: __CLOUD-OWNER__
6887         - name: cloud-region-id
6888           in: path
6889           description: Identifier used by the vendor for the region. Second part of composite key
6890           required: true
6891           type: string
6892           example: __CLOUD-REGION-ID__
6893         - name: network-uuid
6894           in: path
6895           description: UUID of the network. Unique across a cloud-region
6896           required: true
6897           type: string
6898           example: __NETWORK-UUID__
6899   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
6900     get:
6901       tags:
6902         - CloudInfrastructure
6903       summary: returns oam-network
6904       description: returns oam-network
6905       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6906       produces:
6907         - application/json
6908         - application/xml
6909       responses:
6910         "200":
6911           description: successful operation
6912           schema:
6913               $ref: "#/getDefinitions/oam-network"
6914         "default":
6915           description: Response codes found in [response codes](https://wiki.onap.org/).
6916       parameters:
6917         - name: cloud-owner
6918           in: path
6919           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6920           required: true
6921           type: string
6922           example: __CLOUD-OWNER__
6923         - name: cloud-region-id
6924           in: path
6925           description: Identifier used by the vendor for the region. Second part of composite key
6926           required: true
6927           type: string
6928           example: __CLOUD-REGION-ID__
6929         - name: network-uuid
6930           in: path
6931           description: UUID of the network. Unique across a cloud-region
6932           required: true
6933           type: string
6934           example: __NETWORK-UUID__
6935     put:
6936       tags:
6937         - CloudInfrastructure
6938       summary: create or update an existing oam-network
6939       description: |
6940         Create or update an existing oam-network.
6941         #
6942         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6943       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6944       consumes:
6945         - application/json
6946         - application/xml
6947       produces:
6948         - application/json
6949         - application/xml
6950       responses:
6951         "default":
6952           description: Response codes found in [response codes](https://wiki.onap.org/).
6953       parameters:
6954         - name: cloud-owner
6955           in: path
6956           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6957           required: true
6958           type: string
6959           example: __CLOUD-OWNER__
6960         - name: cloud-region-id
6961           in: path
6962           description: Identifier used by the vendor for the region. Second part of composite key
6963           required: true
6964           type: string
6965           example: __CLOUD-REGION-ID__
6966         - name: network-uuid
6967           in: path
6968           description: UUID of the network. Unique across a cloud-region
6969           required: true
6970           type: string
6971           example: __NETWORK-UUID__
6972         - name: body
6973           in: body
6974           description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
6975           required: true
6976           schema:
6977             $ref: "#/definitions/oam-network"
6978     patch:
6979       tags:
6980         - CloudInfrastructure
6981       summary: update an existing oam-network
6982       description: |
6983         Update an existing oam-network
6984         #
6985         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6986         The PUT operation will entirely replace an existing object.
6987         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6988         #
6989         Other differences between PUT and PATCH are:
6990         #
6991         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6992         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6993         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6994       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
6995       consumes:
6996         - application/json
6997         - application/xml
6998       produces:
6999         - application/json
7000         - application/xml
7001       responses:
7002         "default":
7003           description: Response codes found in [response codes](https://wiki.onap.org/).
7004       parameters:
7005         - name: cloud-owner
7006           in: path
7007           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7008           required: true
7009           type: string
7010           example: __CLOUD-OWNER__
7011         - name: cloud-region-id
7012           in: path
7013           description: Identifier used by the vendor for the region. Second part of composite key
7014           required: true
7015           type: string
7016           example: __CLOUD-REGION-ID__
7017         - name: network-uuid
7018           in: path
7019           description: UUID of the network. Unique across a cloud-region
7020           required: true
7021           type: string
7022           example: __NETWORK-UUID__
7023         - name: body
7024           in: body
7025           description: oam-network object that needs to be updated.
7026           required: true
7027           schema:
7028             $ref: "#/patchDefinitions/oam-network"
7029     delete:
7030       tags:
7031         - CloudInfrastructure
7032       summary: delete an existing oam-network
7033       description: delete an existing oam-network
7034       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7035       consumes:
7036         - application/json
7037         - application/xml
7038       produces:
7039         - application/json
7040         - application/xml
7041       responses:
7042         "default":
7043           description: Response codes found in [response codes](https://wiki.onap.org/).
7044       parameters:
7045         - name: cloud-owner
7046           in: path
7047           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7048           required: true
7049           type: string
7050           example: __CLOUD-OWNER__
7051         - name: cloud-region-id
7052           in: path
7053           description: Identifier used by the vendor for the region. Second part of composite key
7054           required: true
7055           type: string
7056           example: __CLOUD-REGION-ID__
7057         - name: network-uuid
7058           in: path
7059           description: UUID of the network. Unique across a cloud-region
7060           required: true
7061           type: string
7062           example: __NETWORK-UUID__
7063         - name: resource-version
7064           in: query
7065           description: resource-version for concurrency
7066           required: true
7067           type: string
7068   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
7069     get:
7070       tags:
7071         - CloudInfrastructure
7072       summary: returns oam-networks
7073       description: returns oam-networks
7074       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
7075       produces:
7076         - application/json
7077         - application/xml
7078       responses:
7079         "200":
7080           description: successful operation
7081           schema:
7082               $ref: "#/getDefinitions/oam-networks"
7083         "default":
7084           description: Response codes found in [response codes](https://wiki.onap.org/).
7085       parameters:
7086         - name: cloud-owner
7087           in: path
7088           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7089           required: true
7090           type: string
7091           example: __CLOUD-OWNER__
7092         - name: cloud-region-id
7093           in: path
7094           description: Identifier used by the vendor for the region. Second part of composite key
7095           required: true
7096           type: string
7097           example: __CLOUD-REGION-ID__
7098         - name: network-uuid
7099           in: query
7100           description:
7101           required: false
7102           type: string
7103         - name: network-name
7104           in: query
7105           description:
7106           required: false
7107           type: string
7108         - name: cvlan-tag
7109           in: query
7110           description:
7111           required: false
7112           type: integer
7113           format: int64
7114   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
7115     put:
7116       tags:
7117         - CloudInfrastructure
7118       summary: see node definition for valid relationships
7119       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7120       consumes:
7121         - application/json
7122         - application/xml
7123       produces:
7124         - application/json
7125         - application/xml
7126       responses:
7127         "default":
7128           description: Response codes found in [response codes](https://wiki.onap.org/).
7129       parameters:
7130         - name: cloud-owner
7131           in: path
7132           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7133           required: true
7134           type: string
7135           example: __CLOUD-OWNER__
7136         - name: cloud-region-id
7137           in: path
7138           description: Identifier used by the vendor for the region. Second part of composite key
7139           required: true
7140           type: string
7141           example: __CLOUD-REGION-ID__
7142         - name: availability-zone-name
7143           in: path
7144           description: Name of the availability zone.  Unique across a cloud region
7145           required: true
7146           type: string
7147           example: __AVAILABILITY-ZONE-NAME__
7148         - name: body
7149           in: body
7150           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7151           required: true
7152           schema:
7153             $ref: "#/definitions/relationship"
7154     delete:
7155       tags:
7156         - CloudInfrastructure
7157       summary: delete an existing relationship
7158       description: delete an existing relationship
7159       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7160       consumes:
7161         - application/json
7162         - application/xml
7163       produces:
7164         - application/json
7165         - application/xml
7166       responses:
7167         "default":
7168           description: Response codes found in [response codes](https://wiki.onap.org/).
7169       parameters:
7170         - name: cloud-owner
7171           in: path
7172           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7173           required: true
7174           type: string
7175           example: __CLOUD-OWNER__
7176         - name: cloud-region-id
7177           in: path
7178           description: Identifier used by the vendor for the region. Second part of composite key
7179           required: true
7180           type: string
7181           example: __CLOUD-REGION-ID__
7182         - name: availability-zone-name
7183           in: path
7184           description: Name of the availability zone.  Unique across a cloud region
7185           required: true
7186           type: string
7187           example: __AVAILABILITY-ZONE-NAME__
7188   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
7189     get:
7190       tags:
7191         - CloudInfrastructure
7192       summary: returns availability-zone
7193       description: returns availability-zone
7194       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7195       produces:
7196         - application/json
7197         - application/xml
7198       responses:
7199         "200":
7200           description: successful operation
7201           schema:
7202               $ref: "#/getDefinitions/availability-zone"
7203         "default":
7204           description: Response codes found in [response codes](https://wiki.onap.org/).
7205       parameters:
7206         - name: cloud-owner
7207           in: path
7208           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7209           required: true
7210           type: string
7211           example: __CLOUD-OWNER__
7212         - name: cloud-region-id
7213           in: path
7214           description: Identifier used by the vendor for the region. Second part of composite key
7215           required: true
7216           type: string
7217           example: __CLOUD-REGION-ID__
7218         - name: availability-zone-name
7219           in: path
7220           description: Name of the availability zone.  Unique across a cloud region
7221           required: true
7222           type: string
7223           example: __AVAILABILITY-ZONE-NAME__
7224     put:
7225       tags:
7226         - CloudInfrastructure
7227       summary: create or update an existing availability-zone
7228       description: |
7229         Create or update an existing availability-zone.
7230         #
7231         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7232       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7233       consumes:
7234         - application/json
7235         - application/xml
7236       produces:
7237         - application/json
7238         - application/xml
7239       responses:
7240         "default":
7241           description: Response codes found in [response codes](https://wiki.onap.org/).
7242       parameters:
7243         - name: cloud-owner
7244           in: path
7245           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7246           required: true
7247           type: string
7248           example: __CLOUD-OWNER__
7249         - name: cloud-region-id
7250           in: path
7251           description: Identifier used by the vendor for the region. Second part of composite key
7252           required: true
7253           type: string
7254           example: __CLOUD-REGION-ID__
7255         - name: availability-zone-name
7256           in: path
7257           description: Name of the availability zone.  Unique across a cloud region
7258           required: true
7259           type: string
7260           example: __AVAILABILITY-ZONE-NAME__
7261         - name: body
7262           in: body
7263           description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7264           required: true
7265           schema:
7266             $ref: "#/definitions/availability-zone"
7267     patch:
7268       tags:
7269         - CloudInfrastructure
7270       summary: update an existing availability-zone
7271       description: |
7272         Update an existing availability-zone
7273         #
7274         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7275         The PUT operation will entirely replace an existing object.
7276         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7277         #
7278         Other differences between PUT and PATCH are:
7279         #
7280         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7281         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7282         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7283       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7284       consumes:
7285         - application/json
7286         - application/xml
7287       produces:
7288         - application/json
7289         - application/xml
7290       responses:
7291         "default":
7292           description: Response codes found in [response codes](https://wiki.onap.org/).
7293       parameters:
7294         - name: cloud-owner
7295           in: path
7296           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7297           required: true
7298           type: string
7299           example: __CLOUD-OWNER__
7300         - name: cloud-region-id
7301           in: path
7302           description: Identifier used by the vendor for the region. Second part of composite key
7303           required: true
7304           type: string
7305           example: __CLOUD-REGION-ID__
7306         - name: availability-zone-name
7307           in: path
7308           description: Name of the availability zone.  Unique across a cloud region
7309           required: true
7310           type: string
7311           example: __AVAILABILITY-ZONE-NAME__
7312         - name: body
7313           in: body
7314           description: availability-zone object that needs to be updated.
7315           required: true
7316           schema:
7317             $ref: "#/patchDefinitions/availability-zone"
7318     delete:
7319       tags:
7320         - CloudInfrastructure
7321       summary: delete an existing availability-zone
7322       description: delete an existing availability-zone
7323       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7324       consumes:
7325         - application/json
7326         - application/xml
7327       produces:
7328         - application/json
7329         - application/xml
7330       responses:
7331         "default":
7332           description: Response codes found in [response codes](https://wiki.onap.org/).
7333       parameters:
7334         - name: cloud-owner
7335           in: path
7336           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7337           required: true
7338           type: string
7339           example: __CLOUD-OWNER__
7340         - name: cloud-region-id
7341           in: path
7342           description: Identifier used by the vendor for the region. Second part of composite key
7343           required: true
7344           type: string
7345           example: __CLOUD-REGION-ID__
7346         - name: availability-zone-name
7347           in: path
7348           description: Name of the availability zone.  Unique across a cloud region
7349           required: true
7350           type: string
7351           example: __AVAILABILITY-ZONE-NAME__
7352         - name: resource-version
7353           in: query
7354           description: resource-version for concurrency
7355           required: true
7356           type: string
7357   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
7358     get:
7359       tags:
7360         - CloudInfrastructure
7361       summary: returns availability-zones
7362       description: returns availability-zones
7363       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
7364       produces:
7365         - application/json
7366         - application/xml
7367       responses:
7368         "200":
7369           description: successful operation
7370           schema:
7371               $ref: "#/getDefinitions/availability-zones"
7372         "default":
7373           description: Response codes found in [response codes](https://wiki.onap.org/).
7374       parameters:
7375         - name: cloud-owner
7376           in: path
7377           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7378           required: true
7379           type: string
7380           example: __CLOUD-OWNER__
7381         - name: cloud-region-id
7382           in: path
7383           description: Identifier used by the vendor for the region. Second part of composite key
7384           required: true
7385           type: string
7386           example: __CLOUD-REGION-ID__
7387         - name: availability-zone-name
7388           in: query
7389           description:
7390           required: false
7391           type: string
7392   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
7393     put:
7394       tags:
7395         - CloudInfrastructure
7396       summary: see node definition for valid relationships
7397       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7398       consumes:
7399         - application/json
7400         - application/xml
7401       produces:
7402         - application/json
7403         - application/xml
7404       responses:
7405         "default":
7406           description: Response codes found in [response codes](https://wiki.onap.org/).
7407       parameters:
7408         - name: cloud-owner
7409           in: path
7410           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7411           required: true
7412           type: string
7413           example: __CLOUD-OWNER__
7414         - name: cloud-region-id
7415           in: path
7416           description: Identifier used by the vendor for the region. Second part of composite key
7417           required: true
7418           type: string
7419           example: __CLOUD-REGION-ID__
7420         - name: body
7421           in: body
7422           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegion.json)
7423           required: true
7424           schema:
7425             $ref: "#/definitions/relationship"
7426     delete:
7427       tags:
7428         - CloudInfrastructure
7429       summary: delete an existing relationship
7430       description: delete an existing relationship
7431       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7432       consumes:
7433         - application/json
7434         - application/xml
7435       produces:
7436         - application/json
7437         - application/xml
7438       responses:
7439         "default":
7440           description: Response codes found in [response codes](https://wiki.onap.org/).
7441       parameters:
7442         - name: cloud-owner
7443           in: path
7444           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7445           required: true
7446           type: string
7447           example: __CLOUD-OWNER__
7448         - name: cloud-region-id
7449           in: path
7450           description: Identifier used by the vendor for the region. Second part of composite key
7451           required: true
7452           type: string
7453           example: __CLOUD-REGION-ID__
7454   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
7455     put:
7456       tags:
7457         - CloudInfrastructure
7458       summary: see node definition for valid relationships
7459       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
7460       consumes:
7461         - application/json
7462         - application/xml
7463       produces:
7464         - application/json
7465         - application/xml
7466       responses:
7467         "default":
7468           description: Response codes found in [response codes](https://wiki.onap.org/).
7469       parameters:
7470         - name: cloud-owner
7471           in: path
7472           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7473           required: true
7474           type: string
7475           example: __CLOUD-OWNER__
7476         - name: cloud-region-id
7477           in: path
7478           description: Identifier used by the vendor for the region. Second part of composite key
7479           required: true
7480           type: string
7481           example: __CLOUD-REGION-ID__
7482         - name: vip-ipv4-address
7483           in: path
7484           description: IP address
7485           required: true
7486           type: string
7487           example: __VIP-IPV4-ADDRESS__
7488         - name: body
7489           in: body
7490           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
7491           required: true
7492           schema:
7493             $ref: "#/definitions/relationship"
7494     delete:
7495       tags:
7496         - CloudInfrastructure
7497       summary: delete an existing relationship
7498       description: delete an existing relationship
7499       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
7500       consumes:
7501         - application/json
7502         - application/xml
7503       produces:
7504         - application/json
7505         - application/xml
7506       responses:
7507         "default":
7508           description: Response codes found in [response codes](https://wiki.onap.org/).
7509       parameters:
7510         - name: cloud-owner
7511           in: path
7512           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7513           required: true
7514           type: string
7515           example: __CLOUD-OWNER__
7516         - name: cloud-region-id
7517           in: path
7518           description: Identifier used by the vendor for the region. Second part of composite key
7519           required: true
7520           type: string
7521           example: __CLOUD-REGION-ID__
7522         - name: vip-ipv4-address
7523           in: path
7524           description: IP address
7525           required: true
7526           type: string
7527           example: __VIP-IPV4-ADDRESS__
7528   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
7529     get:
7530       tags:
7531         - CloudInfrastructure
7532       summary: returns vip-ipv4-address-list
7533       description: returns vip-ipv4-address-list
7534       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7535       produces:
7536         - application/json
7537         - application/xml
7538       responses:
7539         "200":
7540           description: successful operation
7541           schema:
7542               $ref: "#/getDefinitions/vip-ipv4-address-list"
7543         "default":
7544           description: Response codes found in [response codes](https://wiki.onap.org/).
7545       parameters:
7546         - name: cloud-owner
7547           in: path
7548           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7549           required: true
7550           type: string
7551           example: __CLOUD-OWNER__
7552         - name: cloud-region-id
7553           in: path
7554           description: Identifier used by the vendor for the region. Second part of composite key
7555           required: true
7556           type: string
7557           example: __CLOUD-REGION-ID__
7558         - name: vip-ipv4-address
7559           in: path
7560           description: IP address
7561           required: true
7562           type: string
7563           example: __VIP-IPV4-ADDRESS__
7564     put:
7565       tags:
7566         - CloudInfrastructure
7567       summary: create or update an existing vip-ipv4-address-list
7568       description: |
7569         Create or update an existing vip-ipv4-address-list.
7570         #
7571         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7572       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7573       consumes:
7574         - application/json
7575         - application/xml
7576       produces:
7577         - application/json
7578         - application/xml
7579       responses:
7580         "default":
7581           description: Response codes found in [response codes](https://wiki.onap.org/).
7582       parameters:
7583         - name: cloud-owner
7584           in: path
7585           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7586           required: true
7587           type: string
7588           example: __CLOUD-OWNER__
7589         - name: cloud-region-id
7590           in: path
7591           description: Identifier used by the vendor for the region. Second part of composite key
7592           required: true
7593           type: string
7594           example: __CLOUD-REGION-ID__
7595         - name: vip-ipv4-address
7596           in: path
7597           description: IP address
7598           required: true
7599           type: string
7600           example: __VIP-IPV4-ADDRESS__
7601         - name: body
7602           in: body
7603           description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
7604           required: true
7605           schema:
7606             $ref: "#/definitions/vip-ipv4-address-list"
7607     patch:
7608       tags:
7609         - CloudInfrastructure
7610       summary: update an existing vip-ipv4-address-list
7611       description: |
7612         Update an existing vip-ipv4-address-list
7613         #
7614         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7615         The PUT operation will entirely replace an existing object.
7616         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7617         #
7618         Other differences between PUT and PATCH are:
7619         #
7620         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7621         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7622         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7623       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7624       consumes:
7625         - application/json
7626         - application/xml
7627       produces:
7628         - application/json
7629         - application/xml
7630       responses:
7631         "default":
7632           description: Response codes found in [response codes](https://wiki.onap.org/).
7633       parameters:
7634         - name: cloud-owner
7635           in: path
7636           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7637           required: true
7638           type: string
7639           example: __CLOUD-OWNER__
7640         - name: cloud-region-id
7641           in: path
7642           description: Identifier used by the vendor for the region. Second part of composite key
7643           required: true
7644           type: string
7645           example: __CLOUD-REGION-ID__
7646         - name: vip-ipv4-address
7647           in: path
7648           description: IP address
7649           required: true
7650           type: string
7651           example: __VIP-IPV4-ADDRESS__
7652         - name: body
7653           in: body
7654           description: vip-ipv4-address-list object that needs to be updated.
7655           required: true
7656           schema:
7657             $ref: "#/patchDefinitions/vip-ipv4-address-list"
7658     delete:
7659       tags:
7660         - CloudInfrastructure
7661       summary: delete an existing vip-ipv4-address-list
7662       description: delete an existing vip-ipv4-address-list
7663       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
7664       consumes:
7665         - application/json
7666         - application/xml
7667       produces:
7668         - application/json
7669         - application/xml
7670       responses:
7671         "default":
7672           description: Response codes found in [response codes](https://wiki.onap.org/).
7673       parameters:
7674         - name: cloud-owner
7675           in: path
7676           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7677           required: true
7678           type: string
7679           example: __CLOUD-OWNER__
7680         - name: cloud-region-id
7681           in: path
7682           description: Identifier used by the vendor for the region. Second part of composite key
7683           required: true
7684           type: string
7685           example: __CLOUD-REGION-ID__
7686         - name: vip-ipv4-address
7687           in: path
7688           description: IP address
7689           required: true
7690           type: string
7691           example: __VIP-IPV4-ADDRESS__
7692         - name: resource-version
7693           in: query
7694           description: resource-version for concurrency
7695           required: true
7696           type: string
7697   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
7698     put:
7699       tags:
7700         - CloudInfrastructure
7701       summary: see node definition for valid relationships
7702       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
7703       consumes:
7704         - application/json
7705         - application/xml
7706       produces:
7707         - application/json
7708         - application/xml
7709       responses:
7710         "default":
7711           description: Response codes found in [response codes](https://wiki.onap.org/).
7712       parameters:
7713         - name: cloud-owner
7714           in: path
7715           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7716           required: true
7717           type: string
7718           example: __CLOUD-OWNER__
7719         - name: cloud-region-id
7720           in: path
7721           description: Identifier used by the vendor for the region. Second part of composite key
7722           required: true
7723           type: string
7724           example: __CLOUD-REGION-ID__
7725         - name: vip-ipv6-address
7726           in: path
7727           description: IP address
7728           required: true
7729           type: string
7730           example: __VIP-IPV6-ADDRESS__
7731         - name: body
7732           in: body
7733           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
7734           required: true
7735           schema:
7736             $ref: "#/definitions/relationship"
7737     delete:
7738       tags:
7739         - CloudInfrastructure
7740       summary: delete an existing relationship
7741       description: delete an existing relationship
7742       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
7743       consumes:
7744         - application/json
7745         - application/xml
7746       produces:
7747         - application/json
7748         - application/xml
7749       responses:
7750         "default":
7751           description: Response codes found in [response codes](https://wiki.onap.org/).
7752       parameters:
7753         - name: cloud-owner
7754           in: path
7755           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7756           required: true
7757           type: string
7758           example: __CLOUD-OWNER__
7759         - name: cloud-region-id
7760           in: path
7761           description: Identifier used by the vendor for the region. Second part of composite key
7762           required: true
7763           type: string
7764           example: __CLOUD-REGION-ID__
7765         - name: vip-ipv6-address
7766           in: path
7767           description: IP address
7768           required: true
7769           type: string
7770           example: __VIP-IPV6-ADDRESS__
7771   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
7772     get:
7773       tags:
7774         - CloudInfrastructure
7775       summary: returns vip-ipv6-address-list
7776       description: returns vip-ipv6-address-list
7777       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7778       produces:
7779         - application/json
7780         - application/xml
7781       responses:
7782         "200":
7783           description: successful operation
7784           schema:
7785               $ref: "#/getDefinitions/vip-ipv6-address-list"
7786         "default":
7787           description: Response codes found in [response codes](https://wiki.onap.org/).
7788       parameters:
7789         - name: cloud-owner
7790           in: path
7791           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7792           required: true
7793           type: string
7794           example: __CLOUD-OWNER__
7795         - name: cloud-region-id
7796           in: path
7797           description: Identifier used by the vendor for the region. Second part of composite key
7798           required: true
7799           type: string
7800           example: __CLOUD-REGION-ID__
7801         - name: vip-ipv6-address
7802           in: path
7803           description: IP address
7804           required: true
7805           type: string
7806           example: __VIP-IPV6-ADDRESS__
7807     put:
7808       tags:
7809         - CloudInfrastructure
7810       summary: create or update an existing vip-ipv6-address-list
7811       description: |
7812         Create or update an existing vip-ipv6-address-list.
7813         #
7814         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7815       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7816       consumes:
7817         - application/json
7818         - application/xml
7819       produces:
7820         - application/json
7821         - application/xml
7822       responses:
7823         "default":
7824           description: Response codes found in [response codes](https://wiki.onap.org/).
7825       parameters:
7826         - name: cloud-owner
7827           in: path
7828           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7829           required: true
7830           type: string
7831           example: __CLOUD-OWNER__
7832         - name: cloud-region-id
7833           in: path
7834           description: Identifier used by the vendor for the region. Second part of composite key
7835           required: true
7836           type: string
7837           example: __CLOUD-REGION-ID__
7838         - name: vip-ipv6-address
7839           in: path
7840           description: IP address
7841           required: true
7842           type: string
7843           example: __VIP-IPV6-ADDRESS__
7844         - name: body
7845           in: body
7846           description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
7847           required: true
7848           schema:
7849             $ref: "#/definitions/vip-ipv6-address-list"
7850     patch:
7851       tags:
7852         - CloudInfrastructure
7853       summary: update an existing vip-ipv6-address-list
7854       description: |
7855         Update an existing vip-ipv6-address-list
7856         #
7857         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7858         The PUT operation will entirely replace an existing object.
7859         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7860         #
7861         Other differences between PUT and PATCH are:
7862         #
7863         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7864         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7865         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7866       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7867       consumes:
7868         - application/json
7869         - application/xml
7870       produces:
7871         - application/json
7872         - application/xml
7873       responses:
7874         "default":
7875           description: Response codes found in [response codes](https://wiki.onap.org/).
7876       parameters:
7877         - name: cloud-owner
7878           in: path
7879           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7880           required: true
7881           type: string
7882           example: __CLOUD-OWNER__
7883         - name: cloud-region-id
7884           in: path
7885           description: Identifier used by the vendor for the region. Second part of composite key
7886           required: true
7887           type: string
7888           example: __CLOUD-REGION-ID__
7889         - name: vip-ipv6-address
7890           in: path
7891           description: IP address
7892           required: true
7893           type: string
7894           example: __VIP-IPV6-ADDRESS__
7895         - name: body
7896           in: body
7897           description: vip-ipv6-address-list object that needs to be updated.
7898           required: true
7899           schema:
7900             $ref: "#/patchDefinitions/vip-ipv6-address-list"
7901     delete:
7902       tags:
7903         - CloudInfrastructure
7904       summary: delete an existing vip-ipv6-address-list
7905       description: delete an existing vip-ipv6-address-list
7906       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
7907       consumes:
7908         - application/json
7909         - application/xml
7910       produces:
7911         - application/json
7912         - application/xml
7913       responses:
7914         "default":
7915           description: Response codes found in [response codes](https://wiki.onap.org/).
7916       parameters:
7917         - name: cloud-owner
7918           in: path
7919           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7920           required: true
7921           type: string
7922           example: __CLOUD-OWNER__
7923         - name: cloud-region-id
7924           in: path
7925           description: Identifier used by the vendor for the region. Second part of composite key
7926           required: true
7927           type: string
7928           example: __CLOUD-REGION-ID__
7929         - name: vip-ipv6-address
7930           in: path
7931           description: IP address
7932           required: true
7933           type: string
7934           example: __VIP-IPV6-ADDRESS__
7935         - name: resource-version
7936           in: query
7937           description: resource-version for concurrency
7938           required: true
7939           type: string
7940   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship:
7941     put:
7942       tags:
7943         - CloudInfrastructure
7944       summary: see node definition for valid relationships
7945       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
7946       consumes:
7947         - application/json
7948         - application/xml
7949       produces:
7950         - application/json
7951         - application/xml
7952       responses:
7953         "default":
7954           description: Response codes found in [response codes](https://wiki.onap.org/).
7955       parameters:
7956         - name: cloud-owner
7957           in: path
7958           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7959           required: true
7960           type: string
7961           example: __CLOUD-OWNER__
7962         - name: cloud-region-id
7963           in: path
7964           description: Identifier used by the vendor for the region. Second part of composite key
7965           required: true
7966           type: string
7967           example: __CLOUD-REGION-ID__
7968         - name: hpa-capability-id
7969           in: path
7970           description: UUID to uniquely identify a HPA capability
7971           required: true
7972           type: string
7973           example: __HPA-CAPABILITY-ID__
7974         - name: body
7975           in: body
7976           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
7977           required: true
7978           schema:
7979             $ref: "#/definitions/relationship"
7980     delete:
7981       tags:
7982         - CloudInfrastructure
7983       summary: delete an existing relationship
7984       description: delete an existing relationship
7985       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityRelationshipListRelationship
7986       consumes:
7987         - application/json
7988         - application/xml
7989       produces:
7990         - application/json
7991         - application/xml
7992       responses:
7993         "default":
7994           description: Response codes found in [response codes](https://wiki.onap.org/).
7995       parameters:
7996         - name: cloud-owner
7997           in: path
7998           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7999           required: true
8000           type: string
8001           example: __CLOUD-OWNER__
8002         - name: cloud-region-id
8003           in: path
8004           description: Identifier used by the vendor for the region. Second part of composite key
8005           required: true
8006           type: string
8007           example: __CLOUD-REGION-ID__
8008         - name: hpa-capability-id
8009           in: path
8010           description: UUID to uniquely identify a HPA capability
8011           required: true
8012           type: string
8013           example: __HPA-CAPABILITY-ID__
8014   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship:
8015     put:
8016       tags:
8017         - CloudInfrastructure
8018       summary: see node definition for valid relationships
8019       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
8020       consumes:
8021         - application/json
8022         - application/xml
8023       produces:
8024         - application/json
8025         - application/xml
8026       responses:
8027         "default":
8028           description: Response codes found in [response codes](https://wiki.onap.org/).
8029       parameters:
8030         - name: cloud-owner
8031           in: path
8032           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8033           required: true
8034           type: string
8035           example: __CLOUD-OWNER__
8036         - name: cloud-region-id
8037           in: path
8038           description: Identifier used by the vendor for the region. Second part of composite key
8039           required: true
8040           type: string
8041           example: __CLOUD-REGION-ID__
8042         - name: hpa-capability-id
8043           in: path
8044           description: UUID to uniquely identify a HPA capability
8045           required: true
8046           type: string
8047           example: __HPA-CAPABILITY-ID__
8048         - name: hpa-attribute-key
8049           in: path
8050           description: name of the specific HPA attribute
8051           required: true
8052           type: string
8053           example: __HPA-ATTRIBUTE-KEY__
8054         - name: body
8055           in: body
8056           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
8057           required: true
8058           schema:
8059             $ref: "#/definitions/relationship"
8060     delete:
8061       tags:
8062         - CloudInfrastructure
8063       summary: delete an existing relationship
8064       description: delete an existing relationship
8065       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributesRelationshipListRelationship
8066       consumes:
8067         - application/json
8068         - application/xml
8069       produces:
8070         - application/json
8071         - application/xml
8072       responses:
8073         "default":
8074           description: Response codes found in [response codes](https://wiki.onap.org/).
8075       parameters:
8076         - name: cloud-owner
8077           in: path
8078           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8079           required: true
8080           type: string
8081           example: __CLOUD-OWNER__
8082         - name: cloud-region-id
8083           in: path
8084           description: Identifier used by the vendor for the region. Second part of composite key
8085           required: true
8086           type: string
8087           example: __CLOUD-REGION-ID__
8088         - name: hpa-capability-id
8089           in: path
8090           description: UUID to uniquely identify a HPA capability
8091           required: true
8092           type: string
8093           example: __HPA-CAPABILITY-ID__
8094         - name: hpa-attribute-key
8095           in: path
8096           description: name of the specific HPA attribute
8097           required: true
8098           type: string
8099           example: __HPA-ATTRIBUTE-KEY__
8100   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}:
8101     get:
8102       tags:
8103         - CloudInfrastructure
8104       summary: returns hpa-feature-attributes
8105       description: returns hpa-feature-attributes
8106       operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8107       produces:
8108         - application/json
8109         - application/xml
8110       responses:
8111         "200":
8112           description: successful operation
8113           schema:
8114               $ref: "#/getDefinitions/hpa-feature-attributes"
8115         "default":
8116           description: Response codes found in [response codes](https://wiki.onap.org/).
8117       parameters:
8118         - name: cloud-owner
8119           in: path
8120           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8121           required: true
8122           type: string
8123           example: __CLOUD-OWNER__
8124         - name: cloud-region-id
8125           in: path
8126           description: Identifier used by the vendor for the region. Second part of composite key
8127           required: true
8128           type: string
8129           example: __CLOUD-REGION-ID__
8130         - name: hpa-capability-id
8131           in: path
8132           description: UUID to uniquely identify a HPA capability
8133           required: true
8134           type: string
8135           example: __HPA-CAPABILITY-ID__
8136         - name: hpa-attribute-key
8137           in: path
8138           description: name of the specific HPA attribute
8139           required: true
8140           type: string
8141           example: __HPA-ATTRIBUTE-KEY__
8142     put:
8143       tags:
8144         - CloudInfrastructure
8145       summary: create or update an existing hpa-feature-attributes
8146       description: |
8147         Create or update an existing hpa-feature-attributes.
8148         #
8149         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8150       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8151       consumes:
8152         - application/json
8153         - application/xml
8154       produces:
8155         - application/json
8156         - application/xml
8157       responses:
8158         "default":
8159           description: Response codes found in [response codes](https://wiki.onap.org/).
8160       parameters:
8161         - name: cloud-owner
8162           in: path
8163           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8164           required: true
8165           type: string
8166           example: __CLOUD-OWNER__
8167         - name: cloud-region-id
8168           in: path
8169           description: Identifier used by the vendor for the region. Second part of composite key
8170           required: true
8171           type: string
8172           example: __CLOUD-REGION-ID__
8173         - name: hpa-capability-id
8174           in: path
8175           description: UUID to uniquely identify a HPA capability
8176           required: true
8177           type: string
8178           example: __HPA-CAPABILITY-ID__
8179         - name: hpa-attribute-key
8180           in: path
8181           description: name of the specific HPA attribute
8182           required: true
8183           type: string
8184           example: __HPA-ATTRIBUTE-KEY__
8185         - name: body
8186           in: body
8187           description: hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)
8188           required: true
8189           schema:
8190             $ref: "#/definitions/hpa-feature-attributes"
8191     patch:
8192       tags:
8193         - CloudInfrastructure
8194       summary: update an existing hpa-feature-attributes
8195       description: |
8196         Update an existing hpa-feature-attributes
8197         #
8198         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8199         The PUT operation will entirely replace an existing object.
8200         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8201         #
8202         Other differences between PUT and PATCH are:
8203         #
8204         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8205         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8206         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8207       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8208       consumes:
8209         - application/json
8210         - application/xml
8211       produces:
8212         - application/json
8213         - application/xml
8214       responses:
8215         "default":
8216           description: Response codes found in [response codes](https://wiki.onap.org/).
8217       parameters:
8218         - name: cloud-owner
8219           in: path
8220           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8221           required: true
8222           type: string
8223           example: __CLOUD-OWNER__
8224         - name: cloud-region-id
8225           in: path
8226           description: Identifier used by the vendor for the region. Second part of composite key
8227           required: true
8228           type: string
8229           example: __CLOUD-REGION-ID__
8230         - name: hpa-capability-id
8231           in: path
8232           description: UUID to uniquely identify a HPA capability
8233           required: true
8234           type: string
8235           example: __HPA-CAPABILITY-ID__
8236         - name: hpa-attribute-key
8237           in: path
8238           description: name of the specific HPA attribute
8239           required: true
8240           type: string
8241           example: __HPA-ATTRIBUTE-KEY__
8242         - name: body
8243           in: body
8244           description: hpa-feature-attributes object that needs to be updated.
8245           required: true
8246           schema:
8247             $ref: "#/patchDefinitions/hpa-feature-attributes"
8248     delete:
8249       tags:
8250         - CloudInfrastructure
8251       summary: delete an existing hpa-feature-attributes
8252       description: delete an existing hpa-feature-attributes
8253       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapabilityHpaFeatureAttributes
8254       consumes:
8255         - application/json
8256         - application/xml
8257       produces:
8258         - application/json
8259         - application/xml
8260       responses:
8261         "default":
8262           description: Response codes found in [response codes](https://wiki.onap.org/).
8263       parameters:
8264         - name: cloud-owner
8265           in: path
8266           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8267           required: true
8268           type: string
8269           example: __CLOUD-OWNER__
8270         - name: cloud-region-id
8271           in: path
8272           description: Identifier used by the vendor for the region. Second part of composite key
8273           required: true
8274           type: string
8275           example: __CLOUD-REGION-ID__
8276         - name: hpa-capability-id
8277           in: path
8278           description: UUID to uniquely identify a HPA capability
8279           required: true
8280           type: string
8281           example: __HPA-CAPABILITY-ID__
8282         - name: hpa-attribute-key
8283           in: path
8284           description: name of the specific HPA attribute
8285           required: true
8286           type: string
8287           example: __HPA-ATTRIBUTE-KEY__
8288         - name: resource-version
8289           in: query
8290           description: resource-version for concurrency
8291           required: true
8292           type: string
8293   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}:
8294     get:
8295       tags:
8296         - CloudInfrastructure
8297       summary: returns hpa-capability
8298       description: returns hpa-capability
8299       operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8300       produces:
8301         - application/json
8302         - application/xml
8303       responses:
8304         "200":
8305           description: successful operation
8306           schema:
8307               $ref: "#/getDefinitions/hpa-capability"
8308         "default":
8309           description: Response codes found in [response codes](https://wiki.onap.org/).
8310       parameters:
8311         - name: cloud-owner
8312           in: path
8313           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8314           required: true
8315           type: string
8316           example: __CLOUD-OWNER__
8317         - name: cloud-region-id
8318           in: path
8319           description: Identifier used by the vendor for the region. Second part of composite key
8320           required: true
8321           type: string
8322           example: __CLOUD-REGION-ID__
8323         - name: hpa-capability-id
8324           in: path
8325           description: UUID to uniquely identify a HPA capability
8326           required: true
8327           type: string
8328           example: __HPA-CAPABILITY-ID__
8329     put:
8330       tags:
8331         - CloudInfrastructure
8332       summary: create or update an existing hpa-capability
8333       description: |
8334         Create or update an existing hpa-capability.
8335         #
8336         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8337       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8338       consumes:
8339         - application/json
8340         - application/xml
8341       produces:
8342         - application/json
8343         - application/xml
8344       responses:
8345         "default":
8346           description: Response codes found in [response codes](https://wiki.onap.org/).
8347       parameters:
8348         - name: cloud-owner
8349           in: path
8350           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8351           required: true
8352           type: string
8353           example: __CLOUD-OWNER__
8354         - name: cloud-region-id
8355           in: path
8356           description: Identifier used by the vendor for the region. Second part of composite key
8357           required: true
8358           type: string
8359           example: __CLOUD-REGION-ID__
8360         - name: hpa-capability-id
8361           in: path
8362           description: UUID to uniquely identify a HPA capability
8363           required: true
8364           type: string
8365           example: __HPA-CAPABILITY-ID__
8366         - name: body
8367           in: body
8368           description: hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability.json)
8369           required: true
8370           schema:
8371             $ref: "#/definitions/hpa-capability"
8372     patch:
8373       tags:
8374         - CloudInfrastructure
8375       summary: update an existing hpa-capability
8376       description: |
8377         Update an existing hpa-capability
8378         #
8379         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8380         The PUT operation will entirely replace an existing object.
8381         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8382         #
8383         Other differences between PUT and PATCH are:
8384         #
8385         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8386         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8387         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8388       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8389       consumes:
8390         - application/json
8391         - application/xml
8392       produces:
8393         - application/json
8394         - application/xml
8395       responses:
8396         "default":
8397           description: Response codes found in [response codes](https://wiki.onap.org/).
8398       parameters:
8399         - name: cloud-owner
8400           in: path
8401           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8402           required: true
8403           type: string
8404           example: __CLOUD-OWNER__
8405         - name: cloud-region-id
8406           in: path
8407           description: Identifier used by the vendor for the region. Second part of composite key
8408           required: true
8409           type: string
8410           example: __CLOUD-REGION-ID__
8411         - name: hpa-capability-id
8412           in: path
8413           description: UUID to uniquely identify a HPA capability
8414           required: true
8415           type: string
8416           example: __HPA-CAPABILITY-ID__
8417         - name: body
8418           in: body
8419           description: hpa-capability object that needs to be updated.
8420           required: true
8421           schema:
8422             $ref: "#/patchDefinitions/hpa-capability"
8423     delete:
8424       tags:
8425         - CloudInfrastructure
8426       summary: delete an existing hpa-capability
8427       description: delete an existing hpa-capability
8428       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionHpaCapabilitiesHpaCapability
8429       consumes:
8430         - application/json
8431         - application/xml
8432       produces:
8433         - application/json
8434         - application/xml
8435       responses:
8436         "default":
8437           description: Response codes found in [response codes](https://wiki.onap.org/).
8438       parameters:
8439         - name: cloud-owner
8440           in: path
8441           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8442           required: true
8443           type: string
8444           example: __CLOUD-OWNER__
8445         - name: cloud-region-id
8446           in: path
8447           description: Identifier used by the vendor for the region. Second part of composite key
8448           required: true
8449           type: string
8450           example: __CLOUD-REGION-ID__
8451         - name: hpa-capability-id
8452           in: path
8453           description: UUID to uniquely identify a HPA capability
8454           required: true
8455           type: string
8456           example: __HPA-CAPABILITY-ID__
8457         - name: resource-version
8458           in: query
8459           description: resource-version for concurrency
8460           required: true
8461           type: string
8462   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/hpa-capabilities:
8463     get:
8464       tags:
8465         - CloudInfrastructure
8466       summary: returns hpa-capabilities
8467       description: returns hpa-capabilities
8468       operationId: getCloudInfrastructureCloudRegionsCloudRegionHpaCapabilities
8469       produces:
8470         - application/json
8471         - application/xml
8472       responses:
8473         "200":
8474           description: successful operation
8475           schema:
8476               $ref: "#/getDefinitions/hpa-capabilities"
8477         "default":
8478           description: Response codes found in [response codes](https://wiki.onap.org/).
8479       parameters:
8480         - name: cloud-owner
8481           in: path
8482           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8483           required: true
8484           type: string
8485           example: __CLOUD-OWNER__
8486         - name: cloud-region-id
8487           in: path
8488           description: Identifier used by the vendor for the region. Second part of composite key
8489           required: true
8490           type: string
8491           example: __CLOUD-REGION-ID__
8492         - name: hpa-capability-id
8493           in: query
8494           description:
8495           required: false
8496           type: string
8497         - name: hpa-feature
8498           in: query
8499           description:
8500           required: false
8501           type: string
8502         - name: architecture
8503           in: query
8504           description:
8505           required: false
8506           type: string
8507   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
8508     put:
8509       tags:
8510         - CloudInfrastructure
8511       summary: see node definition for valid relationships
8512       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
8513       consumes:
8514         - application/json
8515         - application/xml
8516       produces:
8517         - application/json
8518         - application/xml
8519       responses:
8520         "default":
8521           description: Response codes found in [response codes](https://wiki.onap.org/).
8522       parameters:
8523         - name: cloud-owner
8524           in: path
8525           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8526           required: true
8527           type: string
8528           example: __CLOUD-OWNER__
8529         - name: cloud-region-id
8530           in: path
8531           description: Identifier used by the vendor for the region. Second part of composite key
8532           required: true
8533           type: string
8534           example: __CLOUD-REGION-ID__
8535         - name: esr-system-info-id
8536           in: path
8537           description: Unique ID of esr system info.
8538           required: true
8539           type: string
8540           example: __ESR-SYSTEM-INFO-ID__
8541         - name: body
8542           in: body
8543           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)
8544           required: true
8545           schema:
8546             $ref: "#/definitions/relationship"
8547     delete:
8548       tags:
8549         - CloudInfrastructure
8550       summary: delete an existing relationship
8551       description: delete an existing relationship
8552       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
8553       consumes:
8554         - application/json
8555         - application/xml
8556       produces:
8557         - application/json
8558         - application/xml
8559       responses:
8560         "default":
8561           description: Response codes found in [response codes](https://wiki.onap.org/).
8562       parameters:
8563         - name: cloud-owner
8564           in: path
8565           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8566           required: true
8567           type: string
8568           example: __CLOUD-OWNER__
8569         - name: cloud-region-id
8570           in: path
8571           description: Identifier used by the vendor for the region. Second part of composite key
8572           required: true
8573           type: string
8574           example: __CLOUD-REGION-ID__
8575         - name: esr-system-info-id
8576           in: path
8577           description: Unique ID of esr system info.
8578           required: true
8579           type: string
8580           example: __ESR-SYSTEM-INFO-ID__
8581   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
8582     get:
8583       tags:
8584         - CloudInfrastructure
8585       summary: returns esr-system-info
8586       description: returns esr-system-info
8587       operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
8588       produces:
8589         - application/json
8590         - application/xml
8591       responses:
8592         "200":
8593           description: successful operation
8594           schema:
8595               $ref: "#/getDefinitions/esr-system-info"
8596         "default":
8597           description: Response codes found in [response codes](https://wiki.onap.org/).
8598       parameters:
8599         - name: cloud-owner
8600           in: path
8601           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8602           required: true
8603           type: string
8604           example: __CLOUD-OWNER__
8605         - name: cloud-region-id
8606           in: path
8607           description: Identifier used by the vendor for the region. Second part of composite key
8608           required: true
8609           type: string
8610           example: __CLOUD-REGION-ID__
8611         - name: esr-system-info-id
8612           in: path
8613           description: Unique ID of esr system info.
8614           required: true
8615           type: string
8616           example: __ESR-SYSTEM-INFO-ID__
8617     put:
8618       tags:
8619         - CloudInfrastructure
8620       summary: create or update an existing esr-system-info
8621       description: |
8622         Create or update an existing esr-system-info.
8623         #
8624         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8625       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
8626       consumes:
8627         - application/json
8628         - application/xml
8629       produces:
8630         - application/json
8631         - application/xml
8632       responses:
8633         "default":
8634           description: Response codes found in [response codes](https://wiki.onap.org/).
8635       parameters:
8636         - name: cloud-owner
8637           in: path
8638           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8639           required: true
8640           type: string
8641           example: __CLOUD-OWNER__
8642         - name: cloud-region-id
8643           in: path
8644           description: Identifier used by the vendor for the region. Second part of composite key
8645           required: true
8646           type: string
8647           example: __CLOUD-REGION-ID__
8648         - name: esr-system-info-id
8649           in: path
8650           description: Unique ID of esr system info.
8651           required: true
8652           type: string
8653           example: __ESR-SYSTEM-INFO-ID__
8654         - name: body
8655           in: body
8656           description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)
8657           required: true
8658           schema:
8659             $ref: "#/definitions/esr-system-info"
8660     patch:
8661       tags:
8662         - CloudInfrastructure
8663       summary: update an existing esr-system-info
8664       description: |
8665         Update an existing esr-system-info
8666         #
8667         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8668         The PUT operation will entirely replace an existing object.
8669         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8670         #
8671         Other differences between PUT and PATCH are:
8672         #
8673         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8674         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8675         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8676       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
8677       consumes:
8678         - application/json
8679         - application/xml
8680       produces:
8681         - application/json
8682         - application/xml
8683       responses:
8684         "default":
8685           description: Response codes found in [response codes](https://wiki.onap.org/).
8686       parameters:
8687         - name: cloud-owner
8688           in: path
8689           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8690           required: true
8691           type: string
8692           example: __CLOUD-OWNER__
8693         - name: cloud-region-id
8694           in: path
8695           description: Identifier used by the vendor for the region. Second part of composite key
8696           required: true
8697           type: string
8698           example: __CLOUD-REGION-ID__
8699         - name: esr-system-info-id
8700           in: path
8701           description: Unique ID of esr system info.
8702           required: true
8703           type: string
8704           example: __ESR-SYSTEM-INFO-ID__
8705         - name: body
8706           in: body
8707           description: esr-system-info object that needs to be updated.
8708           required: true
8709           schema:
8710             $ref: "#/patchDefinitions/esr-system-info"
8711     delete:
8712       tags:
8713         - CloudInfrastructure
8714       summary: delete an existing esr-system-info
8715       description: delete an existing esr-system-info
8716       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
8717       consumes:
8718         - application/json
8719         - application/xml
8720       produces:
8721         - application/json
8722         - application/xml
8723       responses:
8724         "default":
8725           description: Response codes found in [response codes](https://wiki.onap.org/).
8726       parameters:
8727         - name: cloud-owner
8728           in: path
8729           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8730           required: true
8731           type: string
8732           example: __CLOUD-OWNER__
8733         - name: cloud-region-id
8734           in: path
8735           description: Identifier used by the vendor for the region. Second part of composite key
8736           required: true
8737           type: string
8738           example: __CLOUD-REGION-ID__
8739         - name: esr-system-info-id
8740           in: path
8741           description: Unique ID of esr system info.
8742           required: true
8743           type: string
8744           example: __ESR-SYSTEM-INFO-ID__
8745         - name: resource-version
8746           in: query
8747           description: resource-version for concurrency
8748           required: true
8749           type: string
8750   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list:
8751     get:
8752       tags:
8753         - CloudInfrastructure
8754       summary: returns esr-system-info-list
8755       description: returns esr-system-info-list
8756       operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList
8757       produces:
8758         - application/json
8759         - application/xml
8760       responses:
8761         "200":
8762           description: successful operation
8763           schema:
8764               $ref: "#/getDefinitions/esr-system-info-list"
8765         "default":
8766           description: Response codes found in [response codes](https://wiki.onap.org/).
8767       parameters:
8768         - name: cloud-owner
8769           in: path
8770           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8771           required: true
8772           type: string
8773           example: __CLOUD-OWNER__
8774         - name: cloud-region-id
8775           in: path
8776           description: Identifier used by the vendor for the region. Second part of composite key
8777           required: true
8778           type: string
8779           example: __CLOUD-REGION-ID__
8780         - name: esr-system-info-id
8781           in: query
8782           description:
8783           required: false
8784           type: string
8785         - name: system-name
8786           in: query
8787           description:
8788           required: false
8789           type: string
8790         - name: system-type
8791           in: query
8792           description:
8793           required: false
8794           type: string
8795   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
8796     get:
8797       tags:
8798         - CloudInfrastructure
8799       summary: returns cloud-region
8800       description: returns cloud-region
8801       operationId: getCloudInfrastructureCloudRegionsCloudRegion
8802       produces:
8803         - application/json
8804         - application/xml
8805       responses:
8806         "200":
8807           description: successful operation
8808           schema:
8809               $ref: "#/getDefinitions/cloud-region"
8810         "default":
8811           description: Response codes found in [response codes](https://wiki.onap.org/).
8812       parameters:
8813         - name: cloud-owner
8814           in: path
8815           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8816           required: true
8817           type: string
8818           example: __CLOUD-OWNER__
8819         - name: cloud-region-id
8820           in: path
8821           description: Identifier used by the vendor for the region. Second part of composite key
8822           required: true
8823           type: string
8824           example: __CLOUD-REGION-ID__
8825     put:
8826       tags:
8827         - CloudInfrastructure
8828       summary: create or update an existing cloud-region
8829       description: |
8830         Create or update an existing cloud-region.
8831         #
8832         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8833       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
8834       consumes:
8835         - application/json
8836         - application/xml
8837       produces:
8838         - application/json
8839         - application/xml
8840       responses:
8841         "default":
8842           description: Response codes found in [response codes](https://wiki.onap.org/).
8843       parameters:
8844         - name: cloud-owner
8845           in: path
8846           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8847           required: true
8848           type: string
8849           example: __CLOUD-OWNER__
8850         - name: cloud-region-id
8851           in: path
8852           description: Identifier used by the vendor for the region. Second part of composite key
8853           required: true
8854           type: string
8855           example: __CLOUD-REGION-ID__
8856         - name: body
8857           in: body
8858           description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegion.json)
8859           required: true
8860           schema:
8861             $ref: "#/definitions/cloud-region"
8862     patch:
8863       tags:
8864         - CloudInfrastructure
8865       summary: update an existing cloud-region
8866       description: |
8867         Update an existing cloud-region
8868         #
8869         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8870         The PUT operation will entirely replace an existing object.
8871         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8872         #
8873         Other differences between PUT and PATCH are:
8874         #
8875         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8876         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8877         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8878       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
8879       consumes:
8880         - application/json
8881         - application/xml
8882       produces:
8883         - application/json
8884         - application/xml
8885       responses:
8886         "default":
8887           description: Response codes found in [response codes](https://wiki.onap.org/).
8888       parameters:
8889         - name: cloud-owner
8890           in: path
8891           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8892           required: true
8893           type: string
8894           example: __CLOUD-OWNER__
8895         - name: cloud-region-id
8896           in: path
8897           description: Identifier used by the vendor for the region. Second part of composite key
8898           required: true
8899           type: string
8900           example: __CLOUD-REGION-ID__
8901         - name: body
8902           in: body
8903           description: cloud-region object that needs to be updated.
8904           required: true
8905           schema:
8906             $ref: "#/patchDefinitions/cloud-region"
8907     delete:
8908       tags:
8909         - CloudInfrastructure
8910       summary: delete an existing cloud-region
8911       description: delete an existing cloud-region
8912       operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
8913       consumes:
8914         - application/json
8915         - application/xml
8916       produces:
8917         - application/json
8918         - application/xml
8919       responses:
8920         "default":
8921           description: Response codes found in [response codes](https://wiki.onap.org/).
8922       parameters:
8923         - name: cloud-owner
8924           in: path
8925           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8926           required: true
8927           type: string
8928           example: __CLOUD-OWNER__
8929         - name: cloud-region-id
8930           in: path
8931           description: Identifier used by the vendor for the region. Second part of composite key
8932           required: true
8933           type: string
8934           example: __CLOUD-REGION-ID__
8935         - name: resource-version
8936           in: query
8937           description: resource-version for concurrency
8938           required: true
8939           type: string
8940   /cloud-infrastructure/cloud-regions:
8941     get:
8942       tags:
8943         - CloudInfrastructure
8944       summary: returns cloud-regions
8945       description: returns cloud-regions
8946       operationId: getCloudInfrastructureCloudRegions
8947       produces:
8948         - application/json
8949         - application/xml
8950       responses:
8951         "200":
8952           description: successful operation
8953           schema:
8954               $ref: "#/getDefinitions/cloud-regions"
8955         "default":
8956           description: Response codes found in [response codes](https://wiki.onap.org/).
8957       parameters:
8958         - name: cloud-owner
8959           in: query
8960           description:
8961           required: false
8962           type: string
8963         - name: cloud-region-id
8964           in: query
8965           description:
8966           required: false
8967           type: string
8968         - name: cloud-type
8969           in: query
8970           description:
8971           required: false
8972           type: string
8973         - name: owner-defined-type
8974           in: query
8975           description:
8976           required: false
8977           type: string
8978   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
8979     put:
8980       tags:
8981         - CloudInfrastructure
8982       summary: see node definition for valid relationships
8983       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
8984       consumes:
8985         - application/json
8986         - application/xml
8987       produces:
8988         - application/json
8989         - application/xml
8990       responses:
8991         "default":
8992           description: Response codes found in [response codes](https://wiki.onap.org/).
8993       parameters:
8994         - name: nm-profile-name
8995           in: path
8996           description: Unique name of network profile.
8997           required: true
8998           type: string
8999           example: __NM-PROFILE-NAME__
9000         - name: body
9001           in: body
9002           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureNetworkProfilesNetworkProfile.json)
9003           required: true
9004           schema:
9005             $ref: "#/definitions/relationship"
9006     delete:
9007       tags:
9008         - CloudInfrastructure
9009       summary: delete an existing relationship
9010       description: delete an existing relationship
9011       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
9012       consumes:
9013         - application/json
9014         - application/xml
9015       produces:
9016         - application/json
9017         - application/xml
9018       responses:
9019         "default":
9020           description: Response codes found in [response codes](https://wiki.onap.org/).
9021       parameters:
9022         - name: nm-profile-name
9023           in: path
9024           description: Unique name of network profile.
9025           required: true
9026           type: string
9027           example: __NM-PROFILE-NAME__
9028   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
9029     get:
9030       tags:
9031         - CloudInfrastructure
9032       summary: returns network-profile
9033       description: returns network-profile
9034       operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
9035       produces:
9036         - application/json
9037         - application/xml
9038       responses:
9039         "200":
9040           description: successful operation
9041           schema:
9042               $ref: "#/getDefinitions/network-profile"
9043         "default":
9044           description: Response codes found in [response codes](https://wiki.onap.org/).
9045       parameters:
9046         - name: nm-profile-name
9047           in: path
9048           description: Unique name of network profile.
9049           required: true
9050           type: string
9051           example: __NM-PROFILE-NAME__
9052     put:
9053       tags:
9054         - CloudInfrastructure
9055       summary: create or update an existing network-profile
9056       description: |
9057         Create or update an existing network-profile.
9058         #
9059         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9060       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
9061       consumes:
9062         - application/json
9063         - application/xml
9064       produces:
9065         - application/json
9066         - application/xml
9067       responses:
9068         "default":
9069           description: Response codes found in [response codes](https://wiki.onap.org/).
9070       parameters:
9071         - name: nm-profile-name
9072           in: path
9073           description: Unique name of network profile.
9074           required: true
9075           type: string
9076           example: __NM-PROFILE-NAME__
9077         - name: body
9078           in: body
9079           description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureNetworkProfilesNetworkProfile.json)
9080           required: true
9081           schema:
9082             $ref: "#/definitions/network-profile"
9083     patch:
9084       tags:
9085         - CloudInfrastructure
9086       summary: update an existing network-profile
9087       description: |
9088         Update an existing network-profile
9089         #
9090         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9091         The PUT operation will entirely replace an existing object.
9092         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9093         #
9094         Other differences between PUT and PATCH are:
9095         #
9096         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9097         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9098         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9099       operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
9100       consumes:
9101         - application/json
9102         - application/xml
9103       produces:
9104         - application/json
9105         - application/xml
9106       responses:
9107         "default":
9108           description: Response codes found in [response codes](https://wiki.onap.org/).
9109       parameters:
9110         - name: nm-profile-name
9111           in: path
9112           description: Unique name of network profile.
9113           required: true
9114           type: string
9115           example: __NM-PROFILE-NAME__
9116         - name: body
9117           in: body
9118           description: network-profile object that needs to be updated.
9119           required: true
9120           schema:
9121             $ref: "#/patchDefinitions/network-profile"
9122     delete:
9123       tags:
9124         - CloudInfrastructure
9125       summary: delete an existing network-profile
9126       description: delete an existing network-profile
9127       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
9128       consumes:
9129         - application/json
9130         - application/xml
9131       produces:
9132         - application/json
9133         - application/xml
9134       responses:
9135         "default":
9136           description: Response codes found in [response codes](https://wiki.onap.org/).
9137       parameters:
9138         - name: nm-profile-name
9139           in: path
9140           description: Unique name of network profile.
9141           required: true
9142           type: string
9143           example: __NM-PROFILE-NAME__
9144         - name: resource-version
9145           in: query
9146           description: resource-version for concurrency
9147           required: true
9148           type: string
9149   /cloud-infrastructure/network-profiles:
9150     get:
9151       tags:
9152         - CloudInfrastructure
9153       summary: returns network-profiles
9154       description: returns network-profiles
9155       operationId: getCloudInfrastructureNetworkProfiles
9156       produces:
9157         - application/json
9158         - application/xml
9159       responses:
9160         "200":
9161           description: successful operation
9162           schema:
9163               $ref: "#/getDefinitions/network-profiles"
9164         "default":
9165           description: Response codes found in [response codes](https://wiki.onap.org/).
9166       parameters:
9167         - name: nm-profile-name
9168           in: query
9169           description:
9170           required: false
9171           type: string
9172   /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
9173     put:
9174       tags:
9175         - CloudInfrastructure
9176       summary: see node definition for valid relationships
9177       operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
9178       consumes:
9179         - application/json
9180         - application/xml
9181       produces:
9182         - application/json
9183         - application/xml
9184       responses:
9185         "default":
9186           description: Response codes found in [response codes](https://wiki.onap.org/).
9187       parameters:
9188         - name: hostname
9189           in: path
9190           description: Value from executing hostname on the compute node.
9191           required: true
9192           type: string
9193           example: __HOSTNAME__
9194         - name: body
9195           in: body
9196           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserver.json)
9197           required: true
9198           schema:
9199             $ref: "#/definitions/relationship"
9200     delete:
9201       tags:
9202         - CloudInfrastructure
9203       summary: delete an existing relationship
9204       description: delete an existing relationship
9205       operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
9206       consumes:
9207         - application/json
9208         - application/xml
9209       produces:
9210         - application/json
9211         - application/xml
9212       responses:
9213         "default":
9214           description: Response codes found in [response codes](https://wiki.onap.org/).
9215       parameters:
9216         - name: hostname
9217           in: path
9218           description: Value from executing hostname on the compute node.
9219           required: true
9220           type: string
9221           example: __HOSTNAME__
9222   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
9223     put:
9224       tags:
9225         - CloudInfrastructure
9226       summary: see node definition for valid relationships
9227       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
9228       consumes:
9229         - application/json
9230         - application/xml
9231       produces:
9232         - application/json
9233         - application/xml
9234       responses:
9235         "default":
9236           description: Response codes found in [response codes](https://wiki.onap.org/).
9237       parameters:
9238         - name: hostname
9239           in: path
9240           description: Value from executing hostname on the compute node.
9241           required: true
9242           type: string
9243           example: __HOSTNAME__
9244         - name: interface-name
9245           in: path
9246           description: Name that identifies the physical interface
9247           required: true
9248           type: string
9249           example: __INTERFACE-NAME__
9250         - name: body
9251           in: body
9252           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
9253           required: true
9254           schema:
9255             $ref: "#/definitions/relationship"
9256     delete:
9257       tags:
9258         - CloudInfrastructure
9259       summary: delete an existing relationship
9260       description: delete an existing relationship
9261       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
9262       consumes:
9263         - application/json
9264         - application/xml
9265       produces:
9266         - application/json
9267         - application/xml
9268       responses:
9269         "default":
9270           description: Response codes found in [response codes](https://wiki.onap.org/).
9271       parameters:
9272         - name: hostname
9273           in: path
9274           description: Value from executing hostname on the compute node.
9275           required: true
9276           type: string
9277           example: __HOSTNAME__
9278         - name: interface-name
9279           in: path
9280           description: Name that identifies the physical interface
9281           required: true
9282           type: string
9283           example: __INTERFACE-NAME__
9284   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
9285     put:
9286       tags:
9287         - CloudInfrastructure
9288       summary: see node definition for valid relationships
9289       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9290       consumes:
9291         - application/json
9292         - application/xml
9293       produces:
9294         - application/json
9295         - application/xml
9296       responses:
9297         "default":
9298           description: Response codes found in [response codes](https://wiki.onap.org/).
9299       parameters:
9300         - name: hostname
9301           in: path
9302           description: Value from executing hostname on the compute node.
9303           required: true
9304           type: string
9305           example: __HOSTNAME__
9306         - name: interface-name
9307           in: path
9308           description: Name that identifies the physical interface
9309           required: true
9310           type: string
9311           example: __INTERFACE-NAME__
9312         - name: pf-pci-id
9313           in: path
9314           description: Identifier for the sriov-pf
9315           required: true
9316           type: string
9317           example: __PF-PCI-ID__
9318         - name: body
9319           in: body
9320           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9321           required: true
9322           schema:
9323             $ref: "#/definitions/relationship"
9324     delete:
9325       tags:
9326         - CloudInfrastructure
9327       summary: delete an existing relationship
9328       description: delete an existing relationship
9329       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9330       consumes:
9331         - application/json
9332         - application/xml
9333       produces:
9334         - application/json
9335         - application/xml
9336       responses:
9337         "default":
9338           description: Response codes found in [response codes](https://wiki.onap.org/).
9339       parameters:
9340         - name: hostname
9341           in: path
9342           description: Value from executing hostname on the compute node.
9343           required: true
9344           type: string
9345           example: __HOSTNAME__
9346         - name: interface-name
9347           in: path
9348           description: Name that identifies the physical interface
9349           required: true
9350           type: string
9351           example: __INTERFACE-NAME__
9352         - name: pf-pci-id
9353           in: path
9354           description: Identifier for the sriov-pf
9355           required: true
9356           type: string
9357           example: __PF-PCI-ID__
9358   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
9359     get:
9360       tags:
9361         - CloudInfrastructure
9362       summary: returns sriov-pf
9363       description: returns sriov-pf
9364       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9365       produces:
9366         - application/json
9367         - application/xml
9368       responses:
9369         "200":
9370           description: successful operation
9371           schema:
9372               $ref: "#/getDefinitions/sriov-pf"
9373         "default":
9374           description: Response codes found in [response codes](https://wiki.onap.org/).
9375       parameters:
9376         - name: hostname
9377           in: path
9378           description: Value from executing hostname on the compute node.
9379           required: true
9380           type: string
9381           example: __HOSTNAME__
9382         - name: interface-name
9383           in: path
9384           description: Name that identifies the physical interface
9385           required: true
9386           type: string
9387           example: __INTERFACE-NAME__
9388         - name: pf-pci-id
9389           in: path
9390           description: Identifier for the sriov-pf
9391           required: true
9392           type: string
9393           example: __PF-PCI-ID__
9394     put:
9395       tags:
9396         - CloudInfrastructure
9397       summary: create or update an existing sriov-pf
9398       description: |
9399         Create or update an existing sriov-pf.
9400         #
9401         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9402       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9403       consumes:
9404         - application/json
9405         - application/xml
9406       produces:
9407         - application/json
9408         - application/xml
9409       responses:
9410         "default":
9411           description: Response codes found in [response codes](https://wiki.onap.org/).
9412       parameters:
9413         - name: hostname
9414           in: path
9415           description: Value from executing hostname on the compute node.
9416           required: true
9417           type: string
9418           example: __HOSTNAME__
9419         - name: interface-name
9420           in: path
9421           description: Name that identifies the physical interface
9422           required: true
9423           type: string
9424           example: __INTERFACE-NAME__
9425         - name: pf-pci-id
9426           in: path
9427           description: Identifier for the sriov-pf
9428           required: true
9429           type: string
9430           example: __PF-PCI-ID__
9431         - name: body
9432           in: body
9433           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9434           required: true
9435           schema:
9436             $ref: "#/definitions/sriov-pf"
9437     patch:
9438       tags:
9439         - CloudInfrastructure
9440       summary: update an existing sriov-pf
9441       description: |
9442         Update an existing sriov-pf
9443         #
9444         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9445         The PUT operation will entirely replace an existing object.
9446         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9447         #
9448         Other differences between PUT and PATCH are:
9449         #
9450         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9451         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9452         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9453       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9454       consumes:
9455         - application/json
9456         - application/xml
9457       produces:
9458         - application/json
9459         - application/xml
9460       responses:
9461         "default":
9462           description: Response codes found in [response codes](https://wiki.onap.org/).
9463       parameters:
9464         - name: hostname
9465           in: path
9466           description: Value from executing hostname on the compute node.
9467           required: true
9468           type: string
9469           example: __HOSTNAME__
9470         - name: interface-name
9471           in: path
9472           description: Name that identifies the physical interface
9473           required: true
9474           type: string
9475           example: __INTERFACE-NAME__
9476         - name: pf-pci-id
9477           in: path
9478           description: Identifier for the sriov-pf
9479           required: true
9480           type: string
9481           example: __PF-PCI-ID__
9482         - name: body
9483           in: body
9484           description: sriov-pf object that needs to be updated.
9485           required: true
9486           schema:
9487             $ref: "#/patchDefinitions/sriov-pf"
9488     delete:
9489       tags:
9490         - CloudInfrastructure
9491       summary: delete an existing sriov-pf
9492       description: delete an existing sriov-pf
9493       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9494       consumes:
9495         - application/json
9496         - application/xml
9497       produces:
9498         - application/json
9499         - application/xml
9500       responses:
9501         "default":
9502           description: Response codes found in [response codes](https://wiki.onap.org/).
9503       parameters:
9504         - name: hostname
9505           in: path
9506           description: Value from executing hostname on the compute node.
9507           required: true
9508           type: string
9509           example: __HOSTNAME__
9510         - name: interface-name
9511           in: path
9512           description: Name that identifies the physical interface
9513           required: true
9514           type: string
9515           example: __INTERFACE-NAME__
9516         - name: pf-pci-id
9517           in: path
9518           description: Identifier for the sriov-pf
9519           required: true
9520           type: string
9521           example: __PF-PCI-ID__
9522         - name: resource-version
9523           in: query
9524           description: resource-version for concurrency
9525           required: true
9526           type: string
9527   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
9528     get:
9529       tags:
9530         - CloudInfrastructure
9531       summary: returns sriov-pfs
9532       description: returns sriov-pfs
9533       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
9534       produces:
9535         - application/json
9536         - application/xml
9537       responses:
9538         "200":
9539           description: successful operation
9540           schema:
9541               $ref: "#/getDefinitions/sriov-pfs"
9542         "default":
9543           description: Response codes found in [response codes](https://wiki.onap.org/).
9544       parameters:
9545         - name: hostname
9546           in: path
9547           description: Value from executing hostname on the compute node.
9548           required: true
9549           type: string
9550           example: __HOSTNAME__
9551         - name: interface-name
9552           in: path
9553           description: Name that identifies the physical interface
9554           required: true
9555           type: string
9556           example: __INTERFACE-NAME__
9557         - name: pf-pci-id
9558           in: query
9559           description:
9560           required: false
9561           type: string
9562   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
9563     put:
9564       tags:
9565         - CloudInfrastructure
9566       summary: see node definition for valid relationships
9567       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9568       consumes:
9569         - application/json
9570         - application/xml
9571       produces:
9572         - application/json
9573         - application/xml
9574       responses:
9575         "default":
9576           description: Response codes found in [response codes](https://wiki.onap.org/).
9577       parameters:
9578         - name: hostname
9579           in: path
9580           description: Value from executing hostname on the compute node.
9581           required: true
9582           type: string
9583           example: __HOSTNAME__
9584         - name: interface-name
9585           in: path
9586           description: Name that identifies the physical interface
9587           required: true
9588           type: string
9589           example: __INTERFACE-NAME__
9590         - name: interface-name
9591           in: path
9592           description: Name given to the interface
9593           required: true
9594           type: string
9595           example: __INTERFACE-NAME__
9596         - name: vlan-interface
9597           in: path
9598           description: String that identifies the interface
9599           required: true
9600           type: string
9601           example: __VLAN-INTERFACE__
9602         - name: body
9603           in: body
9604           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9605           required: true
9606           schema:
9607             $ref: "#/definitions/relationship"
9608     delete:
9609       tags:
9610         - CloudInfrastructure
9611       summary: delete an existing relationship
9612       description: delete an existing relationship
9613       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9614       consumes:
9615         - application/json
9616         - application/xml
9617       produces:
9618         - application/json
9619         - application/xml
9620       responses:
9621         "default":
9622           description: Response codes found in [response codes](https://wiki.onap.org/).
9623       parameters:
9624         - name: hostname
9625           in: path
9626           description: Value from executing hostname on the compute node.
9627           required: true
9628           type: string
9629           example: __HOSTNAME__
9630         - name: interface-name
9631           in: path
9632           description: Name that identifies the physical interface
9633           required: true
9634           type: string
9635           example: __INTERFACE-NAME__
9636         - name: interface-name
9637           in: path
9638           description: Name given to the interface
9639           required: true
9640           type: string
9641           example: __INTERFACE-NAME__
9642         - name: vlan-interface
9643           in: path
9644           description: String that identifies the interface
9645           required: true
9646           type: string
9647           example: __VLAN-INTERFACE__
9648   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
9649     put:
9650       tags:
9651         - CloudInfrastructure
9652       summary: see node definition for valid relationships
9653       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9654       consumes:
9655         - application/json
9656         - application/xml
9657       produces:
9658         - application/json
9659         - application/xml
9660       responses:
9661         "default":
9662           description: Response codes found in [response codes](https://wiki.onap.org/).
9663       parameters:
9664         - name: hostname
9665           in: path
9666           description: Value from executing hostname on the compute node.
9667           required: true
9668           type: string
9669           example: __HOSTNAME__
9670         - name: interface-name
9671           in: path
9672           description: Name that identifies the physical interface
9673           required: true
9674           type: string
9675           example: __INTERFACE-NAME__
9676         - name: interface-name
9677           in: path
9678           description: Name given to the interface
9679           required: true
9680           type: string
9681           example: __INTERFACE-NAME__
9682         - name: vlan-interface
9683           in: path
9684           description: String that identifies the interface
9685           required: true
9686           type: string
9687           example: __VLAN-INTERFACE__
9688         - name: l3-interface-ipv4-address
9689           in: path
9690           description: IP address
9691           required: true
9692           type: string
9693           example: __L3-INTERFACE-IPV4-ADDRESS__
9694         - name: body
9695           in: body
9696           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9697           required: true
9698           schema:
9699             $ref: "#/definitions/relationship"
9700     delete:
9701       tags:
9702         - CloudInfrastructure
9703       summary: delete an existing relationship
9704       description: delete an existing relationship
9705       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9706       consumes:
9707         - application/json
9708         - application/xml
9709       produces:
9710         - application/json
9711         - application/xml
9712       responses:
9713         "default":
9714           description: Response codes found in [response codes](https://wiki.onap.org/).
9715       parameters:
9716         - name: hostname
9717           in: path
9718           description: Value from executing hostname on the compute node.
9719           required: true
9720           type: string
9721           example: __HOSTNAME__
9722         - name: interface-name
9723           in: path
9724           description: Name that identifies the physical interface
9725           required: true
9726           type: string
9727           example: __INTERFACE-NAME__
9728         - name: interface-name
9729           in: path
9730           description: Name given to the interface
9731           required: true
9732           type: string
9733           example: __INTERFACE-NAME__
9734         - name: vlan-interface
9735           in: path
9736           description: String that identifies the interface
9737           required: true
9738           type: string
9739           example: __VLAN-INTERFACE__
9740         - name: l3-interface-ipv4-address
9741           in: path
9742           description: IP address
9743           required: true
9744           type: string
9745           example: __L3-INTERFACE-IPV4-ADDRESS__
9746   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
9747     get:
9748       tags:
9749         - CloudInfrastructure
9750       summary: returns l3-interface-ipv4-address-list
9751       description: returns l3-interface-ipv4-address-list
9752       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9753       produces:
9754         - application/json
9755         - application/xml
9756       responses:
9757         "200":
9758           description: successful operation
9759           schema:
9760               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9761         "default":
9762           description: Response codes found in [response codes](https://wiki.onap.org/).
9763       parameters:
9764         - name: hostname
9765           in: path
9766           description: Value from executing hostname on the compute node.
9767           required: true
9768           type: string
9769           example: __HOSTNAME__
9770         - name: interface-name
9771           in: path
9772           description: Name that identifies the physical interface
9773           required: true
9774           type: string
9775           example: __INTERFACE-NAME__
9776         - name: interface-name
9777           in: path
9778           description: Name given to the interface
9779           required: true
9780           type: string
9781           example: __INTERFACE-NAME__
9782         - name: vlan-interface
9783           in: path
9784           description: String that identifies the interface
9785           required: true
9786           type: string
9787           example: __VLAN-INTERFACE__
9788         - name: l3-interface-ipv4-address
9789           in: path
9790           description: IP address
9791           required: true
9792           type: string
9793           example: __L3-INTERFACE-IPV4-ADDRESS__
9794     put:
9795       tags:
9796         - CloudInfrastructure
9797       summary: create or update an existing l3-interface-ipv4-address-list
9798       description: |
9799         Create or update an existing l3-interface-ipv4-address-list.
9800         #
9801         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9802       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9803       consumes:
9804         - application/json
9805         - application/xml
9806       produces:
9807         - application/json
9808         - application/xml
9809       responses:
9810         "default":
9811           description: Response codes found in [response codes](https://wiki.onap.org/).
9812       parameters:
9813         - name: hostname
9814           in: path
9815           description: Value from executing hostname on the compute node.
9816           required: true
9817           type: string
9818           example: __HOSTNAME__
9819         - name: interface-name
9820           in: path
9821           description: Name that identifies the physical interface
9822           required: true
9823           type: string
9824           example: __INTERFACE-NAME__
9825         - name: interface-name
9826           in: path
9827           description: Name given to the interface
9828           required: true
9829           type: string
9830           example: __INTERFACE-NAME__
9831         - name: vlan-interface
9832           in: path
9833           description: String that identifies the interface
9834           required: true
9835           type: string
9836           example: __VLAN-INTERFACE__
9837         - name: l3-interface-ipv4-address
9838           in: path
9839           description: IP address
9840           required: true
9841           type: string
9842           example: __L3-INTERFACE-IPV4-ADDRESS__
9843         - name: body
9844           in: body
9845           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9846           required: true
9847           schema:
9848             $ref: "#/definitions/l3-interface-ipv4-address-list"
9849     patch:
9850       tags:
9851         - CloudInfrastructure
9852       summary: update an existing l3-interface-ipv4-address-list
9853       description: |
9854         Update an existing l3-interface-ipv4-address-list
9855         #
9856         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9857         The PUT operation will entirely replace an existing object.
9858         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9859         #
9860         Other differences between PUT and PATCH are:
9861         #
9862         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9863         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9864         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9865       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9866       consumes:
9867         - application/json
9868         - application/xml
9869       produces:
9870         - application/json
9871         - application/xml
9872       responses:
9873         "default":
9874           description: Response codes found in [response codes](https://wiki.onap.org/).
9875       parameters:
9876         - name: hostname
9877           in: path
9878           description: Value from executing hostname on the compute node.
9879           required: true
9880           type: string
9881           example: __HOSTNAME__
9882         - name: interface-name
9883           in: path
9884           description: Name that identifies the physical interface
9885           required: true
9886           type: string
9887           example: __INTERFACE-NAME__
9888         - name: interface-name
9889           in: path
9890           description: Name given to the interface
9891           required: true
9892           type: string
9893           example: __INTERFACE-NAME__
9894         - name: vlan-interface
9895           in: path
9896           description: String that identifies the interface
9897           required: true
9898           type: string
9899           example: __VLAN-INTERFACE__
9900         - name: l3-interface-ipv4-address
9901           in: path
9902           description: IP address
9903           required: true
9904           type: string
9905           example: __L3-INTERFACE-IPV4-ADDRESS__
9906         - name: body
9907           in: body
9908           description: l3-interface-ipv4-address-list object that needs to be updated.
9909           required: true
9910           schema:
9911             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
9912     delete:
9913       tags:
9914         - CloudInfrastructure
9915       summary: delete an existing l3-interface-ipv4-address-list
9916       description: delete an existing l3-interface-ipv4-address-list
9917       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9918       consumes:
9919         - application/json
9920         - application/xml
9921       produces:
9922         - application/json
9923         - application/xml
9924       responses:
9925         "default":
9926           description: Response codes found in [response codes](https://wiki.onap.org/).
9927       parameters:
9928         - name: hostname
9929           in: path
9930           description: Value from executing hostname on the compute node.
9931           required: true
9932           type: string
9933           example: __HOSTNAME__
9934         - name: interface-name
9935           in: path
9936           description: Name that identifies the physical interface
9937           required: true
9938           type: string
9939           example: __INTERFACE-NAME__
9940         - name: interface-name
9941           in: path
9942           description: Name given to the interface
9943           required: true
9944           type: string
9945           example: __INTERFACE-NAME__
9946         - name: vlan-interface
9947           in: path
9948           description: String that identifies the interface
9949           required: true
9950           type: string
9951           example: __VLAN-INTERFACE__
9952         - name: l3-interface-ipv4-address
9953           in: path
9954           description: IP address
9955           required: true
9956           type: string
9957           example: __L3-INTERFACE-IPV4-ADDRESS__
9958         - name: resource-version
9959           in: query
9960           description: resource-version for concurrency
9961           required: true
9962           type: string
9963   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
9964     put:
9965       tags:
9966         - CloudInfrastructure
9967       summary: see node definition for valid relationships
9968       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
9969       consumes:
9970         - application/json
9971         - application/xml
9972       produces:
9973         - application/json
9974         - application/xml
9975       responses:
9976         "default":
9977           description: Response codes found in [response codes](https://wiki.onap.org/).
9978       parameters:
9979         - name: hostname
9980           in: path
9981           description: Value from executing hostname on the compute node.
9982           required: true
9983           type: string
9984           example: __HOSTNAME__
9985         - name: interface-name
9986           in: path
9987           description: Name that identifies the physical interface
9988           required: true
9989           type: string
9990           example: __INTERFACE-NAME__
9991         - name: interface-name
9992           in: path
9993           description: Name given to the interface
9994           required: true
9995           type: string
9996           example: __INTERFACE-NAME__
9997         - name: vlan-interface
9998           in: path
9999           description: String that identifies the interface
10000           required: true
10001           type: string
10002           example: __VLAN-INTERFACE__
10003         - name: l3-interface-ipv6-address
10004           in: path
10005           description: IP address
10006           required: true
10007           type: string
10008           example: __L3-INTERFACE-IPV6-ADDRESS__
10009         - name: body
10010           in: body
10011           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10012           required: true
10013           schema:
10014             $ref: "#/definitions/relationship"
10015     delete:
10016       tags:
10017         - CloudInfrastructure
10018       summary: delete an existing relationship
10019       description: delete an existing relationship
10020       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
10021       consumes:
10022         - application/json
10023         - application/xml
10024       produces:
10025         - application/json
10026         - application/xml
10027       responses:
10028         "default":
10029           description: Response codes found in [response codes](https://wiki.onap.org/).
10030       parameters:
10031         - name: hostname
10032           in: path
10033           description: Value from executing hostname on the compute node.
10034           required: true
10035           type: string
10036           example: __HOSTNAME__
10037         - name: interface-name
10038           in: path
10039           description: Name that identifies the physical interface
10040           required: true
10041           type: string
10042           example: __INTERFACE-NAME__
10043         - name: interface-name
10044           in: path
10045           description: Name given to the interface
10046           required: true
10047           type: string
10048           example: __INTERFACE-NAME__
10049         - name: vlan-interface
10050           in: path
10051           description: String that identifies the interface
10052           required: true
10053           type: string
10054           example: __VLAN-INTERFACE__
10055         - name: l3-interface-ipv6-address
10056           in: path
10057           description: IP address
10058           required: true
10059           type: string
10060           example: __L3-INTERFACE-IPV6-ADDRESS__
10061   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
10062     get:
10063       tags:
10064         - CloudInfrastructure
10065       summary: returns l3-interface-ipv6-address-list
10066       description: returns l3-interface-ipv6-address-list
10067       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10068       produces:
10069         - application/json
10070         - application/xml
10071       responses:
10072         "200":
10073           description: successful operation
10074           schema:
10075               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10076         "default":
10077           description: Response codes found in [response codes](https://wiki.onap.org/).
10078       parameters:
10079         - name: hostname
10080           in: path
10081           description: Value from executing hostname on the compute node.
10082           required: true
10083           type: string
10084           example: __HOSTNAME__
10085         - name: interface-name
10086           in: path
10087           description: Name that identifies the physical interface
10088           required: true
10089           type: string
10090           example: __INTERFACE-NAME__
10091         - name: interface-name
10092           in: path
10093           description: Name given to the interface
10094           required: true
10095           type: string
10096           example: __INTERFACE-NAME__
10097         - name: vlan-interface
10098           in: path
10099           description: String that identifies the interface
10100           required: true
10101           type: string
10102           example: __VLAN-INTERFACE__
10103         - name: l3-interface-ipv6-address
10104           in: path
10105           description: IP address
10106           required: true
10107           type: string
10108           example: __L3-INTERFACE-IPV6-ADDRESS__
10109     put:
10110       tags:
10111         - CloudInfrastructure
10112       summary: create or update an existing l3-interface-ipv6-address-list
10113       description: |
10114         Create or update an existing l3-interface-ipv6-address-list.
10115         #
10116         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10117       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10118       consumes:
10119         - application/json
10120         - application/xml
10121       produces:
10122         - application/json
10123         - application/xml
10124       responses:
10125         "default":
10126           description: Response codes found in [response codes](https://wiki.onap.org/).
10127       parameters:
10128         - name: hostname
10129           in: path
10130           description: Value from executing hostname on the compute node.
10131           required: true
10132           type: string
10133           example: __HOSTNAME__
10134         - name: interface-name
10135           in: path
10136           description: Name that identifies the physical interface
10137           required: true
10138           type: string
10139           example: __INTERFACE-NAME__
10140         - name: interface-name
10141           in: path
10142           description: Name given to the interface
10143           required: true
10144           type: string
10145           example: __INTERFACE-NAME__
10146         - name: vlan-interface
10147           in: path
10148           description: String that identifies the interface
10149           required: true
10150           type: string
10151           example: __VLAN-INTERFACE__
10152         - name: l3-interface-ipv6-address
10153           in: path
10154           description: IP address
10155           required: true
10156           type: string
10157           example: __L3-INTERFACE-IPV6-ADDRESS__
10158         - name: body
10159           in: body
10160           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10161           required: true
10162           schema:
10163             $ref: "#/definitions/l3-interface-ipv6-address-list"
10164     patch:
10165       tags:
10166         - CloudInfrastructure
10167       summary: update an existing l3-interface-ipv6-address-list
10168       description: |
10169         Update an existing l3-interface-ipv6-address-list
10170         #
10171         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10172         The PUT operation will entirely replace an existing object.
10173         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10174         #
10175         Other differences between PUT and PATCH are:
10176         #
10177         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10178         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10179         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10180       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10181       consumes:
10182         - application/json
10183         - application/xml
10184       produces:
10185         - application/json
10186         - application/xml
10187       responses:
10188         "default":
10189           description: Response codes found in [response codes](https://wiki.onap.org/).
10190       parameters:
10191         - name: hostname
10192           in: path
10193           description: Value from executing hostname on the compute node.
10194           required: true
10195           type: string
10196           example: __HOSTNAME__
10197         - name: interface-name
10198           in: path
10199           description: Name that identifies the physical interface
10200           required: true
10201           type: string
10202           example: __INTERFACE-NAME__
10203         - name: interface-name
10204           in: path
10205           description: Name given to the interface
10206           required: true
10207           type: string
10208           example: __INTERFACE-NAME__
10209         - name: vlan-interface
10210           in: path
10211           description: String that identifies the interface
10212           required: true
10213           type: string
10214           example: __VLAN-INTERFACE__
10215         - name: l3-interface-ipv6-address
10216           in: path
10217           description: IP address
10218           required: true
10219           type: string
10220           example: __L3-INTERFACE-IPV6-ADDRESS__
10221         - name: body
10222           in: body
10223           description: l3-interface-ipv6-address-list object that needs to be updated.
10224           required: true
10225           schema:
10226             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10227     delete:
10228       tags:
10229         - CloudInfrastructure
10230       summary: delete an existing l3-interface-ipv6-address-list
10231       description: delete an existing l3-interface-ipv6-address-list
10232       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10233       consumes:
10234         - application/json
10235         - application/xml
10236       produces:
10237         - application/json
10238         - application/xml
10239       responses:
10240         "default":
10241           description: Response codes found in [response codes](https://wiki.onap.org/).
10242       parameters:
10243         - name: hostname
10244           in: path
10245           description: Value from executing hostname on the compute node.
10246           required: true
10247           type: string
10248           example: __HOSTNAME__
10249         - name: interface-name
10250           in: path
10251           description: Name that identifies the physical interface
10252           required: true
10253           type: string
10254           example: __INTERFACE-NAME__
10255         - name: interface-name
10256           in: path
10257           description: Name given to the interface
10258           required: true
10259           type: string
10260           example: __INTERFACE-NAME__
10261         - name: vlan-interface
10262           in: path
10263           description: String that identifies the interface
10264           required: true
10265           type: string
10266           example: __VLAN-INTERFACE__
10267         - name: l3-interface-ipv6-address
10268           in: path
10269           description: IP address
10270           required: true
10271           type: string
10272           example: __L3-INTERFACE-IPV6-ADDRESS__
10273         - name: resource-version
10274           in: query
10275           description: resource-version for concurrency
10276           required: true
10277           type: string
10278   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
10279     get:
10280       tags:
10281         - CloudInfrastructure
10282       summary: returns vlan
10283       description: returns vlan
10284       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10285       produces:
10286         - application/json
10287         - application/xml
10288       responses:
10289         "200":
10290           description: successful operation
10291           schema:
10292               $ref: "#/getDefinitions/vlan"
10293         "default":
10294           description: Response codes found in [response codes](https://wiki.onap.org/).
10295       parameters:
10296         - name: hostname
10297           in: path
10298           description: Value from executing hostname on the compute node.
10299           required: true
10300           type: string
10301           example: __HOSTNAME__
10302         - name: interface-name
10303           in: path
10304           description: Name that identifies the physical interface
10305           required: true
10306           type: string
10307           example: __INTERFACE-NAME__
10308         - name: interface-name
10309           in: path
10310           description: Name given to the interface
10311           required: true
10312           type: string
10313           example: __INTERFACE-NAME__
10314         - name: vlan-interface
10315           in: path
10316           description: String that identifies the interface
10317           required: true
10318           type: string
10319           example: __VLAN-INTERFACE__
10320     put:
10321       tags:
10322         - CloudInfrastructure
10323       summary: create or update an existing vlan
10324       description: |
10325         Create or update an existing vlan.
10326         #
10327         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10328       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10329       consumes:
10330         - application/json
10331         - application/xml
10332       produces:
10333         - application/json
10334         - application/xml
10335       responses:
10336         "default":
10337           description: Response codes found in [response codes](https://wiki.onap.org/).
10338       parameters:
10339         - name: hostname
10340           in: path
10341           description: Value from executing hostname on the compute node.
10342           required: true
10343           type: string
10344           example: __HOSTNAME__
10345         - name: interface-name
10346           in: path
10347           description: Name that identifies the physical interface
10348           required: true
10349           type: string
10350           example: __INTERFACE-NAME__
10351         - name: interface-name
10352           in: path
10353           description: Name given to the interface
10354           required: true
10355           type: string
10356           example: __INTERFACE-NAME__
10357         - name: vlan-interface
10358           in: path
10359           description: String that identifies the interface
10360           required: true
10361           type: string
10362           example: __VLAN-INTERFACE__
10363         - name: body
10364           in: body
10365           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
10366           required: true
10367           schema:
10368             $ref: "#/definitions/vlan"
10369     patch:
10370       tags:
10371         - CloudInfrastructure
10372       summary: update an existing vlan
10373       description: |
10374         Update an existing vlan
10375         #
10376         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10377         The PUT operation will entirely replace an existing object.
10378         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10379         #
10380         Other differences between PUT and PATCH are:
10381         #
10382         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10383         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10384         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10385       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10386       consumes:
10387         - application/json
10388         - application/xml
10389       produces:
10390         - application/json
10391         - application/xml
10392       responses:
10393         "default":
10394           description: Response codes found in [response codes](https://wiki.onap.org/).
10395       parameters:
10396         - name: hostname
10397           in: path
10398           description: Value from executing hostname on the compute node.
10399           required: true
10400           type: string
10401           example: __HOSTNAME__
10402         - name: interface-name
10403           in: path
10404           description: Name that identifies the physical interface
10405           required: true
10406           type: string
10407           example: __INTERFACE-NAME__
10408         - name: interface-name
10409           in: path
10410           description: Name given to the interface
10411           required: true
10412           type: string
10413           example: __INTERFACE-NAME__
10414         - name: vlan-interface
10415           in: path
10416           description: String that identifies the interface
10417           required: true
10418           type: string
10419           example: __VLAN-INTERFACE__
10420         - name: body
10421           in: body
10422           description: vlan object that needs to be updated.
10423           required: true
10424           schema:
10425             $ref: "#/patchDefinitions/vlan"
10426     delete:
10427       tags:
10428         - CloudInfrastructure
10429       summary: delete an existing vlan
10430       description: delete an existing vlan
10431       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10432       consumes:
10433         - application/json
10434         - application/xml
10435       produces:
10436         - application/json
10437         - application/xml
10438       responses:
10439         "default":
10440           description: Response codes found in [response codes](https://wiki.onap.org/).
10441       parameters:
10442         - name: hostname
10443           in: path
10444           description: Value from executing hostname on the compute node.
10445           required: true
10446           type: string
10447           example: __HOSTNAME__
10448         - name: interface-name
10449           in: path
10450           description: Name that identifies the physical interface
10451           required: true
10452           type: string
10453           example: __INTERFACE-NAME__
10454         - name: interface-name
10455           in: path
10456           description: Name given to the interface
10457           required: true
10458           type: string
10459           example: __INTERFACE-NAME__
10460         - name: vlan-interface
10461           in: path
10462           description: String that identifies the interface
10463           required: true
10464           type: string
10465           example: __VLAN-INTERFACE__
10466         - name: resource-version
10467           in: query
10468           description: resource-version for concurrency
10469           required: true
10470           type: string
10471   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
10472     get:
10473       tags:
10474         - CloudInfrastructure
10475       summary: returns vlans
10476       description: returns vlans
10477       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
10478       produces:
10479         - application/json
10480         - application/xml
10481       responses:
10482         "200":
10483           description: successful operation
10484           schema:
10485               $ref: "#/getDefinitions/vlans"
10486         "default":
10487           description: Response codes found in [response codes](https://wiki.onap.org/).
10488       parameters:
10489         - name: hostname
10490           in: path
10491           description: Value from executing hostname on the compute node.
10492           required: true
10493           type: string
10494           example: __HOSTNAME__
10495         - name: interface-name
10496           in: path
10497           description: Name that identifies the physical interface
10498           required: true
10499           type: string
10500           example: __INTERFACE-NAME__
10501         - name: interface-name
10502           in: path
10503           description: Name given to the interface
10504           required: true
10505           type: string
10506           example: __INTERFACE-NAME__
10507         - name: vlan-interface
10508           in: query
10509           description:
10510           required: false
10511           type: string
10512         - name: vlan-id-inner
10513           in: query
10514           description:
10515           required: false
10516           type: integer
10517           format: int64
10518         - name: vpn-key
10519           in: query
10520           description:
10521           required: false
10522           type: string
10523   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
10524     put:
10525       tags:
10526         - CloudInfrastructure
10527       summary: see node definition for valid relationships
10528       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10529       consumes:
10530         - application/json
10531         - application/xml
10532       produces:
10533         - application/json
10534         - application/xml
10535       responses:
10536         "default":
10537           description: Response codes found in [response codes](https://wiki.onap.org/).
10538       parameters:
10539         - name: hostname
10540           in: path
10541           description: Value from executing hostname on the compute node.
10542           required: true
10543           type: string
10544           example: __HOSTNAME__
10545         - name: interface-name
10546           in: path
10547           description: Name that identifies the physical interface
10548           required: true
10549           type: string
10550           example: __INTERFACE-NAME__
10551         - name: interface-name
10552           in: path
10553           description: Name given to the interface
10554           required: true
10555           type: string
10556           example: __INTERFACE-NAME__
10557         - name: pci-id
10558           in: path
10559           description: PCI ID used to identify the sriov-vf
10560           required: true
10561           type: string
10562           example: __PCI-ID__
10563         - name: body
10564           in: body
10565           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10566           required: true
10567           schema:
10568             $ref: "#/definitions/relationship"
10569     delete:
10570       tags:
10571         - CloudInfrastructure
10572       summary: delete an existing relationship
10573       description: delete an existing relationship
10574       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10575       consumes:
10576         - application/json
10577         - application/xml
10578       produces:
10579         - application/json
10580         - application/xml
10581       responses:
10582         "default":
10583           description: Response codes found in [response codes](https://wiki.onap.org/).
10584       parameters:
10585         - name: hostname
10586           in: path
10587           description: Value from executing hostname on the compute node.
10588           required: true
10589           type: string
10590           example: __HOSTNAME__
10591         - name: interface-name
10592           in: path
10593           description: Name that identifies the physical interface
10594           required: true
10595           type: string
10596           example: __INTERFACE-NAME__
10597         - name: interface-name
10598           in: path
10599           description: Name given to the interface
10600           required: true
10601           type: string
10602           example: __INTERFACE-NAME__
10603         - name: pci-id
10604           in: path
10605           description: PCI ID used to identify the sriov-vf
10606           required: true
10607           type: string
10608           example: __PCI-ID__
10609   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
10610     get:
10611       tags:
10612         - CloudInfrastructure
10613       summary: returns sriov-vf
10614       description: returns sriov-vf
10615       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10616       produces:
10617         - application/json
10618         - application/xml
10619       responses:
10620         "200":
10621           description: successful operation
10622           schema:
10623               $ref: "#/getDefinitions/sriov-vf"
10624         "default":
10625           description: Response codes found in [response codes](https://wiki.onap.org/).
10626       parameters:
10627         - name: hostname
10628           in: path
10629           description: Value from executing hostname on the compute node.
10630           required: true
10631           type: string
10632           example: __HOSTNAME__
10633         - name: interface-name
10634           in: path
10635           description: Name that identifies the physical interface
10636           required: true
10637           type: string
10638           example: __INTERFACE-NAME__
10639         - name: interface-name
10640           in: path
10641           description: Name given to the interface
10642           required: true
10643           type: string
10644           example: __INTERFACE-NAME__
10645         - name: pci-id
10646           in: path
10647           description: PCI ID used to identify the sriov-vf
10648           required: true
10649           type: string
10650           example: __PCI-ID__
10651     put:
10652       tags:
10653         - CloudInfrastructure
10654       summary: create or update an existing sriov-vf
10655       description: |
10656         Create or update an existing sriov-vf.
10657         #
10658         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10659       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10660       consumes:
10661         - application/json
10662         - application/xml
10663       produces:
10664         - application/json
10665         - application/xml
10666       responses:
10667         "default":
10668           description: Response codes found in [response codes](https://wiki.onap.org/).
10669       parameters:
10670         - name: hostname
10671           in: path
10672           description: Value from executing hostname on the compute node.
10673           required: true
10674           type: string
10675           example: __HOSTNAME__
10676         - name: interface-name
10677           in: path
10678           description: Name that identifies the physical interface
10679           required: true
10680           type: string
10681           example: __INTERFACE-NAME__
10682         - name: interface-name
10683           in: path
10684           description: Name given to the interface
10685           required: true
10686           type: string
10687           example: __INTERFACE-NAME__
10688         - name: pci-id
10689           in: path
10690           description: PCI ID used to identify the sriov-vf
10691           required: true
10692           type: string
10693           example: __PCI-ID__
10694         - name: body
10695           in: body
10696           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10697           required: true
10698           schema:
10699             $ref: "#/definitions/sriov-vf"
10700     patch:
10701       tags:
10702         - CloudInfrastructure
10703       summary: update an existing sriov-vf
10704       description: |
10705         Update an existing sriov-vf
10706         #
10707         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10708         The PUT operation will entirely replace an existing object.
10709         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10710         #
10711         Other differences between PUT and PATCH are:
10712         #
10713         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10714         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10715         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10716       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10717       consumes:
10718         - application/json
10719         - application/xml
10720       produces:
10721         - application/json
10722         - application/xml
10723       responses:
10724         "default":
10725           description: Response codes found in [response codes](https://wiki.onap.org/).
10726       parameters:
10727         - name: hostname
10728           in: path
10729           description: Value from executing hostname on the compute node.
10730           required: true
10731           type: string
10732           example: __HOSTNAME__
10733         - name: interface-name
10734           in: path
10735           description: Name that identifies the physical interface
10736           required: true
10737           type: string
10738           example: __INTERFACE-NAME__
10739         - name: interface-name
10740           in: path
10741           description: Name given to the interface
10742           required: true
10743           type: string
10744           example: __INTERFACE-NAME__
10745         - name: pci-id
10746           in: path
10747           description: PCI ID used to identify the sriov-vf
10748           required: true
10749           type: string
10750           example: __PCI-ID__
10751         - name: body
10752           in: body
10753           description: sriov-vf object that needs to be updated.
10754           required: true
10755           schema:
10756             $ref: "#/patchDefinitions/sriov-vf"
10757     delete:
10758       tags:
10759         - CloudInfrastructure
10760       summary: delete an existing sriov-vf
10761       description: delete an existing sriov-vf
10762       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10763       consumes:
10764         - application/json
10765         - application/xml
10766       produces:
10767         - application/json
10768         - application/xml
10769       responses:
10770         "default":
10771           description: Response codes found in [response codes](https://wiki.onap.org/).
10772       parameters:
10773         - name: hostname
10774           in: path
10775           description: Value from executing hostname on the compute node.
10776           required: true
10777           type: string
10778           example: __HOSTNAME__
10779         - name: interface-name
10780           in: path
10781           description: Name that identifies the physical interface
10782           required: true
10783           type: string
10784           example: __INTERFACE-NAME__
10785         - name: interface-name
10786           in: path
10787           description: Name given to the interface
10788           required: true
10789           type: string
10790           example: __INTERFACE-NAME__
10791         - name: pci-id
10792           in: path
10793           description: PCI ID used to identify the sriov-vf
10794           required: true
10795           type: string
10796           example: __PCI-ID__
10797         - name: resource-version
10798           in: query
10799           description: resource-version for concurrency
10800           required: true
10801           type: string
10802   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
10803     get:
10804       tags:
10805         - CloudInfrastructure
10806       summary: returns sriov-vfs
10807       description: returns sriov-vfs
10808       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
10809       produces:
10810         - application/json
10811         - application/xml
10812       responses:
10813         "200":
10814           description: successful operation
10815           schema:
10816               $ref: "#/getDefinitions/sriov-vfs"
10817         "default":
10818           description: Response codes found in [response codes](https://wiki.onap.org/).
10819       parameters:
10820         - name: hostname
10821           in: path
10822           description: Value from executing hostname on the compute node.
10823           required: true
10824           type: string
10825           example: __HOSTNAME__
10826         - name: interface-name
10827           in: path
10828           description: Name that identifies the physical interface
10829           required: true
10830           type: string
10831           example: __INTERFACE-NAME__
10832         - name: interface-name
10833           in: path
10834           description: Name given to the interface
10835           required: true
10836           type: string
10837           example: __INTERFACE-NAME__
10838         - name: pci-id
10839           in: query
10840           description:
10841           required: false
10842           type: string
10843         - name: vf-vlan-filter
10844           in: query
10845           description:
10846           required: false
10847           type: string
10848         - name: vf-mac-filter
10849           in: query
10850           description:
10851           required: false
10852           type: string
10853         - name: vf-vlan-strip
10854           in: query
10855           description:
10856           required: false
10857           type: boolean
10858         - name: neutron-network-id
10859           in: query
10860           description:
10861           required: false
10862           type: string
10863   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
10864     put:
10865       tags:
10866         - CloudInfrastructure
10867       summary: see node definition for valid relationships
10868       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
10869       consumes:
10870         - application/json
10871         - application/xml
10872       produces:
10873         - application/json
10874         - application/xml
10875       responses:
10876         "default":
10877           description: Response codes found in [response codes](https://wiki.onap.org/).
10878       parameters:
10879         - name: hostname
10880           in: path
10881           description: Value from executing hostname on the compute node.
10882           required: true
10883           type: string
10884           example: __HOSTNAME__
10885         - name: interface-name
10886           in: path
10887           description: Name that identifies the physical interface
10888           required: true
10889           type: string
10890           example: __INTERFACE-NAME__
10891         - name: interface-name
10892           in: path
10893           description: Name given to the interface
10894           required: true
10895           type: string
10896           example: __INTERFACE-NAME__
10897         - name: body
10898           in: body
10899           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
10900           required: true
10901           schema:
10902             $ref: "#/definitions/relationship"
10903     delete:
10904       tags:
10905         - CloudInfrastructure
10906       summary: delete an existing relationship
10907       description: delete an existing relationship
10908       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
10909       consumes:
10910         - application/json
10911         - application/xml
10912       produces:
10913         - application/json
10914         - application/xml
10915       responses:
10916         "default":
10917           description: Response codes found in [response codes](https://wiki.onap.org/).
10918       parameters:
10919         - name: hostname
10920           in: path
10921           description: Value from executing hostname on the compute node.
10922           required: true
10923           type: string
10924           example: __HOSTNAME__
10925         - name: interface-name
10926           in: path
10927           description: Name that identifies the physical interface
10928           required: true
10929           type: string
10930           example: __INTERFACE-NAME__
10931         - name: interface-name
10932           in: path
10933           description: Name given to the interface
10934           required: true
10935           type: string
10936           example: __INTERFACE-NAME__
10937   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
10938     put:
10939       tags:
10940         - CloudInfrastructure
10941       summary: see node definition for valid relationships
10942       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
10943       consumes:
10944         - application/json
10945         - application/xml
10946       produces:
10947         - application/json
10948         - application/xml
10949       responses:
10950         "default":
10951           description: Response codes found in [response codes](https://wiki.onap.org/).
10952       parameters:
10953         - name: hostname
10954           in: path
10955           description: Value from executing hostname on the compute node.
10956           required: true
10957           type: string
10958           example: __HOSTNAME__
10959         - name: interface-name
10960           in: path
10961           description: Name that identifies the physical interface
10962           required: true
10963           type: string
10964           example: __INTERFACE-NAME__
10965         - name: interface-name
10966           in: path
10967           description: Name given to the interface
10968           required: true
10969           type: string
10970           example: __INTERFACE-NAME__
10971         - name: l3-interface-ipv4-address
10972           in: path
10973           description: IP address
10974           required: true
10975           type: string
10976           example: __L3-INTERFACE-IPV4-ADDRESS__
10977         - name: body
10978           in: body
10979           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
10980           required: true
10981           schema:
10982             $ref: "#/definitions/relationship"
10983     delete:
10984       tags:
10985         - CloudInfrastructure
10986       summary: delete an existing relationship
10987       description: delete an existing relationship
10988       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
10989       consumes:
10990         - application/json
10991         - application/xml
10992       produces:
10993         - application/json
10994         - application/xml
10995       responses:
10996         "default":
10997           description: Response codes found in [response codes](https://wiki.onap.org/).
10998       parameters:
10999         - name: hostname
11000           in: path
11001           description: Value from executing hostname on the compute node.
11002           required: true
11003           type: string
11004           example: __HOSTNAME__
11005         - name: interface-name
11006           in: path
11007           description: Name that identifies the physical interface
11008           required: true
11009           type: string
11010           example: __INTERFACE-NAME__
11011         - name: interface-name
11012           in: path
11013           description: Name given to the interface
11014           required: true
11015           type: string
11016           example: __INTERFACE-NAME__
11017         - name: l3-interface-ipv4-address
11018           in: path
11019           description: IP address
11020           required: true
11021           type: string
11022           example: __L3-INTERFACE-IPV4-ADDRESS__
11023   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
11024     get:
11025       tags:
11026         - CloudInfrastructure
11027       summary: returns l3-interface-ipv4-address-list
11028       description: returns l3-interface-ipv4-address-list
11029       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11030       produces:
11031         - application/json
11032         - application/xml
11033       responses:
11034         "200":
11035           description: successful operation
11036           schema:
11037               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11038         "default":
11039           description: Response codes found in [response codes](https://wiki.onap.org/).
11040       parameters:
11041         - name: hostname
11042           in: path
11043           description: Value from executing hostname on the compute node.
11044           required: true
11045           type: string
11046           example: __HOSTNAME__
11047         - name: interface-name
11048           in: path
11049           description: Name that identifies the physical interface
11050           required: true
11051           type: string
11052           example: __INTERFACE-NAME__
11053         - name: interface-name
11054           in: path
11055           description: Name given to the interface
11056           required: true
11057           type: string
11058           example: __INTERFACE-NAME__
11059         - name: l3-interface-ipv4-address
11060           in: path
11061           description: IP address
11062           required: true
11063           type: string
11064           example: __L3-INTERFACE-IPV4-ADDRESS__
11065     put:
11066       tags:
11067         - CloudInfrastructure
11068       summary: create or update an existing l3-interface-ipv4-address-list
11069       description: |
11070         Create or update an existing l3-interface-ipv4-address-list.
11071         #
11072         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11073       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11074       consumes:
11075         - application/json
11076         - application/xml
11077       produces:
11078         - application/json
11079         - application/xml
11080       responses:
11081         "default":
11082           description: Response codes found in [response codes](https://wiki.onap.org/).
11083       parameters:
11084         - name: hostname
11085           in: path
11086           description: Value from executing hostname on the compute node.
11087           required: true
11088           type: string
11089           example: __HOSTNAME__
11090         - name: interface-name
11091           in: path
11092           description: Name that identifies the physical interface
11093           required: true
11094           type: string
11095           example: __INTERFACE-NAME__
11096         - name: interface-name
11097           in: path
11098           description: Name given to the interface
11099           required: true
11100           type: string
11101           example: __INTERFACE-NAME__
11102         - name: l3-interface-ipv4-address
11103           in: path
11104           description: IP address
11105           required: true
11106           type: string
11107           example: __L3-INTERFACE-IPV4-ADDRESS__
11108         - name: body
11109           in: body
11110           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11111           required: true
11112           schema:
11113             $ref: "#/definitions/l3-interface-ipv4-address-list"
11114     patch:
11115       tags:
11116         - CloudInfrastructure
11117       summary: update an existing l3-interface-ipv4-address-list
11118       description: |
11119         Update an existing l3-interface-ipv4-address-list
11120         #
11121         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11122         The PUT operation will entirely replace an existing object.
11123         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11124         #
11125         Other differences between PUT and PATCH are:
11126         #
11127         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11128         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11129         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11130       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11131       consumes:
11132         - application/json
11133         - application/xml
11134       produces:
11135         - application/json
11136         - application/xml
11137       responses:
11138         "default":
11139           description: Response codes found in [response codes](https://wiki.onap.org/).
11140       parameters:
11141         - name: hostname
11142           in: path
11143           description: Value from executing hostname on the compute node.
11144           required: true
11145           type: string
11146           example: __HOSTNAME__
11147         - name: interface-name
11148           in: path
11149           description: Name that identifies the physical interface
11150           required: true
11151           type: string
11152           example: __INTERFACE-NAME__
11153         - name: interface-name
11154           in: path
11155           description: Name given to the interface
11156           required: true
11157           type: string
11158           example: __INTERFACE-NAME__
11159         - name: l3-interface-ipv4-address
11160           in: path
11161           description: IP address
11162           required: true
11163           type: string
11164           example: __L3-INTERFACE-IPV4-ADDRESS__
11165         - name: body
11166           in: body
11167           description: l3-interface-ipv4-address-list object that needs to be updated.
11168           required: true
11169           schema:
11170             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11171     delete:
11172       tags:
11173         - CloudInfrastructure
11174       summary: delete an existing l3-interface-ipv4-address-list
11175       description: delete an existing l3-interface-ipv4-address-list
11176       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11177       consumes:
11178         - application/json
11179         - application/xml
11180       produces:
11181         - application/json
11182         - application/xml
11183       responses:
11184         "default":
11185           description: Response codes found in [response codes](https://wiki.onap.org/).
11186       parameters:
11187         - name: hostname
11188           in: path
11189           description: Value from executing hostname on the compute node.
11190           required: true
11191           type: string
11192           example: __HOSTNAME__
11193         - name: interface-name
11194           in: path
11195           description: Name that identifies the physical interface
11196           required: true
11197           type: string
11198           example: __INTERFACE-NAME__
11199         - name: interface-name
11200           in: path
11201           description: Name given to the interface
11202           required: true
11203           type: string
11204           example: __INTERFACE-NAME__
11205         - name: l3-interface-ipv4-address
11206           in: path
11207           description: IP address
11208           required: true
11209           type: string
11210           example: __L3-INTERFACE-IPV4-ADDRESS__
11211         - name: resource-version
11212           in: query
11213           description: resource-version for concurrency
11214           required: true
11215           type: string
11216   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
11217     put:
11218       tags:
11219         - CloudInfrastructure
11220       summary: see node definition for valid relationships
11221       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11222       consumes:
11223         - application/json
11224         - application/xml
11225       produces:
11226         - application/json
11227         - application/xml
11228       responses:
11229         "default":
11230           description: Response codes found in [response codes](https://wiki.onap.org/).
11231       parameters:
11232         - name: hostname
11233           in: path
11234           description: Value from executing hostname on the compute node.
11235           required: true
11236           type: string
11237           example: __HOSTNAME__
11238         - name: interface-name
11239           in: path
11240           description: Name that identifies the physical interface
11241           required: true
11242           type: string
11243           example: __INTERFACE-NAME__
11244         - name: interface-name
11245           in: path
11246           description: Name given to the interface
11247           required: true
11248           type: string
11249           example: __INTERFACE-NAME__
11250         - name: l3-interface-ipv6-address
11251           in: path
11252           description: IP address
11253           required: true
11254           type: string
11255           example: __L3-INTERFACE-IPV6-ADDRESS__
11256         - name: body
11257           in: body
11258           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11259           required: true
11260           schema:
11261             $ref: "#/definitions/relationship"
11262     delete:
11263       tags:
11264         - CloudInfrastructure
11265       summary: delete an existing relationship
11266       description: delete an existing relationship
11267       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11268       consumes:
11269         - application/json
11270         - application/xml
11271       produces:
11272         - application/json
11273         - application/xml
11274       responses:
11275         "default":
11276           description: Response codes found in [response codes](https://wiki.onap.org/).
11277       parameters:
11278         - name: hostname
11279           in: path
11280           description: Value from executing hostname on the compute node.
11281           required: true
11282           type: string
11283           example: __HOSTNAME__
11284         - name: interface-name
11285           in: path
11286           description: Name that identifies the physical interface
11287           required: true
11288           type: string
11289           example: __INTERFACE-NAME__
11290         - name: interface-name
11291           in: path
11292           description: Name given to the interface
11293           required: true
11294           type: string
11295           example: __INTERFACE-NAME__
11296         - name: l3-interface-ipv6-address
11297           in: path
11298           description: IP address
11299           required: true
11300           type: string
11301           example: __L3-INTERFACE-IPV6-ADDRESS__
11302   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
11303     get:
11304       tags:
11305         - CloudInfrastructure
11306       summary: returns l3-interface-ipv6-address-list
11307       description: returns l3-interface-ipv6-address-list
11308       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11309       produces:
11310         - application/json
11311         - application/xml
11312       responses:
11313         "200":
11314           description: successful operation
11315           schema:
11316               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11317         "default":
11318           description: Response codes found in [response codes](https://wiki.onap.org/).
11319       parameters:
11320         - name: hostname
11321           in: path
11322           description: Value from executing hostname on the compute node.
11323           required: true
11324           type: string
11325           example: __HOSTNAME__
11326         - name: interface-name
11327           in: path
11328           description: Name that identifies the physical interface
11329           required: true
11330           type: string
11331           example: __INTERFACE-NAME__
11332         - name: interface-name
11333           in: path
11334           description: Name given to the interface
11335           required: true
11336           type: string
11337           example: __INTERFACE-NAME__
11338         - name: l3-interface-ipv6-address
11339           in: path
11340           description: IP address
11341           required: true
11342           type: string
11343           example: __L3-INTERFACE-IPV6-ADDRESS__
11344     put:
11345       tags:
11346         - CloudInfrastructure
11347       summary: create or update an existing l3-interface-ipv6-address-list
11348       description: |
11349         Create or update an existing l3-interface-ipv6-address-list.
11350         #
11351         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11352       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11353       consumes:
11354         - application/json
11355         - application/xml
11356       produces:
11357         - application/json
11358         - application/xml
11359       responses:
11360         "default":
11361           description: Response codes found in [response codes](https://wiki.onap.org/).
11362       parameters:
11363         - name: hostname
11364           in: path
11365           description: Value from executing hostname on the compute node.
11366           required: true
11367           type: string
11368           example: __HOSTNAME__
11369         - name: interface-name
11370           in: path
11371           description: Name that identifies the physical interface
11372           required: true
11373           type: string
11374           example: __INTERFACE-NAME__
11375         - name: interface-name
11376           in: path
11377           description: Name given to the interface
11378           required: true
11379           type: string
11380           example: __INTERFACE-NAME__
11381         - name: l3-interface-ipv6-address
11382           in: path
11383           description: IP address
11384           required: true
11385           type: string
11386           example: __L3-INTERFACE-IPV6-ADDRESS__
11387         - name: body
11388           in: body
11389           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11390           required: true
11391           schema:
11392             $ref: "#/definitions/l3-interface-ipv6-address-list"
11393     patch:
11394       tags:
11395         - CloudInfrastructure
11396       summary: update an existing l3-interface-ipv6-address-list
11397       description: |
11398         Update an existing l3-interface-ipv6-address-list
11399         #
11400         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11401         The PUT operation will entirely replace an existing object.
11402         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11403         #
11404         Other differences between PUT and PATCH are:
11405         #
11406         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11407         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11408         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11409       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11410       consumes:
11411         - application/json
11412         - application/xml
11413       produces:
11414         - application/json
11415         - application/xml
11416       responses:
11417         "default":
11418           description: Response codes found in [response codes](https://wiki.onap.org/).
11419       parameters:
11420         - name: hostname
11421           in: path
11422           description: Value from executing hostname on the compute node.
11423           required: true
11424           type: string
11425           example: __HOSTNAME__
11426         - name: interface-name
11427           in: path
11428           description: Name that identifies the physical interface
11429           required: true
11430           type: string
11431           example: __INTERFACE-NAME__
11432         - name: interface-name
11433           in: path
11434           description: Name given to the interface
11435           required: true
11436           type: string
11437           example: __INTERFACE-NAME__
11438         - name: l3-interface-ipv6-address
11439           in: path
11440           description: IP address
11441           required: true
11442           type: string
11443           example: __L3-INTERFACE-IPV6-ADDRESS__
11444         - name: body
11445           in: body
11446           description: l3-interface-ipv6-address-list object that needs to be updated.
11447           required: true
11448           schema:
11449             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11450     delete:
11451       tags:
11452         - CloudInfrastructure
11453       summary: delete an existing l3-interface-ipv6-address-list
11454       description: delete an existing l3-interface-ipv6-address-list
11455       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11456       consumes:
11457         - application/json
11458         - application/xml
11459       produces:
11460         - application/json
11461         - application/xml
11462       responses:
11463         "default":
11464           description: Response codes found in [response codes](https://wiki.onap.org/).
11465       parameters:
11466         - name: hostname
11467           in: path
11468           description: Value from executing hostname on the compute node.
11469           required: true
11470           type: string
11471           example: __HOSTNAME__
11472         - name: interface-name
11473           in: path
11474           description: Name that identifies the physical interface
11475           required: true
11476           type: string
11477           example: __INTERFACE-NAME__
11478         - name: interface-name
11479           in: path
11480           description: Name given to the interface
11481           required: true
11482           type: string
11483           example: __INTERFACE-NAME__
11484         - name: l3-interface-ipv6-address
11485           in: path
11486           description: IP address
11487           required: true
11488           type: string
11489           example: __L3-INTERFACE-IPV6-ADDRESS__
11490         - name: resource-version
11491           in: query
11492           description: resource-version for concurrency
11493           required: true
11494           type: string
11495   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
11496     get:
11497       tags:
11498         - CloudInfrastructure
11499       summary: returns l-interface
11500       description: returns l-interface
11501       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11502       produces:
11503         - application/json
11504         - application/xml
11505       responses:
11506         "200":
11507           description: successful operation
11508           schema:
11509               $ref: "#/getDefinitions/l-interface"
11510         "default":
11511           description: Response codes found in [response codes](https://wiki.onap.org/).
11512       parameters:
11513         - name: hostname
11514           in: path
11515           description: Value from executing hostname on the compute node.
11516           required: true
11517           type: string
11518           example: __HOSTNAME__
11519         - name: interface-name
11520           in: path
11521           description: Name that identifies the physical interface
11522           required: true
11523           type: string
11524           example: __INTERFACE-NAME__
11525         - name: interface-name
11526           in: path
11527           description: Name given to the interface
11528           required: true
11529           type: string
11530           example: __INTERFACE-NAME__
11531     put:
11532       tags:
11533         - CloudInfrastructure
11534       summary: create or update an existing l-interface
11535       description: |
11536         Create or update an existing l-interface.
11537         #
11538         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11539       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11540       consumes:
11541         - application/json
11542         - application/xml
11543       produces:
11544         - application/json
11545         - application/xml
11546       responses:
11547         "default":
11548           description: Response codes found in [response codes](https://wiki.onap.org/).
11549       parameters:
11550         - name: hostname
11551           in: path
11552           description: Value from executing hostname on the compute node.
11553           required: true
11554           type: string
11555           example: __HOSTNAME__
11556         - name: interface-name
11557           in: path
11558           description: Name that identifies the physical interface
11559           required: true
11560           type: string
11561           example: __INTERFACE-NAME__
11562         - name: interface-name
11563           in: path
11564           description: Name given to the interface
11565           required: true
11566           type: string
11567           example: __INTERFACE-NAME__
11568         - name: body
11569           in: body
11570           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
11571           required: true
11572           schema:
11573             $ref: "#/definitions/l-interface"
11574     patch:
11575       tags:
11576         - CloudInfrastructure
11577       summary: update an existing l-interface
11578       description: |
11579         Update an existing l-interface
11580         #
11581         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11582         The PUT operation will entirely replace an existing object.
11583         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11584         #
11585         Other differences between PUT and PATCH are:
11586         #
11587         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11588         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11589         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11590       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11591       consumes:
11592         - application/json
11593         - application/xml
11594       produces:
11595         - application/json
11596         - application/xml
11597       responses:
11598         "default":
11599           description: Response codes found in [response codes](https://wiki.onap.org/).
11600       parameters:
11601         - name: hostname
11602           in: path
11603           description: Value from executing hostname on the compute node.
11604           required: true
11605           type: string
11606           example: __HOSTNAME__
11607         - name: interface-name
11608           in: path
11609           description: Name that identifies the physical interface
11610           required: true
11611           type: string
11612           example: __INTERFACE-NAME__
11613         - name: interface-name
11614           in: path
11615           description: Name given to the interface
11616           required: true
11617           type: string
11618           example: __INTERFACE-NAME__
11619         - name: body
11620           in: body
11621           description: l-interface object that needs to be updated.
11622           required: true
11623           schema:
11624             $ref: "#/patchDefinitions/l-interface"
11625     delete:
11626       tags:
11627         - CloudInfrastructure
11628       summary: delete an existing l-interface
11629       description: delete an existing l-interface
11630       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11631       consumes:
11632         - application/json
11633         - application/xml
11634       produces:
11635         - application/json
11636         - application/xml
11637       responses:
11638         "default":
11639           description: Response codes found in [response codes](https://wiki.onap.org/).
11640       parameters:
11641         - name: hostname
11642           in: path
11643           description: Value from executing hostname on the compute node.
11644           required: true
11645           type: string
11646           example: __HOSTNAME__
11647         - name: interface-name
11648           in: path
11649           description: Name that identifies the physical interface
11650           required: true
11651           type: string
11652           example: __INTERFACE-NAME__
11653         - name: interface-name
11654           in: path
11655           description: Name given to the interface
11656           required: true
11657           type: string
11658           example: __INTERFACE-NAME__
11659         - name: resource-version
11660           in: query
11661           description: resource-version for concurrency
11662           required: true
11663           type: string
11664   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
11665     get:
11666       tags:
11667         - CloudInfrastructure
11668       summary: returns l-interfaces
11669       description: returns l-interfaces
11670       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
11671       produces:
11672         - application/json
11673         - application/xml
11674       responses:
11675         "200":
11676           description: successful operation
11677           schema:
11678               $ref: "#/getDefinitions/l-interfaces"
11679         "default":
11680           description: Response codes found in [response codes](https://wiki.onap.org/).
11681       parameters:
11682         - name: hostname
11683           in: path
11684           description: Value from executing hostname on the compute node.
11685           required: true
11686           type: string
11687           example: __HOSTNAME__
11688         - name: interface-name
11689           in: path
11690           description: Name that identifies the physical interface
11691           required: true
11692           type: string
11693           example: __INTERFACE-NAME__
11694         - name: interface-name
11695           in: query
11696           description:
11697           required: false
11698           type: string
11699         - name: interface-id
11700           in: query
11701           description:
11702           required: false
11703           type: string
11704         - name: macaddr
11705           in: query
11706           description:
11707           required: false
11708           type: string
11709         - name: network-name
11710           in: query
11711           description:
11712           required: false
11713           type: string
11714   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
11715     get:
11716       tags:
11717         - CloudInfrastructure
11718       summary: returns p-interface
11719       description: returns p-interface
11720       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
11721       produces:
11722         - application/json
11723         - application/xml
11724       responses:
11725         "200":
11726           description: successful operation
11727           schema:
11728               $ref: "#/getDefinitions/p-interface"
11729         "default":
11730           description: Response codes found in [response codes](https://wiki.onap.org/).
11731       parameters:
11732         - name: hostname
11733           in: path
11734           description: Value from executing hostname on the compute node.
11735           required: true
11736           type: string
11737           example: __HOSTNAME__
11738         - name: interface-name
11739           in: path
11740           description: Name that identifies the physical interface
11741           required: true
11742           type: string
11743           example: __INTERFACE-NAME__
11744     put:
11745       tags:
11746         - CloudInfrastructure
11747       summary: create or update an existing p-interface
11748       description: |
11749         Create or update an existing p-interface.
11750         #
11751         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11752       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
11753       consumes:
11754         - application/json
11755         - application/xml
11756       produces:
11757         - application/json
11758         - application/xml
11759       responses:
11760         "default":
11761           description: Response codes found in [response codes](https://wiki.onap.org/).
11762       parameters:
11763         - name: hostname
11764           in: path
11765           description: Value from executing hostname on the compute node.
11766           required: true
11767           type: string
11768           example: __HOSTNAME__
11769         - name: interface-name
11770           in: path
11771           description: Name that identifies the physical interface
11772           required: true
11773           type: string
11774           example: __INTERFACE-NAME__
11775         - name: body
11776           in: body
11777           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
11778           required: true
11779           schema:
11780             $ref: "#/definitions/p-interface"
11781     patch:
11782       tags:
11783         - CloudInfrastructure
11784       summary: update an existing p-interface
11785       description: |
11786         Update an existing p-interface
11787         #
11788         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11789         The PUT operation will entirely replace an existing object.
11790         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11791         #
11792         Other differences between PUT and PATCH are:
11793         #
11794         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11795         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11796         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11797       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
11798       consumes:
11799         - application/json
11800         - application/xml
11801       produces:
11802         - application/json
11803         - application/xml
11804       responses:
11805         "default":
11806           description: Response codes found in [response codes](https://wiki.onap.org/).
11807       parameters:
11808         - name: hostname
11809           in: path
11810           description: Value from executing hostname on the compute node.
11811           required: true
11812           type: string
11813           example: __HOSTNAME__
11814         - name: interface-name
11815           in: path
11816           description: Name that identifies the physical interface
11817           required: true
11818           type: string
11819           example: __INTERFACE-NAME__
11820         - name: body
11821           in: body
11822           description: p-interface object that needs to be updated.
11823           required: true
11824           schema:
11825             $ref: "#/patchDefinitions/p-interface"
11826     delete:
11827       tags:
11828         - CloudInfrastructure
11829       summary: delete an existing p-interface
11830       description: delete an existing p-interface
11831       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
11832       consumes:
11833         - application/json
11834         - application/xml
11835       produces:
11836         - application/json
11837         - application/xml
11838       responses:
11839         "default":
11840           description: Response codes found in [response codes](https://wiki.onap.org/).
11841       parameters:
11842         - name: hostname
11843           in: path
11844           description: Value from executing hostname on the compute node.
11845           required: true
11846           type: string
11847           example: __HOSTNAME__
11848         - name: interface-name
11849           in: path
11850           description: Name that identifies the physical interface
11851           required: true
11852           type: string
11853           example: __INTERFACE-NAME__
11854         - name: resource-version
11855           in: query
11856           description: resource-version for concurrency
11857           required: true
11858           type: string
11859   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
11860     get:
11861       tags:
11862         - CloudInfrastructure
11863       summary: returns p-interfaces
11864       description: returns p-interfaces
11865       operationId: getCloudInfrastructurePserversPserverPInterfaces
11866       produces:
11867         - application/json
11868         - application/xml
11869       responses:
11870         "200":
11871           description: successful operation
11872           schema:
11873               $ref: "#/getDefinitions/p-interfaces"
11874         "default":
11875           description: Response codes found in [response codes](https://wiki.onap.org/).
11876       parameters:
11877         - name: hostname
11878           in: path
11879           description: Value from executing hostname on the compute node.
11880           required: true
11881           type: string
11882           example: __HOSTNAME__
11883         - name: interface-name
11884           in: query
11885           description:
11886           required: false
11887           type: string
11888         - name: prov-status
11889           in: query
11890           description:
11891           required: false
11892           type: string
11893   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
11894     put:
11895       tags:
11896         - CloudInfrastructure
11897       summary: see node definition for valid relationships
11898       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
11899       consumes:
11900         - application/json
11901         - application/xml
11902       produces:
11903         - application/json
11904         - application/xml
11905       responses:
11906         "default":
11907           description: Response codes found in [response codes](https://wiki.onap.org/).
11908       parameters:
11909         - name: hostname
11910           in: path
11911           description: Value from executing hostname on the compute node.
11912           required: true
11913           type: string
11914           example: __HOSTNAME__
11915         - name: interface-name
11916           in: path
11917           description: Name that identifies the link aggregate interface
11918           required: true
11919           type: string
11920           example: __INTERFACE-NAME__
11921         - name: body
11922           in: body
11923           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
11924           required: true
11925           schema:
11926             $ref: "#/definitions/relationship"
11927     delete:
11928       tags:
11929         - CloudInfrastructure
11930       summary: delete an existing relationship
11931       description: delete an existing relationship
11932       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
11933       consumes:
11934         - application/json
11935         - application/xml
11936       produces:
11937         - application/json
11938         - application/xml
11939       responses:
11940         "default":
11941           description: Response codes found in [response codes](https://wiki.onap.org/).
11942       parameters:
11943         - name: hostname
11944           in: path
11945           description: Value from executing hostname on the compute node.
11946           required: true
11947           type: string
11948           example: __HOSTNAME__
11949         - name: interface-name
11950           in: path
11951           description: Name that identifies the link aggregate interface
11952           required: true
11953           type: string
11954           example: __INTERFACE-NAME__
11955   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
11956     put:
11957       tags:
11958         - CloudInfrastructure
11959       summary: see node definition for valid relationships
11960       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11961       consumes:
11962         - application/json
11963         - application/xml
11964       produces:
11965         - application/json
11966         - application/xml
11967       responses:
11968         "default":
11969           description: Response codes found in [response codes](https://wiki.onap.org/).
11970       parameters:
11971         - name: hostname
11972           in: path
11973           description: Value from executing hostname on the compute node.
11974           required: true
11975           type: string
11976           example: __HOSTNAME__
11977         - name: interface-name
11978           in: path
11979           description: Name that identifies the link aggregate interface
11980           required: true
11981           type: string
11982           example: __INTERFACE-NAME__
11983         - name: interface-name
11984           in: path
11985           description: Name given to the interface
11986           required: true
11987           type: string
11988           example: __INTERFACE-NAME__
11989         - name: vlan-interface
11990           in: path
11991           description: String that identifies the interface
11992           required: true
11993           type: string
11994           example: __VLAN-INTERFACE__
11995         - name: body
11996           in: body
11997           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
11998           required: true
11999           schema:
12000             $ref: "#/definitions/relationship"
12001     delete:
12002       tags:
12003         - CloudInfrastructure
12004       summary: delete an existing relationship
12005       description: delete an existing relationship
12006       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
12007       consumes:
12008         - application/json
12009         - application/xml
12010       produces:
12011         - application/json
12012         - application/xml
12013       responses:
12014         "default":
12015           description: Response codes found in [response codes](https://wiki.onap.org/).
12016       parameters:
12017         - name: hostname
12018           in: path
12019           description: Value from executing hostname on the compute node.
12020           required: true
12021           type: string
12022           example: __HOSTNAME__
12023         - name: interface-name
12024           in: path
12025           description: Name that identifies the link aggregate interface
12026           required: true
12027           type: string
12028           example: __INTERFACE-NAME__
12029         - name: interface-name
12030           in: path
12031           description: Name given to the interface
12032           required: true
12033           type: string
12034           example: __INTERFACE-NAME__
12035         - name: vlan-interface
12036           in: path
12037           description: String that identifies the interface
12038           required: true
12039           type: string
12040           example: __VLAN-INTERFACE__
12041   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
12042     put:
12043       tags:
12044         - CloudInfrastructure
12045       summary: see node definition for valid relationships
12046       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
12047       consumes:
12048         - application/json
12049         - application/xml
12050       produces:
12051         - application/json
12052         - application/xml
12053       responses:
12054         "default":
12055           description: Response codes found in [response codes](https://wiki.onap.org/).
12056       parameters:
12057         - name: hostname
12058           in: path
12059           description: Value from executing hostname on the compute node.
12060           required: true
12061           type: string
12062           example: __HOSTNAME__
12063         - name: interface-name
12064           in: path
12065           description: Name that identifies the link aggregate interface
12066           required: true
12067           type: string
12068           example: __INTERFACE-NAME__
12069         - name: interface-name
12070           in: path
12071           description: Name given to the interface
12072           required: true
12073           type: string
12074           example: __INTERFACE-NAME__
12075         - name: vlan-interface
12076           in: path
12077           description: String that identifies the interface
12078           required: true
12079           type: string
12080           example: __VLAN-INTERFACE__
12081         - name: l3-interface-ipv4-address
12082           in: path
12083           description: IP address
12084           required: true
12085           type: string
12086           example: __L3-INTERFACE-IPV4-ADDRESS__
12087         - name: body
12088           in: body
12089           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
12090           required: true
12091           schema:
12092             $ref: "#/definitions/relationship"
12093     delete:
12094       tags:
12095         - CloudInfrastructure
12096       summary: delete an existing relationship
12097       description: delete an existing relationship
12098       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
12099       consumes:
12100         - application/json
12101         - application/xml
12102       produces:
12103         - application/json
12104         - application/xml
12105       responses:
12106         "default":
12107           description: Response codes found in [response codes](https://wiki.onap.org/).
12108       parameters:
12109         - name: hostname
12110           in: path
12111           description: Value from executing hostname on the compute node.
12112           required: true
12113           type: string
12114           example: __HOSTNAME__
12115         - name: interface-name
12116           in: path
12117           description: Name that identifies the link aggregate interface
12118           required: true
12119           type: string
12120           example: __INTERFACE-NAME__
12121         - name: interface-name
12122           in: path
12123           description: Name given to the interface
12124           required: true
12125           type: string
12126           example: __INTERFACE-NAME__
12127         - name: vlan-interface
12128           in: path
12129           description: String that identifies the interface
12130           required: true
12131           type: string
12132           example: __VLAN-INTERFACE__
12133         - name: l3-interface-ipv4-address
12134           in: path
12135           description: IP address
12136           required: true
12137           type: string
12138           example: __L3-INTERFACE-IPV4-ADDRESS__
12139   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
12140     get:
12141       tags:
12142         - CloudInfrastructure
12143       summary: returns l3-interface-ipv4-address-list
12144       description: returns l3-interface-ipv4-address-list
12145       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12146       produces:
12147         - application/json
12148         - application/xml
12149       responses:
12150         "200":
12151           description: successful operation
12152           schema:
12153               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12154         "default":
12155           description: Response codes found in [response codes](https://wiki.onap.org/).
12156       parameters:
12157         - name: hostname
12158           in: path
12159           description: Value from executing hostname on the compute node.
12160           required: true
12161           type: string
12162           example: __HOSTNAME__
12163         - name: interface-name
12164           in: path
12165           description: Name that identifies the link aggregate interface
12166           required: true
12167           type: string
12168           example: __INTERFACE-NAME__
12169         - name: interface-name
12170           in: path
12171           description: Name given to the interface
12172           required: true
12173           type: string
12174           example: __INTERFACE-NAME__
12175         - name: vlan-interface
12176           in: path
12177           description: String that identifies the interface
12178           required: true
12179           type: string
12180           example: __VLAN-INTERFACE__
12181         - name: l3-interface-ipv4-address
12182           in: path
12183           description: IP address
12184           required: true
12185           type: string
12186           example: __L3-INTERFACE-IPV4-ADDRESS__
12187     put:
12188       tags:
12189         - CloudInfrastructure
12190       summary: create or update an existing l3-interface-ipv4-address-list
12191       description: |
12192         Create or update an existing l3-interface-ipv4-address-list.
12193         #
12194         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12195       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12196       consumes:
12197         - application/json
12198         - application/xml
12199       produces:
12200         - application/json
12201         - application/xml
12202       responses:
12203         "default":
12204           description: Response codes found in [response codes](https://wiki.onap.org/).
12205       parameters:
12206         - name: hostname
12207           in: path
12208           description: Value from executing hostname on the compute node.
12209           required: true
12210           type: string
12211           example: __HOSTNAME__
12212         - name: interface-name
12213           in: path
12214           description: Name that identifies the link aggregate interface
12215           required: true
12216           type: string
12217           example: __INTERFACE-NAME__
12218         - name: interface-name
12219           in: path
12220           description: Name given to the interface
12221           required: true
12222           type: string
12223           example: __INTERFACE-NAME__
12224         - name: vlan-interface
12225           in: path
12226           description: String that identifies the interface
12227           required: true
12228           type: string
12229           example: __VLAN-INTERFACE__
12230         - name: l3-interface-ipv4-address
12231           in: path
12232           description: IP address
12233           required: true
12234           type: string
12235           example: __L3-INTERFACE-IPV4-ADDRESS__
12236         - name: body
12237           in: body
12238           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
12239           required: true
12240           schema:
12241             $ref: "#/definitions/l3-interface-ipv4-address-list"
12242     patch:
12243       tags:
12244         - CloudInfrastructure
12245       summary: update an existing l3-interface-ipv4-address-list
12246       description: |
12247         Update an existing l3-interface-ipv4-address-list
12248         #
12249         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12250         The PUT operation will entirely replace an existing object.
12251         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12252         #
12253         Other differences between PUT and PATCH are:
12254         #
12255         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12256         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12257         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12258       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12259       consumes:
12260         - application/json
12261         - application/xml
12262       produces:
12263         - application/json
12264         - application/xml
12265       responses:
12266         "default":
12267           description: Response codes found in [response codes](https://wiki.onap.org/).
12268       parameters:
12269         - name: hostname
12270           in: path
12271           description: Value from executing hostname on the compute node.
12272           required: true
12273           type: string
12274           example: __HOSTNAME__
12275         - name: interface-name
12276           in: path
12277           description: Name that identifies the link aggregate interface
12278           required: true
12279           type: string
12280           example: __INTERFACE-NAME__
12281         - name: interface-name
12282           in: path
12283           description: Name given to the interface
12284           required: true
12285           type: string
12286           example: __INTERFACE-NAME__
12287         - name: vlan-interface
12288           in: path
12289           description: String that identifies the interface
12290           required: true
12291           type: string
12292           example: __VLAN-INTERFACE__
12293         - name: l3-interface-ipv4-address
12294           in: path
12295           description: IP address
12296           required: true
12297           type: string
12298           example: __L3-INTERFACE-IPV4-ADDRESS__
12299         - name: body
12300           in: body
12301           description: l3-interface-ipv4-address-list object that needs to be updated.
12302           required: true
12303           schema:
12304             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12305     delete:
12306       tags:
12307         - CloudInfrastructure
12308       summary: delete an existing l3-interface-ipv4-address-list
12309       description: delete an existing l3-interface-ipv4-address-list
12310       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12311       consumes:
12312         - application/json
12313         - application/xml
12314       produces:
12315         - application/json
12316         - application/xml
12317       responses:
12318         "default":
12319           description: Response codes found in [response codes](https://wiki.onap.org/).
12320       parameters:
12321         - name: hostname
12322           in: path
12323           description: Value from executing hostname on the compute node.
12324           required: true
12325           type: string
12326           example: __HOSTNAME__
12327         - name: interface-name
12328           in: path
12329           description: Name that identifies the link aggregate interface
12330           required: true
12331           type: string
12332           example: __INTERFACE-NAME__
12333         - name: interface-name
12334           in: path
12335           description: Name given to the interface
12336           required: true
12337           type: string
12338           example: __INTERFACE-NAME__
12339         - name: vlan-interface
12340           in: path
12341           description: String that identifies the interface
12342           required: true
12343           type: string
12344           example: __VLAN-INTERFACE__
12345         - name: l3-interface-ipv4-address
12346           in: path
12347           description: IP address
12348           required: true
12349           type: string
12350           example: __L3-INTERFACE-IPV4-ADDRESS__
12351         - name: resource-version
12352           in: query
12353           description: resource-version for concurrency
12354           required: true
12355           type: string
12356   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
12357     put:
12358       tags:
12359         - CloudInfrastructure
12360       summary: see node definition for valid relationships
12361       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12362       consumes:
12363         - application/json
12364         - application/xml
12365       produces:
12366         - application/json
12367         - application/xml
12368       responses:
12369         "default":
12370           description: Response codes found in [response codes](https://wiki.onap.org/).
12371       parameters:
12372         - name: hostname
12373           in: path
12374           description: Value from executing hostname on the compute node.
12375           required: true
12376           type: string
12377           example: __HOSTNAME__
12378         - name: interface-name
12379           in: path
12380           description: Name that identifies the link aggregate interface
12381           required: true
12382           type: string
12383           example: __INTERFACE-NAME__
12384         - name: interface-name
12385           in: path
12386           description: Name given to the interface
12387           required: true
12388           type: string
12389           example: __INTERFACE-NAME__
12390         - name: vlan-interface
12391           in: path
12392           description: String that identifies the interface
12393           required: true
12394           type: string
12395           example: __VLAN-INTERFACE__
12396         - name: l3-interface-ipv6-address
12397           in: path
12398           description: IP address
12399           required: true
12400           type: string
12401           example: __L3-INTERFACE-IPV6-ADDRESS__
12402         - name: body
12403           in: body
12404           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12405           required: true
12406           schema:
12407             $ref: "#/definitions/relationship"
12408     delete:
12409       tags:
12410         - CloudInfrastructure
12411       summary: delete an existing relationship
12412       description: delete an existing relationship
12413       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12414       consumes:
12415         - application/json
12416         - application/xml
12417       produces:
12418         - application/json
12419         - application/xml
12420       responses:
12421         "default":
12422           description: Response codes found in [response codes](https://wiki.onap.org/).
12423       parameters:
12424         - name: hostname
12425           in: path
12426           description: Value from executing hostname on the compute node.
12427           required: true
12428           type: string
12429           example: __HOSTNAME__
12430         - name: interface-name
12431           in: path
12432           description: Name that identifies the link aggregate interface
12433           required: true
12434           type: string
12435           example: __INTERFACE-NAME__
12436         - name: interface-name
12437           in: path
12438           description: Name given to the interface
12439           required: true
12440           type: string
12441           example: __INTERFACE-NAME__
12442         - name: vlan-interface
12443           in: path
12444           description: String that identifies the interface
12445           required: true
12446           type: string
12447           example: __VLAN-INTERFACE__
12448         - name: l3-interface-ipv6-address
12449           in: path
12450           description: IP address
12451           required: true
12452           type: string
12453           example: __L3-INTERFACE-IPV6-ADDRESS__
12454   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
12455     get:
12456       tags:
12457         - CloudInfrastructure
12458       summary: returns l3-interface-ipv6-address-list
12459       description: returns l3-interface-ipv6-address-list
12460       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12461       produces:
12462         - application/json
12463         - application/xml
12464       responses:
12465         "200":
12466           description: successful operation
12467           schema:
12468               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
12469         "default":
12470           description: Response codes found in [response codes](https://wiki.onap.org/).
12471       parameters:
12472         - name: hostname
12473           in: path
12474           description: Value from executing hostname on the compute node.
12475           required: true
12476           type: string
12477           example: __HOSTNAME__
12478         - name: interface-name
12479           in: path
12480           description: Name that identifies the link aggregate interface
12481           required: true
12482           type: string
12483           example: __INTERFACE-NAME__
12484         - name: interface-name
12485           in: path
12486           description: Name given to the interface
12487           required: true
12488           type: string
12489           example: __INTERFACE-NAME__
12490         - name: vlan-interface
12491           in: path
12492           description: String that identifies the interface
12493           required: true
12494           type: string
12495           example: __VLAN-INTERFACE__
12496         - name: l3-interface-ipv6-address
12497           in: path
12498           description: IP address
12499           required: true
12500           type: string
12501           example: __L3-INTERFACE-IPV6-ADDRESS__
12502     put:
12503       tags:
12504         - CloudInfrastructure
12505       summary: create or update an existing l3-interface-ipv6-address-list
12506       description: |
12507         Create or update an existing l3-interface-ipv6-address-list.
12508         #
12509         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12510       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12511       consumes:
12512         - application/json
12513         - application/xml
12514       produces:
12515         - application/json
12516         - application/xml
12517       responses:
12518         "default":
12519           description: Response codes found in [response codes](https://wiki.onap.org/).
12520       parameters:
12521         - name: hostname
12522           in: path
12523           description: Value from executing hostname on the compute node.
12524           required: true
12525           type: string
12526           example: __HOSTNAME__
12527         - name: interface-name
12528           in: path
12529           description: Name that identifies the link aggregate interface
12530           required: true
12531           type: string
12532           example: __INTERFACE-NAME__
12533         - name: interface-name
12534           in: path
12535           description: Name given to the interface
12536           required: true
12537           type: string
12538           example: __INTERFACE-NAME__
12539         - name: vlan-interface
12540           in: path
12541           description: String that identifies the interface
12542           required: true
12543           type: string
12544           example: __VLAN-INTERFACE__
12545         - name: l3-interface-ipv6-address
12546           in: path
12547           description: IP address
12548           required: true
12549           type: string
12550           example: __L3-INTERFACE-IPV6-ADDRESS__
12551         - name: body
12552           in: body
12553           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12554           required: true
12555           schema:
12556             $ref: "#/definitions/l3-interface-ipv6-address-list"
12557     patch:
12558       tags:
12559         - CloudInfrastructure
12560       summary: update an existing l3-interface-ipv6-address-list
12561       description: |
12562         Update an existing l3-interface-ipv6-address-list
12563         #
12564         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12565         The PUT operation will entirely replace an existing object.
12566         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12567         #
12568         Other differences between PUT and PATCH are:
12569         #
12570         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12571         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12572         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12573       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12574       consumes:
12575         - application/json
12576         - application/xml
12577       produces:
12578         - application/json
12579         - application/xml
12580       responses:
12581         "default":
12582           description: Response codes found in [response codes](https://wiki.onap.org/).
12583       parameters:
12584         - name: hostname
12585           in: path
12586           description: Value from executing hostname on the compute node.
12587           required: true
12588           type: string
12589           example: __HOSTNAME__
12590         - name: interface-name
12591           in: path
12592           description: Name that identifies the link aggregate interface
12593           required: true
12594           type: string
12595           example: __INTERFACE-NAME__
12596         - name: interface-name
12597           in: path
12598           description: Name given to the interface
12599           required: true
12600           type: string
12601           example: __INTERFACE-NAME__
12602         - name: vlan-interface
12603           in: path
12604           description: String that identifies the interface
12605           required: true
12606           type: string
12607           example: __VLAN-INTERFACE__
12608         - name: l3-interface-ipv6-address
12609           in: path
12610           description: IP address
12611           required: true
12612           type: string
12613           example: __L3-INTERFACE-IPV6-ADDRESS__
12614         - name: body
12615           in: body
12616           description: l3-interface-ipv6-address-list object that needs to be updated.
12617           required: true
12618           schema:
12619             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
12620     delete:
12621       tags:
12622         - CloudInfrastructure
12623       summary: delete an existing l3-interface-ipv6-address-list
12624       description: delete an existing l3-interface-ipv6-address-list
12625       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12626       consumes:
12627         - application/json
12628         - application/xml
12629       produces:
12630         - application/json
12631         - application/xml
12632       responses:
12633         "default":
12634           description: Response codes found in [response codes](https://wiki.onap.org/).
12635       parameters:
12636         - name: hostname
12637           in: path
12638           description: Value from executing hostname on the compute node.
12639           required: true
12640           type: string
12641           example: __HOSTNAME__
12642         - name: interface-name
12643           in: path
12644           description: Name that identifies the link aggregate interface
12645           required: true
12646           type: string
12647           example: __INTERFACE-NAME__
12648         - name: interface-name
12649           in: path
12650           description: Name given to the interface
12651           required: true
12652           type: string
12653           example: __INTERFACE-NAME__
12654         - name: vlan-interface
12655           in: path
12656           description: String that identifies the interface
12657           required: true
12658           type: string
12659           example: __VLAN-INTERFACE__
12660         - name: l3-interface-ipv6-address
12661           in: path
12662           description: IP address
12663           required: true
12664           type: string
12665           example: __L3-INTERFACE-IPV6-ADDRESS__
12666         - name: resource-version
12667           in: query
12668           description: resource-version for concurrency
12669           required: true
12670           type: string
12671   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
12672     get:
12673       tags:
12674         - CloudInfrastructure
12675       summary: returns vlan
12676       description: returns vlan
12677       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12678       produces:
12679         - application/json
12680         - application/xml
12681       responses:
12682         "200":
12683           description: successful operation
12684           schema:
12685               $ref: "#/getDefinitions/vlan"
12686         "default":
12687           description: Response codes found in [response codes](https://wiki.onap.org/).
12688       parameters:
12689         - name: hostname
12690           in: path
12691           description: Value from executing hostname on the compute node.
12692           required: true
12693           type: string
12694           example: __HOSTNAME__
12695         - name: interface-name
12696           in: path
12697           description: Name that identifies the link aggregate interface
12698           required: true
12699           type: string
12700           example: __INTERFACE-NAME__
12701         - name: interface-name
12702           in: path
12703           description: Name given to the interface
12704           required: true
12705           type: string
12706           example: __INTERFACE-NAME__
12707         - name: vlan-interface
12708           in: path
12709           description: String that identifies the interface
12710           required: true
12711           type: string
12712           example: __VLAN-INTERFACE__
12713     put:
12714       tags:
12715         - CloudInfrastructure
12716       summary: create or update an existing vlan
12717       description: |
12718         Create or update an existing vlan.
12719         #
12720         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12721       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12722       consumes:
12723         - application/json
12724         - application/xml
12725       produces:
12726         - application/json
12727         - application/xml
12728       responses:
12729         "default":
12730           description: Response codes found in [response codes](https://wiki.onap.org/).
12731       parameters:
12732         - name: hostname
12733           in: path
12734           description: Value from executing hostname on the compute node.
12735           required: true
12736           type: string
12737           example: __HOSTNAME__
12738         - name: interface-name
12739           in: path
12740           description: Name that identifies the link aggregate interface
12741           required: true
12742           type: string
12743           example: __INTERFACE-NAME__
12744         - name: interface-name
12745           in: path
12746           description: Name given to the interface
12747           required: true
12748           type: string
12749           example: __INTERFACE-NAME__
12750         - name: vlan-interface
12751           in: path
12752           description: String that identifies the interface
12753           required: true
12754           type: string
12755           example: __VLAN-INTERFACE__
12756         - name: body
12757           in: body
12758           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
12759           required: true
12760           schema:
12761             $ref: "#/definitions/vlan"
12762     patch:
12763       tags:
12764         - CloudInfrastructure
12765       summary: update an existing vlan
12766       description: |
12767         Update an existing vlan
12768         #
12769         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12770         The PUT operation will entirely replace an existing object.
12771         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12772         #
12773         Other differences between PUT and PATCH are:
12774         #
12775         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12776         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12777         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12778       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12779       consumes:
12780         - application/json
12781         - application/xml
12782       produces:
12783         - application/json
12784         - application/xml
12785       responses:
12786         "default":
12787           description: Response codes found in [response codes](https://wiki.onap.org/).
12788       parameters:
12789         - name: hostname
12790           in: path
12791           description: Value from executing hostname on the compute node.
12792           required: true
12793           type: string
12794           example: __HOSTNAME__
12795         - name: interface-name
12796           in: path
12797           description: Name that identifies the link aggregate interface
12798           required: true
12799           type: string
12800           example: __INTERFACE-NAME__
12801         - name: interface-name
12802           in: path
12803           description: Name given to the interface
12804           required: true
12805           type: string
12806           example: __INTERFACE-NAME__
12807         - name: vlan-interface
12808           in: path
12809           description: String that identifies the interface
12810           required: true
12811           type: string
12812           example: __VLAN-INTERFACE__
12813         - name: body
12814           in: body
12815           description: vlan object that needs to be updated.
12816           required: true
12817           schema:
12818             $ref: "#/patchDefinitions/vlan"
12819     delete:
12820       tags:
12821         - CloudInfrastructure
12822       summary: delete an existing vlan
12823       description: delete an existing vlan
12824       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12825       consumes:
12826         - application/json
12827         - application/xml
12828       produces:
12829         - application/json
12830         - application/xml
12831       responses:
12832         "default":
12833           description: Response codes found in [response codes](https://wiki.onap.org/).
12834       parameters:
12835         - name: hostname
12836           in: path
12837           description: Value from executing hostname on the compute node.
12838           required: true
12839           type: string
12840           example: __HOSTNAME__
12841         - name: interface-name
12842           in: path
12843           description: Name that identifies the link aggregate interface
12844           required: true
12845           type: string
12846           example: __INTERFACE-NAME__
12847         - name: interface-name
12848           in: path
12849           description: Name given to the interface
12850           required: true
12851           type: string
12852           example: __INTERFACE-NAME__
12853         - name: vlan-interface
12854           in: path
12855           description: String that identifies the interface
12856           required: true
12857           type: string
12858           example: __VLAN-INTERFACE__
12859         - name: resource-version
12860           in: query
12861           description: resource-version for concurrency
12862           required: true
12863           type: string
12864   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
12865     get:
12866       tags:
12867         - CloudInfrastructure
12868       summary: returns vlans
12869       description: returns vlans
12870       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
12871       produces:
12872         - application/json
12873         - application/xml
12874       responses:
12875         "200":
12876           description: successful operation
12877           schema:
12878               $ref: "#/getDefinitions/vlans"
12879         "default":
12880           description: Response codes found in [response codes](https://wiki.onap.org/).
12881       parameters:
12882         - name: hostname
12883           in: path
12884           description: Value from executing hostname on the compute node.
12885           required: true
12886           type: string
12887           example: __HOSTNAME__
12888         - name: interface-name
12889           in: path
12890           description: Name that identifies the link aggregate interface
12891           required: true
12892           type: string
12893           example: __INTERFACE-NAME__
12894         - name: interface-name
12895           in: path
12896           description: Name given to the interface
12897           required: true
12898           type: string
12899           example: __INTERFACE-NAME__
12900         - name: vlan-interface
12901           in: query
12902           description:
12903           required: false
12904           type: string
12905         - name: vlan-id-inner
12906           in: query
12907           description:
12908           required: false
12909           type: integer
12910           format: int64
12911         - name: vpn-key
12912           in: query
12913           description:
12914           required: false
12915           type: string
12916   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
12917     put:
12918       tags:
12919         - CloudInfrastructure
12920       summary: see node definition for valid relationships
12921       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12922       consumes:
12923         - application/json
12924         - application/xml
12925       produces:
12926         - application/json
12927         - application/xml
12928       responses:
12929         "default":
12930           description: Response codes found in [response codes](https://wiki.onap.org/).
12931       parameters:
12932         - name: hostname
12933           in: path
12934           description: Value from executing hostname on the compute node.
12935           required: true
12936           type: string
12937           example: __HOSTNAME__
12938         - name: interface-name
12939           in: path
12940           description: Name that identifies the link aggregate interface
12941           required: true
12942           type: string
12943           example: __INTERFACE-NAME__
12944         - name: interface-name
12945           in: path
12946           description: Name given to the interface
12947           required: true
12948           type: string
12949           example: __INTERFACE-NAME__
12950         - name: pci-id
12951           in: path
12952           description: PCI ID used to identify the sriov-vf
12953           required: true
12954           type: string
12955           example: __PCI-ID__
12956         - name: body
12957           in: body
12958           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12959           required: true
12960           schema:
12961             $ref: "#/definitions/relationship"
12962     delete:
12963       tags:
12964         - CloudInfrastructure
12965       summary: delete an existing relationship
12966       description: delete an existing relationship
12967       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12968       consumes:
12969         - application/json
12970         - application/xml
12971       produces:
12972         - application/json
12973         - application/xml
12974       responses:
12975         "default":
12976           description: Response codes found in [response codes](https://wiki.onap.org/).
12977       parameters:
12978         - name: hostname
12979           in: path
12980           description: Value from executing hostname on the compute node.
12981           required: true
12982           type: string
12983           example: __HOSTNAME__
12984         - name: interface-name
12985           in: path
12986           description: Name that identifies the link aggregate interface
12987           required: true
12988           type: string
12989           example: __INTERFACE-NAME__
12990         - name: interface-name
12991           in: path
12992           description: Name given to the interface
12993           required: true
12994           type: string
12995           example: __INTERFACE-NAME__
12996         - name: pci-id
12997           in: path
12998           description: PCI ID used to identify the sriov-vf
12999           required: true
13000           type: string
13001           example: __PCI-ID__
13002   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
13003     get:
13004       tags:
13005         - CloudInfrastructure
13006       summary: returns sriov-vf
13007       description: returns sriov-vf
13008       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13009       produces:
13010         - application/json
13011         - application/xml
13012       responses:
13013         "200":
13014           description: successful operation
13015           schema:
13016               $ref: "#/getDefinitions/sriov-vf"
13017         "default":
13018           description: Response codes found in [response codes](https://wiki.onap.org/).
13019       parameters:
13020         - name: hostname
13021           in: path
13022           description: Value from executing hostname on the compute node.
13023           required: true
13024           type: string
13025           example: __HOSTNAME__
13026         - name: interface-name
13027           in: path
13028           description: Name that identifies the link aggregate interface
13029           required: true
13030           type: string
13031           example: __INTERFACE-NAME__
13032         - name: interface-name
13033           in: path
13034           description: Name given to the interface
13035           required: true
13036           type: string
13037           example: __INTERFACE-NAME__
13038         - name: pci-id
13039           in: path
13040           description: PCI ID used to identify the sriov-vf
13041           required: true
13042           type: string
13043           example: __PCI-ID__
13044     put:
13045       tags:
13046         - CloudInfrastructure
13047       summary: create or update an existing sriov-vf
13048       description: |
13049         Create or update an existing sriov-vf.
13050         #
13051         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13052       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13053       consumes:
13054         - application/json
13055         - application/xml
13056       produces:
13057         - application/json
13058         - application/xml
13059       responses:
13060         "default":
13061           description: Response codes found in [response codes](https://wiki.onap.org/).
13062       parameters:
13063         - name: hostname
13064           in: path
13065           description: Value from executing hostname on the compute node.
13066           required: true
13067           type: string
13068           example: __HOSTNAME__
13069         - name: interface-name
13070           in: path
13071           description: Name that identifies the link aggregate interface
13072           required: true
13073           type: string
13074           example: __INTERFACE-NAME__
13075         - name: interface-name
13076           in: path
13077           description: Name given to the interface
13078           required: true
13079           type: string
13080           example: __INTERFACE-NAME__
13081         - name: pci-id
13082           in: path
13083           description: PCI ID used to identify the sriov-vf
13084           required: true
13085           type: string
13086           example: __PCI-ID__
13087         - name: body
13088           in: body
13089           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
13090           required: true
13091           schema:
13092             $ref: "#/definitions/sriov-vf"
13093     patch:
13094       tags:
13095         - CloudInfrastructure
13096       summary: update an existing sriov-vf
13097       description: |
13098         Update an existing sriov-vf
13099         #
13100         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13101         The PUT operation will entirely replace an existing object.
13102         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13103         #
13104         Other differences between PUT and PATCH are:
13105         #
13106         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13107         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13108         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13109       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13110       consumes:
13111         - application/json
13112         - application/xml
13113       produces:
13114         - application/json
13115         - application/xml
13116       responses:
13117         "default":
13118           description: Response codes found in [response codes](https://wiki.onap.org/).
13119       parameters:
13120         - name: hostname
13121           in: path
13122           description: Value from executing hostname on the compute node.
13123           required: true
13124           type: string
13125           example: __HOSTNAME__
13126         - name: interface-name
13127           in: path
13128           description: Name that identifies the link aggregate interface
13129           required: true
13130           type: string
13131           example: __INTERFACE-NAME__
13132         - name: interface-name
13133           in: path
13134           description: Name given to the interface
13135           required: true
13136           type: string
13137           example: __INTERFACE-NAME__
13138         - name: pci-id
13139           in: path
13140           description: PCI ID used to identify the sriov-vf
13141           required: true
13142           type: string
13143           example: __PCI-ID__
13144         - name: body
13145           in: body
13146           description: sriov-vf object that needs to be updated.
13147           required: true
13148           schema:
13149             $ref: "#/patchDefinitions/sriov-vf"
13150     delete:
13151       tags:
13152         - CloudInfrastructure
13153       summary: delete an existing sriov-vf
13154       description: delete an existing sriov-vf
13155       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13156       consumes:
13157         - application/json
13158         - application/xml
13159       produces:
13160         - application/json
13161         - application/xml
13162       responses:
13163         "default":
13164           description: Response codes found in [response codes](https://wiki.onap.org/).
13165       parameters:
13166         - name: hostname
13167           in: path
13168           description: Value from executing hostname on the compute node.
13169           required: true
13170           type: string
13171           example: __HOSTNAME__
13172         - name: interface-name
13173           in: path
13174           description: Name that identifies the link aggregate interface
13175           required: true
13176           type: string
13177           example: __INTERFACE-NAME__
13178         - name: interface-name
13179           in: path
13180           description: Name given to the interface
13181           required: true
13182           type: string
13183           example: __INTERFACE-NAME__
13184         - name: pci-id
13185           in: path
13186           description: PCI ID used to identify the sriov-vf
13187           required: true
13188           type: string
13189           example: __PCI-ID__
13190         - name: resource-version
13191           in: query
13192           description: resource-version for concurrency
13193           required: true
13194           type: string
13195   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
13196     get:
13197       tags:
13198         - CloudInfrastructure
13199       summary: returns sriov-vfs
13200       description: returns sriov-vfs
13201       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
13202       produces:
13203         - application/json
13204         - application/xml
13205       responses:
13206         "200":
13207           description: successful operation
13208           schema:
13209               $ref: "#/getDefinitions/sriov-vfs"
13210         "default":
13211           description: Response codes found in [response codes](https://wiki.onap.org/).
13212       parameters:
13213         - name: hostname
13214           in: path
13215           description: Value from executing hostname on the compute node.
13216           required: true
13217           type: string
13218           example: __HOSTNAME__
13219         - name: interface-name
13220           in: path
13221           description: Name that identifies the link aggregate interface
13222           required: true
13223           type: string
13224           example: __INTERFACE-NAME__
13225         - name: interface-name
13226           in: path
13227           description: Name given to the interface
13228           required: true
13229           type: string
13230           example: __INTERFACE-NAME__
13231         - name: pci-id
13232           in: query
13233           description:
13234           required: false
13235           type: string
13236         - name: vf-vlan-filter
13237           in: query
13238           description:
13239           required: false
13240           type: string
13241         - name: vf-mac-filter
13242           in: query
13243           description:
13244           required: false
13245           type: string
13246         - name: vf-vlan-strip
13247           in: query
13248           description:
13249           required: false
13250           type: boolean
13251         - name: neutron-network-id
13252           in: query
13253           description:
13254           required: false
13255           type: string
13256   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
13257     put:
13258       tags:
13259         - CloudInfrastructure
13260       summary: see node definition for valid relationships
13261       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
13262       consumes:
13263         - application/json
13264         - application/xml
13265       produces:
13266         - application/json
13267         - application/xml
13268       responses:
13269         "default":
13270           description: Response codes found in [response codes](https://wiki.onap.org/).
13271       parameters:
13272         - name: hostname
13273           in: path
13274           description: Value from executing hostname on the compute node.
13275           required: true
13276           type: string
13277           example: __HOSTNAME__
13278         - name: interface-name
13279           in: path
13280           description: Name that identifies the link aggregate interface
13281           required: true
13282           type: string
13283           example: __INTERFACE-NAME__
13284         - name: interface-name
13285           in: path
13286           description: Name given to the interface
13287           required: true
13288           type: string
13289           example: __INTERFACE-NAME__
13290         - name: body
13291           in: body
13292           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13293           required: true
13294           schema:
13295             $ref: "#/definitions/relationship"
13296     delete:
13297       tags:
13298         - CloudInfrastructure
13299       summary: delete an existing relationship
13300       description: delete an existing relationship
13301       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
13302       consumes:
13303         - application/json
13304         - application/xml
13305       produces:
13306         - application/json
13307         - application/xml
13308       responses:
13309         "default":
13310           description: Response codes found in [response codes](https://wiki.onap.org/).
13311       parameters:
13312         - name: hostname
13313           in: path
13314           description: Value from executing hostname on the compute node.
13315           required: true
13316           type: string
13317           example: __HOSTNAME__
13318         - name: interface-name
13319           in: path
13320           description: Name that identifies the link aggregate interface
13321           required: true
13322           type: string
13323           example: __INTERFACE-NAME__
13324         - name: interface-name
13325           in: path
13326           description: Name given to the interface
13327           required: true
13328           type: string
13329           example: __INTERFACE-NAME__
13330   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
13331     put:
13332       tags:
13333         - CloudInfrastructure
13334       summary: see node definition for valid relationships
13335       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13336       consumes:
13337         - application/json
13338         - application/xml
13339       produces:
13340         - application/json
13341         - application/xml
13342       responses:
13343         "default":
13344           description: Response codes found in [response codes](https://wiki.onap.org/).
13345       parameters:
13346         - name: hostname
13347           in: path
13348           description: Value from executing hostname on the compute node.
13349           required: true
13350           type: string
13351           example: __HOSTNAME__
13352         - name: interface-name
13353           in: path
13354           description: Name that identifies the link aggregate interface
13355           required: true
13356           type: string
13357           example: __INTERFACE-NAME__
13358         - name: interface-name
13359           in: path
13360           description: Name given to the interface
13361           required: true
13362           type: string
13363           example: __INTERFACE-NAME__
13364         - name: l3-interface-ipv4-address
13365           in: path
13366           description: IP address
13367           required: true
13368           type: string
13369           example: __L3-INTERFACE-IPV4-ADDRESS__
13370         - name: body
13371           in: body
13372           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
13373           required: true
13374           schema:
13375             $ref: "#/definitions/relationship"
13376     delete:
13377       tags:
13378         - CloudInfrastructure
13379       summary: delete an existing relationship
13380       description: delete an existing relationship
13381       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13382       consumes:
13383         - application/json
13384         - application/xml
13385       produces:
13386         - application/json
13387         - application/xml
13388       responses:
13389         "default":
13390           description: Response codes found in [response codes](https://wiki.onap.org/).
13391       parameters:
13392         - name: hostname
13393           in: path
13394           description: Value from executing hostname on the compute node.
13395           required: true
13396           type: string
13397           example: __HOSTNAME__
13398         - name: interface-name
13399           in: path
13400           description: Name that identifies the link aggregate interface
13401           required: true
13402           type: string
13403           example: __INTERFACE-NAME__
13404         - name: interface-name
13405           in: path
13406           description: Name given to the interface
13407           required: true
13408           type: string
13409           example: __INTERFACE-NAME__
13410         - name: l3-interface-ipv4-address
13411           in: path
13412           description: IP address
13413           required: true
13414           type: string
13415           example: __L3-INTERFACE-IPV4-ADDRESS__
13416   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
13417     get:
13418       tags:
13419         - CloudInfrastructure
13420       summary: returns l3-interface-ipv4-address-list
13421       description: returns l3-interface-ipv4-address-list
13422       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13423       produces:
13424         - application/json
13425         - application/xml
13426       responses:
13427         "200":
13428           description: successful operation
13429           schema:
13430               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
13431         "default":
13432           description: Response codes found in [response codes](https://wiki.onap.org/).
13433       parameters:
13434         - name: hostname
13435           in: path
13436           description: Value from executing hostname on the compute node.
13437           required: true
13438           type: string
13439           example: __HOSTNAME__
13440         - name: interface-name
13441           in: path
13442           description: Name that identifies the link aggregate interface
13443           required: true
13444           type: string
13445           example: __INTERFACE-NAME__
13446         - name: interface-name
13447           in: path
13448           description: Name given to the interface
13449           required: true
13450           type: string
13451           example: __INTERFACE-NAME__
13452         - name: l3-interface-ipv4-address
13453           in: path
13454           description: IP address
13455           required: true
13456           type: string
13457           example: __L3-INTERFACE-IPV4-ADDRESS__
13458     put:
13459       tags:
13460         - CloudInfrastructure
13461       summary: create or update an existing l3-interface-ipv4-address-list
13462       description: |
13463         Create or update an existing l3-interface-ipv4-address-list.
13464         #
13465         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13466       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13467       consumes:
13468         - application/json
13469         - application/xml
13470       produces:
13471         - application/json
13472         - application/xml
13473       responses:
13474         "default":
13475           description: Response codes found in [response codes](https://wiki.onap.org/).
13476       parameters:
13477         - name: hostname
13478           in: path
13479           description: Value from executing hostname on the compute node.
13480           required: true
13481           type: string
13482           example: __HOSTNAME__
13483         - name: interface-name
13484           in: path
13485           description: Name that identifies the link aggregate interface
13486           required: true
13487           type: string
13488           example: __INTERFACE-NAME__
13489         - name: interface-name
13490           in: path
13491           description: Name given to the interface
13492           required: true
13493           type: string
13494           example: __INTERFACE-NAME__
13495         - name: l3-interface-ipv4-address
13496           in: path
13497           description: IP address
13498           required: true
13499           type: string
13500           example: __L3-INTERFACE-IPV4-ADDRESS__
13501         - name: body
13502           in: body
13503           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
13504           required: true
13505           schema:
13506             $ref: "#/definitions/l3-interface-ipv4-address-list"
13507     patch:
13508       tags:
13509         - CloudInfrastructure
13510       summary: update an existing l3-interface-ipv4-address-list
13511       description: |
13512         Update an existing l3-interface-ipv4-address-list
13513         #
13514         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13515         The PUT operation will entirely replace an existing object.
13516         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13517         #
13518         Other differences between PUT and PATCH are:
13519         #
13520         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13521         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13522         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13523       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13524       consumes:
13525         - application/json
13526         - application/xml
13527       produces:
13528         - application/json
13529         - application/xml
13530       responses:
13531         "default":
13532           description: Response codes found in [response codes](https://wiki.onap.org/).
13533       parameters:
13534         - name: hostname
13535           in: path
13536           description: Value from executing hostname on the compute node.
13537           required: true
13538           type: string
13539           example: __HOSTNAME__
13540         - name: interface-name
13541           in: path
13542           description: Name that identifies the link aggregate interface
13543           required: true
13544           type: string
13545           example: __INTERFACE-NAME__
13546         - name: interface-name
13547           in: path
13548           description: Name given to the interface
13549           required: true
13550           type: string
13551           example: __INTERFACE-NAME__
13552         - name: l3-interface-ipv4-address
13553           in: path
13554           description: IP address
13555           required: true
13556           type: string
13557           example: __L3-INTERFACE-IPV4-ADDRESS__
13558         - name: body
13559           in: body
13560           description: l3-interface-ipv4-address-list object that needs to be updated.
13561           required: true
13562           schema:
13563             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
13564     delete:
13565       tags:
13566         - CloudInfrastructure
13567       summary: delete an existing l3-interface-ipv4-address-list
13568       description: delete an existing l3-interface-ipv4-address-list
13569       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
13570       consumes:
13571         - application/json
13572         - application/xml
13573       produces:
13574         - application/json
13575         - application/xml
13576       responses:
13577         "default":
13578           description: Response codes found in [response codes](https://wiki.onap.org/).
13579       parameters:
13580         - name: hostname
13581           in: path
13582           description: Value from executing hostname on the compute node.
13583           required: true
13584           type: string
13585           example: __HOSTNAME__
13586         - name: interface-name
13587           in: path
13588           description: Name that identifies the link aggregate interface
13589           required: true
13590           type: string
13591           example: __INTERFACE-NAME__
13592         - name: interface-name
13593           in: path
13594           description: Name given to the interface
13595           required: true
13596           type: string
13597           example: __INTERFACE-NAME__
13598         - name: l3-interface-ipv4-address
13599           in: path
13600           description: IP address
13601           required: true
13602           type: string
13603           example: __L3-INTERFACE-IPV4-ADDRESS__
13604         - name: resource-version
13605           in: query
13606           description: resource-version for concurrency
13607           required: true
13608           type: string
13609   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
13610     put:
13611       tags:
13612         - CloudInfrastructure
13613       summary: see node definition for valid relationships
13614       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13615       consumes:
13616         - application/json
13617         - application/xml
13618       produces:
13619         - application/json
13620         - application/xml
13621       responses:
13622         "default":
13623           description: Response codes found in [response codes](https://wiki.onap.org/).
13624       parameters:
13625         - name: hostname
13626           in: path
13627           description: Value from executing hostname on the compute node.
13628           required: true
13629           type: string
13630           example: __HOSTNAME__
13631         - name: interface-name
13632           in: path
13633           description: Name that identifies the link aggregate interface
13634           required: true
13635           type: string
13636           example: __INTERFACE-NAME__
13637         - name: interface-name
13638           in: path
13639           description: Name given to the interface
13640           required: true
13641           type: string
13642           example: __INTERFACE-NAME__
13643         - name: l3-interface-ipv6-address
13644           in: path
13645           description: IP address
13646           required: true
13647           type: string
13648           example: __L3-INTERFACE-IPV6-ADDRESS__
13649         - name: body
13650           in: body
13651           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13652           required: true
13653           schema:
13654             $ref: "#/definitions/relationship"
13655     delete:
13656       tags:
13657         - CloudInfrastructure
13658       summary: delete an existing relationship
13659       description: delete an existing relationship
13660       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13661       consumes:
13662         - application/json
13663         - application/xml
13664       produces:
13665         - application/json
13666         - application/xml
13667       responses:
13668         "default":
13669           description: Response codes found in [response codes](https://wiki.onap.org/).
13670       parameters:
13671         - name: hostname
13672           in: path
13673           description: Value from executing hostname on the compute node.
13674           required: true
13675           type: string
13676           example: __HOSTNAME__
13677         - name: interface-name
13678           in: path
13679           description: Name that identifies the link aggregate interface
13680           required: true
13681           type: string
13682           example: __INTERFACE-NAME__
13683         - name: interface-name
13684           in: path
13685           description: Name given to the interface
13686           required: true
13687           type: string
13688           example: __INTERFACE-NAME__
13689         - name: l3-interface-ipv6-address
13690           in: path
13691           description: IP address
13692           required: true
13693           type: string
13694           example: __L3-INTERFACE-IPV6-ADDRESS__
13695   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
13696     get:
13697       tags:
13698         - CloudInfrastructure
13699       summary: returns l3-interface-ipv6-address-list
13700       description: returns l3-interface-ipv6-address-list
13701       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13702       produces:
13703         - application/json
13704         - application/xml
13705       responses:
13706         "200":
13707           description: successful operation
13708           schema:
13709               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
13710         "default":
13711           description: Response codes found in [response codes](https://wiki.onap.org/).
13712       parameters:
13713         - name: hostname
13714           in: path
13715           description: Value from executing hostname on the compute node.
13716           required: true
13717           type: string
13718           example: __HOSTNAME__
13719         - name: interface-name
13720           in: path
13721           description: Name that identifies the link aggregate interface
13722           required: true
13723           type: string
13724           example: __INTERFACE-NAME__
13725         - name: interface-name
13726           in: path
13727           description: Name given to the interface
13728           required: true
13729           type: string
13730           example: __INTERFACE-NAME__
13731         - name: l3-interface-ipv6-address
13732           in: path
13733           description: IP address
13734           required: true
13735           type: string
13736           example: __L3-INTERFACE-IPV6-ADDRESS__
13737     put:
13738       tags:
13739         - CloudInfrastructure
13740       summary: create or update an existing l3-interface-ipv6-address-list
13741       description: |
13742         Create or update an existing l3-interface-ipv6-address-list.
13743         #
13744         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13745       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13746       consumes:
13747         - application/json
13748         - application/xml
13749       produces:
13750         - application/json
13751         - application/xml
13752       responses:
13753         "default":
13754           description: Response codes found in [response codes](https://wiki.onap.org/).
13755       parameters:
13756         - name: hostname
13757           in: path
13758           description: Value from executing hostname on the compute node.
13759           required: true
13760           type: string
13761           example: __HOSTNAME__
13762         - name: interface-name
13763           in: path
13764           description: Name that identifies the link aggregate interface
13765           required: true
13766           type: string
13767           example: __INTERFACE-NAME__
13768         - name: interface-name
13769           in: path
13770           description: Name given to the interface
13771           required: true
13772           type: string
13773           example: __INTERFACE-NAME__
13774         - name: l3-interface-ipv6-address
13775           in: path
13776           description: IP address
13777           required: true
13778           type: string
13779           example: __L3-INTERFACE-IPV6-ADDRESS__
13780         - name: body
13781           in: body
13782           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13783           required: true
13784           schema:
13785             $ref: "#/definitions/l3-interface-ipv6-address-list"
13786     patch:
13787       tags:
13788         - CloudInfrastructure
13789       summary: update an existing l3-interface-ipv6-address-list
13790       description: |
13791         Update an existing l3-interface-ipv6-address-list
13792         #
13793         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13794         The PUT operation will entirely replace an existing object.
13795         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13796         #
13797         Other differences between PUT and PATCH are:
13798         #
13799         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13800         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13801         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13802       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13803       consumes:
13804         - application/json
13805         - application/xml
13806       produces:
13807         - application/json
13808         - application/xml
13809       responses:
13810         "default":
13811           description: Response codes found in [response codes](https://wiki.onap.org/).
13812       parameters:
13813         - name: hostname
13814           in: path
13815           description: Value from executing hostname on the compute node.
13816           required: true
13817           type: string
13818           example: __HOSTNAME__
13819         - name: interface-name
13820           in: path
13821           description: Name that identifies the link aggregate interface
13822           required: true
13823           type: string
13824           example: __INTERFACE-NAME__
13825         - name: interface-name
13826           in: path
13827           description: Name given to the interface
13828           required: true
13829           type: string
13830           example: __INTERFACE-NAME__
13831         - name: l3-interface-ipv6-address
13832           in: path
13833           description: IP address
13834           required: true
13835           type: string
13836           example: __L3-INTERFACE-IPV6-ADDRESS__
13837         - name: body
13838           in: body
13839           description: l3-interface-ipv6-address-list object that needs to be updated.
13840           required: true
13841           schema:
13842             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
13843     delete:
13844       tags:
13845         - CloudInfrastructure
13846       summary: delete an existing l3-interface-ipv6-address-list
13847       description: delete an existing l3-interface-ipv6-address-list
13848       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13849       consumes:
13850         - application/json
13851         - application/xml
13852       produces:
13853         - application/json
13854         - application/xml
13855       responses:
13856         "default":
13857           description: Response codes found in [response codes](https://wiki.onap.org/).
13858       parameters:
13859         - name: hostname
13860           in: path
13861           description: Value from executing hostname on the compute node.
13862           required: true
13863           type: string
13864           example: __HOSTNAME__
13865         - name: interface-name
13866           in: path
13867           description: Name that identifies the link aggregate interface
13868           required: true
13869           type: string
13870           example: __INTERFACE-NAME__
13871         - name: interface-name
13872           in: path
13873           description: Name given to the interface
13874           required: true
13875           type: string
13876           example: __INTERFACE-NAME__
13877         - name: l3-interface-ipv6-address
13878           in: path
13879           description: IP address
13880           required: true
13881           type: string
13882           example: __L3-INTERFACE-IPV6-ADDRESS__
13883         - name: resource-version
13884           in: query
13885           description: resource-version for concurrency
13886           required: true
13887           type: string
13888   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
13889     get:
13890       tags:
13891         - CloudInfrastructure
13892       summary: returns l-interface
13893       description: returns l-interface
13894       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13895       produces:
13896         - application/json
13897         - application/xml
13898       responses:
13899         "200":
13900           description: successful operation
13901           schema:
13902               $ref: "#/getDefinitions/l-interface"
13903         "default":
13904           description: Response codes found in [response codes](https://wiki.onap.org/).
13905       parameters:
13906         - name: hostname
13907           in: path
13908           description: Value from executing hostname on the compute node.
13909           required: true
13910           type: string
13911           example: __HOSTNAME__
13912         - name: interface-name
13913           in: path
13914           description: Name that identifies the link aggregate interface
13915           required: true
13916           type: string
13917           example: __INTERFACE-NAME__
13918         - name: interface-name
13919           in: path
13920           description: Name given to the interface
13921           required: true
13922           type: string
13923           example: __INTERFACE-NAME__
13924     put:
13925       tags:
13926         - CloudInfrastructure
13927       summary: create or update an existing l-interface
13928       description: |
13929         Create or update an existing l-interface.
13930         #
13931         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13932       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13933       consumes:
13934         - application/json
13935         - application/xml
13936       produces:
13937         - application/json
13938         - application/xml
13939       responses:
13940         "default":
13941           description: Response codes found in [response codes](https://wiki.onap.org/).
13942       parameters:
13943         - name: hostname
13944           in: path
13945           description: Value from executing hostname on the compute node.
13946           required: true
13947           type: string
13948           example: __HOSTNAME__
13949         - name: interface-name
13950           in: path
13951           description: Name that identifies the link aggregate interface
13952           required: true
13953           type: string
13954           example: __INTERFACE-NAME__
13955         - name: interface-name
13956           in: path
13957           description: Name given to the interface
13958           required: true
13959           type: string
13960           example: __INTERFACE-NAME__
13961         - name: body
13962           in: body
13963           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13964           required: true
13965           schema:
13966             $ref: "#/definitions/l-interface"
13967     patch:
13968       tags:
13969         - CloudInfrastructure
13970       summary: update an existing l-interface
13971       description: |
13972         Update an existing l-interface
13973         #
13974         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13975         The PUT operation will entirely replace an existing object.
13976         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13977         #
13978         Other differences between PUT and PATCH are:
13979         #
13980         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13981         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13982         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13983       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13984       consumes:
13985         - application/json
13986         - application/xml
13987       produces:
13988         - application/json
13989         - application/xml
13990       responses:
13991         "default":
13992           description: Response codes found in [response codes](https://wiki.onap.org/).
13993       parameters:
13994         - name: hostname
13995           in: path
13996           description: Value from executing hostname on the compute node.
13997           required: true
13998           type: string
13999           example: __HOSTNAME__
14000         - name: interface-name
14001           in: path
14002           description: Name that identifies the link aggregate interface
14003           required: true
14004           type: string
14005           example: __INTERFACE-NAME__
14006         - name: interface-name
14007           in: path
14008           description: Name given to the interface
14009           required: true
14010           type: string
14011           example: __INTERFACE-NAME__
14012         - name: body
14013           in: body
14014           description: l-interface object that needs to be updated.
14015           required: true
14016           schema:
14017             $ref: "#/patchDefinitions/l-interface"
14018     delete:
14019       tags:
14020         - CloudInfrastructure
14021       summary: delete an existing l-interface
14022       description: delete an existing l-interface
14023       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14024       consumes:
14025         - application/json
14026         - application/xml
14027       produces:
14028         - application/json
14029         - application/xml
14030       responses:
14031         "default":
14032           description: Response codes found in [response codes](https://wiki.onap.org/).
14033       parameters:
14034         - name: hostname
14035           in: path
14036           description: Value from executing hostname on the compute node.
14037           required: true
14038           type: string
14039           example: __HOSTNAME__
14040         - name: interface-name
14041           in: path
14042           description: Name that identifies the link aggregate interface
14043           required: true
14044           type: string
14045           example: __INTERFACE-NAME__
14046         - name: interface-name
14047           in: path
14048           description: Name given to the interface
14049           required: true
14050           type: string
14051           example: __INTERFACE-NAME__
14052         - name: resource-version
14053           in: query
14054           description: resource-version for concurrency
14055           required: true
14056           type: string
14057   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
14058     get:
14059       tags:
14060         - CloudInfrastructure
14061       summary: returns l-interfaces
14062       description: returns l-interfaces
14063       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
14064       produces:
14065         - application/json
14066         - application/xml
14067       responses:
14068         "200":
14069           description: successful operation
14070           schema:
14071               $ref: "#/getDefinitions/l-interfaces"
14072         "default":
14073           description: Response codes found in [response codes](https://wiki.onap.org/).
14074       parameters:
14075         - name: hostname
14076           in: path
14077           description: Value from executing hostname on the compute node.
14078           required: true
14079           type: string
14080           example: __HOSTNAME__
14081         - name: interface-name
14082           in: path
14083           description: Name that identifies the link aggregate interface
14084           required: true
14085           type: string
14086           example: __INTERFACE-NAME__
14087         - name: interface-name
14088           in: query
14089           description:
14090           required: false
14091           type: string
14092         - name: interface-id
14093           in: query
14094           description:
14095           required: false
14096           type: string
14097         - name: macaddr
14098           in: query
14099           description:
14100           required: false
14101           type: string
14102         - name: network-name
14103           in: query
14104           description:
14105           required: false
14106           type: string
14107   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
14108     get:
14109       tags:
14110         - CloudInfrastructure
14111       summary: returns lag-interface
14112       description: returns lag-interface
14113       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
14114       produces:
14115         - application/json
14116         - application/xml
14117       responses:
14118         "200":
14119           description: successful operation
14120           schema:
14121               $ref: "#/getDefinitions/lag-interface"
14122         "default":
14123           description: Response codes found in [response codes](https://wiki.onap.org/).
14124       parameters:
14125         - name: hostname
14126           in: path
14127           description: Value from executing hostname on the compute node.
14128           required: true
14129           type: string
14130           example: __HOSTNAME__
14131         - name: interface-name
14132           in: path
14133           description: Name that identifies the link aggregate interface
14134           required: true
14135           type: string
14136           example: __INTERFACE-NAME__
14137     put:
14138       tags:
14139         - CloudInfrastructure
14140       summary: create or update an existing lag-interface
14141       description: |
14142         Create or update an existing lag-interface.
14143         #
14144         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14145       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
14146       consumes:
14147         - application/json
14148         - application/xml
14149       produces:
14150         - application/json
14151         - application/xml
14152       responses:
14153         "default":
14154           description: Response codes found in [response codes](https://wiki.onap.org/).
14155       parameters:
14156         - name: hostname
14157           in: path
14158           description: Value from executing hostname on the compute node.
14159           required: true
14160           type: string
14161           example: __HOSTNAME__
14162         - name: interface-name
14163           in: path
14164           description: Name that identifies the link aggregate interface
14165           required: true
14166           type: string
14167           example: __INTERFACE-NAME__
14168         - name: body
14169           in: body
14170           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
14171           required: true
14172           schema:
14173             $ref: "#/definitions/lag-interface"
14174     patch:
14175       tags:
14176         - CloudInfrastructure
14177       summary: update an existing lag-interface
14178       description: |
14179         Update an existing lag-interface
14180         #
14181         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14182         The PUT operation will entirely replace an existing object.
14183         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14184         #
14185         Other differences between PUT and PATCH are:
14186         #
14187         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14188         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14189         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14190       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
14191       consumes:
14192         - application/json
14193         - application/xml
14194       produces:
14195         - application/json
14196         - application/xml
14197       responses:
14198         "default":
14199           description: Response codes found in [response codes](https://wiki.onap.org/).
14200       parameters:
14201         - name: hostname
14202           in: path
14203           description: Value from executing hostname on the compute node.
14204           required: true
14205           type: string
14206           example: __HOSTNAME__
14207         - name: interface-name
14208           in: path
14209           description: Name that identifies the link aggregate interface
14210           required: true
14211           type: string
14212           example: __INTERFACE-NAME__
14213         - name: body
14214           in: body
14215           description: lag-interface object that needs to be updated.
14216           required: true
14217           schema:
14218             $ref: "#/patchDefinitions/lag-interface"
14219     delete:
14220       tags:
14221         - CloudInfrastructure
14222       summary: delete an existing lag-interface
14223       description: delete an existing lag-interface
14224       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
14225       consumes:
14226         - application/json
14227         - application/xml
14228       produces:
14229         - application/json
14230         - application/xml
14231       responses:
14232         "default":
14233           description: Response codes found in [response codes](https://wiki.onap.org/).
14234       parameters:
14235         - name: hostname
14236           in: path
14237           description: Value from executing hostname on the compute node.
14238           required: true
14239           type: string
14240           example: __HOSTNAME__
14241         - name: interface-name
14242           in: path
14243           description: Name that identifies the link aggregate interface
14244           required: true
14245           type: string
14246           example: __INTERFACE-NAME__
14247         - name: resource-version
14248           in: query
14249           description: resource-version for concurrency
14250           required: true
14251           type: string
14252   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
14253     get:
14254       tags:
14255         - CloudInfrastructure
14256       summary: returns lag-interfaces
14257       description: returns lag-interfaces
14258       operationId: getCloudInfrastructurePserversPserverLagInterfaces
14259       produces:
14260         - application/json
14261         - application/xml
14262       responses:
14263         "200":
14264           description: successful operation
14265           schema:
14266               $ref: "#/getDefinitions/lag-interfaces"
14267         "default":
14268           description: Response codes found in [response codes](https://wiki.onap.org/).
14269       parameters:
14270         - name: hostname
14271           in: path
14272           description: Value from executing hostname on the compute node.
14273           required: true
14274           type: string
14275           example: __HOSTNAME__
14276         - name: interface-name
14277           in: query
14278           description:
14279           required: false
14280           type: string
14281         - name: interface-id
14282           in: query
14283           description:
14284           required: false
14285           type: string
14286         - name: interface-role
14287           in: query
14288           description:
14289           required: false
14290           type: string
14291   /cloud-infrastructure/pservers/pserver/{hostname}:
14292     get:
14293       tags:
14294         - CloudInfrastructure
14295       summary: returns pserver
14296       description: returns pserver
14297       operationId: getCloudInfrastructurePserversPserver
14298       produces:
14299         - application/json
14300         - application/xml
14301       responses:
14302         "200":
14303           description: successful operation
14304           schema:
14305               $ref: "#/getDefinitions/pserver"
14306         "default":
14307           description: Response codes found in [response codes](https://wiki.onap.org/).
14308       parameters:
14309         - name: hostname
14310           in: path
14311           description: Value from executing hostname on the compute node.
14312           required: true
14313           type: string
14314           example: __HOSTNAME__
14315     put:
14316       tags:
14317         - CloudInfrastructure
14318       summary: create or update an existing pserver
14319       description: |
14320         Create or update an existing pserver.
14321         #
14322         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14323       operationId: createOrUpdateCloudInfrastructurePserversPserver
14324       consumes:
14325         - application/json
14326         - application/xml
14327       produces:
14328         - application/json
14329         - application/xml
14330       responses:
14331         "default":
14332           description: Response codes found in [response codes](https://wiki.onap.org/).
14333       parameters:
14334         - name: hostname
14335           in: path
14336           description: Value from executing hostname on the compute node.
14337           required: true
14338           type: string
14339           example: __HOSTNAME__
14340         - name: body
14341           in: body
14342           description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserver.json)
14343           required: true
14344           schema:
14345             $ref: "#/definitions/pserver"
14346     patch:
14347       tags:
14348         - CloudInfrastructure
14349       summary: update an existing pserver
14350       description: |
14351         Update an existing pserver
14352         #
14353         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14354         The PUT operation will entirely replace an existing object.
14355         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14356         #
14357         Other differences between PUT and PATCH are:
14358         #
14359         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14360         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14361         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14362       operationId: UpdateCloudInfrastructurePserversPserver
14363       consumes:
14364         - application/json
14365         - application/xml
14366       produces:
14367         - application/json
14368         - application/xml
14369       responses:
14370         "default":
14371           description: Response codes found in [response codes](https://wiki.onap.org/).
14372       parameters:
14373         - name: hostname
14374           in: path
14375           description: Value from executing hostname on the compute node.
14376           required: true
14377           type: string
14378           example: __HOSTNAME__
14379         - name: body
14380           in: body
14381           description: pserver object that needs to be updated.
14382           required: true
14383           schema:
14384             $ref: "#/patchDefinitions/pserver"
14385     delete:
14386       tags:
14387         - CloudInfrastructure
14388       summary: delete an existing pserver
14389       description: delete an existing pserver
14390       operationId: deleteCloudInfrastructurePserversPserver
14391       consumes:
14392         - application/json
14393         - application/xml
14394       produces:
14395         - application/json
14396         - application/xml
14397       responses:
14398         "default":
14399           description: Response codes found in [response codes](https://wiki.onap.org/).
14400       parameters:
14401         - name: hostname
14402           in: path
14403           description: Value from executing hostname on the compute node.
14404           required: true
14405           type: string
14406           example: __HOSTNAME__
14407         - name: resource-version
14408           in: query
14409           description: resource-version for concurrency
14410           required: true
14411           type: string
14412   /cloud-infrastructure/pservers:
14413     get:
14414       tags:
14415         - CloudInfrastructure
14416       summary: returns pservers
14417       description: returns pservers
14418       operationId: getCloudInfrastructurePservers
14419       produces:
14420         - application/json
14421         - application/xml
14422       responses:
14423         "200":
14424           description: successful operation
14425           schema:
14426               $ref: "#/getDefinitions/pservers"
14427         "default":
14428           description: Response codes found in [response codes](https://wiki.onap.org/).
14429       parameters:
14430         - name: hostname
14431           in: query
14432           description:
14433           required: false
14434           type: string
14435         - name: inv-status
14436           in: query
14437           description:
14438           required: false
14439           type: string
14440         - name: pserver-id
14441           in: query
14442           description:
14443           required: false
14444           type: string
14445         - name: in-maint
14446           in: query
14447           description:
14448           required: false
14449           type: boolean
14450         - name: pserver-name2
14451           in: query
14452           description:
14453           required: false
14454           type: string
14455   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
14456     put:
14457       tags:
14458         - CloudInfrastructure
14459       summary: see node definition for valid relationships
14460       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14461       consumes:
14462         - application/json
14463         - application/xml
14464       produces:
14465         - application/json
14466         - application/xml
14467       responses:
14468         "default":
14469           description: Response codes found in [response codes](https://wiki.onap.org/).
14470       parameters:
14471         - name: vdc-id
14472           in: path
14473           description: Unique ID of the vdc
14474           required: true
14475           type: string
14476           example: __VDC-ID__
14477         - name: body
14478           in: body
14479           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14480           required: true
14481           schema:
14482             $ref: "#/definitions/relationship"
14483     delete:
14484       tags:
14485         - CloudInfrastructure
14486       summary: delete an existing relationship
14487       description: delete an existing relationship
14488       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14489       consumes:
14490         - application/json
14491         - application/xml
14492       produces:
14493         - application/json
14494         - application/xml
14495       responses:
14496         "default":
14497           description: Response codes found in [response codes](https://wiki.onap.org/).
14498       parameters:
14499         - name: vdc-id
14500           in: path
14501           description: Unique ID of the vdc
14502           required: true
14503           type: string
14504           example: __VDC-ID__
14505   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
14506     get:
14507       tags:
14508         - CloudInfrastructure
14509       summary: returns virtual-data-center
14510       description: returns virtual-data-center
14511       operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
14512       produces:
14513         - application/json
14514         - application/xml
14515       responses:
14516         "200":
14517           description: successful operation
14518           schema:
14519               $ref: "#/getDefinitions/virtual-data-center"
14520         "default":
14521           description: Response codes found in [response codes](https://wiki.onap.org/).
14522       parameters:
14523         - name: vdc-id
14524           in: path
14525           description: Unique ID of the vdc
14526           required: true
14527           type: string
14528           example: __VDC-ID__
14529     put:
14530       tags:
14531         - CloudInfrastructure
14532       summary: create or update an existing virtual-data-center
14533       description: |
14534         Create or update an existing virtual-data-center.
14535         #
14536         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14537       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14538       consumes:
14539         - application/json
14540         - application/xml
14541       produces:
14542         - application/json
14543         - application/xml
14544       responses:
14545         "default":
14546           description: Response codes found in [response codes](https://wiki.onap.org/).
14547       parameters:
14548         - name: vdc-id
14549           in: path
14550           description: Unique ID of the vdc
14551           required: true
14552           type: string
14553           example: __VDC-ID__
14554         - name: body
14555           in: body
14556           description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14557           required: true
14558           schema:
14559             $ref: "#/definitions/virtual-data-center"
14560     patch:
14561       tags:
14562         - CloudInfrastructure
14563       summary: update an existing virtual-data-center
14564       description: |
14565         Update an existing virtual-data-center
14566         #
14567         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14568         The PUT operation will entirely replace an existing object.
14569         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14570         #
14571         Other differences between PUT and PATCH are:
14572         #
14573         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14574         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14575         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14576       operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14577       consumes:
14578         - application/json
14579         - application/xml
14580       produces:
14581         - application/json
14582         - application/xml
14583       responses:
14584         "default":
14585           description: Response codes found in [response codes](https://wiki.onap.org/).
14586       parameters:
14587         - name: vdc-id
14588           in: path
14589           description: Unique ID of the vdc
14590           required: true
14591           type: string
14592           example: __VDC-ID__
14593         - name: body
14594           in: body
14595           description: virtual-data-center object that needs to be updated.
14596           required: true
14597           schema:
14598             $ref: "#/patchDefinitions/virtual-data-center"
14599     delete:
14600       tags:
14601         - CloudInfrastructure
14602       summary: delete an existing virtual-data-center
14603       description: delete an existing virtual-data-center
14604       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
14605       consumes:
14606         - application/json
14607         - application/xml
14608       produces:
14609         - application/json
14610         - application/xml
14611       responses:
14612         "default":
14613           description: Response codes found in [response codes](https://wiki.onap.org/).
14614       parameters:
14615         - name: vdc-id
14616           in: path
14617           description: Unique ID of the vdc
14618           required: true
14619           type: string
14620           example: __VDC-ID__
14621         - name: resource-version
14622           in: query
14623           description: resource-version for concurrency
14624           required: true
14625           type: string
14626   /cloud-infrastructure/virtual-data-centers:
14627     get:
14628       tags:
14629         - CloudInfrastructure
14630       summary: returns virtual-data-centers
14631       description: returns virtual-data-centers
14632       operationId: getCloudInfrastructureVirtualDataCenters
14633       produces:
14634         - application/json
14635         - application/xml
14636       responses:
14637         "200":
14638           description: successful operation
14639           schema:
14640               $ref: "#/getDefinitions/virtual-data-centers"
14641         "default":
14642           description: Response codes found in [response codes](https://wiki.onap.org/).
14643       parameters:
14644         - name: vdc-id
14645           in: query
14646           description:
14647           required: false
14648           type: string
14649         - name: vdc-name
14650           in: query
14651           description:
14652           required: false
14653           type: string
14654   /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}/relationship-list/relationship:
14655     put:
14656       tags:
14657         - CloudInfrastructure
14658       summary: see node definition for valid relationships
14659       operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
14660       consumes:
14661         - application/json
14662         - application/xml
14663       produces:
14664         - application/json
14665         - application/xml
14666       responses:
14667         "default":
14668           description: Response codes found in [response codes](https://wiki.onap.org/).
14669       parameters:
14670         - name: operational-environment-id
14671           in: path
14672           description: UUID of an operational environment
14673           required: true
14674           type: string
14675           example: __OPERATIONAL-ENVIRONMENT-ID__
14676         - name: body
14677           in: body
14678           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
14679           required: true
14680           schema:
14681             $ref: "#/definitions/relationship"
14682     delete:
14683       tags:
14684         - CloudInfrastructure
14685       summary: delete an existing relationship
14686       description: delete an existing relationship
14687       operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironmentRelationshipListRelationship
14688       consumes:
14689         - application/json
14690         - application/xml
14691       produces:
14692         - application/json
14693         - application/xml
14694       responses:
14695         "default":
14696           description: Response codes found in [response codes](https://wiki.onap.org/).
14697       parameters:
14698         - name: operational-environment-id
14699           in: path
14700           description: UUID of an operational environment
14701           required: true
14702           type: string
14703           example: __OPERATIONAL-ENVIRONMENT-ID__
14704   /cloud-infrastructure/operational-environments/operational-environment/{operational-environment-id}:
14705     get:
14706       tags:
14707         - CloudInfrastructure
14708       summary: returns operational-environment
14709       description: returns operational-environment
14710       operationId: getCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14711       produces:
14712         - application/json
14713         - application/xml
14714       responses:
14715         "200":
14716           description: successful operation
14717           schema:
14718               $ref: "#/getDefinitions/operational-environment"
14719         "default":
14720           description: Response codes found in [response codes](https://wiki.onap.org/).
14721       parameters:
14722         - name: operational-environment-id
14723           in: path
14724           description: UUID of an operational environment
14725           required: true
14726           type: string
14727           example: __OPERATIONAL-ENVIRONMENT-ID__
14728     put:
14729       tags:
14730         - CloudInfrastructure
14731       summary: create or update an existing operational-environment
14732       description: |
14733         Create or update an existing operational-environment.
14734         #
14735         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14736       operationId: createOrUpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14737       consumes:
14738         - application/json
14739         - application/xml
14740       produces:
14741         - application/json
14742         - application/xml
14743       responses:
14744         "default":
14745           description: Response codes found in [response codes](https://wiki.onap.org/).
14746       parameters:
14747         - name: operational-environment-id
14748           in: path
14749           description: UUID of an operational environment
14750           required: true
14751           type: string
14752           example: __OPERATIONAL-ENVIRONMENT-ID__
14753         - name: body
14754           in: body
14755           description: operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)
14756           required: true
14757           schema:
14758             $ref: "#/definitions/operational-environment"
14759     patch:
14760       tags:
14761         - CloudInfrastructure
14762       summary: update an existing operational-environment
14763       description: |
14764         Update an existing operational-environment
14765         #
14766         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14767         The PUT operation will entirely replace an existing object.
14768         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14769         #
14770         Other differences between PUT and PATCH are:
14771         #
14772         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14773         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14774         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14775       operationId: UpdateCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14776       consumes:
14777         - application/json
14778         - application/xml
14779       produces:
14780         - application/json
14781         - application/xml
14782       responses:
14783         "default":
14784           description: Response codes found in [response codes](https://wiki.onap.org/).
14785       parameters:
14786         - name: operational-environment-id
14787           in: path
14788           description: UUID of an operational environment
14789           required: true
14790           type: string
14791           example: __OPERATIONAL-ENVIRONMENT-ID__
14792         - name: body
14793           in: body
14794           description: operational-environment object that needs to be updated.
14795           required: true
14796           schema:
14797             $ref: "#/patchDefinitions/operational-environment"
14798     delete:
14799       tags:
14800         - CloudInfrastructure
14801       summary: delete an existing operational-environment
14802       description: delete an existing operational-environment
14803       operationId: deleteCloudInfrastructureOperationalEnvironmentsOperationalEnvironment
14804       consumes:
14805         - application/json
14806         - application/xml
14807       produces:
14808         - application/json
14809         - application/xml
14810       responses:
14811         "default":
14812           description: Response codes found in [response codes](https://wiki.onap.org/).
14813       parameters:
14814         - name: operational-environment-id
14815           in: path
14816           description: UUID of an operational environment
14817           required: true
14818           type: string
14819           example: __OPERATIONAL-ENVIRONMENT-ID__
14820         - name: resource-version
14821           in: query
14822           description: resource-version for concurrency
14823           required: true
14824           type: string
14825   /cloud-infrastructure/operational-environments:
14826     get:
14827       tags:
14828         - CloudInfrastructure
14829       summary: returns operational-environments
14830       description: returns operational-environments
14831       operationId: getCloudInfrastructureOperationalEnvironments
14832       produces:
14833         - application/json
14834         - application/xml
14835       responses:
14836         "200":
14837           description: successful operation
14838           schema:
14839               $ref: "#/getDefinitions/operational-environments"
14840         "default":
14841           description: Response codes found in [response codes](https://wiki.onap.org/).
14842       parameters:
14843         - name: operational-environment-id
14844           in: query
14845           description:
14846           required: false
14847           type: string
14848   /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
14849     put:
14850       tags:
14851         - Business
14852       summary: see node definition for valid relationships
14853       operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
14854       consumes:
14855         - application/json
14856         - application/xml
14857       produces:
14858         - application/json
14859         - application/xml
14860       responses:
14861         "default":
14862           description: Response codes found in [response codes](https://wiki.onap.org/).
14863       parameters:
14864         - name: resource-instance-id
14865           in: path
14866           description: Unique id of resource instance.
14867           required: true
14868           type: string
14869           example: __RESOURCE-INSTANCE-ID__
14870         - name: body
14871           in: body
14872           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessConnectorsConnector.json)
14873           required: true
14874           schema:
14875             $ref: "#/definitions/relationship"
14876     delete:
14877       tags:
14878         - Business
14879       summary: delete an existing relationship
14880       description: delete an existing relationship
14881       operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
14882       consumes:
14883         - application/json
14884         - application/xml
14885       produces:
14886         - application/json
14887         - application/xml
14888       responses:
14889         "default":
14890           description: Response codes found in [response codes](https://wiki.onap.org/).
14891       parameters:
14892         - name: resource-instance-id
14893           in: path
14894           description: Unique id of resource instance.
14895           required: true
14896           type: string
14897           example: __RESOURCE-INSTANCE-ID__
14898   /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
14899     get:
14900       tags:
14901         - Business
14902       summary: returns metadatum
14903       description: returns metadatum
14904       operationId: getBusinessConnectorsConnectorMetadataMetadatum
14905       produces:
14906         - application/json
14907         - application/xml
14908       responses:
14909         "200":
14910           description: successful operation
14911           schema:
14912               $ref: "#/getDefinitions/metadatum"
14913         "default":
14914           description: Response codes found in [response codes](https://wiki.onap.org/).
14915       parameters:
14916         - name: resource-instance-id
14917           in: path
14918           description: Unique id of resource instance.
14919           required: true
14920           type: string
14921           example: __RESOURCE-INSTANCE-ID__
14922         - name: metaname
14923           in: path
14924           required: true
14925           type: string
14926           example: __METANAME__
14927     put:
14928       tags:
14929         - Business
14930       summary: create or update an existing metadatum
14931       description: |
14932         Create or update an existing metadatum.
14933         #
14934         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14935       operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
14936       consumes:
14937         - application/json
14938         - application/xml
14939       produces:
14940         - application/json
14941         - application/xml
14942       responses:
14943         "default":
14944           description: Response codes found in [response codes](https://wiki.onap.org/).
14945       parameters:
14946         - name: resource-instance-id
14947           in: path
14948           description: Unique id of resource instance.
14949           required: true
14950           type: string
14951           example: __RESOURCE-INSTANCE-ID__
14952         - name: metaname
14953           in: path
14954           required: true
14955           type: string
14956           example: __METANAME__
14957         - name: body
14958           in: body
14959           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessConnectorsConnectorMetadataMetadatum.json)
14960           required: true
14961           schema:
14962             $ref: "#/definitions/metadatum"
14963     patch:
14964       tags:
14965         - Business
14966       summary: update an existing metadatum
14967       description: |
14968         Update an existing metadatum
14969         #
14970         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14971         The PUT operation will entirely replace an existing object.
14972         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14973         #
14974         Other differences between PUT and PATCH are:
14975         #
14976         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14977         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14978         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14979       operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
14980       consumes:
14981         - application/json
14982         - application/xml
14983       produces:
14984         - application/json
14985         - application/xml
14986       responses:
14987         "default":
14988           description: Response codes found in [response codes](https://wiki.onap.org/).
14989       parameters:
14990         - name: resource-instance-id
14991           in: path
14992           description: Unique id of resource instance.
14993           required: true
14994           type: string
14995           example: __RESOURCE-INSTANCE-ID__
14996         - name: metaname
14997           in: path
14998           required: true
14999           type: string
15000           example: __METANAME__
15001         - name: body
15002           in: body
15003           description: metadatum object that needs to be updated.
15004           required: true
15005           schema:
15006             $ref: "#/patchDefinitions/metadatum"
15007     delete:
15008       tags:
15009         - Business
15010       summary: delete an existing metadatum
15011       description: delete an existing metadatum
15012       operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
15013       consumes:
15014         - application/json
15015         - application/xml
15016       produces:
15017         - application/json
15018         - application/xml
15019       responses:
15020         "default":
15021           description: Response codes found in [response codes](https://wiki.onap.org/).
15022       parameters:
15023         - name: resource-instance-id
15024           in: path
15025           description: Unique id of resource instance.
15026           required: true
15027           type: string
15028           example: __RESOURCE-INSTANCE-ID__
15029         - name: metaname
15030           in: path
15031           required: true
15032           type: string
15033           example: __METANAME__
15034         - name: resource-version
15035           in: query
15036           description: resource-version for concurrency
15037           required: true
15038           type: string
15039   /business/connectors/connector/{resource-instance-id}/metadata:
15040     get:
15041       tags:
15042         - Business
15043       summary: returns metadata
15044       description: returns metadata
15045       operationId: getBusinessConnectorsConnectorMetadata
15046       produces:
15047         - application/json
15048         - application/xml
15049       responses:
15050         "200":
15051           description: successful operation
15052           schema:
15053               $ref: "#/getDefinitions/metadata"
15054         "default":
15055           description: Response codes found in [response codes](https://wiki.onap.org/).
15056       parameters:
15057         - name: resource-instance-id
15058           in: path
15059           description: Unique id of resource instance.
15060           required: true
15061           type: string
15062           example: __RESOURCE-INSTANCE-ID__
15063         - name: metaname
15064           in: query
15065           description:
15066           required: false
15067           type: string
15068   /business/connectors/connector/{resource-instance-id}:
15069     get:
15070       tags:
15071         - Business
15072       summary: returns connector
15073       description: returns connector
15074       operationId: getBusinessConnectorsConnector
15075       produces:
15076         - application/json
15077         - application/xml
15078       responses:
15079         "200":
15080           description: successful operation
15081           schema:
15082               $ref: "#/getDefinitions/connector"
15083         "default":
15084           description: Response codes found in [response codes](https://wiki.onap.org/).
15085       parameters:
15086         - name: resource-instance-id
15087           in: path
15088           description: Unique id of resource instance.
15089           required: true
15090           type: string
15091           example: __RESOURCE-INSTANCE-ID__
15092     put:
15093       tags:
15094         - Business
15095       summary: create or update an existing connector
15096       description: |
15097         Create or update an existing connector.
15098         #
15099         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15100       operationId: createOrUpdateBusinessConnectorsConnector
15101       consumes:
15102         - application/json
15103         - application/xml
15104       produces:
15105         - application/json
15106         - application/xml
15107       responses:
15108         "default":
15109           description: Response codes found in [response codes](https://wiki.onap.org/).
15110       parameters:
15111         - name: resource-instance-id
15112           in: path
15113           description: Unique id of resource instance.
15114           required: true
15115           type: string
15116           example: __RESOURCE-INSTANCE-ID__
15117         - name: body
15118           in: body
15119           description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessConnectorsConnector.json)
15120           required: true
15121           schema:
15122             $ref: "#/definitions/connector"
15123     patch:
15124       tags:
15125         - Business
15126       summary: update an existing connector
15127       description: |
15128         Update an existing connector
15129         #
15130         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15131         The PUT operation will entirely replace an existing object.
15132         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15133         #
15134         Other differences between PUT and PATCH are:
15135         #
15136         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15137         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15138         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15139       operationId: UpdateBusinessConnectorsConnector
15140       consumes:
15141         - application/json
15142         - application/xml
15143       produces:
15144         - application/json
15145         - application/xml
15146       responses:
15147         "default":
15148           description: Response codes found in [response codes](https://wiki.onap.org/).
15149       parameters:
15150         - name: resource-instance-id
15151           in: path
15152           description: Unique id of resource instance.
15153           required: true
15154           type: string
15155           example: __RESOURCE-INSTANCE-ID__
15156         - name: body
15157           in: body
15158           description: connector object that needs to be updated.
15159           required: true
15160           schema:
15161             $ref: "#/patchDefinitions/connector"
15162     delete:
15163       tags:
15164         - Business
15165       summary: delete an existing connector
15166       description: delete an existing connector
15167       operationId: deleteBusinessConnectorsConnector
15168       consumes:
15169         - application/json
15170         - application/xml
15171       produces:
15172         - application/json
15173         - application/xml
15174       responses:
15175         "default":
15176           description: Response codes found in [response codes](https://wiki.onap.org/).
15177       parameters:
15178         - name: resource-instance-id
15179           in: path
15180           description: Unique id of resource instance.
15181           required: true
15182           type: string
15183           example: __RESOURCE-INSTANCE-ID__
15184         - name: resource-version
15185           in: query
15186           description: resource-version for concurrency
15187           required: true
15188           type: string
15189   /business/connectors:
15190     get:
15191       tags:
15192         - Business
15193       summary: returns connectors
15194       description: returns connectors
15195       operationId: getBusinessConnectors
15196       produces:
15197         - application/json
15198         - application/xml
15199       responses:
15200         "200":
15201           description: successful operation
15202           schema:
15203               $ref: "#/getDefinitions/connectors"
15204         "default":
15205           description: Response codes found in [response codes](https://wiki.onap.org/).
15206       parameters:
15207         - name: resource-instance-id
15208           in: query
15209           description:
15210           required: false
15211           type: string
15212         - name: model-invariant-id
15213           in: query
15214           description:
15215           required: false
15216           type: string
15217         - name: model-version-id
15218           in: query
15219           description:
15220           required: false
15221           type: string
15222         - name: widget-model-id
15223           in: query
15224           description:
15225           required: false
15226           type: string
15227         - name: widget-model-version
15228           in: query
15229           description:
15230           required: false
15231           type: string
15232   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
15233     put:
15234       tags:
15235         - Business
15236       summary: see node definition for valid relationships
15237       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
15238       consumes:
15239         - application/json
15240         - application/xml
15241       produces:
15242         - application/json
15243         - application/xml
15244       responses:
15245         "default":
15246           description: Response codes found in [response codes](https://wiki.onap.org/).
15247       parameters:
15248         - name: global-customer-id
15249           in: path
15250           description: Global customer id used across ECOMP to uniquely identify customer.
15251           required: true
15252           type: string
15253           example: __GLOBAL-CUSTOMER-ID__
15254         - name: service-type
15255           in: path
15256           description: Value defined by orchestration to identify this service across ECOMP.
15257           required: true
15258           type: string
15259           example: __SERVICE-TYPE__
15260         - name: service-instance-id
15261           in: path
15262           description: Uniquely identifies this instance of a service
15263           required: true
15264           type: string
15265           example: __SERVICE-INSTANCE-ID__
15266         - name: body
15267           in: body
15268           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
15269           required: true
15270           schema:
15271             $ref: "#/definitions/relationship"
15272     delete:
15273       tags:
15274         - Business
15275       summary: delete an existing relationship
15276       description: delete an existing relationship
15277       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
15278       consumes:
15279         - application/json
15280         - application/xml
15281       produces:
15282         - application/json
15283         - application/xml
15284       responses:
15285         "default":
15286           description: Response codes found in [response codes](https://wiki.onap.org/).
15287       parameters:
15288         - name: global-customer-id
15289           in: path
15290           description: Global customer id used across ECOMP to uniquely identify customer.
15291           required: true
15292           type: string
15293           example: __GLOBAL-CUSTOMER-ID__
15294         - name: service-type
15295           in: path
15296           description: Value defined by orchestration to identify this service across ECOMP.
15297           required: true
15298           type: string
15299           example: __SERVICE-TYPE__
15300         - name: service-instance-id
15301           in: path
15302           description: Uniquely identifies this instance of a service
15303           required: true
15304           type: string
15305           example: __SERVICE-INSTANCE-ID__
15306   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
15307     get:
15308       tags:
15309         - Business
15310       summary: returns metadatum
15311       description: returns metadatum
15312       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15313       produces:
15314         - application/json
15315         - application/xml
15316       responses:
15317         "200":
15318           description: successful operation
15319           schema:
15320               $ref: "#/getDefinitions/metadatum"
15321         "default":
15322           description: Response codes found in [response codes](https://wiki.onap.org/).
15323       parameters:
15324         - name: global-customer-id
15325           in: path
15326           description: Global customer id used across ECOMP to uniquely identify customer.
15327           required: true
15328           type: string
15329           example: __GLOBAL-CUSTOMER-ID__
15330         - name: service-type
15331           in: path
15332           description: Value defined by orchestration to identify this service across ECOMP.
15333           required: true
15334           type: string
15335           example: __SERVICE-TYPE__
15336         - name: service-instance-id
15337           in: path
15338           description: Uniquely identifies this instance of a service
15339           required: true
15340           type: string
15341           example: __SERVICE-INSTANCE-ID__
15342         - name: metaname
15343           in: path
15344           required: true
15345           type: string
15346           example: __METANAME__
15347     put:
15348       tags:
15349         - Business
15350       summary: create or update an existing metadatum
15351       description: |
15352         Create or update an existing metadatum.
15353         #
15354         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15355       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15356       consumes:
15357         - application/json
15358         - application/xml
15359       produces:
15360         - application/json
15361         - application/xml
15362       responses:
15363         "default":
15364           description: Response codes found in [response codes](https://wiki.onap.org/).
15365       parameters:
15366         - name: global-customer-id
15367           in: path
15368           description: Global customer id used across ECOMP to uniquely identify customer.
15369           required: true
15370           type: string
15371           example: __GLOBAL-CUSTOMER-ID__
15372         - name: service-type
15373           in: path
15374           description: Value defined by orchestration to identify this service across ECOMP.
15375           required: true
15376           type: string
15377           example: __SERVICE-TYPE__
15378         - name: service-instance-id
15379           in: path
15380           description: Uniquely identifies this instance of a service
15381           required: true
15382           type: string
15383           example: __SERVICE-INSTANCE-ID__
15384         - name: metaname
15385           in: path
15386           required: true
15387           type: string
15388           example: __METANAME__
15389         - name: body
15390           in: body
15391           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
15392           required: true
15393           schema:
15394             $ref: "#/definitions/metadatum"
15395     patch:
15396       tags:
15397         - Business
15398       summary: update an existing metadatum
15399       description: |
15400         Update an existing metadatum
15401         #
15402         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15403         The PUT operation will entirely replace an existing object.
15404         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15405         #
15406         Other differences between PUT and PATCH are:
15407         #
15408         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15409         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15410         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15411       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15412       consumes:
15413         - application/json
15414         - application/xml
15415       produces:
15416         - application/json
15417         - application/xml
15418       responses:
15419         "default":
15420           description: Response codes found in [response codes](https://wiki.onap.org/).
15421       parameters:
15422         - name: global-customer-id
15423           in: path
15424           description: Global customer id used across ECOMP to uniquely identify customer.
15425           required: true
15426           type: string
15427           example: __GLOBAL-CUSTOMER-ID__
15428         - name: service-type
15429           in: path
15430           description: Value defined by orchestration to identify this service across ECOMP.
15431           required: true
15432           type: string
15433           example: __SERVICE-TYPE__
15434         - name: service-instance-id
15435           in: path
15436           description: Uniquely identifies this instance of a service
15437           required: true
15438           type: string
15439           example: __SERVICE-INSTANCE-ID__
15440         - name: metaname
15441           in: path
15442           required: true
15443           type: string
15444           example: __METANAME__
15445         - name: body
15446           in: body
15447           description: metadatum object that needs to be updated.
15448           required: true
15449           schema:
15450             $ref: "#/patchDefinitions/metadatum"
15451     delete:
15452       tags:
15453         - Business
15454       summary: delete an existing metadatum
15455       description: delete an existing metadatum
15456       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15457       consumes:
15458         - application/json
15459         - application/xml
15460       produces:
15461         - application/json
15462         - application/xml
15463       responses:
15464         "default":
15465           description: Response codes found in [response codes](https://wiki.onap.org/).
15466       parameters:
15467         - name: global-customer-id
15468           in: path
15469           description: Global customer id used across ECOMP to uniquely identify customer.
15470           required: true
15471           type: string
15472           example: __GLOBAL-CUSTOMER-ID__
15473         - name: service-type
15474           in: path
15475           description: Value defined by orchestration to identify this service across ECOMP.
15476           required: true
15477           type: string
15478           example: __SERVICE-TYPE__
15479         - name: service-instance-id
15480           in: path
15481           description: Uniquely identifies this instance of a service
15482           required: true
15483           type: string
15484           example: __SERVICE-INSTANCE-ID__
15485         - name: metaname
15486           in: path
15487           required: true
15488           type: string
15489           example: __METANAME__
15490         - name: resource-version
15491           in: query
15492           description: resource-version for concurrency
15493           required: true
15494           type: string
15495   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
15496     get:
15497       tags:
15498         - Business
15499       summary: returns metadata
15500       description: returns metadata
15501       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
15502       produces:
15503         - application/json
15504         - application/xml
15505       responses:
15506         "200":
15507           description: successful operation
15508           schema:
15509               $ref: "#/getDefinitions/metadata"
15510         "default":
15511           description: Response codes found in [response codes](https://wiki.onap.org/).
15512       parameters:
15513         - name: global-customer-id
15514           in: path
15515           description: Global customer id used across ECOMP to uniquely identify customer.
15516           required: true
15517           type: string
15518           example: __GLOBAL-CUSTOMER-ID__
15519         - name: service-type
15520           in: path
15521           description: Value defined by orchestration to identify this service across ECOMP.
15522           required: true
15523           type: string
15524           example: __SERVICE-TYPE__
15525         - name: service-instance-id
15526           in: path
15527           description: Uniquely identifies this instance of a service
15528           required: true
15529           type: string
15530           example: __SERVICE-INSTANCE-ID__
15531         - name: metaname
15532           in: query
15533           description:
15534           required: false
15535           type: string
15536   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship:
15537     put:
15538       tags:
15539         - Business
15540       summary: see node definition for valid relationships
15541       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15542       consumes:
15543         - application/json
15544         - application/xml
15545       produces:
15546         - application/json
15547         - application/xml
15548       responses:
15549         "default":
15550           description: Response codes found in [response codes](https://wiki.onap.org/).
15551       parameters:
15552         - name: global-customer-id
15553           in: path
15554           description: Global customer id used across ECOMP to uniquely identify customer.
15555           required: true
15556           type: string
15557           example: __GLOBAL-CUSTOMER-ID__
15558         - name: service-type
15559           in: path
15560           description: Value defined by orchestration to identify this service across ECOMP.
15561           required: true
15562           type: string
15563           example: __SERVICE-TYPE__
15564         - name: service-instance-id
15565           in: path
15566           description: Uniquely identifies this instance of a service
15567           required: true
15568           type: string
15569           example: __SERVICE-INSTANCE-ID__
15570         - name: id
15571           in: path
15572           description: Allotted Resource id UUID assigned to this instance.
15573           required: true
15574           type: string
15575           example: __ID__
15576         - name: id
15577           in: path
15578           description: Allotted Resource id UUID assigned to this instance.
15579           required: true
15580           type: string
15581           example: __ID__
15582         - name: body
15583           in: body
15584           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15585           required: true
15586           schema:
15587             $ref: "#/definitions/relationship"
15588     delete:
15589       tags:
15590         - Business
15591       summary: delete an existing relationship
15592       description: delete an existing relationship
15593       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15594       consumes:
15595         - application/json
15596         - application/xml
15597       produces:
15598         - application/json
15599         - application/xml
15600       responses:
15601         "default":
15602           description: Response codes found in [response codes](https://wiki.onap.org/).
15603       parameters:
15604         - name: global-customer-id
15605           in: path
15606           description: Global customer id used across ECOMP to uniquely identify customer.
15607           required: true
15608           type: string
15609           example: __GLOBAL-CUSTOMER-ID__
15610         - name: service-type
15611           in: path
15612           description: Value defined by orchestration to identify this service across ECOMP.
15613           required: true
15614           type: string
15615           example: __SERVICE-TYPE__
15616         - name: service-instance-id
15617           in: path
15618           description: Uniquely identifies this instance of a service
15619           required: true
15620           type: string
15621           example: __SERVICE-INSTANCE-ID__
15622         - name: id
15623           in: path
15624           description: Allotted Resource id UUID assigned to this instance.
15625           required: true
15626           type: string
15627           example: __ID__
15628         - name: id
15629           in: path
15630           description: Allotted Resource id UUID assigned to this instance.
15631           required: true
15632           type: string
15633           example: __ID__
15634   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}:
15635     get:
15636       tags:
15637         - Business
15638       summary: returns tunnel-xconnect
15639       description: returns tunnel-xconnect
15640       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15641       produces:
15642         - application/json
15643         - application/xml
15644       responses:
15645         "200":
15646           description: successful operation
15647           schema:
15648               $ref: "#/getDefinitions/tunnel-xconnect"
15649         "default":
15650           description: Response codes found in [response codes](https://wiki.onap.org/).
15651       parameters:
15652         - name: global-customer-id
15653           in: path
15654           description: Global customer id used across ECOMP to uniquely identify customer.
15655           required: true
15656           type: string
15657           example: __GLOBAL-CUSTOMER-ID__
15658         - name: service-type
15659           in: path
15660           description: Value defined by orchestration to identify this service across ECOMP.
15661           required: true
15662           type: string
15663           example: __SERVICE-TYPE__
15664         - name: service-instance-id
15665           in: path
15666           description: Uniquely identifies this instance of a service
15667           required: true
15668           type: string
15669           example: __SERVICE-INSTANCE-ID__
15670         - name: id
15671           in: path
15672           description: Allotted Resource id UUID assigned to this instance.
15673           required: true
15674           type: string
15675           example: __ID__
15676         - name: id
15677           in: path
15678           description: Allotted Resource id UUID assigned to this instance.
15679           required: true
15680           type: string
15681           example: __ID__
15682     put:
15683       tags:
15684         - Business
15685       summary: create or update an existing tunnel-xconnect
15686       description: |
15687         Create or update an existing tunnel-xconnect.
15688         #
15689         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15690       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15691       consumes:
15692         - application/json
15693         - application/xml
15694       produces:
15695         - application/json
15696         - application/xml
15697       responses:
15698         "default":
15699           description: Response codes found in [response codes](https://wiki.onap.org/).
15700       parameters:
15701         - name: global-customer-id
15702           in: path
15703           description: Global customer id used across ECOMP to uniquely identify customer.
15704           required: true
15705           type: string
15706           example: __GLOBAL-CUSTOMER-ID__
15707         - name: service-type
15708           in: path
15709           description: Value defined by orchestration to identify this service across ECOMP.
15710           required: true
15711           type: string
15712           example: __SERVICE-TYPE__
15713         - name: service-instance-id
15714           in: path
15715           description: Uniquely identifies this instance of a service
15716           required: true
15717           type: string
15718           example: __SERVICE-INSTANCE-ID__
15719         - name: id
15720           in: path
15721           description: Allotted Resource id UUID assigned to this instance.
15722           required: true
15723           type: string
15724           example: __ID__
15725         - name: id
15726           in: path
15727           description: Allotted Resource id UUID assigned to this instance.
15728           required: true
15729           type: string
15730           example: __ID__
15731         - name: body
15732           in: body
15733           description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15734           required: true
15735           schema:
15736             $ref: "#/definitions/tunnel-xconnect"
15737     patch:
15738       tags:
15739         - Business
15740       summary: update an existing tunnel-xconnect
15741       description: |
15742         Update an existing tunnel-xconnect
15743         #
15744         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15745         The PUT operation will entirely replace an existing object.
15746         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15747         #
15748         Other differences between PUT and PATCH are:
15749         #
15750         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15751         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15752         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15753       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15754       consumes:
15755         - application/json
15756         - application/xml
15757       produces:
15758         - application/json
15759         - application/xml
15760       responses:
15761         "default":
15762           description: Response codes found in [response codes](https://wiki.onap.org/).
15763       parameters:
15764         - name: global-customer-id
15765           in: path
15766           description: Global customer id used across ECOMP to uniquely identify customer.
15767           required: true
15768           type: string
15769           example: __GLOBAL-CUSTOMER-ID__
15770         - name: service-type
15771           in: path
15772           description: Value defined by orchestration to identify this service across ECOMP.
15773           required: true
15774           type: string
15775           example: __SERVICE-TYPE__
15776         - name: service-instance-id
15777           in: path
15778           description: Uniquely identifies this instance of a service
15779           required: true
15780           type: string
15781           example: __SERVICE-INSTANCE-ID__
15782         - name: id
15783           in: path
15784           description: Allotted Resource id UUID assigned to this instance.
15785           required: true
15786           type: string
15787           example: __ID__
15788         - name: id
15789           in: path
15790           description: Allotted Resource id UUID assigned to this instance.
15791           required: true
15792           type: string
15793           example: __ID__
15794         - name: body
15795           in: body
15796           description: tunnel-xconnect object that needs to be updated.
15797           required: true
15798           schema:
15799             $ref: "#/patchDefinitions/tunnel-xconnect"
15800     delete:
15801       tags:
15802         - Business
15803       summary: delete an existing tunnel-xconnect
15804       description: delete an existing tunnel-xconnect
15805       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15806       consumes:
15807         - application/json
15808         - application/xml
15809       produces:
15810         - application/json
15811         - application/xml
15812       responses:
15813         "default":
15814           description: Response codes found in [response codes](https://wiki.onap.org/).
15815       parameters:
15816         - name: global-customer-id
15817           in: path
15818           description: Global customer id used across ECOMP to uniquely identify customer.
15819           required: true
15820           type: string
15821           example: __GLOBAL-CUSTOMER-ID__
15822         - name: service-type
15823           in: path
15824           description: Value defined by orchestration to identify this service across ECOMP.
15825           required: true
15826           type: string
15827           example: __SERVICE-TYPE__
15828         - name: service-instance-id
15829           in: path
15830           description: Uniquely identifies this instance of a service
15831           required: true
15832           type: string
15833           example: __SERVICE-INSTANCE-ID__
15834         - name: id
15835           in: path
15836           description: Allotted Resource id UUID assigned to this instance.
15837           required: true
15838           type: string
15839           example: __ID__
15840         - name: id
15841           in: path
15842           description: Allotted Resource id UUID assigned to this instance.
15843           required: true
15844           type: string
15845           example: __ID__
15846         - name: resource-version
15847           in: query
15848           description: resource-version for concurrency
15849           required: true
15850           type: string
15851   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
15852     get:
15853       tags:
15854         - Business
15855       summary: returns tunnel-xconnects
15856       description: returns tunnel-xconnects
15857       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
15858       produces:
15859         - application/json
15860         - application/xml
15861       responses:
15862         "200":
15863           description: successful operation
15864           schema:
15865               $ref: "#/getDefinitions/tunnel-xconnects"
15866         "default":
15867           description: Response codes found in [response codes](https://wiki.onap.org/).
15868       parameters:
15869         - name: global-customer-id
15870           in: path
15871           description: Global customer id used across ECOMP to uniquely identify customer.
15872           required: true
15873           type: string
15874           example: __GLOBAL-CUSTOMER-ID__
15875         - name: service-type
15876           in: path
15877           description: Value defined by orchestration to identify this service across ECOMP.
15878           required: true
15879           type: string
15880           example: __SERVICE-TYPE__
15881         - name: service-instance-id
15882           in: path
15883           description: Uniquely identifies this instance of a service
15884           required: true
15885           type: string
15886           example: __SERVICE-INSTANCE-ID__
15887         - name: id
15888           in: path
15889           description: Allotted Resource id UUID assigned to this instance.
15890           required: true
15891           type: string
15892           example: __ID__
15893         - name: id
15894           in: query
15895           description:
15896           required: false
15897           type: string
15898   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
15899     put:
15900       tags:
15901         - Business
15902       summary: see node definition for valid relationships
15903       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15904       consumes:
15905         - application/json
15906         - application/xml
15907       produces:
15908         - application/json
15909         - application/xml
15910       responses:
15911         "default":
15912           description: Response codes found in [response codes](https://wiki.onap.org/).
15913       parameters:
15914         - name: global-customer-id
15915           in: path
15916           description: Global customer id used across ECOMP to uniquely identify customer.
15917           required: true
15918           type: string
15919           example: __GLOBAL-CUSTOMER-ID__
15920         - name: service-type
15921           in: path
15922           description: Value defined by orchestration to identify this service across ECOMP.
15923           required: true
15924           type: string
15925           example: __SERVICE-TYPE__
15926         - name: service-instance-id
15927           in: path
15928           description: Uniquely identifies this instance of a service
15929           required: true
15930           type: string
15931           example: __SERVICE-INSTANCE-ID__
15932         - name: id
15933           in: path
15934           description: Allotted Resource id UUID assigned to this instance.
15935           required: true
15936           type: string
15937           example: __ID__
15938         - name: body
15939           in: body
15940           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15941           required: true
15942           schema:
15943             $ref: "#/definitions/relationship"
15944     delete:
15945       tags:
15946         - Business
15947       summary: delete an existing relationship
15948       description: delete an existing relationship
15949       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15950       consumes:
15951         - application/json
15952         - application/xml
15953       produces:
15954         - application/json
15955         - application/xml
15956       responses:
15957         "default":
15958           description: Response codes found in [response codes](https://wiki.onap.org/).
15959       parameters:
15960         - name: global-customer-id
15961           in: path
15962           description: Global customer id used across ECOMP to uniquely identify customer.
15963           required: true
15964           type: string
15965           example: __GLOBAL-CUSTOMER-ID__
15966         - name: service-type
15967           in: path
15968           description: Value defined by orchestration to identify this service across ECOMP.
15969           required: true
15970           type: string
15971           example: __SERVICE-TYPE__
15972         - name: service-instance-id
15973           in: path
15974           description: Uniquely identifies this instance of a service
15975           required: true
15976           type: string
15977           example: __SERVICE-INSTANCE-ID__
15978         - name: id
15979           in: path
15980           description: Allotted Resource id UUID assigned to this instance.
15981           required: true
15982           type: string
15983           example: __ID__
15984   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
15985     get:
15986       tags:
15987         - Business
15988       summary: returns allotted-resource
15989       description: returns allotted-resource
15990       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15991       produces:
15992         - application/json
15993         - application/xml
15994       responses:
15995         "200":
15996           description: successful operation
15997           schema:
15998               $ref: "#/getDefinitions/allotted-resource"
15999         "default":
16000           description: Response codes found in [response codes](https://wiki.onap.org/).
16001       parameters:
16002         - name: global-customer-id
16003           in: path
16004           description: Global customer id used across ECOMP to uniquely identify customer.
16005           required: true
16006           type: string
16007           example: __GLOBAL-CUSTOMER-ID__
16008         - name: service-type
16009           in: path
16010           description: Value defined by orchestration to identify this service across ECOMP.
16011           required: true
16012           type: string
16013           example: __SERVICE-TYPE__
16014         - name: service-instance-id
16015           in: path
16016           description: Uniquely identifies this instance of a service
16017           required: true
16018           type: string
16019           example: __SERVICE-INSTANCE-ID__
16020         - name: id
16021           in: path
16022           description: Allotted Resource id UUID assigned to this instance.
16023           required: true
16024           type: string
16025           example: __ID__
16026     put:
16027       tags:
16028         - Business
16029       summary: create or update an existing allotted-resource
16030       description: |
16031         Create or update an existing allotted-resource.
16032         #
16033         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16034       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16035       consumes:
16036         - application/json
16037         - application/xml
16038       produces:
16039         - application/json
16040         - application/xml
16041       responses:
16042         "default":
16043           description: Response codes found in [response codes](https://wiki.onap.org/).
16044       parameters:
16045         - name: global-customer-id
16046           in: path
16047           description: Global customer id used across ECOMP to uniquely identify customer.
16048           required: true
16049           type: string
16050           example: __GLOBAL-CUSTOMER-ID__
16051         - name: service-type
16052           in: path
16053           description: Value defined by orchestration to identify this service across ECOMP.
16054           required: true
16055           type: string
16056           example: __SERVICE-TYPE__
16057         - name: service-instance-id
16058           in: path
16059           description: Uniquely identifies this instance of a service
16060           required: true
16061           type: string
16062           example: __SERVICE-INSTANCE-ID__
16063         - name: id
16064           in: path
16065           description: Allotted Resource id UUID assigned to this instance.
16066           required: true
16067           type: string
16068           example: __ID__
16069         - name: body
16070           in: body
16071           description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
16072           required: true
16073           schema:
16074             $ref: "#/definitions/allotted-resource"
16075     patch:
16076       tags:
16077         - Business
16078       summary: update an existing allotted-resource
16079       description: |
16080         Update an existing allotted-resource
16081         #
16082         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16083         The PUT operation will entirely replace an existing object.
16084         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16085         #
16086         Other differences between PUT and PATCH are:
16087         #
16088         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16089         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16090         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16091       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16092       consumes:
16093         - application/json
16094         - application/xml
16095       produces:
16096         - application/json
16097         - application/xml
16098       responses:
16099         "default":
16100           description: Response codes found in [response codes](https://wiki.onap.org/).
16101       parameters:
16102         - name: global-customer-id
16103           in: path
16104           description: Global customer id used across ECOMP to uniquely identify customer.
16105           required: true
16106           type: string
16107           example: __GLOBAL-CUSTOMER-ID__
16108         - name: service-type
16109           in: path
16110           description: Value defined by orchestration to identify this service across ECOMP.
16111           required: true
16112           type: string
16113           example: __SERVICE-TYPE__
16114         - name: service-instance-id
16115           in: path
16116           description: Uniquely identifies this instance of a service
16117           required: true
16118           type: string
16119           example: __SERVICE-INSTANCE-ID__
16120         - name: id
16121           in: path
16122           description: Allotted Resource id UUID assigned to this instance.
16123           required: true
16124           type: string
16125           example: __ID__
16126         - name: body
16127           in: body
16128           description: allotted-resource object that needs to be updated.
16129           required: true
16130           schema:
16131             $ref: "#/patchDefinitions/allotted-resource"
16132     delete:
16133       tags:
16134         - Business
16135       summary: delete an existing allotted-resource
16136       description: delete an existing allotted-resource
16137       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16138       consumes:
16139         - application/json
16140         - application/xml
16141       produces:
16142         - application/json
16143         - application/xml
16144       responses:
16145         "default":
16146           description: Response codes found in [response codes](https://wiki.onap.org/).
16147       parameters:
16148         - name: global-customer-id
16149           in: path
16150           description: Global customer id used across ECOMP to uniquely identify customer.
16151           required: true
16152           type: string
16153           example: __GLOBAL-CUSTOMER-ID__
16154         - name: service-type
16155           in: path
16156           description: Value defined by orchestration to identify this service across ECOMP.
16157           required: true
16158           type: string
16159           example: __SERVICE-TYPE__
16160         - name: service-instance-id
16161           in: path
16162           description: Uniquely identifies this instance of a service
16163           required: true
16164           type: string
16165           example: __SERVICE-INSTANCE-ID__
16166         - name: id
16167           in: path
16168           description: Allotted Resource id UUID assigned to this instance.
16169           required: true
16170           type: string
16171           example: __ID__
16172         - name: resource-version
16173           in: query
16174           description: resource-version for concurrency
16175           required: true
16176           type: string
16177   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
16178     get:
16179       tags:
16180         - Business
16181       summary: returns allotted-resources
16182       description: returns allotted-resources
16183       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
16184       produces:
16185         - application/json
16186         - application/xml
16187       responses:
16188         "200":
16189           description: successful operation
16190           schema:
16191               $ref: "#/getDefinitions/allotted-resources"
16192         "default":
16193           description: Response codes found in [response codes](https://wiki.onap.org/).
16194       parameters:
16195         - name: global-customer-id
16196           in: path
16197           description: Global customer id used across ECOMP to uniquely identify customer.
16198           required: true
16199           type: string
16200           example: __GLOBAL-CUSTOMER-ID__
16201         - name: service-type
16202           in: path
16203           description: Value defined by orchestration to identify this service across ECOMP.
16204           required: true
16205           type: string
16206           example: __SERVICE-TYPE__
16207         - name: service-instance-id
16208           in: path
16209           description: Uniquely identifies this instance of a service
16210           required: true
16211           type: string
16212           example: __SERVICE-INSTANCE-ID__
16213         - name: id
16214           in: query
16215           description:
16216           required: false
16217           type: string
16218         - name: model-invariant-id
16219           in: query
16220           description:
16221           required: false
16222           type: string
16223         - name: model-version-id
16224           in: query
16225           description:
16226           required: false
16227           type: string
16228         - name: type
16229           in: query
16230           description:
16231           required: false
16232           type: string
16233         - name: role
16234           in: query
16235           description:
16236           required: false
16237           type: string
16238   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
16239     get:
16240       tags:
16241         - Business
16242       summary: returns service-instance
16243       description: returns service-instance
16244       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16245       produces:
16246         - application/json
16247         - application/xml
16248       responses:
16249         "200":
16250           description: successful operation
16251           schema:
16252               $ref: "#/getDefinitions/service-instance"
16253         "default":
16254           description: Response codes found in [response codes](https://wiki.onap.org/).
16255       parameters:
16256         - name: global-customer-id
16257           in: path
16258           description: Global customer id used across ECOMP to uniquely identify customer.
16259           required: true
16260           type: string
16261           example: __GLOBAL-CUSTOMER-ID__
16262         - name: service-type
16263           in: path
16264           description: Value defined by orchestration to identify this service across ECOMP.
16265           required: true
16266           type: string
16267           example: __SERVICE-TYPE__
16268         - name: service-instance-id
16269           in: path
16270           description: Uniquely identifies this instance of a service
16271           required: true
16272           type: string
16273           example: __SERVICE-INSTANCE-ID__
16274     put:
16275       tags:
16276         - Business
16277       summary: create or update an existing service-instance
16278       description: |
16279         Create or update an existing service-instance.
16280         #
16281         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16282       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16283       consumes:
16284         - application/json
16285         - application/xml
16286       produces:
16287         - application/json
16288         - application/xml
16289       responses:
16290         "default":
16291           description: Response codes found in [response codes](https://wiki.onap.org/).
16292       parameters:
16293         - name: global-customer-id
16294           in: path
16295           description: Global customer id used across ECOMP to uniquely identify customer.
16296           required: true
16297           type: string
16298           example: __GLOBAL-CUSTOMER-ID__
16299         - name: service-type
16300           in: path
16301           description: Value defined by orchestration to identify this service across ECOMP.
16302           required: true
16303           type: string
16304           example: __SERVICE-TYPE__
16305         - name: service-instance-id
16306           in: path
16307           description: Uniquely identifies this instance of a service
16308           required: true
16309           type: string
16310           example: __SERVICE-INSTANCE-ID__
16311         - name: body
16312           in: body
16313           description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
16314           required: true
16315           schema:
16316             $ref: "#/definitions/service-instance"
16317     patch:
16318       tags:
16319         - Business
16320       summary: update an existing service-instance
16321       description: |
16322         Update an existing service-instance
16323         #
16324         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16325         The PUT operation will entirely replace an existing object.
16326         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16327         #
16328         Other differences between PUT and PATCH are:
16329         #
16330         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16331         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16332         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16333       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16334       consumes:
16335         - application/json
16336         - application/xml
16337       produces:
16338         - application/json
16339         - application/xml
16340       responses:
16341         "default":
16342           description: Response codes found in [response codes](https://wiki.onap.org/).
16343       parameters:
16344         - name: global-customer-id
16345           in: path
16346           description: Global customer id used across ECOMP to uniquely identify customer.
16347           required: true
16348           type: string
16349           example: __GLOBAL-CUSTOMER-ID__
16350         - name: service-type
16351           in: path
16352           description: Value defined by orchestration to identify this service across ECOMP.
16353           required: true
16354           type: string
16355           example: __SERVICE-TYPE__
16356         - name: service-instance-id
16357           in: path
16358           description: Uniquely identifies this instance of a service
16359           required: true
16360           type: string
16361           example: __SERVICE-INSTANCE-ID__
16362         - name: body
16363           in: body
16364           description: service-instance object that needs to be updated.
16365           required: true
16366           schema:
16367             $ref: "#/patchDefinitions/service-instance"
16368     delete:
16369       tags:
16370         - Business
16371       summary: delete an existing service-instance
16372       description: delete an existing service-instance
16373       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16374       consumes:
16375         - application/json
16376         - application/xml
16377       produces:
16378         - application/json
16379         - application/xml
16380       responses:
16381         "default":
16382           description: Response codes found in [response codes](https://wiki.onap.org/).
16383       parameters:
16384         - name: global-customer-id
16385           in: path
16386           description: Global customer id used across ECOMP to uniquely identify customer.
16387           required: true
16388           type: string
16389           example: __GLOBAL-CUSTOMER-ID__
16390         - name: service-type
16391           in: path
16392           description: Value defined by orchestration to identify this service across ECOMP.
16393           required: true
16394           type: string
16395           example: __SERVICE-TYPE__
16396         - name: service-instance-id
16397           in: path
16398           description: Uniquely identifies this instance of a service
16399           required: true
16400           type: string
16401           example: __SERVICE-INSTANCE-ID__
16402         - name: resource-version
16403           in: query
16404           description: resource-version for concurrency
16405           required: true
16406           type: string
16407   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
16408     get:
16409       tags:
16410         - Business
16411       summary: returns service-instances
16412       description: returns service-instances
16413       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
16414       produces:
16415         - application/json
16416         - application/xml
16417       responses:
16418         "200":
16419           description: successful operation
16420           schema:
16421               $ref: "#/getDefinitions/service-instances"
16422         "default":
16423           description: Response codes found in [response codes](https://wiki.onap.org/).
16424       parameters:
16425         - name: global-customer-id
16426           in: path
16427           description: Global customer id used across ECOMP to uniquely identify customer.
16428           required: true
16429           type: string
16430           example: __GLOBAL-CUSTOMER-ID__
16431         - name: service-type
16432           in: path
16433           description: Value defined by orchestration to identify this service across ECOMP.
16434           required: true
16435           type: string
16436           example: __SERVICE-TYPE__
16437         - name: service-instance-id
16438           in: query
16439           description:
16440           required: false
16441           type: string
16442         - name: service-instance-name
16443           in: query
16444           description:
16445           required: false
16446           type: string
16447         - name: environment-context
16448           in: query
16449           description:
16450           required: false
16451           type: string
16452         - name: workload-context
16453           in: query
16454           description:
16455           required: false
16456           type: string
16457         - name: model-invariant-id
16458           in: query
16459           description:
16460           required: false
16461           type: string
16462         - name: model-version-id
16463           in: query
16464           description:
16465           required: false
16466           type: string
16467         - name: widget-model-id
16468           in: query
16469           description:
16470           required: false
16471           type: string
16472         - name: widget-model-version
16473           in: query
16474           description:
16475           required: false
16476           type: string
16477         - name: service-instance-location-id
16478           in: query
16479           description:
16480           required: false
16481           type: string
16482         - name: orchestration-status
16483           in: query
16484           description:
16485           required: false
16486           type: string
16487   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
16488     put:
16489       tags:
16490         - Business
16491       summary: see node definition for valid relationships
16492       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16493       consumes:
16494         - application/json
16495         - application/xml
16496       produces:
16497         - application/json
16498         - application/xml
16499       responses:
16500         "default":
16501           description: Response codes found in [response codes](https://wiki.onap.org/).
16502       parameters:
16503         - name: global-customer-id
16504           in: path
16505           description: Global customer id used across ECOMP to uniquely identify customer.
16506           required: true
16507           type: string
16508           example: __GLOBAL-CUSTOMER-ID__
16509         - name: service-type
16510           in: path
16511           description: Value defined by orchestration to identify this service across ECOMP.
16512           required: true
16513           type: string
16514           example: __SERVICE-TYPE__
16515         - name: body
16516           in: body
16517           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16518           required: true
16519           schema:
16520             $ref: "#/definitions/relationship"
16521     delete:
16522       tags:
16523         - Business
16524       summary: delete an existing relationship
16525       description: delete an existing relationship
16526       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16527       consumes:
16528         - application/json
16529         - application/xml
16530       produces:
16531         - application/json
16532         - application/xml
16533       responses:
16534         "default":
16535           description: Response codes found in [response codes](https://wiki.onap.org/).
16536       parameters:
16537         - name: global-customer-id
16538           in: path
16539           description: Global customer id used across ECOMP to uniquely identify customer.
16540           required: true
16541           type: string
16542           example: __GLOBAL-CUSTOMER-ID__
16543         - name: service-type
16544           in: path
16545           description: Value defined by orchestration to identify this service across ECOMP.
16546           required: true
16547           type: string
16548           example: __SERVICE-TYPE__
16549   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
16550     get:
16551       tags:
16552         - Business
16553       summary: returns service-subscription
16554       description: returns service-subscription
16555       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16556       produces:
16557         - application/json
16558         - application/xml
16559       responses:
16560         "200":
16561           description: successful operation
16562           schema:
16563               $ref: "#/getDefinitions/service-subscription"
16564         "default":
16565           description: Response codes found in [response codes](https://wiki.onap.org/).
16566       parameters:
16567         - name: global-customer-id
16568           in: path
16569           description: Global customer id used across ECOMP to uniquely identify customer.
16570           required: true
16571           type: string
16572           example: __GLOBAL-CUSTOMER-ID__
16573         - name: service-type
16574           in: path
16575           description: Value defined by orchestration to identify this service across ECOMP.
16576           required: true
16577           type: string
16578           example: __SERVICE-TYPE__
16579     put:
16580       tags:
16581         - Business
16582       summary: create or update an existing service-subscription
16583       description: |
16584         Create or update an existing service-subscription.
16585         #
16586         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16587       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16588       consumes:
16589         - application/json
16590         - application/xml
16591       produces:
16592         - application/json
16593         - application/xml
16594       responses:
16595         "default":
16596           description: Response codes found in [response codes](https://wiki.onap.org/).
16597       parameters:
16598         - name: global-customer-id
16599           in: path
16600           description: Global customer id used across ECOMP to uniquely identify customer.
16601           required: true
16602           type: string
16603           example: __GLOBAL-CUSTOMER-ID__
16604         - name: service-type
16605           in: path
16606           description: Value defined by orchestration to identify this service across ECOMP.
16607           required: true
16608           type: string
16609           example: __SERVICE-TYPE__
16610         - name: body
16611           in: body
16612           description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16613           required: true
16614           schema:
16615             $ref: "#/definitions/service-subscription"
16616     patch:
16617       tags:
16618         - Business
16619       summary: update an existing service-subscription
16620       description: |
16621         Update an existing service-subscription
16622         #
16623         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16624         The PUT operation will entirely replace an existing object.
16625         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16626         #
16627         Other differences between PUT and PATCH are:
16628         #
16629         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16630         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16631         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16632       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16633       consumes:
16634         - application/json
16635         - application/xml
16636       produces:
16637         - application/json
16638         - application/xml
16639       responses:
16640         "default":
16641           description: Response codes found in [response codes](https://wiki.onap.org/).
16642       parameters:
16643         - name: global-customer-id
16644           in: path
16645           description: Global customer id used across ECOMP to uniquely identify customer.
16646           required: true
16647           type: string
16648           example: __GLOBAL-CUSTOMER-ID__
16649         - name: service-type
16650           in: path
16651           description: Value defined by orchestration to identify this service across ECOMP.
16652           required: true
16653           type: string
16654           example: __SERVICE-TYPE__
16655         - name: body
16656           in: body
16657           description: service-subscription object that needs to be updated.
16658           required: true
16659           schema:
16660             $ref: "#/patchDefinitions/service-subscription"
16661     delete:
16662       tags:
16663         - Business
16664       summary: delete an existing service-subscription
16665       description: delete an existing service-subscription
16666       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16667       consumes:
16668         - application/json
16669         - application/xml
16670       produces:
16671         - application/json
16672         - application/xml
16673       responses:
16674         "default":
16675           description: Response codes found in [response codes](https://wiki.onap.org/).
16676       parameters:
16677         - name: global-customer-id
16678           in: path
16679           description: Global customer id used across ECOMP to uniquely identify customer.
16680           required: true
16681           type: string
16682           example: __GLOBAL-CUSTOMER-ID__
16683         - name: service-type
16684           in: path
16685           description: Value defined by orchestration to identify this service across ECOMP.
16686           required: true
16687           type: string
16688           example: __SERVICE-TYPE__
16689         - name: resource-version
16690           in: query
16691           description: resource-version for concurrency
16692           required: true
16693           type: string
16694   /business/customers/customer/{global-customer-id}/service-subscriptions:
16695     get:
16696       tags:
16697         - Business
16698       summary: returns service-subscriptions
16699       description: returns service-subscriptions
16700       operationId: getBusinessCustomersCustomerServiceSubscriptions
16701       produces:
16702         - application/json
16703         - application/xml
16704       responses:
16705         "200":
16706           description: successful operation
16707           schema:
16708               $ref: "#/getDefinitions/service-subscriptions"
16709         "default":
16710           description: Response codes found in [response codes](https://wiki.onap.org/).
16711       parameters:
16712         - name: global-customer-id
16713           in: path
16714           description: Global customer id used across ECOMP to uniquely identify customer.
16715           required: true
16716           type: string
16717           example: __GLOBAL-CUSTOMER-ID__
16718         - name: service-type
16719           in: query
16720           description:
16721           required: false
16722           type: string
16723   /business/customers/customer/{global-customer-id}/relationship-list/relationship:
16724     put:
16725       tags:
16726         - Business
16727       summary: see node definition for valid relationships
16728       operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
16729       consumes:
16730         - application/json
16731         - application/xml
16732       produces:
16733         - application/json
16734         - application/xml
16735       responses:
16736         "default":
16737           description: Response codes found in [response codes](https://wiki.onap.org/).
16738       parameters:
16739         - name: global-customer-id
16740           in: path
16741           description: Global customer id used across ECOMP to uniquely identify customer.
16742           required: true
16743           type: string
16744           example: __GLOBAL-CUSTOMER-ID__
16745         - name: body
16746           in: body
16747           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomer.json)
16748           required: true
16749           schema:
16750             $ref: "#/definitions/relationship"
16751     delete:
16752       tags:
16753         - Business
16754       summary: delete an existing relationship
16755       description: delete an existing relationship
16756       operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
16757       consumes:
16758         - application/json
16759         - application/xml
16760       produces:
16761         - application/json
16762         - application/xml
16763       responses:
16764         "default":
16765           description: Response codes found in [response codes](https://wiki.onap.org/).
16766       parameters:
16767         - name: global-customer-id
16768           in: path
16769           description: Global customer id used across ECOMP to uniquely identify customer.
16770           required: true
16771           type: string
16772           example: __GLOBAL-CUSTOMER-ID__
16773   /business/customers/customer/{global-customer-id}:
16774     get:
16775       tags:
16776         - Business
16777       summary: returns customer
16778       description: returns customer
16779       operationId: getBusinessCustomersCustomer
16780       produces:
16781         - application/json
16782         - application/xml
16783       responses:
16784         "200":
16785           description: successful operation
16786           schema:
16787               $ref: "#/getDefinitions/customer"
16788         "default":
16789           description: Response codes found in [response codes](https://wiki.onap.org/).
16790       parameters:
16791         - name: global-customer-id
16792           in: path
16793           description: Global customer id used across ECOMP to uniquely identify customer.
16794           required: true
16795           type: string
16796           example: __GLOBAL-CUSTOMER-ID__
16797     put:
16798       tags:
16799         - Business
16800       summary: create or update an existing customer
16801       description: |
16802         Create or update an existing customer.
16803         #
16804         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16805       operationId: createOrUpdateBusinessCustomersCustomer
16806       consumes:
16807         - application/json
16808         - application/xml
16809       produces:
16810         - application/json
16811         - application/xml
16812       responses:
16813         "default":
16814           description: Response codes found in [response codes](https://wiki.onap.org/).
16815       parameters:
16816         - name: global-customer-id
16817           in: path
16818           description: Global customer id used across ECOMP to uniquely identify customer.
16819           required: true
16820           type: string
16821           example: __GLOBAL-CUSTOMER-ID__
16822         - name: body
16823           in: body
16824           description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessCustomersCustomer.json)
16825           required: true
16826           schema:
16827             $ref: "#/definitions/customer"
16828     patch:
16829       tags:
16830         - Business
16831       summary: update an existing customer
16832       description: |
16833         Update an existing customer
16834         #
16835         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16836         The PUT operation will entirely replace an existing object.
16837         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16838         #
16839         Other differences between PUT and PATCH are:
16840         #
16841         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16842         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16843         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16844       operationId: UpdateBusinessCustomersCustomer
16845       consumes:
16846         - application/json
16847         - application/xml
16848       produces:
16849         - application/json
16850         - application/xml
16851       responses:
16852         "default":
16853           description: Response codes found in [response codes](https://wiki.onap.org/).
16854       parameters:
16855         - name: global-customer-id
16856           in: path
16857           description: Global customer id used across ECOMP to uniquely identify customer.
16858           required: true
16859           type: string
16860           example: __GLOBAL-CUSTOMER-ID__
16861         - name: body
16862           in: body
16863           description: customer object that needs to be updated.
16864           required: true
16865           schema:
16866             $ref: "#/patchDefinitions/customer"
16867     delete:
16868       tags:
16869         - Business
16870       summary: delete an existing customer
16871       description: delete an existing customer
16872       operationId: deleteBusinessCustomersCustomer
16873       consumes:
16874         - application/json
16875         - application/xml
16876       produces:
16877         - application/json
16878         - application/xml
16879       responses:
16880         "default":
16881           description: Response codes found in [response codes](https://wiki.onap.org/).
16882       parameters:
16883         - name: global-customer-id
16884           in: path
16885           description: Global customer id used across ECOMP to uniquely identify customer.
16886           required: true
16887           type: string
16888           example: __GLOBAL-CUSTOMER-ID__
16889         - name: resource-version
16890           in: query
16891           description: resource-version for concurrency
16892           required: true
16893           type: string
16894   /business/customers:
16895     get:
16896       tags:
16897         - Business
16898       summary: returns customers
16899       description: returns customers
16900       operationId: getBusinessCustomers
16901       produces:
16902         - application/json
16903         - application/xml
16904       responses:
16905         "200":
16906           description: successful operation
16907           schema:
16908               $ref: "#/getDefinitions/customers"
16909         "default":
16910           description: Response codes found in [response codes](https://wiki.onap.org/).
16911       parameters:
16912         - name: global-customer-id
16913           in: query
16914           description:
16915           required: false
16916           type: string
16917         - name: subscriber-name
16918           in: query
16919           description:
16920           required: false
16921           type: string
16922         - name: subscriber-type
16923           in: query
16924           description:
16925           required: false
16926           type: string
16927   /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
16928     put:
16929       tags:
16930         - Business
16931       summary: see node definition for valid relationships
16932       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
16933       consumes:
16934         - application/json
16935         - application/xml
16936       produces:
16937         - application/json
16938         - application/xml
16939       responses:
16940         "default":
16941           description: Response codes found in [response codes](https://wiki.onap.org/).
16942       parameters:
16943         - name: line-of-business-name
16944           in: path
16945           description: Name of the line-of-business (product)
16946           required: true
16947           type: string
16948           example: __LINE-OF-BUSINESS-NAME__
16949         - name: body
16950           in: body
16951           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessLinesOfBusinessLineOfBusiness.json)
16952           required: true
16953           schema:
16954             $ref: "#/definitions/relationship"
16955     delete:
16956       tags:
16957         - Business
16958       summary: delete an existing relationship
16959       description: delete an existing relationship
16960       operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
16961       consumes:
16962         - application/json
16963         - application/xml
16964       produces:
16965         - application/json
16966         - application/xml
16967       responses:
16968         "default":
16969           description: Response codes found in [response codes](https://wiki.onap.org/).
16970       parameters:
16971         - name: line-of-business-name
16972           in: path
16973           description: Name of the line-of-business (product)
16974           required: true
16975           type: string
16976           example: __LINE-OF-BUSINESS-NAME__
16977   /business/lines-of-business/line-of-business/{line-of-business-name}:
16978     get:
16979       tags:
16980         - Business
16981       summary: returns line-of-business
16982       description: returns line-of-business
16983       operationId: getBusinessLinesOfBusinessLineOfBusiness
16984       produces:
16985         - application/json
16986         - application/xml
16987       responses:
16988         "200":
16989           description: successful operation
16990           schema:
16991               $ref: "#/getDefinitions/line-of-business"
16992         "default":
16993           description: Response codes found in [response codes](https://wiki.onap.org/).
16994       parameters:
16995         - name: line-of-business-name
16996           in: path
16997           description: Name of the line-of-business (product)
16998           required: true
16999           type: string
17000           example: __LINE-OF-BUSINESS-NAME__
17001     put:
17002       tags:
17003         - Business
17004       summary: create or update an existing line-of-business
17005       description: |
17006         Create or update an existing line-of-business.
17007         #
17008         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17009       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
17010       consumes:
17011         - application/json
17012         - application/xml
17013       produces:
17014         - application/json
17015         - application/xml
17016       responses:
17017         "default":
17018           description: Response codes found in [response codes](https://wiki.onap.org/).
17019       parameters:
17020         - name: line-of-business-name
17021           in: path
17022           description: Name of the line-of-business (product)
17023           required: true
17024           type: string
17025           example: __LINE-OF-BUSINESS-NAME__
17026         - name: body
17027           in: body
17028           description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessLinesOfBusinessLineOfBusiness.json)
17029           required: true
17030           schema:
17031             $ref: "#/definitions/line-of-business"
17032     patch:
17033       tags:
17034         - Business
17035       summary: update an existing line-of-business
17036       description: |
17037         Update an existing line-of-business
17038         #
17039         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17040         The PUT operation will entirely replace an existing object.
17041         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17042         #
17043         Other differences between PUT and PATCH are:
17044         #
17045         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17046         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17047         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17048       operationId: UpdateBusinessLinesOfBusinessLineOfBusiness
17049       consumes:
17050         - application/json
17051         - application/xml
17052       produces:
17053         - application/json
17054         - application/xml
17055       responses:
17056         "default":
17057           description: Response codes found in [response codes](https://wiki.onap.org/).
17058       parameters:
17059         - name: line-of-business-name
17060           in: path
17061           description: Name of the line-of-business (product)
17062           required: true
17063           type: string
17064           example: __LINE-OF-BUSINESS-NAME__
17065         - name: body
17066           in: body
17067           description: line-of-business object that needs to be updated.
17068           required: true
17069           schema:
17070             $ref: "#/patchDefinitions/line-of-business"
17071     delete:
17072       tags:
17073         - Business
17074       summary: delete an existing line-of-business
17075       description: delete an existing line-of-business
17076       operationId: deleteBusinessLinesOfBusinessLineOfBusiness
17077       consumes:
17078         - application/json
17079         - application/xml
17080       produces:
17081         - application/json
17082         - application/xml
17083       responses:
17084         "default":
17085           description: Response codes found in [response codes](https://wiki.onap.org/).
17086       parameters:
17087         - name: line-of-business-name
17088           in: path
17089           description: Name of the line-of-business (product)
17090           required: true
17091           type: string
17092           example: __LINE-OF-BUSINESS-NAME__
17093         - name: resource-version
17094           in: query
17095           description: resource-version for concurrency
17096           required: true
17097           type: string
17098   /business/lines-of-business:
17099     get:
17100       tags:
17101         - Business
17102       summary: returns lines-of-business
17103       description: returns lines-of-business
17104       operationId: getBusinessLinesOfBusiness
17105       produces:
17106         - application/json
17107         - application/xml
17108       responses:
17109         "200":
17110           description: successful operation
17111           schema:
17112               $ref: "#/getDefinitions/lines-of-business"
17113         "default":
17114           description: Response codes found in [response codes](https://wiki.onap.org/).
17115       parameters:
17116         - name: line-of-business-name
17117           in: query
17118           description:
17119           required: false
17120           type: string
17121   /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
17122     put:
17123       tags:
17124         - Business
17125       summary: see node definition for valid relationships
17126       operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
17127       consumes:
17128         - application/json
17129         - application/xml
17130       produces:
17131         - application/json
17132         - application/xml
17133       responses:
17134         "default":
17135           description: Response codes found in [response codes](https://wiki.onap.org/).
17136       parameters:
17137         - name: owning-entity-id
17138           in: path
17139           description: UUID of an owning entity
17140           required: true
17141           type: string
17142           example: __OWNING-ENTITY-ID__
17143         - name: body
17144           in: body
17145           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessOwningEntitiesOwningEntity.json)
17146           required: true
17147           schema:
17148             $ref: "#/definitions/relationship"
17149     delete:
17150       tags:
17151         - Business
17152       summary: delete an existing relationship
17153       description: delete an existing relationship
17154       operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
17155       consumes:
17156         - application/json
17157         - application/xml
17158       produces:
17159         - application/json
17160         - application/xml
17161       responses:
17162         "default":
17163           description: Response codes found in [response codes](https://wiki.onap.org/).
17164       parameters:
17165         - name: owning-entity-id
17166           in: path
17167           description: UUID of an owning entity
17168           required: true
17169           type: string
17170           example: __OWNING-ENTITY-ID__
17171   /business/owning-entities/owning-entity/{owning-entity-id}:
17172     get:
17173       tags:
17174         - Business
17175       summary: returns owning-entity
17176       description: returns owning-entity
17177       operationId: getBusinessOwningEntitiesOwningEntity
17178       produces:
17179         - application/json
17180         - application/xml
17181       responses:
17182         "200":
17183           description: successful operation
17184           schema:
17185               $ref: "#/getDefinitions/owning-entity"
17186         "default":
17187           description: Response codes found in [response codes](https://wiki.onap.org/).
17188       parameters:
17189         - name: owning-entity-id
17190           in: path
17191           description: UUID of an owning entity
17192           required: true
17193           type: string
17194           example: __OWNING-ENTITY-ID__
17195     put:
17196       tags:
17197         - Business
17198       summary: create or update an existing owning-entity
17199       description: |
17200         Create or update an existing owning-entity.
17201         #
17202         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17203       operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
17204       consumes:
17205         - application/json
17206         - application/xml
17207       produces:
17208         - application/json
17209         - application/xml
17210       responses:
17211         "default":
17212           description: Response codes found in [response codes](https://wiki.onap.org/).
17213       parameters:
17214         - name: owning-entity-id
17215           in: path
17216           description: UUID of an owning entity
17217           required: true
17218           type: string
17219           example: __OWNING-ENTITY-ID__
17220         - name: body
17221           in: body
17222           description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessOwningEntitiesOwningEntity.json)
17223           required: true
17224           schema:
17225             $ref: "#/definitions/owning-entity"
17226     patch:
17227       tags:
17228         - Business
17229       summary: update an existing owning-entity
17230       description: |
17231         Update an existing owning-entity
17232         #
17233         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17234         The PUT operation will entirely replace an existing object.
17235         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17236         #
17237         Other differences between PUT and PATCH are:
17238         #
17239         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17240         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17241         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17242       operationId: UpdateBusinessOwningEntitiesOwningEntity
17243       consumes:
17244         - application/json
17245         - application/xml
17246       produces:
17247         - application/json
17248         - application/xml
17249       responses:
17250         "default":
17251           description: Response codes found in [response codes](https://wiki.onap.org/).
17252       parameters:
17253         - name: owning-entity-id
17254           in: path
17255           description: UUID of an owning entity
17256           required: true
17257           type: string
17258           example: __OWNING-ENTITY-ID__
17259         - name: body
17260           in: body
17261           description: owning-entity object that needs to be updated.
17262           required: true
17263           schema:
17264             $ref: "#/patchDefinitions/owning-entity"
17265     delete:
17266       tags:
17267         - Business
17268       summary: delete an existing owning-entity
17269       description: delete an existing owning-entity
17270       operationId: deleteBusinessOwningEntitiesOwningEntity
17271       consumes:
17272         - application/json
17273         - application/xml
17274       produces:
17275         - application/json
17276         - application/xml
17277       responses:
17278         "default":
17279           description: Response codes found in [response codes](https://wiki.onap.org/).
17280       parameters:
17281         - name: owning-entity-id
17282           in: path
17283           description: UUID of an owning entity
17284           required: true
17285           type: string
17286           example: __OWNING-ENTITY-ID__
17287         - name: resource-version
17288           in: query
17289           description: resource-version for concurrency
17290           required: true
17291           type: string
17292   /business/owning-entities:
17293     get:
17294       tags:
17295         - Business
17296       summary: returns owning-entities
17297       description: returns owning-entities
17298       operationId: getBusinessOwningEntities
17299       produces:
17300         - application/json
17301         - application/xml
17302       responses:
17303         "200":
17304           description: successful operation
17305           schema:
17306               $ref: "#/getDefinitions/owning-entities"
17307         "default":
17308           description: Response codes found in [response codes](https://wiki.onap.org/).
17309       parameters:
17310         - name: owning-entity-id
17311           in: query
17312           description:
17313           required: false
17314           type: string
17315   /business/platforms/platform/{platform-name}/relationship-list/relationship:
17316     put:
17317       tags:
17318         - Business
17319       summary: see node definition for valid relationships
17320       operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
17321       consumes:
17322         - application/json
17323         - application/xml
17324       produces:
17325         - application/json
17326         - application/xml
17327       responses:
17328         "default":
17329           description: Response codes found in [response codes](https://wiki.onap.org/).
17330       parameters:
17331         - name: platform-name
17332           in: path
17333           description: Name of the platform
17334           required: true
17335           type: string
17336           example: __PLATFORM-NAME__
17337         - name: body
17338           in: body
17339           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessPlatformsPlatform.json)
17340           required: true
17341           schema:
17342             $ref: "#/definitions/relationship"
17343     delete:
17344       tags:
17345         - Business
17346       summary: delete an existing relationship
17347       description: delete an existing relationship
17348       operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
17349       consumes:
17350         - application/json
17351         - application/xml
17352       produces:
17353         - application/json
17354         - application/xml
17355       responses:
17356         "default":
17357           description: Response codes found in [response codes](https://wiki.onap.org/).
17358       parameters:
17359         - name: platform-name
17360           in: path
17361           description: Name of the platform
17362           required: true
17363           type: string
17364           example: __PLATFORM-NAME__
17365   /business/platforms/platform/{platform-name}:
17366     get:
17367       tags:
17368         - Business
17369       summary: returns platform
17370       description: returns platform
17371       operationId: getBusinessPlatformsPlatform
17372       produces:
17373         - application/json
17374         - application/xml
17375       responses:
17376         "200":
17377           description: successful operation
17378           schema:
17379               $ref: "#/getDefinitions/platform"
17380         "default":
17381           description: Response codes found in [response codes](https://wiki.onap.org/).
17382       parameters:
17383         - name: platform-name
17384           in: path
17385           description: Name of the platform
17386           required: true
17387           type: string
17388           example: __PLATFORM-NAME__
17389     put:
17390       tags:
17391         - Business
17392       summary: create or update an existing platform
17393       description: |
17394         Create or update an existing platform.
17395         #
17396         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17397       operationId: createOrUpdateBusinessPlatformsPlatform
17398       consumes:
17399         - application/json
17400         - application/xml
17401       produces:
17402         - application/json
17403         - application/xml
17404       responses:
17405         "default":
17406           description: Response codes found in [response codes](https://wiki.onap.org/).
17407       parameters:
17408         - name: platform-name
17409           in: path
17410           description: Name of the platform
17411           required: true
17412           type: string
17413           example: __PLATFORM-NAME__
17414         - name: body
17415           in: body
17416           description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessPlatformsPlatform.json)
17417           required: true
17418           schema:
17419             $ref: "#/definitions/platform"
17420     patch:
17421       tags:
17422         - Business
17423       summary: update an existing platform
17424       description: |
17425         Update an existing platform
17426         #
17427         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17428         The PUT operation will entirely replace an existing object.
17429         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17430         #
17431         Other differences between PUT and PATCH are:
17432         #
17433         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17434         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17435         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17436       operationId: UpdateBusinessPlatformsPlatform
17437       consumes:
17438         - application/json
17439         - application/xml
17440       produces:
17441         - application/json
17442         - application/xml
17443       responses:
17444         "default":
17445           description: Response codes found in [response codes](https://wiki.onap.org/).
17446       parameters:
17447         - name: platform-name
17448           in: path
17449           description: Name of the platform
17450           required: true
17451           type: string
17452           example: __PLATFORM-NAME__
17453         - name: body
17454           in: body
17455           description: platform object that needs to be updated.
17456           required: true
17457           schema:
17458             $ref: "#/patchDefinitions/platform"
17459     delete:
17460       tags:
17461         - Business
17462       summary: delete an existing platform
17463       description: delete an existing platform
17464       operationId: deleteBusinessPlatformsPlatform
17465       consumes:
17466         - application/json
17467         - application/xml
17468       produces:
17469         - application/json
17470         - application/xml
17471       responses:
17472         "default":
17473           description: Response codes found in [response codes](https://wiki.onap.org/).
17474       parameters:
17475         - name: platform-name
17476           in: path
17477           description: Name of the platform
17478           required: true
17479           type: string
17480           example: __PLATFORM-NAME__
17481         - name: resource-version
17482           in: query
17483           description: resource-version for concurrency
17484           required: true
17485           type: string
17486   /business/platforms:
17487     get:
17488       tags:
17489         - Business
17490       summary: returns platforms
17491       description: returns platforms
17492       operationId: getBusinessPlatforms
17493       produces:
17494         - application/json
17495         - application/xml
17496       responses:
17497         "200":
17498           description: successful operation
17499           schema:
17500               $ref: "#/getDefinitions/platforms"
17501         "default":
17502           description: Response codes found in [response codes](https://wiki.onap.org/).
17503       parameters:
17504         - name: platform-name
17505           in: query
17506           description:
17507           required: false
17508           type: string
17509   /business/projects/project/{project-name}/relationship-list/relationship:
17510     put:
17511       tags:
17512         - Business
17513       summary: see node definition for valid relationships
17514       operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
17515       consumes:
17516         - application/json
17517         - application/xml
17518       produces:
17519         - application/json
17520         - application/xml
17521       responses:
17522         "default":
17523           description: Response codes found in [response codes](https://wiki.onap.org/).
17524       parameters:
17525         - name: project-name
17526           in: path
17527           description: Name of the project deploying a service
17528           required: true
17529           type: string
17530           example: __PROJECT-NAME__
17531         - name: body
17532           in: body
17533           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessProjectsProject.json)
17534           required: true
17535           schema:
17536             $ref: "#/definitions/relationship"
17537     delete:
17538       tags:
17539         - Business
17540       summary: delete an existing relationship
17541       description: delete an existing relationship
17542       operationId: deleteBusinessProjectsProjectRelationshipListRelationship
17543       consumes:
17544         - application/json
17545         - application/xml
17546       produces:
17547         - application/json
17548         - application/xml
17549       responses:
17550         "default":
17551           description: Response codes found in [response codes](https://wiki.onap.org/).
17552       parameters:
17553         - name: project-name
17554           in: path
17555           description: Name of the project deploying a service
17556           required: true
17557           type: string
17558           example: __PROJECT-NAME__
17559   /business/projects/project/{project-name}:
17560     get:
17561       tags:
17562         - Business
17563       summary: returns project
17564       description: returns project
17565       operationId: getBusinessProjectsProject
17566       produces:
17567         - application/json
17568         - application/xml
17569       responses:
17570         "200":
17571           description: successful operation
17572           schema:
17573               $ref: "#/getDefinitions/project"
17574         "default":
17575           description: Response codes found in [response codes](https://wiki.onap.org/).
17576       parameters:
17577         - name: project-name
17578           in: path
17579           description: Name of the project deploying a service
17580           required: true
17581           type: string
17582           example: __PROJECT-NAME__
17583     put:
17584       tags:
17585         - Business
17586       summary: create or update an existing project
17587       description: |
17588         Create or update an existing project.
17589         #
17590         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17591       operationId: createOrUpdateBusinessProjectsProject
17592       consumes:
17593         - application/json
17594         - application/xml
17595       produces:
17596         - application/json
17597         - application/xml
17598       responses:
17599         "default":
17600           description: Response codes found in [response codes](https://wiki.onap.org/).
17601       parameters:
17602         - name: project-name
17603           in: path
17604           description: Name of the project deploying a service
17605           required: true
17606           type: string
17607           example: __PROJECT-NAME__
17608         - name: body
17609           in: body
17610           description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/BusinessProjectsProject.json)
17611           required: true
17612           schema:
17613             $ref: "#/definitions/project"
17614     patch:
17615       tags:
17616         - Business
17617       summary: update an existing project
17618       description: |
17619         Update an existing project
17620         #
17621         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17622         The PUT operation will entirely replace an existing object.
17623         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17624         #
17625         Other differences between PUT and PATCH are:
17626         #
17627         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17628         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17629         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17630       operationId: UpdateBusinessProjectsProject
17631       consumes:
17632         - application/json
17633         - application/xml
17634       produces:
17635         - application/json
17636         - application/xml
17637       responses:
17638         "default":
17639           description: Response codes found in [response codes](https://wiki.onap.org/).
17640       parameters:
17641         - name: project-name
17642           in: path
17643           description: Name of the project deploying a service
17644           required: true
17645           type: string
17646           example: __PROJECT-NAME__
17647         - name: body
17648           in: body
17649           description: project object that needs to be updated.
17650           required: true
17651           schema:
17652             $ref: "#/patchDefinitions/project"
17653     delete:
17654       tags:
17655         - Business
17656       summary: delete an existing project
17657       description: delete an existing project
17658       operationId: deleteBusinessProjectsProject
17659       consumes:
17660         - application/json
17661         - application/xml
17662       produces:
17663         - application/json
17664         - application/xml
17665       responses:
17666         "default":
17667           description: Response codes found in [response codes](https://wiki.onap.org/).
17668       parameters:
17669         - name: project-name
17670           in: path
17671           description: Name of the project deploying a service
17672           required: true
17673           type: string
17674           example: __PROJECT-NAME__
17675         - name: resource-version
17676           in: query
17677           description: resource-version for concurrency
17678           required: true
17679           type: string
17680   /business/projects:
17681     get:
17682       tags:
17683         - Business
17684       summary: returns projects
17685       description: returns projects
17686       operationId: getBusinessProjects
17687       produces:
17688         - application/json
17689         - application/xml
17690       responses:
17691         "200":
17692           description: successful operation
17693           schema:
17694               $ref: "#/getDefinitions/projects"
17695         "default":
17696           description: Response codes found in [response codes](https://wiki.onap.org/).
17697       parameters:
17698         - name: project-name
17699           in: query
17700           description:
17701           required: false
17702           type: string
17703   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
17704     put:
17705       tags:
17706         - ServiceDesignAndCreation
17707       summary: see node definition for valid relationships
17708       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
17709       consumes:
17710         - application/json
17711         - application/xml
17712       produces:
17713         - application/json
17714         - application/xml
17715       responses:
17716         "default":
17717           description: Response codes found in [response codes](https://wiki.onap.org/).
17718       parameters:
17719         - name: vnf-image-uuid
17720           in: path
17721           description: Unique ID of this asset
17722           required: true
17723           type: string
17724           example: __VNF-IMAGE-UUID__
17725         - name: body
17726           in: body
17727           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationVnfImagesVnfImage.json)
17728           required: true
17729           schema:
17730             $ref: "#/definitions/relationship"
17731     delete:
17732       tags:
17733         - ServiceDesignAndCreation
17734       summary: delete an existing relationship
17735       description: delete an existing relationship
17736       operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
17737       consumes:
17738         - application/json
17739         - application/xml
17740       produces:
17741         - application/json
17742         - application/xml
17743       responses:
17744         "default":
17745           description: Response codes found in [response codes](https://wiki.onap.org/).
17746       parameters:
17747         - name: vnf-image-uuid
17748           in: path
17749           description: Unique ID of this asset
17750           required: true
17751           type: string
17752           example: __VNF-IMAGE-UUID__
17753   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
17754     get:
17755       tags:
17756         - ServiceDesignAndCreation
17757       summary: returns vnf-image
17758       description: returns vnf-image
17759       operationId: getServiceDesignAndCreationVnfImagesVnfImage
17760       produces:
17761         - application/json
17762         - application/xml
17763       responses:
17764         "200":
17765           description: successful operation
17766           schema:
17767               $ref: "#/getDefinitions/vnf-image"
17768         "default":
17769           description: Response codes found in [response codes](https://wiki.onap.org/).
17770       parameters:
17771         - name: vnf-image-uuid
17772           in: path
17773           description: Unique ID of this asset
17774           required: true
17775           type: string
17776           example: __VNF-IMAGE-UUID__
17777     put:
17778       tags:
17779         - ServiceDesignAndCreation
17780       summary: create or update an existing vnf-image
17781       description: |
17782         Create or update an existing vnf-image.
17783         #
17784         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17785       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
17786       consumes:
17787         - application/json
17788         - application/xml
17789       produces:
17790         - application/json
17791         - application/xml
17792       responses:
17793         "default":
17794           description: Response codes found in [response codes](https://wiki.onap.org/).
17795       parameters:
17796         - name: vnf-image-uuid
17797           in: path
17798           description: Unique ID of this asset
17799           required: true
17800           type: string
17801           example: __VNF-IMAGE-UUID__
17802         - name: body
17803           in: body
17804           description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationVnfImagesVnfImage.json)
17805           required: true
17806           schema:
17807             $ref: "#/definitions/vnf-image"
17808     patch:
17809       tags:
17810         - ServiceDesignAndCreation
17811       summary: update an existing vnf-image
17812       description: |
17813         Update an existing vnf-image
17814         #
17815         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17816         The PUT operation will entirely replace an existing object.
17817         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17818         #
17819         Other differences between PUT and PATCH are:
17820         #
17821         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17822         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17823         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17824       operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
17825       consumes:
17826         - application/json
17827         - application/xml
17828       produces:
17829         - application/json
17830         - application/xml
17831       responses:
17832         "default":
17833           description: Response codes found in [response codes](https://wiki.onap.org/).
17834       parameters:
17835         - name: vnf-image-uuid
17836           in: path
17837           description: Unique ID of this asset
17838           required: true
17839           type: string
17840           example: __VNF-IMAGE-UUID__
17841         - name: body
17842           in: body
17843           description: vnf-image object that needs to be updated.
17844           required: true
17845           schema:
17846             $ref: "#/patchDefinitions/vnf-image"
17847     delete:
17848       tags:
17849         - ServiceDesignAndCreation
17850       summary: delete an existing vnf-image
17851       description: delete an existing vnf-image
17852       operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
17853       consumes:
17854         - application/json
17855         - application/xml
17856       produces:
17857         - application/json
17858         - application/xml
17859       responses:
17860         "default":
17861           description: Response codes found in [response codes](https://wiki.onap.org/).
17862       parameters:
17863         - name: vnf-image-uuid
17864           in: path
17865           description: Unique ID of this asset
17866           required: true
17867           type: string
17868           example: __VNF-IMAGE-UUID__
17869         - name: resource-version
17870           in: query
17871           description: resource-version for concurrency
17872           required: true
17873           type: string
17874   /service-design-and-creation/vnf-images:
17875     get:
17876       tags:
17877         - ServiceDesignAndCreation
17878       summary: returns vnf-images
17879       description: returns vnf-images
17880       operationId: getServiceDesignAndCreationVnfImages
17881       produces:
17882         - application/json
17883         - application/xml
17884       responses:
17885         "200":
17886           description: successful operation
17887           schema:
17888               $ref: "#/getDefinitions/vnf-images"
17889         "default":
17890           description: Response codes found in [response codes](https://wiki.onap.org/).
17891       parameters:
17892         - name: vnf-image-uuid
17893           in: query
17894           description:
17895           required: false
17896           type: string
17897         - name: application
17898           in: query
17899           description:
17900           required: false
17901           type: string
17902         - name: application-vendor
17903           in: query
17904           description:
17905           required: false
17906           type: string
17907         - name: application-version
17908           in: query
17909           description:
17910           required: false
17911           type: string
17912   /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
17913     put:
17914       tags:
17915         - ServiceDesignAndCreation
17916       summary: see node definition for valid relationships
17917       operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
17918       consumes:
17919         - application/json
17920         - application/xml
17921       produces:
17922         - application/json
17923         - application/xml
17924       responses:
17925         "default":
17926           description: Response codes found in [response codes](https://wiki.onap.org/).
17927       parameters:
17928         - name: service-id
17929           in: path
17930           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17931           required: true
17932           type: string
17933           example: __SERVICE-ID__
17934         - name: body
17935           in: body
17936           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServicesService.json)
17937           required: true
17938           schema:
17939             $ref: "#/definitions/relationship"
17940     delete:
17941       tags:
17942         - ServiceDesignAndCreation
17943       summary: delete an existing relationship
17944       description: delete an existing relationship
17945       operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
17946       consumes:
17947         - application/json
17948         - application/xml
17949       produces:
17950         - application/json
17951         - application/xml
17952       responses:
17953         "default":
17954           description: Response codes found in [response codes](https://wiki.onap.org/).
17955       parameters:
17956         - name: service-id
17957           in: path
17958           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17959           required: true
17960           type: string
17961           example: __SERVICE-ID__
17962   /service-design-and-creation/services/service/{service-id}:
17963     get:
17964       tags:
17965         - ServiceDesignAndCreation
17966       summary: returns service
17967       description: returns service
17968       operationId: getServiceDesignAndCreationServicesService
17969       produces:
17970         - application/json
17971         - application/xml
17972       responses:
17973         "200":
17974           description: successful operation
17975           schema:
17976               $ref: "#/getDefinitions/service"
17977         "default":
17978           description: Response codes found in [response codes](https://wiki.onap.org/).
17979       parameters:
17980         - name: service-id
17981           in: path
17982           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17983           required: true
17984           type: string
17985           example: __SERVICE-ID__
17986     put:
17987       tags:
17988         - ServiceDesignAndCreation
17989       summary: create or update an existing service
17990       description: |
17991         Create or update an existing service.
17992         #
17993         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17994       operationId: createOrUpdateServiceDesignAndCreationServicesService
17995       consumes:
17996         - application/json
17997         - application/xml
17998       produces:
17999         - application/json
18000         - application/xml
18001       responses:
18002         "default":
18003           description: Response codes found in [response codes](https://wiki.onap.org/).
18004       parameters:
18005         - name: service-id
18006           in: path
18007           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18008           required: true
18009           type: string
18010           example: __SERVICE-ID__
18011         - name: body
18012           in: body
18013           description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServicesService.json)
18014           required: true
18015           schema:
18016             $ref: "#/definitions/service"
18017     patch:
18018       tags:
18019         - ServiceDesignAndCreation
18020       summary: update an existing service
18021       description: |
18022         Update an existing service
18023         #
18024         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18025         The PUT operation will entirely replace an existing object.
18026         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18027         #
18028         Other differences between PUT and PATCH are:
18029         #
18030         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18031         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18032         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18033       operationId: UpdateServiceDesignAndCreationServicesService
18034       consumes:
18035         - application/json
18036         - application/xml
18037       produces:
18038         - application/json
18039         - application/xml
18040       responses:
18041         "default":
18042           description: Response codes found in [response codes](https://wiki.onap.org/).
18043       parameters:
18044         - name: service-id
18045           in: path
18046           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18047           required: true
18048           type: string
18049           example: __SERVICE-ID__
18050         - name: body
18051           in: body
18052           description: service object that needs to be updated.
18053           required: true
18054           schema:
18055             $ref: "#/patchDefinitions/service"
18056     delete:
18057       tags:
18058         - ServiceDesignAndCreation
18059       summary: delete an existing service
18060       description: delete an existing service
18061       operationId: deleteServiceDesignAndCreationServicesService
18062       consumes:
18063         - application/json
18064         - application/xml
18065       produces:
18066         - application/json
18067         - application/xml
18068       responses:
18069         "default":
18070           description: Response codes found in [response codes](https://wiki.onap.org/).
18071       parameters:
18072         - name: service-id
18073           in: path
18074           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18075           required: true
18076           type: string
18077           example: __SERVICE-ID__
18078         - name: resource-version
18079           in: query
18080           description: resource-version for concurrency
18081           required: true
18082           type: string
18083   /service-design-and-creation/services:
18084     get:
18085       tags:
18086         - ServiceDesignAndCreation
18087       summary: returns services
18088       description: returns services
18089       operationId: getServiceDesignAndCreationServices
18090       produces:
18091         - application/json
18092         - application/xml
18093       responses:
18094         "200":
18095           description: successful operation
18096           schema:
18097               $ref: "#/getDefinitions/services"
18098         "default":
18099           description: Response codes found in [response codes](https://wiki.onap.org/).
18100       parameters:
18101         - name: service-id
18102           in: query
18103           description:
18104           required: false
18105           type: string
18106         - name: service-description
18107           in: query
18108           description:
18109           required: false
18110           type: string
18111   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
18112     put:
18113       tags:
18114         - ServiceDesignAndCreation
18115       summary: see node definition for valid relationships
18116       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
18117       consumes:
18118         - application/json
18119         - application/xml
18120       produces:
18121         - application/json
18122         - application/xml
18123       responses:
18124         "default":
18125           description: Response codes found in [response codes](https://wiki.onap.org/).
18126       parameters:
18127         - name: service-type
18128           in: path
18129           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18130           required: true
18131           type: string
18132           example: __SERVICE-TYPE__
18133         - name: vnf-type
18134           in: path
18135           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
18136           required: true
18137           type: string
18138           example: __VNF-TYPE__
18139         - name: body
18140           in: body
18141           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
18142           required: true
18143           schema:
18144             $ref: "#/definitions/relationship"
18145     delete:
18146       tags:
18147         - ServiceDesignAndCreation
18148       summary: delete an existing relationship
18149       description: delete an existing relationship
18150       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
18151       consumes:
18152         - application/json
18153         - application/xml
18154       produces:
18155         - application/json
18156         - application/xml
18157       responses:
18158         "default":
18159           description: Response codes found in [response codes](https://wiki.onap.org/).
18160       parameters:
18161         - name: service-type
18162           in: path
18163           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18164           required: true
18165           type: string
18166           example: __SERVICE-TYPE__
18167         - name: vnf-type
18168           in: path
18169           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
18170           required: true
18171           type: string
18172           example: __VNF-TYPE__
18173   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
18174     get:
18175       tags:
18176         - ServiceDesignAndCreation
18177       summary: returns service-capability
18178       description: returns service-capability
18179       operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
18180       produces:
18181         - application/json
18182         - application/xml
18183       responses:
18184         "200":
18185           description: successful operation
18186           schema:
18187               $ref: "#/getDefinitions/service-capability"
18188         "default":
18189           description: Response codes found in [response codes](https://wiki.onap.org/).
18190       parameters:
18191         - name: service-type
18192           in: path
18193           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18194           required: true
18195           type: string
18196           example: __SERVICE-TYPE__
18197         - name: vnf-type
18198           in: path
18199           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
18200           required: true
18201           type: string
18202           example: __VNF-TYPE__
18203     put:
18204       tags:
18205         - ServiceDesignAndCreation
18206       summary: create or update an existing service-capability
18207       description: |
18208         Create or update an existing service-capability.
18209         #
18210         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18211       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
18212       consumes:
18213         - application/json
18214         - application/xml
18215       produces:
18216         - application/json
18217         - application/xml
18218       responses:
18219         "default":
18220           description: Response codes found in [response codes](https://wiki.onap.org/).
18221       parameters:
18222         - name: service-type
18223           in: path
18224           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18225           required: true
18226           type: string
18227           example: __SERVICE-TYPE__
18228         - name: vnf-type
18229           in: path
18230           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
18231           required: true
18232           type: string
18233           example: __VNF-TYPE__
18234         - name: body
18235           in: body
18236           description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
18237           required: true
18238           schema:
18239             $ref: "#/definitions/service-capability"
18240     patch:
18241       tags:
18242         - ServiceDesignAndCreation
18243       summary: update an existing service-capability
18244       description: |
18245         Update an existing service-capability
18246         #
18247         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18248         The PUT operation will entirely replace an existing object.
18249         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18250         #
18251         Other differences between PUT and PATCH are:
18252         #
18253         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18254         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18255         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18256       operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
18257       consumes:
18258         - application/json
18259         - application/xml
18260       produces:
18261         - application/json
18262         - application/xml
18263       responses:
18264         "default":
18265           description: Response codes found in [response codes](https://wiki.onap.org/).
18266       parameters:
18267         - name: service-type
18268           in: path
18269           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18270           required: true
18271           type: string
18272           example: __SERVICE-TYPE__
18273         - name: vnf-type
18274           in: path
18275           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
18276           required: true
18277           type: string
18278           example: __VNF-TYPE__
18279         - name: body
18280           in: body
18281           description: service-capability object that needs to be updated.
18282           required: true
18283           schema:
18284             $ref: "#/patchDefinitions/service-capability"
18285     delete:
18286       tags:
18287         - ServiceDesignAndCreation
18288       summary: delete an existing service-capability
18289       description: delete an existing service-capability
18290       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
18291       consumes:
18292         - application/json
18293         - application/xml
18294       produces:
18295         - application/json
18296         - application/xml
18297       responses:
18298         "default":
18299           description: Response codes found in [response codes](https://wiki.onap.org/).
18300       parameters:
18301         - name: service-type
18302           in: path
18303           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18304           required: true
18305           type: string
18306           example: __SERVICE-TYPE__
18307         - name: vnf-type
18308           in: path
18309           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
18310           required: true
18311           type: string
18312           example: __VNF-TYPE__
18313         - name: resource-version
18314           in: query
18315           description: resource-version for concurrency
18316           required: true
18317           type: string
18318   /service-design-and-creation/service-capabilities:
18319     get:
18320       tags:
18321         - ServiceDesignAndCreation
18322       summary: returns service-capabilities
18323       description: returns service-capabilities
18324       operationId: getServiceDesignAndCreationServiceCapabilities
18325       produces:
18326         - application/json
18327         - application/xml
18328       responses:
18329         "200":
18330           description: successful operation
18331           schema:
18332               $ref: "#/getDefinitions/service-capabilities"
18333         "default":
18334           description: Response codes found in [response codes](https://wiki.onap.org/).
18335       parameters:
18336         - name: service-type
18337           in: query
18338           description:
18339           required: false
18340           type: string
18341         - name: vnf-type
18342           in: query
18343           description:
18344           required: false
18345           type: string
18346   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship:
18347     put:
18348       tags:
18349         - ServiceDesignAndCreation
18350       summary: see node definition for valid relationships
18351       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
18352       consumes:
18353         - application/json
18354         - application/xml
18355       produces:
18356         - application/json
18357         - application/xml
18358       responses:
18359         "default":
18360           description: Response codes found in [response codes](https://wiki.onap.org/).
18361       parameters:
18362         - name: model-invariant-id
18363           in: path
18364           description: Unique identifier corresponding to the main definition of a model in ASDC
18365           required: true
18366           type: string
18367           example: __MODEL-INVARIANT-ID__
18368         - name: model-version-id
18369           in: path
18370           description: Unique identifier corresponding to one version of a model in ASDC
18371           required: true
18372           type: string
18373           example: __MODEL-VERSION-ID__
18374         - name: model-element-uuid
18375           in: path
18376           required: true
18377           type: string
18378           example: __MODEL-ELEMENT-UUID__
18379         - name: model-constraint-uuid
18380           in: path
18381           required: true
18382           type: string
18383           example: __MODEL-CONSTRAINT-UUID__
18384         - name: constrained-element-set-uuid
18385           in: path
18386           required: true
18387           type: string
18388           example: __CONSTRAINED-ELEMENT-SET-UUID__
18389         - name: element-choice-set-uuid
18390           in: path
18391           required: true
18392           type: string
18393           example: __ELEMENT-CHOICE-SET-UUID__
18394         - name: body
18395           in: body
18396           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
18397           required: true
18398           schema:
18399             $ref: "#/definitions/relationship"
18400     delete:
18401       tags:
18402         - ServiceDesignAndCreation
18403       summary: delete an existing relationship
18404       description: delete an existing relationship
18405       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
18406       consumes:
18407         - application/json
18408         - application/xml
18409       produces:
18410         - application/json
18411         - application/xml
18412       responses:
18413         "default":
18414           description: Response codes found in [response codes](https://wiki.onap.org/).
18415       parameters:
18416         - name: model-invariant-id
18417           in: path
18418           description: Unique identifier corresponding to the main definition of a model in ASDC
18419           required: true
18420           type: string
18421           example: __MODEL-INVARIANT-ID__
18422         - name: model-version-id
18423           in: path
18424           description: Unique identifier corresponding to one version of a model in ASDC
18425           required: true
18426           type: string
18427           example: __MODEL-VERSION-ID__
18428         - name: model-element-uuid
18429           in: path
18430           required: true
18431           type: string
18432           example: __MODEL-ELEMENT-UUID__
18433         - name: model-constraint-uuid
18434           in: path
18435           required: true
18436           type: string
18437           example: __MODEL-CONSTRAINT-UUID__
18438         - name: constrained-element-set-uuid
18439           in: path
18440           required: true
18441           type: string
18442           example: __CONSTRAINED-ELEMENT-SET-UUID__
18443         - name: element-choice-set-uuid
18444           in: path
18445           required: true
18446           type: string
18447           example: __ELEMENT-CHOICE-SET-UUID__
18448   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}:
18449     get:
18450       tags:
18451         - ServiceDesignAndCreation
18452       summary: returns element-choice-set
18453       description: returns element-choice-set
18454       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18455       produces:
18456         - application/json
18457         - application/xml
18458       responses:
18459         "200":
18460           description: successful operation
18461           schema:
18462               $ref: "#/getDefinitions/element-choice-set"
18463         "default":
18464           description: Response codes found in [response codes](https://wiki.onap.org/).
18465       parameters:
18466         - name: model-invariant-id
18467           in: path
18468           description: Unique identifier corresponding to the main definition of a model in ASDC
18469           required: true
18470           type: string
18471           example: __MODEL-INVARIANT-ID__
18472         - name: model-version-id
18473           in: path
18474           description: Unique identifier corresponding to one version of a model in ASDC
18475           required: true
18476           type: string
18477           example: __MODEL-VERSION-ID__
18478         - name: model-element-uuid
18479           in: path
18480           required: true
18481           type: string
18482           example: __MODEL-ELEMENT-UUID__
18483         - name: model-constraint-uuid
18484           in: path
18485           required: true
18486           type: string
18487           example: __MODEL-CONSTRAINT-UUID__
18488         - name: constrained-element-set-uuid
18489           in: path
18490           required: true
18491           type: string
18492           example: __CONSTRAINED-ELEMENT-SET-UUID__
18493         - name: element-choice-set-uuid
18494           in: path
18495           required: true
18496           type: string
18497           example: __ELEMENT-CHOICE-SET-UUID__
18498     put:
18499       tags:
18500         - ServiceDesignAndCreation
18501       summary: create or update an existing element-choice-set
18502       description: |
18503         Create or update an existing element-choice-set.
18504         #
18505         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18506       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18507       consumes:
18508         - application/json
18509         - application/xml
18510       produces:
18511         - application/json
18512         - application/xml
18513       responses:
18514         "default":
18515           description: Response codes found in [response codes](https://wiki.onap.org/).
18516       parameters:
18517         - name: model-invariant-id
18518           in: path
18519           description: Unique identifier corresponding to the main definition of a model in ASDC
18520           required: true
18521           type: string
18522           example: __MODEL-INVARIANT-ID__
18523         - name: model-version-id
18524           in: path
18525           description: Unique identifier corresponding to one version of a model in ASDC
18526           required: true
18527           type: string
18528           example: __MODEL-VERSION-ID__
18529         - name: model-element-uuid
18530           in: path
18531           required: true
18532           type: string
18533           example: __MODEL-ELEMENT-UUID__
18534         - name: model-constraint-uuid
18535           in: path
18536           required: true
18537           type: string
18538           example: __MODEL-CONSTRAINT-UUID__
18539         - name: constrained-element-set-uuid
18540           in: path
18541           required: true
18542           type: string
18543           example: __CONSTRAINED-ELEMENT-SET-UUID__
18544         - name: element-choice-set-uuid
18545           in: path
18546           required: true
18547           type: string
18548           example: __ELEMENT-CHOICE-SET-UUID__
18549         - name: body
18550           in: body
18551           description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
18552           required: true
18553           schema:
18554             $ref: "#/definitions/element-choice-set"
18555     patch:
18556       tags:
18557         - ServiceDesignAndCreation
18558       summary: update an existing element-choice-set
18559       description: |
18560         Update an existing element-choice-set
18561         #
18562         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18563         The PUT operation will entirely replace an existing object.
18564         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18565         #
18566         Other differences between PUT and PATCH are:
18567         #
18568         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18569         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18570         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18571       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18572       consumes:
18573         - application/json
18574         - application/xml
18575       produces:
18576         - application/json
18577         - application/xml
18578       responses:
18579         "default":
18580           description: Response codes found in [response codes](https://wiki.onap.org/).
18581       parameters:
18582         - name: model-invariant-id
18583           in: path
18584           description: Unique identifier corresponding to the main definition of a model in ASDC
18585           required: true
18586           type: string
18587           example: __MODEL-INVARIANT-ID__
18588         - name: model-version-id
18589           in: path
18590           description: Unique identifier corresponding to one version of a model in ASDC
18591           required: true
18592           type: string
18593           example: __MODEL-VERSION-ID__
18594         - name: model-element-uuid
18595           in: path
18596           required: true
18597           type: string
18598           example: __MODEL-ELEMENT-UUID__
18599         - name: model-constraint-uuid
18600           in: path
18601           required: true
18602           type: string
18603           example: __MODEL-CONSTRAINT-UUID__
18604         - name: constrained-element-set-uuid
18605           in: path
18606           required: true
18607           type: string
18608           example: __CONSTRAINED-ELEMENT-SET-UUID__
18609         - name: element-choice-set-uuid
18610           in: path
18611           required: true
18612           type: string
18613           example: __ELEMENT-CHOICE-SET-UUID__
18614         - name: body
18615           in: body
18616           description: element-choice-set object that needs to be updated.
18617           required: true
18618           schema:
18619             $ref: "#/patchDefinitions/element-choice-set"
18620     delete:
18621       tags:
18622         - ServiceDesignAndCreation
18623       summary: delete an existing element-choice-set
18624       description: delete an existing element-choice-set
18625       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
18626       consumes:
18627         - application/json
18628         - application/xml
18629       produces:
18630         - application/json
18631         - application/xml
18632       responses:
18633         "default":
18634           description: Response codes found in [response codes](https://wiki.onap.org/).
18635       parameters:
18636         - name: model-invariant-id
18637           in: path
18638           description: Unique identifier corresponding to the main definition of a model in ASDC
18639           required: true
18640           type: string
18641           example: __MODEL-INVARIANT-ID__
18642         - name: model-version-id
18643           in: path
18644           description: Unique identifier corresponding to one version of a model in ASDC
18645           required: true
18646           type: string
18647           example: __MODEL-VERSION-ID__
18648         - name: model-element-uuid
18649           in: path
18650           required: true
18651           type: string
18652           example: __MODEL-ELEMENT-UUID__
18653         - name: model-constraint-uuid
18654           in: path
18655           required: true
18656           type: string
18657           example: __MODEL-CONSTRAINT-UUID__
18658         - name: constrained-element-set-uuid
18659           in: path
18660           required: true
18661           type: string
18662           example: __CONSTRAINED-ELEMENT-SET-UUID__
18663         - name: element-choice-set-uuid
18664           in: path
18665           required: true
18666           type: string
18667           example: __ELEMENT-CHOICE-SET-UUID__
18668         - name: resource-version
18669           in: query
18670           description: resource-version for concurrency
18671           required: true
18672           type: string
18673   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets:
18674     get:
18675       tags:
18676         - ServiceDesignAndCreation
18677       summary: returns element-choice-sets
18678       description: returns element-choice-sets
18679       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
18680       produces:
18681         - application/json
18682         - application/xml
18683       responses:
18684         "200":
18685           description: successful operation
18686           schema:
18687               $ref: "#/getDefinitions/element-choice-sets"
18688         "default":
18689           description: Response codes found in [response codes](https://wiki.onap.org/).
18690       parameters:
18691         - name: model-invariant-id
18692           in: path
18693           description: Unique identifier corresponding to the main definition of a model in ASDC
18694           required: true
18695           type: string
18696           example: __MODEL-INVARIANT-ID__
18697         - name: model-version-id
18698           in: path
18699           description: Unique identifier corresponding to one version of a model in ASDC
18700           required: true
18701           type: string
18702           example: __MODEL-VERSION-ID__
18703         - name: model-element-uuid
18704           in: path
18705           required: true
18706           type: string
18707           example: __MODEL-ELEMENT-UUID__
18708         - name: model-constraint-uuid
18709           in: path
18710           required: true
18711           type: string
18712           example: __MODEL-CONSTRAINT-UUID__
18713         - name: constrained-element-set-uuid
18714           in: path
18715           required: true
18716           type: string
18717           example: __CONSTRAINED-ELEMENT-SET-UUID__
18718         - name: element-choice-set-uuid
18719           in: query
18720           description:
18721           required: false
18722           type: string
18723   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship:
18724     put:
18725       tags:
18726         - ServiceDesignAndCreation
18727       summary: see node definition for valid relationships
18728       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
18729       consumes:
18730         - application/json
18731         - application/xml
18732       produces:
18733         - application/json
18734         - application/xml
18735       responses:
18736         "default":
18737           description: Response codes found in [response codes](https://wiki.onap.org/).
18738       parameters:
18739         - name: model-invariant-id
18740           in: path
18741           description: Unique identifier corresponding to the main definition of a model in ASDC
18742           required: true
18743           type: string
18744           example: __MODEL-INVARIANT-ID__
18745         - name: model-version-id
18746           in: path
18747           description: Unique identifier corresponding to one version of a model in ASDC
18748           required: true
18749           type: string
18750           example: __MODEL-VERSION-ID__
18751         - name: model-element-uuid
18752           in: path
18753           required: true
18754           type: string
18755           example: __MODEL-ELEMENT-UUID__
18756         - name: model-constraint-uuid
18757           in: path
18758           required: true
18759           type: string
18760           example: __MODEL-CONSTRAINT-UUID__
18761         - name: constrained-element-set-uuid
18762           in: path
18763           required: true
18764           type: string
18765           example: __CONSTRAINED-ELEMENT-SET-UUID__
18766         - name: body
18767           in: body
18768           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
18769           required: true
18770           schema:
18771             $ref: "#/definitions/relationship"
18772     delete:
18773       tags:
18774         - ServiceDesignAndCreation
18775       summary: delete an existing relationship
18776       description: delete an existing relationship
18777       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
18778       consumes:
18779         - application/json
18780         - application/xml
18781       produces:
18782         - application/json
18783         - application/xml
18784       responses:
18785         "default":
18786           description: Response codes found in [response codes](https://wiki.onap.org/).
18787       parameters:
18788         - name: model-invariant-id
18789           in: path
18790           description: Unique identifier corresponding to the main definition of a model in ASDC
18791           required: true
18792           type: string
18793           example: __MODEL-INVARIANT-ID__
18794         - name: model-version-id
18795           in: path
18796           description: Unique identifier corresponding to one version of a model in ASDC
18797           required: true
18798           type: string
18799           example: __MODEL-VERSION-ID__
18800         - name: model-element-uuid
18801           in: path
18802           required: true
18803           type: string
18804           example: __MODEL-ELEMENT-UUID__
18805         - name: model-constraint-uuid
18806           in: path
18807           required: true
18808           type: string
18809           example: __MODEL-CONSTRAINT-UUID__
18810         - name: constrained-element-set-uuid
18811           in: path
18812           required: true
18813           type: string
18814           example: __CONSTRAINED-ELEMENT-SET-UUID__
18815   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}:
18816     get:
18817       tags:
18818         - ServiceDesignAndCreation
18819       summary: returns constrained-element-set
18820       description: returns constrained-element-set
18821       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18822       produces:
18823         - application/json
18824         - application/xml
18825       responses:
18826         "200":
18827           description: successful operation
18828           schema:
18829               $ref: "#/getDefinitions/constrained-element-set"
18830         "default":
18831           description: Response codes found in [response codes](https://wiki.onap.org/).
18832       parameters:
18833         - name: model-invariant-id
18834           in: path
18835           description: Unique identifier corresponding to the main definition of a model in ASDC
18836           required: true
18837           type: string
18838           example: __MODEL-INVARIANT-ID__
18839         - name: model-version-id
18840           in: path
18841           description: Unique identifier corresponding to one version of a model in ASDC
18842           required: true
18843           type: string
18844           example: __MODEL-VERSION-ID__
18845         - name: model-element-uuid
18846           in: path
18847           required: true
18848           type: string
18849           example: __MODEL-ELEMENT-UUID__
18850         - name: model-constraint-uuid
18851           in: path
18852           required: true
18853           type: string
18854           example: __MODEL-CONSTRAINT-UUID__
18855         - name: constrained-element-set-uuid
18856           in: path
18857           required: true
18858           type: string
18859           example: __CONSTRAINED-ELEMENT-SET-UUID__
18860     put:
18861       tags:
18862         - ServiceDesignAndCreation
18863       summary: create or update an existing constrained-element-set
18864       description: |
18865         Create or update an existing constrained-element-set.
18866         #
18867         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18868       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18869       consumes:
18870         - application/json
18871         - application/xml
18872       produces:
18873         - application/json
18874         - application/xml
18875       responses:
18876         "default":
18877           description: Response codes found in [response codes](https://wiki.onap.org/).
18878       parameters:
18879         - name: model-invariant-id
18880           in: path
18881           description: Unique identifier corresponding to the main definition of a model in ASDC
18882           required: true
18883           type: string
18884           example: __MODEL-INVARIANT-ID__
18885         - name: model-version-id
18886           in: path
18887           description: Unique identifier corresponding to one version of a model in ASDC
18888           required: true
18889           type: string
18890           example: __MODEL-VERSION-ID__
18891         - name: model-element-uuid
18892           in: path
18893           required: true
18894           type: string
18895           example: __MODEL-ELEMENT-UUID__
18896         - name: model-constraint-uuid
18897           in: path
18898           required: true
18899           type: string
18900           example: __MODEL-CONSTRAINT-UUID__
18901         - name: constrained-element-set-uuid
18902           in: path
18903           required: true
18904           type: string
18905           example: __CONSTRAINED-ELEMENT-SET-UUID__
18906         - name: body
18907           in: body
18908           description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
18909           required: true
18910           schema:
18911             $ref: "#/definitions/constrained-element-set"
18912     patch:
18913       tags:
18914         - ServiceDesignAndCreation
18915       summary: update an existing constrained-element-set
18916       description: |
18917         Update an existing constrained-element-set
18918         #
18919         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18920         The PUT operation will entirely replace an existing object.
18921         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18922         #
18923         Other differences between PUT and PATCH are:
18924         #
18925         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18926         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18927         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18928       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18929       consumes:
18930         - application/json
18931         - application/xml
18932       produces:
18933         - application/json
18934         - application/xml
18935       responses:
18936         "default":
18937           description: Response codes found in [response codes](https://wiki.onap.org/).
18938       parameters:
18939         - name: model-invariant-id
18940           in: path
18941           description: Unique identifier corresponding to the main definition of a model in ASDC
18942           required: true
18943           type: string
18944           example: __MODEL-INVARIANT-ID__
18945         - name: model-version-id
18946           in: path
18947           description: Unique identifier corresponding to one version of a model in ASDC
18948           required: true
18949           type: string
18950           example: __MODEL-VERSION-ID__
18951         - name: model-element-uuid
18952           in: path
18953           required: true
18954           type: string
18955           example: __MODEL-ELEMENT-UUID__
18956         - name: model-constraint-uuid
18957           in: path
18958           required: true
18959           type: string
18960           example: __MODEL-CONSTRAINT-UUID__
18961         - name: constrained-element-set-uuid
18962           in: path
18963           required: true
18964           type: string
18965           example: __CONSTRAINED-ELEMENT-SET-UUID__
18966         - name: body
18967           in: body
18968           description: constrained-element-set object that needs to be updated.
18969           required: true
18970           schema:
18971             $ref: "#/patchDefinitions/constrained-element-set"
18972     delete:
18973       tags:
18974         - ServiceDesignAndCreation
18975       summary: delete an existing constrained-element-set
18976       description: delete an existing constrained-element-set
18977       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
18978       consumes:
18979         - application/json
18980         - application/xml
18981       produces:
18982         - application/json
18983         - application/xml
18984       responses:
18985         "default":
18986           description: Response codes found in [response codes](https://wiki.onap.org/).
18987       parameters:
18988         - name: model-invariant-id
18989           in: path
18990           description: Unique identifier corresponding to the main definition of a model in ASDC
18991           required: true
18992           type: string
18993           example: __MODEL-INVARIANT-ID__
18994         - name: model-version-id
18995           in: path
18996           description: Unique identifier corresponding to one version of a model in ASDC
18997           required: true
18998           type: string
18999           example: __MODEL-VERSION-ID__
19000         - name: model-element-uuid
19001           in: path
19002           required: true
19003           type: string
19004           example: __MODEL-ELEMENT-UUID__
19005         - name: model-constraint-uuid
19006           in: path
19007           required: true
19008           type: string
19009           example: __MODEL-CONSTRAINT-UUID__
19010         - name: constrained-element-set-uuid
19011           in: path
19012           required: true
19013           type: string
19014           example: __CONSTRAINED-ELEMENT-SET-UUID__
19015         - name: resource-version
19016           in: query
19017           description: resource-version for concurrency
19018           required: true
19019           type: string
19020   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
19021     get:
19022       tags:
19023         - ServiceDesignAndCreation
19024       summary: returns constrained-element-sets
19025       description: returns constrained-element-sets
19026       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
19027       produces:
19028         - application/json
19029         - application/xml
19030       responses:
19031         "200":
19032           description: successful operation
19033           schema:
19034               $ref: "#/getDefinitions/constrained-element-sets"
19035         "default":
19036           description: Response codes found in [response codes](https://wiki.onap.org/).
19037       parameters:
19038         - name: model-invariant-id
19039           in: path
19040           description: Unique identifier corresponding to the main definition of a model in ASDC
19041           required: true
19042           type: string
19043           example: __MODEL-INVARIANT-ID__
19044         - name: model-version-id
19045           in: path
19046           description: Unique identifier corresponding to one version of a model in ASDC
19047           required: true
19048           type: string
19049           example: __MODEL-VERSION-ID__
19050         - name: model-element-uuid
19051           in: path
19052           required: true
19053           type: string
19054           example: __MODEL-ELEMENT-UUID__
19055         - name: model-constraint-uuid
19056           in: path
19057           required: true
19058           type: string
19059           example: __MODEL-CONSTRAINT-UUID__
19060         - name: constrained-element-set-uuid
19061           in: query
19062           description:
19063           required: false
19064           type: string
19065   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
19066     get:
19067       tags:
19068         - ServiceDesignAndCreation
19069       summary: returns model-constraint
19070       description: returns model-constraint
19071       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
19072       produces:
19073         - application/json
19074         - application/xml
19075       responses:
19076         "200":
19077           description: successful operation
19078           schema:
19079               $ref: "#/getDefinitions/model-constraint"
19080         "default":
19081           description: Response codes found in [response codes](https://wiki.onap.org/).
19082       parameters:
19083         - name: model-invariant-id
19084           in: path
19085           description: Unique identifier corresponding to the main definition of a model in ASDC
19086           required: true
19087           type: string
19088           example: __MODEL-INVARIANT-ID__
19089         - name: model-version-id
19090           in: path
19091           description: Unique identifier corresponding to one version of a model in ASDC
19092           required: true
19093           type: string
19094           example: __MODEL-VERSION-ID__
19095         - name: model-element-uuid
19096           in: path
19097           required: true
19098           type: string
19099           example: __MODEL-ELEMENT-UUID__
19100         - name: model-constraint-uuid
19101           in: path
19102           required: true
19103           type: string
19104           example: __MODEL-CONSTRAINT-UUID__
19105     put:
19106       tags:
19107         - ServiceDesignAndCreation
19108       summary: create or update an existing model-constraint
19109       description: |
19110         Create or update an existing model-constraint.
19111         #
19112         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19113       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
19114       consumes:
19115         - application/json
19116         - application/xml
19117       produces:
19118         - application/json
19119         - application/xml
19120       responses:
19121         "default":
19122           description: Response codes found in [response codes](https://wiki.onap.org/).
19123       parameters:
19124         - name: model-invariant-id
19125           in: path
19126           description: Unique identifier corresponding to the main definition of a model in ASDC
19127           required: true
19128           type: string
19129           example: __MODEL-INVARIANT-ID__
19130         - name: model-version-id
19131           in: path
19132           description: Unique identifier corresponding to one version of a model in ASDC
19133           required: true
19134           type: string
19135           example: __MODEL-VERSION-ID__
19136         - name: model-element-uuid
19137           in: path
19138           required: true
19139           type: string
19140           example: __MODEL-ELEMENT-UUID__
19141         - name: model-constraint-uuid
19142           in: path
19143           required: true
19144           type: string
19145           example: __MODEL-CONSTRAINT-UUID__
19146         - name: body
19147           in: body
19148           description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
19149           required: true
19150           schema:
19151             $ref: "#/definitions/model-constraint"
19152     patch:
19153       tags:
19154         - ServiceDesignAndCreation
19155       summary: update an existing model-constraint
19156       description: |
19157         Update an existing model-constraint
19158         #
19159         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19160         The PUT operation will entirely replace an existing object.
19161         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19162         #
19163         Other differences between PUT and PATCH are:
19164         #
19165         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19166         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19167         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19168       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
19169       consumes:
19170         - application/json
19171         - application/xml
19172       produces:
19173         - application/json
19174         - application/xml
19175       responses:
19176         "default":
19177           description: Response codes found in [response codes](https://wiki.onap.org/).
19178       parameters:
19179         - name: model-invariant-id
19180           in: path
19181           description: Unique identifier corresponding to the main definition of a model in ASDC
19182           required: true
19183           type: string
19184           example: __MODEL-INVARIANT-ID__
19185         - name: model-version-id
19186           in: path
19187           description: Unique identifier corresponding to one version of a model in ASDC
19188           required: true
19189           type: string
19190           example: __MODEL-VERSION-ID__
19191         - name: model-element-uuid
19192           in: path
19193           required: true
19194           type: string
19195           example: __MODEL-ELEMENT-UUID__
19196         - name: model-constraint-uuid
19197           in: path
19198           required: true
19199           type: string
19200           example: __MODEL-CONSTRAINT-UUID__
19201         - name: body
19202           in: body
19203           description: model-constraint object that needs to be updated.
19204           required: true
19205           schema:
19206             $ref: "#/patchDefinitions/model-constraint"
19207     delete:
19208       tags:
19209         - ServiceDesignAndCreation
19210       summary: delete an existing model-constraint
19211       description: delete an existing model-constraint
19212       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
19213       consumes:
19214         - application/json
19215         - application/xml
19216       produces:
19217         - application/json
19218         - application/xml
19219       responses:
19220         "default":
19221           description: Response codes found in [response codes](https://wiki.onap.org/).
19222       parameters:
19223         - name: model-invariant-id
19224           in: path
19225           description: Unique identifier corresponding to the main definition of a model in ASDC
19226           required: true
19227           type: string
19228           example: __MODEL-INVARIANT-ID__
19229         - name: model-version-id
19230           in: path
19231           description: Unique identifier corresponding to one version of a model in ASDC
19232           required: true
19233           type: string
19234           example: __MODEL-VERSION-ID__
19235         - name: model-element-uuid
19236           in: path
19237           required: true
19238           type: string
19239           example: __MODEL-ELEMENT-UUID__
19240         - name: model-constraint-uuid
19241           in: path
19242           required: true
19243           type: string
19244           example: __MODEL-CONSTRAINT-UUID__
19245         - name: resource-version
19246           in: query
19247           description: resource-version for concurrency
19248           required: true
19249           type: string
19250   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints:
19251     get:
19252       tags:
19253         - ServiceDesignAndCreation
19254       summary: returns model-constraints
19255       description: returns model-constraints
19256       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
19257       produces:
19258         - application/json
19259         - application/xml
19260       responses:
19261         "200":
19262           description: successful operation
19263           schema:
19264               $ref: "#/getDefinitions/model-constraints"
19265         "default":
19266           description: Response codes found in [response codes](https://wiki.onap.org/).
19267       parameters:
19268         - name: model-invariant-id
19269           in: path
19270           description: Unique identifier corresponding to the main definition of a model in ASDC
19271           required: true
19272           type: string
19273           example: __MODEL-INVARIANT-ID__
19274         - name: model-version-id
19275           in: path
19276           description: Unique identifier corresponding to one version of a model in ASDC
19277           required: true
19278           type: string
19279           example: __MODEL-VERSION-ID__
19280         - name: model-element-uuid
19281           in: path
19282           required: true
19283           type: string
19284           example: __MODEL-ELEMENT-UUID__
19285         - name: model-constraint-uuid
19286           in: query
19287           description:
19288           required: false
19289           type: string
19290   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
19291     put:
19292       tags:
19293         - ServiceDesignAndCreation
19294       summary: see node definition for valid relationships
19295       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
19296       consumes:
19297         - application/json
19298         - application/xml
19299       produces:
19300         - application/json
19301         - application/xml
19302       responses:
19303         "default":
19304           description: Response codes found in [response codes](https://wiki.onap.org/).
19305       parameters:
19306         - name: model-invariant-id
19307           in: path
19308           description: Unique identifier corresponding to the main definition of a model in ASDC
19309           required: true
19310           type: string
19311           example: __MODEL-INVARIANT-ID__
19312         - name: model-version-id
19313           in: path
19314           description: Unique identifier corresponding to one version of a model in ASDC
19315           required: true
19316           type: string
19317           example: __MODEL-VERSION-ID__
19318         - name: model-element-uuid
19319           in: path
19320           required: true
19321           type: string
19322           example: __MODEL-ELEMENT-UUID__
19323         - name: body
19324           in: body
19325           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
19326           required: true
19327           schema:
19328             $ref: "#/definitions/relationship"
19329     delete:
19330       tags:
19331         - ServiceDesignAndCreation
19332       summary: delete an existing relationship
19333       description: delete an existing relationship
19334       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
19335       consumes:
19336         - application/json
19337         - application/xml
19338       produces:
19339         - application/json
19340         - application/xml
19341       responses:
19342         "default":
19343           description: Response codes found in [response codes](https://wiki.onap.org/).
19344       parameters:
19345         - name: model-invariant-id
19346           in: path
19347           description: Unique identifier corresponding to the main definition of a model in ASDC
19348           required: true
19349           type: string
19350           example: __MODEL-INVARIANT-ID__
19351         - name: model-version-id
19352           in: path
19353           description: Unique identifier corresponding to one version of a model in ASDC
19354           required: true
19355           type: string
19356           example: __MODEL-VERSION-ID__
19357         - name: model-element-uuid
19358           in: path
19359           required: true
19360           type: string
19361           example: __MODEL-ELEMENT-UUID__
19362   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
19363     get:
19364       tags:
19365         - ServiceDesignAndCreation
19366       summary: returns model-element
19367       description: returns model-element
19368       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19369       produces:
19370         - application/json
19371         - application/xml
19372       responses:
19373         "200":
19374           description: successful operation
19375           schema:
19376               $ref: "#/getDefinitions/model-element"
19377         "default":
19378           description: Response codes found in [response codes](https://wiki.onap.org/).
19379       parameters:
19380         - name: model-invariant-id
19381           in: path
19382           description: Unique identifier corresponding to the main definition of a model in ASDC
19383           required: true
19384           type: string
19385           example: __MODEL-INVARIANT-ID__
19386         - name: model-version-id
19387           in: path
19388           description: Unique identifier corresponding to one version of a model in ASDC
19389           required: true
19390           type: string
19391           example: __MODEL-VERSION-ID__
19392         - name: model-element-uuid
19393           in: path
19394           required: true
19395           type: string
19396           example: __MODEL-ELEMENT-UUID__
19397     put:
19398       tags:
19399         - ServiceDesignAndCreation
19400       summary: create or update an existing model-element
19401       description: |
19402         Create or update an existing model-element.
19403         #
19404         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19405       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19406       consumes:
19407         - application/json
19408         - application/xml
19409       produces:
19410         - application/json
19411         - application/xml
19412       responses:
19413         "default":
19414           description: Response codes found in [response codes](https://wiki.onap.org/).
19415       parameters:
19416         - name: model-invariant-id
19417           in: path
19418           description: Unique identifier corresponding to the main definition of a model in ASDC
19419           required: true
19420           type: string
19421           example: __MODEL-INVARIANT-ID__
19422         - name: model-version-id
19423           in: path
19424           description: Unique identifier corresponding to one version of a model in ASDC
19425           required: true
19426           type: string
19427           example: __MODEL-VERSION-ID__
19428         - name: model-element-uuid
19429           in: path
19430           required: true
19431           type: string
19432           example: __MODEL-ELEMENT-UUID__
19433         - name: body
19434           in: body
19435           description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
19436           required: true
19437           schema:
19438             $ref: "#/definitions/model-element"
19439     patch:
19440       tags:
19441         - ServiceDesignAndCreation
19442       summary: update an existing model-element
19443       description: |
19444         Update an existing model-element
19445         #
19446         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19447         The PUT operation will entirely replace an existing object.
19448         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19449         #
19450         Other differences between PUT and PATCH are:
19451         #
19452         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19453         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19454         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19455       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19456       consumes:
19457         - application/json
19458         - application/xml
19459       produces:
19460         - application/json
19461         - application/xml
19462       responses:
19463         "default":
19464           description: Response codes found in [response codes](https://wiki.onap.org/).
19465       parameters:
19466         - name: model-invariant-id
19467           in: path
19468           description: Unique identifier corresponding to the main definition of a model in ASDC
19469           required: true
19470           type: string
19471           example: __MODEL-INVARIANT-ID__
19472         - name: model-version-id
19473           in: path
19474           description: Unique identifier corresponding to one version of a model in ASDC
19475           required: true
19476           type: string
19477           example: __MODEL-VERSION-ID__
19478         - name: model-element-uuid
19479           in: path
19480           required: true
19481           type: string
19482           example: __MODEL-ELEMENT-UUID__
19483         - name: body
19484           in: body
19485           description: model-element object that needs to be updated.
19486           required: true
19487           schema:
19488             $ref: "#/patchDefinitions/model-element"
19489     delete:
19490       tags:
19491         - ServiceDesignAndCreation
19492       summary: delete an existing model-element
19493       description: delete an existing model-element
19494       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
19495       consumes:
19496         - application/json
19497         - application/xml
19498       produces:
19499         - application/json
19500         - application/xml
19501       responses:
19502         "default":
19503           description: Response codes found in [response codes](https://wiki.onap.org/).
19504       parameters:
19505         - name: model-invariant-id
19506           in: path
19507           description: Unique identifier corresponding to the main definition of a model in ASDC
19508           required: true
19509           type: string
19510           example: __MODEL-INVARIANT-ID__
19511         - name: model-version-id
19512           in: path
19513           description: Unique identifier corresponding to one version of a model in ASDC
19514           required: true
19515           type: string
19516           example: __MODEL-VERSION-ID__
19517         - name: model-element-uuid
19518           in: path
19519           required: true
19520           type: string
19521           example: __MODEL-ELEMENT-UUID__
19522         - name: resource-version
19523           in: query
19524           description: resource-version for concurrency
19525           required: true
19526           type: string
19527   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
19528     get:
19529       tags:
19530         - ServiceDesignAndCreation
19531       summary: returns model-elements
19532       description: returns model-elements
19533       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
19534       produces:
19535         - application/json
19536         - application/xml
19537       responses:
19538         "200":
19539           description: successful operation
19540           schema:
19541               $ref: "#/getDefinitions/model-elements"
19542         "default":
19543           description: Response codes found in [response codes](https://wiki.onap.org/).
19544       parameters:
19545         - name: model-invariant-id
19546           in: path
19547           description: Unique identifier corresponding to the main definition of a model in ASDC
19548           required: true
19549           type: string
19550           example: __MODEL-INVARIANT-ID__
19551         - name: model-version-id
19552           in: path
19553           description: Unique identifier corresponding to one version of a model in ASDC
19554           required: true
19555           type: string
19556           example: __MODEL-VERSION-ID__
19557         - name: model-element-uuid
19558           in: query
19559           description:
19560           required: false
19561           type: string
19562   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
19563     get:
19564       tags:
19565         - ServiceDesignAndCreation
19566       summary: returns metadatum
19567       description: returns metadatum
19568       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19569       produces:
19570         - application/json
19571         - application/xml
19572       responses:
19573         "200":
19574           description: successful operation
19575           schema:
19576               $ref: "#/getDefinitions/metadatum"
19577         "default":
19578           description: Response codes found in [response codes](https://wiki.onap.org/).
19579       parameters:
19580         - name: model-invariant-id
19581           in: path
19582           description: Unique identifier corresponding to the main definition of a model in ASDC
19583           required: true
19584           type: string
19585           example: __MODEL-INVARIANT-ID__
19586         - name: model-version-id
19587           in: path
19588           description: Unique identifier corresponding to one version of a model in ASDC
19589           required: true
19590           type: string
19591           example: __MODEL-VERSION-ID__
19592         - name: metaname
19593           in: path
19594           required: true
19595           type: string
19596           example: __METANAME__
19597     put:
19598       tags:
19599         - ServiceDesignAndCreation
19600       summary: create or update an existing metadatum
19601       description: |
19602         Create or update an existing metadatum.
19603         #
19604         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19605       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19606       consumes:
19607         - application/json
19608         - application/xml
19609       produces:
19610         - application/json
19611         - application/xml
19612       responses:
19613         "default":
19614           description: Response codes found in [response codes](https://wiki.onap.org/).
19615       parameters:
19616         - name: model-invariant-id
19617           in: path
19618           description: Unique identifier corresponding to the main definition of a model in ASDC
19619           required: true
19620           type: string
19621           example: __MODEL-INVARIANT-ID__
19622         - name: model-version-id
19623           in: path
19624           description: Unique identifier corresponding to one version of a model in ASDC
19625           required: true
19626           type: string
19627           example: __MODEL-VERSION-ID__
19628         - name: metaname
19629           in: path
19630           required: true
19631           type: string
19632           example: __METANAME__
19633         - name: body
19634           in: body
19635           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
19636           required: true
19637           schema:
19638             $ref: "#/definitions/metadatum"
19639     patch:
19640       tags:
19641         - ServiceDesignAndCreation
19642       summary: update an existing metadatum
19643       description: |
19644         Update an existing metadatum
19645         #
19646         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19647         The PUT operation will entirely replace an existing object.
19648         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19649         #
19650         Other differences between PUT and PATCH are:
19651         #
19652         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19653         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19654         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19655       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19656       consumes:
19657         - application/json
19658         - application/xml
19659       produces:
19660         - application/json
19661         - application/xml
19662       responses:
19663         "default":
19664           description: Response codes found in [response codes](https://wiki.onap.org/).
19665       parameters:
19666         - name: model-invariant-id
19667           in: path
19668           description: Unique identifier corresponding to the main definition of a model in ASDC
19669           required: true
19670           type: string
19671           example: __MODEL-INVARIANT-ID__
19672         - name: model-version-id
19673           in: path
19674           description: Unique identifier corresponding to one version of a model in ASDC
19675           required: true
19676           type: string
19677           example: __MODEL-VERSION-ID__
19678         - name: metaname
19679           in: path
19680           required: true
19681           type: string
19682           example: __METANAME__
19683         - name: body
19684           in: body
19685           description: metadatum object that needs to be updated.
19686           required: true
19687           schema:
19688             $ref: "#/patchDefinitions/metadatum"
19689     delete:
19690       tags:
19691         - ServiceDesignAndCreation
19692       summary: delete an existing metadatum
19693       description: delete an existing metadatum
19694       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
19695       consumes:
19696         - application/json
19697         - application/xml
19698       produces:
19699         - application/json
19700         - application/xml
19701       responses:
19702         "default":
19703           description: Response codes found in [response codes](https://wiki.onap.org/).
19704       parameters:
19705         - name: model-invariant-id
19706           in: path
19707           description: Unique identifier corresponding to the main definition of a model in ASDC
19708           required: true
19709           type: string
19710           example: __MODEL-INVARIANT-ID__
19711         - name: model-version-id
19712           in: path
19713           description: Unique identifier corresponding to one version of a model in ASDC
19714           required: true
19715           type: string
19716           example: __MODEL-VERSION-ID__
19717         - name: metaname
19718           in: path
19719           required: true
19720           type: string
19721           example: __METANAME__
19722         - name: resource-version
19723           in: query
19724           description: resource-version for concurrency
19725           required: true
19726           type: string
19727   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
19728     get:
19729       tags:
19730         - ServiceDesignAndCreation
19731       summary: returns metadata
19732       description: returns metadata
19733       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
19734       produces:
19735         - application/json
19736         - application/xml
19737       responses:
19738         "200":
19739           description: successful operation
19740           schema:
19741               $ref: "#/getDefinitions/metadata"
19742         "default":
19743           description: Response codes found in [response codes](https://wiki.onap.org/).
19744       parameters:
19745         - name: model-invariant-id
19746           in: path
19747           description: Unique identifier corresponding to the main definition of a model in ASDC
19748           required: true
19749           type: string
19750           example: __MODEL-INVARIANT-ID__
19751         - name: model-version-id
19752           in: path
19753           description: Unique identifier corresponding to one version of a model in ASDC
19754           required: true
19755           type: string
19756           example: __MODEL-VERSION-ID__
19757         - name: metaname
19758           in: query
19759           description:
19760           required: false
19761           type: string
19762   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
19763     put:
19764       tags:
19765         - ServiceDesignAndCreation
19766       summary: see node definition for valid relationships
19767       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
19768       consumes:
19769         - application/json
19770         - application/xml
19771       produces:
19772         - application/json
19773         - application/xml
19774       responses:
19775         "default":
19776           description: Response codes found in [response codes](https://wiki.onap.org/).
19777       parameters:
19778         - name: model-invariant-id
19779           in: path
19780           description: Unique identifier corresponding to the main definition of a model in ASDC
19781           required: true
19782           type: string
19783           example: __MODEL-INVARIANT-ID__
19784         - name: model-version-id
19785           in: path
19786           description: Unique identifier corresponding to one version of a model in ASDC
19787           required: true
19788           type: string
19789           example: __MODEL-VERSION-ID__
19790         - name: body
19791           in: body
19792           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
19793           required: true
19794           schema:
19795             $ref: "#/definitions/relationship"
19796     delete:
19797       tags:
19798         - ServiceDesignAndCreation
19799       summary: delete an existing relationship
19800       description: delete an existing relationship
19801       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
19802       consumes:
19803         - application/json
19804         - application/xml
19805       produces:
19806         - application/json
19807         - application/xml
19808       responses:
19809         "default":
19810           description: Response codes found in [response codes](https://wiki.onap.org/).
19811       parameters:
19812         - name: model-invariant-id
19813           in: path
19814           description: Unique identifier corresponding to the main definition of a model in ASDC
19815           required: true
19816           type: string
19817           example: __MODEL-INVARIANT-ID__
19818         - name: model-version-id
19819           in: path
19820           description: Unique identifier corresponding to one version of a model in ASDC
19821           required: true
19822           type: string
19823           example: __MODEL-VERSION-ID__
19824   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
19825     get:
19826       tags:
19827         - ServiceDesignAndCreation
19828       summary: returns model-ver
19829       description: returns model-ver
19830       operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
19831       produces:
19832         - application/json
19833         - application/xml
19834       responses:
19835         "200":
19836           description: successful operation
19837           schema:
19838               $ref: "#/getDefinitions/model-ver"
19839         "default":
19840           description: Response codes found in [response codes](https://wiki.onap.org/).
19841       parameters:
19842         - name: model-invariant-id
19843           in: path
19844           description: Unique identifier corresponding to the main definition of a model in ASDC
19845           required: true
19846           type: string
19847           example: __MODEL-INVARIANT-ID__
19848         - name: model-version-id
19849           in: path
19850           description: Unique identifier corresponding to one version of a model in ASDC
19851           required: true
19852           type: string
19853           example: __MODEL-VERSION-ID__
19854     put:
19855       tags:
19856         - ServiceDesignAndCreation
19857       summary: create or update an existing model-ver
19858       description: |
19859         Create or update an existing model-ver.
19860         #
19861         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19862       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
19863       consumes:
19864         - application/json
19865         - application/xml
19866       produces:
19867         - application/json
19868         - application/xml
19869       responses:
19870         "default":
19871           description: Response codes found in [response codes](https://wiki.onap.org/).
19872       parameters:
19873         - name: model-invariant-id
19874           in: path
19875           description: Unique identifier corresponding to the main definition of a model in ASDC
19876           required: true
19877           type: string
19878           example: __MODEL-INVARIANT-ID__
19879         - name: model-version-id
19880           in: path
19881           description: Unique identifier corresponding to one version of a model in ASDC
19882           required: true
19883           type: string
19884           example: __MODEL-VERSION-ID__
19885         - name: body
19886           in: body
19887           description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
19888           required: true
19889           schema:
19890             $ref: "#/definitions/model-ver"
19891     patch:
19892       tags:
19893         - ServiceDesignAndCreation
19894       summary: update an existing model-ver
19895       description: |
19896         Update an existing model-ver
19897         #
19898         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19899         The PUT operation will entirely replace an existing object.
19900         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19901         #
19902         Other differences between PUT and PATCH are:
19903         #
19904         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19905         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19906         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19907       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
19908       consumes:
19909         - application/json
19910         - application/xml
19911       produces:
19912         - application/json
19913         - application/xml
19914       responses:
19915         "default":
19916           description: Response codes found in [response codes](https://wiki.onap.org/).
19917       parameters:
19918         - name: model-invariant-id
19919           in: path
19920           description: Unique identifier corresponding to the main definition of a model in ASDC
19921           required: true
19922           type: string
19923           example: __MODEL-INVARIANT-ID__
19924         - name: model-version-id
19925           in: path
19926           description: Unique identifier corresponding to one version of a model in ASDC
19927           required: true
19928           type: string
19929           example: __MODEL-VERSION-ID__
19930         - name: body
19931           in: body
19932           description: model-ver object that needs to be updated.
19933           required: true
19934           schema:
19935             $ref: "#/patchDefinitions/model-ver"
19936     delete:
19937       tags:
19938         - ServiceDesignAndCreation
19939       summary: delete an existing model-ver
19940       description: delete an existing model-ver
19941       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
19942       consumes:
19943         - application/json
19944         - application/xml
19945       produces:
19946         - application/json
19947         - application/xml
19948       responses:
19949         "default":
19950           description: Response codes found in [response codes](https://wiki.onap.org/).
19951       parameters:
19952         - name: model-invariant-id
19953           in: path
19954           description: Unique identifier corresponding to the main definition of a model in ASDC
19955           required: true
19956           type: string
19957           example: __MODEL-INVARIANT-ID__
19958         - name: model-version-id
19959           in: path
19960           description: Unique identifier corresponding to one version of a model in ASDC
19961           required: true
19962           type: string
19963           example: __MODEL-VERSION-ID__
19964         - name: resource-version
19965           in: query
19966           description: resource-version for concurrency
19967           required: true
19968           type: string
19969   /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
19970     get:
19971       tags:
19972         - ServiceDesignAndCreation
19973       summary: returns model-vers
19974       description: returns model-vers
19975       operationId: getServiceDesignAndCreationModelsModelModelVers
19976       produces:
19977         - application/json
19978         - application/xml
19979       responses:
19980         "200":
19981           description: successful operation
19982           schema:
19983               $ref: "#/getDefinitions/model-vers"
19984         "default":
19985           description: Response codes found in [response codes](https://wiki.onap.org/).
19986       parameters:
19987         - name: model-invariant-id
19988           in: path
19989           description: Unique identifier corresponding to the main definition of a model in ASDC
19990           required: true
19991           type: string
19992           example: __MODEL-INVARIANT-ID__
19993         - name: model-version-id
19994           in: query
19995           description:
19996           required: false
19997           type: string
19998         - name: model-name
19999           in: query
20000           description:
20001           required: false
20002           type: string
20003         - name: model-version
20004           in: query
20005           description:
20006           required: false
20007           type: string
20008         - name: distribution-status
20009           in: query
20010           description:
20011           required: false
20012           type: string
20013   /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
20014     put:
20015       tags:
20016         - ServiceDesignAndCreation
20017       summary: see node definition for valid relationships
20018       operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
20019       consumes:
20020         - application/json
20021         - application/xml
20022       produces:
20023         - application/json
20024         - application/xml
20025       responses:
20026         "default":
20027           description: Response codes found in [response codes](https://wiki.onap.org/).
20028       parameters:
20029         - name: model-invariant-id
20030           in: path
20031           description: Unique identifier corresponding to the main definition of a model in ASDC
20032           required: true
20033           type: string
20034           example: __MODEL-INVARIANT-ID__
20035         - name: body
20036           in: body
20037           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModel.json)
20038           required: true
20039           schema:
20040             $ref: "#/definitions/relationship"
20041     delete:
20042       tags:
20043         - ServiceDesignAndCreation
20044       summary: delete an existing relationship
20045       description: delete an existing relationship
20046       operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
20047       consumes:
20048         - application/json
20049         - application/xml
20050       produces:
20051         - application/json
20052         - application/xml
20053       responses:
20054         "default":
20055           description: Response codes found in [response codes](https://wiki.onap.org/).
20056       parameters:
20057         - name: model-invariant-id
20058           in: path
20059           description: Unique identifier corresponding to the main definition of a model in ASDC
20060           required: true
20061           type: string
20062           example: __MODEL-INVARIANT-ID__
20063   /service-design-and-creation/models/model/{model-invariant-id}:
20064     get:
20065       tags:
20066         - ServiceDesignAndCreation
20067       summary: returns model
20068       description: returns model
20069       operationId: getServiceDesignAndCreationModelsModel
20070       produces:
20071         - application/json
20072         - application/xml
20073       responses:
20074         "200":
20075           description: successful operation
20076           schema:
20077               $ref: "#/getDefinitions/model"
20078         "default":
20079           description: Response codes found in [response codes](https://wiki.onap.org/).
20080       parameters:
20081         - name: model-invariant-id
20082           in: path
20083           description: Unique identifier corresponding to the main definition of a model in ASDC
20084           required: true
20085           type: string
20086           example: __MODEL-INVARIANT-ID__
20087     put:
20088       tags:
20089         - ServiceDesignAndCreation
20090       summary: create or update an existing model
20091       description: |
20092         Create or update an existing model.
20093         #
20094         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20095       operationId: createOrUpdateServiceDesignAndCreationModelsModel
20096       consumes:
20097         - application/json
20098         - application/xml
20099       produces:
20100         - application/json
20101         - application/xml
20102       responses:
20103         "default":
20104           description: Response codes found in [response codes](https://wiki.onap.org/).
20105       parameters:
20106         - name: model-invariant-id
20107           in: path
20108           description: Unique identifier corresponding to the main definition of a model in ASDC
20109           required: true
20110           type: string
20111           example: __MODEL-INVARIANT-ID__
20112         - name: body
20113           in: body
20114           description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModel.json)
20115           required: true
20116           schema:
20117             $ref: "#/definitions/model"
20118     patch:
20119       tags:
20120         - ServiceDesignAndCreation
20121       summary: update an existing model
20122       description: |
20123         Update an existing model
20124         #
20125         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20126         The PUT operation will entirely replace an existing object.
20127         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20128         #
20129         Other differences between PUT and PATCH are:
20130         #
20131         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20132         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20133         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20134       operationId: UpdateServiceDesignAndCreationModelsModel
20135       consumes:
20136         - application/json
20137         - application/xml
20138       produces:
20139         - application/json
20140         - application/xml
20141       responses:
20142         "default":
20143           description: Response codes found in [response codes](https://wiki.onap.org/).
20144       parameters:
20145         - name: model-invariant-id
20146           in: path
20147           description: Unique identifier corresponding to the main definition of a model in ASDC
20148           required: true
20149           type: string
20150           example: __MODEL-INVARIANT-ID__
20151         - name: body
20152           in: body
20153           description: model object that needs to be updated.
20154           required: true
20155           schema:
20156             $ref: "#/patchDefinitions/model"
20157     delete:
20158       tags:
20159         - ServiceDesignAndCreation
20160       summary: delete an existing model
20161       description: delete an existing model
20162       operationId: deleteServiceDesignAndCreationModelsModel
20163       consumes:
20164         - application/json
20165         - application/xml
20166       produces:
20167         - application/json
20168         - application/xml
20169       responses:
20170         "default":
20171           description: Response codes found in [response codes](https://wiki.onap.org/).
20172       parameters:
20173         - name: model-invariant-id
20174           in: path
20175           description: Unique identifier corresponding to the main definition of a model in ASDC
20176           required: true
20177           type: string
20178           example: __MODEL-INVARIANT-ID__
20179         - name: resource-version
20180           in: query
20181           description: resource-version for concurrency
20182           required: true
20183           type: string
20184   /service-design-and-creation/models:
20185     get:
20186       tags:
20187         - ServiceDesignAndCreation
20188       summary: returns models
20189       description: returns models
20190       operationId: getServiceDesignAndCreationModels
20191       produces:
20192         - application/json
20193         - application/xml
20194       responses:
20195         "200":
20196           description: successful operation
20197           schema:
20198               $ref: "#/getDefinitions/models"
20199         "default":
20200           description: Response codes found in [response codes](https://wiki.onap.org/).
20201       parameters:
20202         - name: model-invariant-id
20203           in: query
20204           description:
20205           required: false
20206           type: string
20207         - name: model-type
20208           in: query
20209           description:
20210           required: false
20211           type: string
20212   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}/relationship-list/relationship:
20213     put:
20214       tags:
20215         - ServiceDesignAndCreation
20216       summary: see node definition for valid relationships
20217       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
20218       consumes:
20219         - application/json
20220         - application/xml
20221       produces:
20222         - application/json
20223         - application/xml
20224       responses:
20225         "default":
20226           description: Response codes found in [response codes](https://wiki.onap.org/).
20227       parameters:
20228         - name: named-query-uuid
20229           in: path
20230           required: true
20231           type: string
20232           example: __NAMED-QUERY-UUID__
20233         - name: named-query-element-uuid
20234           in: path
20235           required: true
20236           type: string
20237           example: __NAMED-QUERY-ELEMENT-UUID__
20238         - name: related-lookup-uuid
20239           in: path
20240           required: true
20241           type: string
20242           example: __RELATED-LOOKUP-UUID__
20243         - name: body
20244           in: body
20245           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
20246           required: true
20247           schema:
20248             $ref: "#/definitions/relationship"
20249     delete:
20250       tags:
20251         - ServiceDesignAndCreation
20252       summary: delete an existing relationship
20253       description: delete an existing relationship
20254       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
20255       consumes:
20256         - application/json
20257         - application/xml
20258       produces:
20259         - application/json
20260         - application/xml
20261       responses:
20262         "default":
20263           description: Response codes found in [response codes](https://wiki.onap.org/).
20264       parameters:
20265         - name: named-query-uuid
20266           in: path
20267           required: true
20268           type: string
20269           example: __NAMED-QUERY-UUID__
20270         - name: named-query-element-uuid
20271           in: path
20272           required: true
20273           type: string
20274           example: __NAMED-QUERY-ELEMENT-UUID__
20275         - name: related-lookup-uuid
20276           in: path
20277           required: true
20278           type: string
20279           example: __RELATED-LOOKUP-UUID__
20280   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}:
20281     get:
20282       tags:
20283         - ServiceDesignAndCreation
20284       summary: returns related-lookup
20285       description: returns related-lookup
20286       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20287       produces:
20288         - application/json
20289         - application/xml
20290       responses:
20291         "200":
20292           description: successful operation
20293           schema:
20294               $ref: "#/getDefinitions/related-lookup"
20295         "default":
20296           description: Response codes found in [response codes](https://wiki.onap.org/).
20297       parameters:
20298         - name: named-query-uuid
20299           in: path
20300           required: true
20301           type: string
20302           example: __NAMED-QUERY-UUID__
20303         - name: named-query-element-uuid
20304           in: path
20305           required: true
20306           type: string
20307           example: __NAMED-QUERY-ELEMENT-UUID__
20308         - name: related-lookup-uuid
20309           in: path
20310           required: true
20311           type: string
20312           example: __RELATED-LOOKUP-UUID__
20313     put:
20314       tags:
20315         - ServiceDesignAndCreation
20316       summary: create or update an existing related-lookup
20317       description: |
20318         Create or update an existing related-lookup.
20319         #
20320         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20321       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20322       consumes:
20323         - application/json
20324         - application/xml
20325       produces:
20326         - application/json
20327         - application/xml
20328       responses:
20329         "default":
20330           description: Response codes found in [response codes](https://wiki.onap.org/).
20331       parameters:
20332         - name: named-query-uuid
20333           in: path
20334           required: true
20335           type: string
20336           example: __NAMED-QUERY-UUID__
20337         - name: named-query-element-uuid
20338           in: path
20339           required: true
20340           type: string
20341           example: __NAMED-QUERY-ELEMENT-UUID__
20342         - name: related-lookup-uuid
20343           in: path
20344           required: true
20345           type: string
20346           example: __RELATED-LOOKUP-UUID__
20347         - name: body
20348           in: body
20349           description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
20350           required: true
20351           schema:
20352             $ref: "#/definitions/related-lookup"
20353     patch:
20354       tags:
20355         - ServiceDesignAndCreation
20356       summary: update an existing related-lookup
20357       description: |
20358         Update an existing related-lookup
20359         #
20360         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20361         The PUT operation will entirely replace an existing object.
20362         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20363         #
20364         Other differences between PUT and PATCH are:
20365         #
20366         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20367         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20368         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20369       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20370       consumes:
20371         - application/json
20372         - application/xml
20373       produces:
20374         - application/json
20375         - application/xml
20376       responses:
20377         "default":
20378           description: Response codes found in [response codes](https://wiki.onap.org/).
20379       parameters:
20380         - name: named-query-uuid
20381           in: path
20382           required: true
20383           type: string
20384           example: __NAMED-QUERY-UUID__
20385         - name: named-query-element-uuid
20386           in: path
20387           required: true
20388           type: string
20389           example: __NAMED-QUERY-ELEMENT-UUID__
20390         - name: related-lookup-uuid
20391           in: path
20392           required: true
20393           type: string
20394           example: __RELATED-LOOKUP-UUID__
20395         - name: body
20396           in: body
20397           description: related-lookup object that needs to be updated.
20398           required: true
20399           schema:
20400             $ref: "#/patchDefinitions/related-lookup"
20401     delete:
20402       tags:
20403         - ServiceDesignAndCreation
20404       summary: delete an existing related-lookup
20405       description: delete an existing related-lookup
20406       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
20407       consumes:
20408         - application/json
20409         - application/xml
20410       produces:
20411         - application/json
20412         - application/xml
20413       responses:
20414         "default":
20415           description: Response codes found in [response codes](https://wiki.onap.org/).
20416       parameters:
20417         - name: named-query-uuid
20418           in: path
20419           required: true
20420           type: string
20421           example: __NAMED-QUERY-UUID__
20422         - name: named-query-element-uuid
20423           in: path
20424           required: true
20425           type: string
20426           example: __NAMED-QUERY-ELEMENT-UUID__
20427         - name: related-lookup-uuid
20428           in: path
20429           required: true
20430           type: string
20431           example: __RELATED-LOOKUP-UUID__
20432         - name: resource-version
20433           in: query
20434           description: resource-version for concurrency
20435           required: true
20436           type: string
20437   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
20438     get:
20439       tags:
20440         - ServiceDesignAndCreation
20441       summary: returns related-lookups
20442       description: returns related-lookups
20443       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
20444       produces:
20445         - application/json
20446         - application/xml
20447       responses:
20448         "200":
20449           description: successful operation
20450           schema:
20451               $ref: "#/getDefinitions/related-lookups"
20452         "default":
20453           description: Response codes found in [response codes](https://wiki.onap.org/).
20454       parameters:
20455         - name: named-query-uuid
20456           in: path
20457           required: true
20458           type: string
20459           example: __NAMED-QUERY-UUID__
20460         - name: named-query-element-uuid
20461           in: path
20462           required: true
20463           type: string
20464           example: __NAMED-QUERY-ELEMENT-UUID__
20465         - name: related-lookup-uuid
20466           in: query
20467           description:
20468           required: false
20469           type: string
20470   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}:
20471     get:
20472       tags:
20473         - ServiceDesignAndCreation
20474       summary: returns property-constraint
20475       description: returns property-constraint
20476       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20477       produces:
20478         - application/json
20479         - application/xml
20480       responses:
20481         "200":
20482           description: successful operation
20483           schema:
20484               $ref: "#/getDefinitions/property-constraint"
20485         "default":
20486           description: Response codes found in [response codes](https://wiki.onap.org/).
20487       parameters:
20488         - name: named-query-uuid
20489           in: path
20490           required: true
20491           type: string
20492           example: __NAMED-QUERY-UUID__
20493         - name: named-query-element-uuid
20494           in: path
20495           required: true
20496           type: string
20497           example: __NAMED-QUERY-ELEMENT-UUID__
20498         - name: property-constraint-uuid
20499           in: path
20500           required: true
20501           type: string
20502           example: __PROPERTY-CONSTRAINT-UUID__
20503     put:
20504       tags:
20505         - ServiceDesignAndCreation
20506       summary: create or update an existing property-constraint
20507       description: |
20508         Create or update an existing property-constraint.
20509         #
20510         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20511       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20512       consumes:
20513         - application/json
20514         - application/xml
20515       produces:
20516         - application/json
20517         - application/xml
20518       responses:
20519         "default":
20520           description: Response codes found in [response codes](https://wiki.onap.org/).
20521       parameters:
20522         - name: named-query-uuid
20523           in: path
20524           required: true
20525           type: string
20526           example: __NAMED-QUERY-UUID__
20527         - name: named-query-element-uuid
20528           in: path
20529           required: true
20530           type: string
20531           example: __NAMED-QUERY-ELEMENT-UUID__
20532         - name: property-constraint-uuid
20533           in: path
20534           required: true
20535           type: string
20536           example: __PROPERTY-CONSTRAINT-UUID__
20537         - name: body
20538           in: body
20539           description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
20540           required: true
20541           schema:
20542             $ref: "#/definitions/property-constraint"
20543     patch:
20544       tags:
20545         - ServiceDesignAndCreation
20546       summary: update an existing property-constraint
20547       description: |
20548         Update an existing property-constraint
20549         #
20550         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20551         The PUT operation will entirely replace an existing object.
20552         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20553         #
20554         Other differences between PUT and PATCH are:
20555         #
20556         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20557         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20558         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20559       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20560       consumes:
20561         - application/json
20562         - application/xml
20563       produces:
20564         - application/json
20565         - application/xml
20566       responses:
20567         "default":
20568           description: Response codes found in [response codes](https://wiki.onap.org/).
20569       parameters:
20570         - name: named-query-uuid
20571           in: path
20572           required: true
20573           type: string
20574           example: __NAMED-QUERY-UUID__
20575         - name: named-query-element-uuid
20576           in: path
20577           required: true
20578           type: string
20579           example: __NAMED-QUERY-ELEMENT-UUID__
20580         - name: property-constraint-uuid
20581           in: path
20582           required: true
20583           type: string
20584           example: __PROPERTY-CONSTRAINT-UUID__
20585         - name: body
20586           in: body
20587           description: property-constraint object that needs to be updated.
20588           required: true
20589           schema:
20590             $ref: "#/patchDefinitions/property-constraint"
20591     delete:
20592       tags:
20593         - ServiceDesignAndCreation
20594       summary: delete an existing property-constraint
20595       description: delete an existing property-constraint
20596       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
20597       consumes:
20598         - application/json
20599         - application/xml
20600       produces:
20601         - application/json
20602         - application/xml
20603       responses:
20604         "default":
20605           description: Response codes found in [response codes](https://wiki.onap.org/).
20606       parameters:
20607         - name: named-query-uuid
20608           in: path
20609           required: true
20610           type: string
20611           example: __NAMED-QUERY-UUID__
20612         - name: named-query-element-uuid
20613           in: path
20614           required: true
20615           type: string
20616           example: __NAMED-QUERY-ELEMENT-UUID__
20617         - name: property-constraint-uuid
20618           in: path
20619           required: true
20620           type: string
20621           example: __PROPERTY-CONSTRAINT-UUID__
20622         - name: resource-version
20623           in: query
20624           description: resource-version for concurrency
20625           required: true
20626           type: string
20627   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
20628     get:
20629       tags:
20630         - ServiceDesignAndCreation
20631       summary: returns property-constraints
20632       description: returns property-constraints
20633       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
20634       produces:
20635         - application/json
20636         - application/xml
20637       responses:
20638         "200":
20639           description: successful operation
20640           schema:
20641               $ref: "#/getDefinitions/property-constraints"
20642         "default":
20643           description: Response codes found in [response codes](https://wiki.onap.org/).
20644       parameters:
20645         - name: named-query-uuid
20646           in: path
20647           required: true
20648           type: string
20649           example: __NAMED-QUERY-UUID__
20650         - name: named-query-element-uuid
20651           in: path
20652           required: true
20653           type: string
20654           example: __NAMED-QUERY-ELEMENT-UUID__
20655         - name: property-constraint-uuid
20656           in: query
20657           description:
20658           required: false
20659           type: string
20660   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
20661     put:
20662       tags:
20663         - ServiceDesignAndCreation
20664       summary: see node definition for valid relationships
20665       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
20666       consumes:
20667         - application/json
20668         - application/xml
20669       produces:
20670         - application/json
20671         - application/xml
20672       responses:
20673         "default":
20674           description: Response codes found in [response codes](https://wiki.onap.org/).
20675       parameters:
20676         - name: named-query-uuid
20677           in: path
20678           required: true
20679           type: string
20680           example: __NAMED-QUERY-UUID__
20681         - name: named-query-element-uuid
20682           in: path
20683           required: true
20684           type: string
20685           example: __NAMED-QUERY-ELEMENT-UUID__
20686         - name: body
20687           in: body
20688           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
20689           required: true
20690           schema:
20691             $ref: "#/definitions/relationship"
20692     delete:
20693       tags:
20694         - ServiceDesignAndCreation
20695       summary: delete an existing relationship
20696       description: delete an existing relationship
20697       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
20698       consumes:
20699         - application/json
20700         - application/xml
20701       produces:
20702         - application/json
20703         - application/xml
20704       responses:
20705         "default":
20706           description: Response codes found in [response codes](https://wiki.onap.org/).
20707       parameters:
20708         - name: named-query-uuid
20709           in: path
20710           required: true
20711           type: string
20712           example: __NAMED-QUERY-UUID__
20713         - name: named-query-element-uuid
20714           in: path
20715           required: true
20716           type: string
20717           example: __NAMED-QUERY-ELEMENT-UUID__
20718   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
20719     get:
20720       tags:
20721         - ServiceDesignAndCreation
20722       summary: returns named-query-element
20723       description: returns named-query-element
20724       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20725       produces:
20726         - application/json
20727         - application/xml
20728       responses:
20729         "200":
20730           description: successful operation
20731           schema:
20732               $ref: "#/getDefinitions/named-query-element"
20733         "default":
20734           description: Response codes found in [response codes](https://wiki.onap.org/).
20735       parameters:
20736         - name: named-query-uuid
20737           in: path
20738           required: true
20739           type: string
20740           example: __NAMED-QUERY-UUID__
20741         - name: named-query-element-uuid
20742           in: path
20743           required: true
20744           type: string
20745           example: __NAMED-QUERY-ELEMENT-UUID__
20746     put:
20747       tags:
20748         - ServiceDesignAndCreation
20749       summary: create or update an existing named-query-element
20750       description: |
20751         Create or update an existing named-query-element.
20752         #
20753         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20754       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20755       consumes:
20756         - application/json
20757         - application/xml
20758       produces:
20759         - application/json
20760         - application/xml
20761       responses:
20762         "default":
20763           description: Response codes found in [response codes](https://wiki.onap.org/).
20764       parameters:
20765         - name: named-query-uuid
20766           in: path
20767           required: true
20768           type: string
20769           example: __NAMED-QUERY-UUID__
20770         - name: named-query-element-uuid
20771           in: path
20772           required: true
20773           type: string
20774           example: __NAMED-QUERY-ELEMENT-UUID__
20775         - name: body
20776           in: body
20777           description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
20778           required: true
20779           schema:
20780             $ref: "#/definitions/named-query-element"
20781     patch:
20782       tags:
20783         - ServiceDesignAndCreation
20784       summary: update an existing named-query-element
20785       description: |
20786         Update an existing named-query-element
20787         #
20788         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20789         The PUT operation will entirely replace an existing object.
20790         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20791         #
20792         Other differences between PUT and PATCH are:
20793         #
20794         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20795         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20796         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20797       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20798       consumes:
20799         - application/json
20800         - application/xml
20801       produces:
20802         - application/json
20803         - application/xml
20804       responses:
20805         "default":
20806           description: Response codes found in [response codes](https://wiki.onap.org/).
20807       parameters:
20808         - name: named-query-uuid
20809           in: path
20810           required: true
20811           type: string
20812           example: __NAMED-QUERY-UUID__
20813         - name: named-query-element-uuid
20814           in: path
20815           required: true
20816           type: string
20817           example: __NAMED-QUERY-ELEMENT-UUID__
20818         - name: body
20819           in: body
20820           description: named-query-element object that needs to be updated.
20821           required: true
20822           schema:
20823             $ref: "#/patchDefinitions/named-query-element"
20824     delete:
20825       tags:
20826         - ServiceDesignAndCreation
20827       summary: delete an existing named-query-element
20828       description: delete an existing named-query-element
20829       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
20830       consumes:
20831         - application/json
20832         - application/xml
20833       produces:
20834         - application/json
20835         - application/xml
20836       responses:
20837         "default":
20838           description: Response codes found in [response codes](https://wiki.onap.org/).
20839       parameters:
20840         - name: named-query-uuid
20841           in: path
20842           required: true
20843           type: string
20844           example: __NAMED-QUERY-UUID__
20845         - name: named-query-element-uuid
20846           in: path
20847           required: true
20848           type: string
20849           example: __NAMED-QUERY-ELEMENT-UUID__
20850         - name: resource-version
20851           in: query
20852           description: resource-version for concurrency
20853           required: true
20854           type: string
20855   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
20856     get:
20857       tags:
20858         - ServiceDesignAndCreation
20859       summary: returns named-query-elements
20860       description: returns named-query-elements
20861       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
20862       produces:
20863         - application/json
20864         - application/xml
20865       responses:
20866         "200":
20867           description: successful operation
20868           schema:
20869               $ref: "#/getDefinitions/named-query-elements"
20870         "default":
20871           description: Response codes found in [response codes](https://wiki.onap.org/).
20872       parameters:
20873         - name: named-query-uuid
20874           in: path
20875           required: true
20876           type: string
20877           example: __NAMED-QUERY-UUID__
20878         - name: named-query-element-uuid
20879           in: query
20880           description:
20881           required: false
20882           type: string
20883   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
20884     put:
20885       tags:
20886         - ServiceDesignAndCreation
20887       summary: see node definition for valid relationships
20888       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
20889       consumes:
20890         - application/json
20891         - application/xml
20892       produces:
20893         - application/json
20894         - application/xml
20895       responses:
20896         "default":
20897           description: Response codes found in [response codes](https://wiki.onap.org/).
20898       parameters:
20899         - name: named-query-uuid
20900           in: path
20901           required: true
20902           type: string
20903           example: __NAMED-QUERY-UUID__
20904         - name: body
20905           in: body
20906           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
20907           required: true
20908           schema:
20909             $ref: "#/definitions/relationship"
20910     delete:
20911       tags:
20912         - ServiceDesignAndCreation
20913       summary: delete an existing relationship
20914       description: delete an existing relationship
20915       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
20916       consumes:
20917         - application/json
20918         - application/xml
20919       produces:
20920         - application/json
20921         - application/xml
20922       responses:
20923         "default":
20924           description: Response codes found in [response codes](https://wiki.onap.org/).
20925       parameters:
20926         - name: named-query-uuid
20927           in: path
20928           required: true
20929           type: string
20930           example: __NAMED-QUERY-UUID__
20931   /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
20932     get:
20933       tags:
20934         - ServiceDesignAndCreation
20935       summary: returns named-query
20936       description: returns named-query
20937       operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
20938       produces:
20939         - application/json
20940         - application/xml
20941       responses:
20942         "200":
20943           description: successful operation
20944           schema:
20945               $ref: "#/getDefinitions/named-query"
20946         "default":
20947           description: Response codes found in [response codes](https://wiki.onap.org/).
20948       parameters:
20949         - name: named-query-uuid
20950           in: path
20951           required: true
20952           type: string
20953           example: __NAMED-QUERY-UUID__
20954     put:
20955       tags:
20956         - ServiceDesignAndCreation
20957       summary: create or update an existing named-query
20958       description: |
20959         Create or update an existing named-query.
20960         #
20961         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20962       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
20963       consumes:
20964         - application/json
20965         - application/xml
20966       produces:
20967         - application/json
20968         - application/xml
20969       responses:
20970         "default":
20971           description: Response codes found in [response codes](https://wiki.onap.org/).
20972       parameters:
20973         - name: named-query-uuid
20974           in: path
20975           required: true
20976           type: string
20977           example: __NAMED-QUERY-UUID__
20978         - name: body
20979           in: body
20980           description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
20981           required: true
20982           schema:
20983             $ref: "#/definitions/named-query"
20984     patch:
20985       tags:
20986         - ServiceDesignAndCreation
20987       summary: update an existing named-query
20988       description: |
20989         Update an existing named-query
20990         #
20991         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20992         The PUT operation will entirely replace an existing object.
20993         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20994         #
20995         Other differences between PUT and PATCH are:
20996         #
20997         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20998         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20999         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21000       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
21001       consumes:
21002         - application/json
21003         - application/xml
21004       produces:
21005         - application/json
21006         - application/xml
21007       responses:
21008         "default":
21009           description: Response codes found in [response codes](https://wiki.onap.org/).
21010       parameters:
21011         - name: named-query-uuid
21012           in: path
21013           required: true
21014           type: string
21015           example: __NAMED-QUERY-UUID__
21016         - name: body
21017           in: body
21018           description: named-query object that needs to be updated.
21019           required: true
21020           schema:
21021             $ref: "#/patchDefinitions/named-query"
21022     delete:
21023       tags:
21024         - ServiceDesignAndCreation
21025       summary: delete an existing named-query
21026       description: delete an existing named-query
21027       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
21028       consumes:
21029         - application/json
21030         - application/xml
21031       produces:
21032         - application/json
21033         - application/xml
21034       responses:
21035         "default":
21036           description: Response codes found in [response codes](https://wiki.onap.org/).
21037       parameters:
21038         - name: named-query-uuid
21039           in: path
21040           required: true
21041           type: string
21042           example: __NAMED-QUERY-UUID__
21043         - name: resource-version
21044           in: query
21045           description: resource-version for concurrency
21046           required: true
21047           type: string
21048   /service-design-and-creation/named-queries:
21049     get:
21050       tags:
21051         - ServiceDesignAndCreation
21052       summary: returns named-queries
21053       description: returns named-queries
21054       operationId: getServiceDesignAndCreationNamedQueries
21055       produces:
21056         - application/json
21057         - application/xml
21058       responses:
21059         "200":
21060           description: successful operation
21061           schema:
21062               $ref: "#/getDefinitions/named-queries"
21063         "default":
21064           description: Response codes found in [response codes](https://wiki.onap.org/).
21065       parameters:
21066         - name: named-query-uuid
21067           in: query
21068           description:
21069           required: false
21070           type: string
21071         - name: named-query-name
21072           in: query
21073           description:
21074           required: false
21075           type: string
21076   /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
21077     put:
21078       tags:
21079         - Network
21080       summary: see node definition for valid relationships
21081       operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
21082       consumes:
21083         - application/json
21084         - application/xml
21085       produces:
21086         - application/json
21087         - application/xml
21088       responses:
21089         "default":
21090           description: Response codes found in [response codes](https://wiki.onap.org/).
21091       parameters:
21092         - name: link-name
21093           in: path
21094           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
21095           required: true
21096           type: string
21097           example: __LINK-NAME__
21098         - name: body
21099           in: body
21100           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLogicalLinksLogicalLink.json)
21101           required: true
21102           schema:
21103             $ref: "#/definitions/relationship"
21104     delete:
21105       tags:
21106         - Network
21107       summary: delete an existing relationship
21108       description: delete an existing relationship
21109       operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
21110       consumes:
21111         - application/json
21112         - application/xml
21113       produces:
21114         - application/json
21115         - application/xml
21116       responses:
21117         "default":
21118           description: Response codes found in [response codes](https://wiki.onap.org/).
21119       parameters:
21120         - name: link-name
21121           in: path
21122           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
21123           required: true
21124           type: string
21125           example: __LINK-NAME__
21126   /network/logical-links/logical-link/{link-name}:
21127     get:
21128       tags:
21129         - Network
21130       summary: returns logical-link
21131       description: returns logical-link
21132       operationId: getNetworkLogicalLinksLogicalLink
21133       produces:
21134         - application/json
21135         - application/xml
21136       responses:
21137         "200":
21138           description: successful operation
21139           schema:
21140               $ref: "#/getDefinitions/logical-link"
21141         "default":
21142           description: Response codes found in [response codes](https://wiki.onap.org/).
21143       parameters:
21144         - name: link-name
21145           in: path
21146           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
21147           required: true
21148           type: string
21149           example: __LINK-NAME__
21150     put:
21151       tags:
21152         - Network
21153       summary: create or update an existing logical-link
21154       description: |
21155         Create or update an existing logical-link.
21156         #
21157         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21158       operationId: createOrUpdateNetworkLogicalLinksLogicalLink
21159       consumes:
21160         - application/json
21161         - application/xml
21162       produces:
21163         - application/json
21164         - application/xml
21165       responses:
21166         "default":
21167           description: Response codes found in [response codes](https://wiki.onap.org/).
21168       parameters:
21169         - name: link-name
21170           in: path
21171           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
21172           required: true
21173           type: string
21174           example: __LINK-NAME__
21175         - name: body
21176           in: body
21177           description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLogicalLinksLogicalLink.json)
21178           required: true
21179           schema:
21180             $ref: "#/definitions/logical-link"
21181     patch:
21182       tags:
21183         - Network
21184       summary: update an existing logical-link
21185       description: |
21186         Update an existing logical-link
21187         #
21188         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21189         The PUT operation will entirely replace an existing object.
21190         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21191         #
21192         Other differences between PUT and PATCH are:
21193         #
21194         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21195         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21196         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21197       operationId: UpdateNetworkLogicalLinksLogicalLink
21198       consumes:
21199         - application/json
21200         - application/xml
21201       produces:
21202         - application/json
21203         - application/xml
21204       responses:
21205         "default":
21206           description: Response codes found in [response codes](https://wiki.onap.org/).
21207       parameters:
21208         - name: link-name
21209           in: path
21210           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
21211           required: true
21212           type: string
21213           example: __LINK-NAME__
21214         - name: body
21215           in: body
21216           description: logical-link object that needs to be updated.
21217           required: true
21218           schema:
21219             $ref: "#/patchDefinitions/logical-link"
21220     delete:
21221       tags:
21222         - Network
21223       summary: delete an existing logical-link
21224       description: delete an existing logical-link
21225       operationId: deleteNetworkLogicalLinksLogicalLink
21226       consumes:
21227         - application/json
21228         - application/xml
21229       produces:
21230         - application/json
21231         - application/xml
21232       responses:
21233         "default":
21234           description: Response codes found in [response codes](https://wiki.onap.org/).
21235       parameters:
21236         - name: link-name
21237           in: path
21238           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
21239           required: true
21240           type: string
21241           example: __LINK-NAME__
21242         - name: resource-version
21243           in: query
21244           description: resource-version for concurrency
21245           required: true
21246           type: string
21247   /network/logical-links:
21248     get:
21249       tags:
21250         - Network
21251       summary: returns logical-links
21252       description: returns logical-links
21253       operationId: getNetworkLogicalLinks
21254       produces:
21255         - application/json
21256         - application/xml
21257       responses:
21258         "200":
21259           description: successful operation
21260           schema:
21261               $ref: "#/getDefinitions/logical-links"
21262         "default":
21263           description: Response codes found in [response codes](https://wiki.onap.org/).
21264       parameters:
21265         - name: link-name
21266           in: query
21267           description:
21268           required: false
21269           type: string
21270         - name: model-invariant-id
21271           in: query
21272           description:
21273           required: false
21274           type: string
21275         - name: model-version-id
21276           in: query
21277           description:
21278           required: false
21279           type: string
21280         - name: widget-model-id
21281           in: query
21282           description:
21283           required: false
21284           type: string
21285         - name: widget-model-version
21286           in: query
21287           description:
21288           required: false
21289           type: string
21290         - name: prov-status
21291           in: query
21292           description:
21293           required: false
21294           type: string
21295         - name: link-id
21296           in: query
21297           description:
21298           required: false
21299           type: string
21300         - name: circuit-id
21301           in: query
21302           description:
21303           required: false
21304           type: string
21305         - name: purpose
21306           in: query
21307           description:
21308           required: false
21309           type: string
21310   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship:
21311     put:
21312       tags:
21313         - Network
21314       summary: see node definition for valid relationships
21315       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
21316       consumes:
21317         - application/json
21318         - application/xml
21319       produces:
21320         - application/json
21321         - application/xml
21322       responses:
21323         "default":
21324           description: Response codes found in [response codes](https://wiki.onap.org/).
21325       parameters:
21326         - name: site-pair-set-id
21327           in: path
21328           description: Unique id of site pair set.
21329           required: true
21330           type: string
21331           example: __SITE-PAIR-SET-ID__
21332         - name: routing-instance-id
21333           in: path
21334           description: Unique id of routing instance
21335           required: true
21336           type: string
21337           example: __ROUTING-INSTANCE-ID__
21338         - name: site-pair-id
21339           in: path
21340           description: unique identifier of probe
21341           required: true
21342           type: string
21343           example: __SITE-PAIR-ID__
21344         - name: cos
21345           in: path
21346           description: unique identifier of probe
21347           required: true
21348           type: string
21349           example: __COS__
21350         - name: body
21351           in: body
21352           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
21353           required: true
21354           schema:
21355             $ref: "#/definitions/relationship"
21356     delete:
21357       tags:
21358         - Network
21359       summary: delete an existing relationship
21360       description: delete an existing relationship
21361       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
21362       consumes:
21363         - application/json
21364         - application/xml
21365       produces:
21366         - application/json
21367         - application/xml
21368       responses:
21369         "default":
21370           description: Response codes found in [response codes](https://wiki.onap.org/).
21371       parameters:
21372         - name: site-pair-set-id
21373           in: path
21374           description: Unique id of site pair set.
21375           required: true
21376           type: string
21377           example: __SITE-PAIR-SET-ID__
21378         - name: routing-instance-id
21379           in: path
21380           description: Unique id of routing instance
21381           required: true
21382           type: string
21383           example: __ROUTING-INSTANCE-ID__
21384         - name: site-pair-id
21385           in: path
21386           description: unique identifier of probe
21387           required: true
21388           type: string
21389           example: __SITE-PAIR-ID__
21390         - name: cos
21391           in: path
21392           description: unique identifier of probe
21393           required: true
21394           type: string
21395           example: __COS__
21396   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}:
21397     get:
21398       tags:
21399         - Network
21400       summary: returns class-of-service
21401       description: returns class-of-service
21402       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21403       produces:
21404         - application/json
21405         - application/xml
21406       responses:
21407         "200":
21408           description: successful operation
21409           schema:
21410               $ref: "#/getDefinitions/class-of-service"
21411         "default":
21412           description: Response codes found in [response codes](https://wiki.onap.org/).
21413       parameters:
21414         - name: site-pair-set-id
21415           in: path
21416           description: Unique id of site pair set.
21417           required: true
21418           type: string
21419           example: __SITE-PAIR-SET-ID__
21420         - name: routing-instance-id
21421           in: path
21422           description: Unique id of routing instance
21423           required: true
21424           type: string
21425           example: __ROUTING-INSTANCE-ID__
21426         - name: site-pair-id
21427           in: path
21428           description: unique identifier of probe
21429           required: true
21430           type: string
21431           example: __SITE-PAIR-ID__
21432         - name: cos
21433           in: path
21434           description: unique identifier of probe
21435           required: true
21436           type: string
21437           example: __COS__
21438     put:
21439       tags:
21440         - Network
21441       summary: create or update an existing class-of-service
21442       description: |
21443         Create or update an existing class-of-service.
21444         #
21445         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21446       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21447       consumes:
21448         - application/json
21449         - application/xml
21450       produces:
21451         - application/json
21452         - application/xml
21453       responses:
21454         "default":
21455           description: Response codes found in [response codes](https://wiki.onap.org/).
21456       parameters:
21457         - name: site-pair-set-id
21458           in: path
21459           description: Unique id of site pair set.
21460           required: true
21461           type: string
21462           example: __SITE-PAIR-SET-ID__
21463         - name: routing-instance-id
21464           in: path
21465           description: Unique id of routing instance
21466           required: true
21467           type: string
21468           example: __ROUTING-INSTANCE-ID__
21469         - name: site-pair-id
21470           in: path
21471           description: unique identifier of probe
21472           required: true
21473           type: string
21474           example: __SITE-PAIR-ID__
21475         - name: cos
21476           in: path
21477           description: unique identifier of probe
21478           required: true
21479           type: string
21480           example: __COS__
21481         - name: body
21482           in: body
21483           description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
21484           required: true
21485           schema:
21486             $ref: "#/definitions/class-of-service"
21487     patch:
21488       tags:
21489         - Network
21490       summary: update an existing class-of-service
21491       description: |
21492         Update an existing class-of-service
21493         #
21494         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21495         The PUT operation will entirely replace an existing object.
21496         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21497         #
21498         Other differences between PUT and PATCH are:
21499         #
21500         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21501         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21502         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21503       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21504       consumes:
21505         - application/json
21506         - application/xml
21507       produces:
21508         - application/json
21509         - application/xml
21510       responses:
21511         "default":
21512           description: Response codes found in [response codes](https://wiki.onap.org/).
21513       parameters:
21514         - name: site-pair-set-id
21515           in: path
21516           description: Unique id of site pair set.
21517           required: true
21518           type: string
21519           example: __SITE-PAIR-SET-ID__
21520         - name: routing-instance-id
21521           in: path
21522           description: Unique id of routing instance
21523           required: true
21524           type: string
21525           example: __ROUTING-INSTANCE-ID__
21526         - name: site-pair-id
21527           in: path
21528           description: unique identifier of probe
21529           required: true
21530           type: string
21531           example: __SITE-PAIR-ID__
21532         - name: cos
21533           in: path
21534           description: unique identifier of probe
21535           required: true
21536           type: string
21537           example: __COS__
21538         - name: body
21539           in: body
21540           description: class-of-service object that needs to be updated.
21541           required: true
21542           schema:
21543             $ref: "#/patchDefinitions/class-of-service"
21544     delete:
21545       tags:
21546         - Network
21547       summary: delete an existing class-of-service
21548       description: delete an existing class-of-service
21549       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
21550       consumes:
21551         - application/json
21552         - application/xml
21553       produces:
21554         - application/json
21555         - application/xml
21556       responses:
21557         "default":
21558           description: Response codes found in [response codes](https://wiki.onap.org/).
21559       parameters:
21560         - name: site-pair-set-id
21561           in: path
21562           description: Unique id of site pair set.
21563           required: true
21564           type: string
21565           example: __SITE-PAIR-SET-ID__
21566         - name: routing-instance-id
21567           in: path
21568           description: Unique id of routing instance
21569           required: true
21570           type: string
21571           example: __ROUTING-INSTANCE-ID__
21572         - name: site-pair-id
21573           in: path
21574           description: unique identifier of probe
21575           required: true
21576           type: string
21577           example: __SITE-PAIR-ID__
21578         - name: cos
21579           in: path
21580           description: unique identifier of probe
21581           required: true
21582           type: string
21583           example: __COS__
21584         - name: resource-version
21585           in: query
21586           description: resource-version for concurrency
21587           required: true
21588           type: string
21589   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service:
21590     get:
21591       tags:
21592         - Network
21593       summary: returns classes-of-service
21594       description: returns classes-of-service
21595       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
21596       produces:
21597         - application/json
21598         - application/xml
21599       responses:
21600         "200":
21601           description: successful operation
21602           schema:
21603               $ref: "#/getDefinitions/classes-of-service"
21604         "default":
21605           description: Response codes found in [response codes](https://wiki.onap.org/).
21606       parameters:
21607         - name: site-pair-set-id
21608           in: path
21609           description: Unique id of site pair set.
21610           required: true
21611           type: string
21612           example: __SITE-PAIR-SET-ID__
21613         - name: routing-instance-id
21614           in: path
21615           description: Unique id of routing instance
21616           required: true
21617           type: string
21618           example: __ROUTING-INSTANCE-ID__
21619         - name: site-pair-id
21620           in: path
21621           description: unique identifier of probe
21622           required: true
21623           type: string
21624           example: __SITE-PAIR-ID__
21625         - name: cos
21626           in: query
21627           description:
21628           required: false
21629           type: string
21630   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship:
21631     put:
21632       tags:
21633         - Network
21634       summary: see node definition for valid relationships
21635       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
21636       consumes:
21637         - application/json
21638         - application/xml
21639       produces:
21640         - application/json
21641         - application/xml
21642       responses:
21643         "default":
21644           description: Response codes found in [response codes](https://wiki.onap.org/).
21645       parameters:
21646         - name: site-pair-set-id
21647           in: path
21648           description: Unique id of site pair set.
21649           required: true
21650           type: string
21651           example: __SITE-PAIR-SET-ID__
21652         - name: routing-instance-id
21653           in: path
21654           description: Unique id of routing instance
21655           required: true
21656           type: string
21657           example: __ROUTING-INSTANCE-ID__
21658         - name: site-pair-id
21659           in: path
21660           description: unique identifier of probe
21661           required: true
21662           type: string
21663           example: __SITE-PAIR-ID__
21664         - name: body
21665           in: body
21666           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
21667           required: true
21668           schema:
21669             $ref: "#/definitions/relationship"
21670     delete:
21671       tags:
21672         - Network
21673       summary: delete an existing relationship
21674       description: delete an existing relationship
21675       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
21676       consumes:
21677         - application/json
21678         - application/xml
21679       produces:
21680         - application/json
21681         - application/xml
21682       responses:
21683         "default":
21684           description: Response codes found in [response codes](https://wiki.onap.org/).
21685       parameters:
21686         - name: site-pair-set-id
21687           in: path
21688           description: Unique id of site pair set.
21689           required: true
21690           type: string
21691           example: __SITE-PAIR-SET-ID__
21692         - name: routing-instance-id
21693           in: path
21694           description: Unique id of routing instance
21695           required: true
21696           type: string
21697           example: __ROUTING-INSTANCE-ID__
21698         - name: site-pair-id
21699           in: path
21700           description: unique identifier of probe
21701           required: true
21702           type: string
21703           example: __SITE-PAIR-ID__
21704   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}:
21705     get:
21706       tags:
21707         - Network
21708       summary: returns site-pair
21709       description: returns site-pair
21710       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21711       produces:
21712         - application/json
21713         - application/xml
21714       responses:
21715         "200":
21716           description: successful operation
21717           schema:
21718               $ref: "#/getDefinitions/site-pair"
21719         "default":
21720           description: Response codes found in [response codes](https://wiki.onap.org/).
21721       parameters:
21722         - name: site-pair-set-id
21723           in: path
21724           description: Unique id of site pair set.
21725           required: true
21726           type: string
21727           example: __SITE-PAIR-SET-ID__
21728         - name: routing-instance-id
21729           in: path
21730           description: Unique id of routing instance
21731           required: true
21732           type: string
21733           example: __ROUTING-INSTANCE-ID__
21734         - name: site-pair-id
21735           in: path
21736           description: unique identifier of probe
21737           required: true
21738           type: string
21739           example: __SITE-PAIR-ID__
21740     put:
21741       tags:
21742         - Network
21743       summary: create or update an existing site-pair
21744       description: |
21745         Create or update an existing site-pair.
21746         #
21747         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21748       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21749       consumes:
21750         - application/json
21751         - application/xml
21752       produces:
21753         - application/json
21754         - application/xml
21755       responses:
21756         "default":
21757           description: Response codes found in [response codes](https://wiki.onap.org/).
21758       parameters:
21759         - name: site-pair-set-id
21760           in: path
21761           description: Unique id of site pair set.
21762           required: true
21763           type: string
21764           example: __SITE-PAIR-SET-ID__
21765         - name: routing-instance-id
21766           in: path
21767           description: Unique id of routing instance
21768           required: true
21769           type: string
21770           example: __ROUTING-INSTANCE-ID__
21771         - name: site-pair-id
21772           in: path
21773           description: unique identifier of probe
21774           required: true
21775           type: string
21776           example: __SITE-PAIR-ID__
21777         - name: body
21778           in: body
21779           description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
21780           required: true
21781           schema:
21782             $ref: "#/definitions/site-pair"
21783     patch:
21784       tags:
21785         - Network
21786       summary: update an existing site-pair
21787       description: |
21788         Update an existing site-pair
21789         #
21790         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21791         The PUT operation will entirely replace an existing object.
21792         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21793         #
21794         Other differences between PUT and PATCH are:
21795         #
21796         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21797         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21798         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21799       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21800       consumes:
21801         - application/json
21802         - application/xml
21803       produces:
21804         - application/json
21805         - application/xml
21806       responses:
21807         "default":
21808           description: Response codes found in [response codes](https://wiki.onap.org/).
21809       parameters:
21810         - name: site-pair-set-id
21811           in: path
21812           description: Unique id of site pair set.
21813           required: true
21814           type: string
21815           example: __SITE-PAIR-SET-ID__
21816         - name: routing-instance-id
21817           in: path
21818           description: Unique id of routing instance
21819           required: true
21820           type: string
21821           example: __ROUTING-INSTANCE-ID__
21822         - name: site-pair-id
21823           in: path
21824           description: unique identifier of probe
21825           required: true
21826           type: string
21827           example: __SITE-PAIR-ID__
21828         - name: body
21829           in: body
21830           description: site-pair object that needs to be updated.
21831           required: true
21832           schema:
21833             $ref: "#/patchDefinitions/site-pair"
21834     delete:
21835       tags:
21836         - Network
21837       summary: delete an existing site-pair
21838       description: delete an existing site-pair
21839       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
21840       consumes:
21841         - application/json
21842         - application/xml
21843       produces:
21844         - application/json
21845         - application/xml
21846       responses:
21847         "default":
21848           description: Response codes found in [response codes](https://wiki.onap.org/).
21849       parameters:
21850         - name: site-pair-set-id
21851           in: path
21852           description: Unique id of site pair set.
21853           required: true
21854           type: string
21855           example: __SITE-PAIR-SET-ID__
21856         - name: routing-instance-id
21857           in: path
21858           description: Unique id of routing instance
21859           required: true
21860           type: string
21861           example: __ROUTING-INSTANCE-ID__
21862         - name: site-pair-id
21863           in: path
21864           description: unique identifier of probe
21865           required: true
21866           type: string
21867           example: __SITE-PAIR-ID__
21868         - name: resource-version
21869           in: query
21870           description: resource-version for concurrency
21871           required: true
21872           type: string
21873   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
21874     get:
21875       tags:
21876         - Network
21877       summary: returns site-pairs
21878       description: returns site-pairs
21879       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
21880       produces:
21881         - application/json
21882         - application/xml
21883       responses:
21884         "200":
21885           description: successful operation
21886           schema:
21887               $ref: "#/getDefinitions/site-pairs"
21888         "default":
21889           description: Response codes found in [response codes](https://wiki.onap.org/).
21890       parameters:
21891         - name: site-pair-set-id
21892           in: path
21893           description: Unique id of site pair set.
21894           required: true
21895           type: string
21896           example: __SITE-PAIR-SET-ID__
21897         - name: routing-instance-id
21898           in: path
21899           description: Unique id of routing instance
21900           required: true
21901           type: string
21902           example: __ROUTING-INSTANCE-ID__
21903         - name: site-pair-id
21904           in: query
21905           description:
21906           required: false
21907           type: string
21908   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
21909     put:
21910       tags:
21911         - Network
21912       summary: see node definition for valid relationships
21913       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
21914       consumes:
21915         - application/json
21916         - application/xml
21917       produces:
21918         - application/json
21919         - application/xml
21920       responses:
21921         "default":
21922           description: Response codes found in [response codes](https://wiki.onap.org/).
21923       parameters:
21924         - name: site-pair-set-id
21925           in: path
21926           description: Unique id of site pair set.
21927           required: true
21928           type: string
21929           example: __SITE-PAIR-SET-ID__
21930         - name: routing-instance-id
21931           in: path
21932           description: Unique id of routing instance
21933           required: true
21934           type: string
21935           example: __ROUTING-INSTANCE-ID__
21936         - name: body
21937           in: body
21938           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
21939           required: true
21940           schema:
21941             $ref: "#/definitions/relationship"
21942     delete:
21943       tags:
21944         - Network
21945       summary: delete an existing relationship
21946       description: delete an existing relationship
21947       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
21948       consumes:
21949         - application/json
21950         - application/xml
21951       produces:
21952         - application/json
21953         - application/xml
21954       responses:
21955         "default":
21956           description: Response codes found in [response codes](https://wiki.onap.org/).
21957       parameters:
21958         - name: site-pair-set-id
21959           in: path
21960           description: Unique id of site pair set.
21961           required: true
21962           type: string
21963           example: __SITE-PAIR-SET-ID__
21964         - name: routing-instance-id
21965           in: path
21966           description: Unique id of routing instance
21967           required: true
21968           type: string
21969           example: __ROUTING-INSTANCE-ID__
21970   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
21971     get:
21972       tags:
21973         - Network
21974       summary: returns routing-instance
21975       description: returns routing-instance
21976       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21977       produces:
21978         - application/json
21979         - application/xml
21980       responses:
21981         "200":
21982           description: successful operation
21983           schema:
21984               $ref: "#/getDefinitions/routing-instance"
21985         "default":
21986           description: Response codes found in [response codes](https://wiki.onap.org/).
21987       parameters:
21988         - name: site-pair-set-id
21989           in: path
21990           description: Unique id of site pair set.
21991           required: true
21992           type: string
21993           example: __SITE-PAIR-SET-ID__
21994         - name: routing-instance-id
21995           in: path
21996           description: Unique id of routing instance
21997           required: true
21998           type: string
21999           example: __ROUTING-INSTANCE-ID__
22000     put:
22001       tags:
22002         - Network
22003       summary: create or update an existing routing-instance
22004       description: |
22005         Create or update an existing routing-instance.
22006         #
22007         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22008       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
22009       consumes:
22010         - application/json
22011         - application/xml
22012       produces:
22013         - application/json
22014         - application/xml
22015       responses:
22016         "default":
22017           description: Response codes found in [response codes](https://wiki.onap.org/).
22018       parameters:
22019         - name: site-pair-set-id
22020           in: path
22021           description: Unique id of site pair set.
22022           required: true
22023           type: string
22024           example: __SITE-PAIR-SET-ID__
22025         - name: routing-instance-id
22026           in: path
22027           description: Unique id of routing instance
22028           required: true
22029           type: string
22030           example: __ROUTING-INSTANCE-ID__
22031         - name: body
22032           in: body
22033           description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
22034           required: true
22035           schema:
22036             $ref: "#/definitions/routing-instance"
22037     patch:
22038       tags:
22039         - Network
22040       summary: update an existing routing-instance
22041       description: |
22042         Update an existing routing-instance
22043         #
22044         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22045         The PUT operation will entirely replace an existing object.
22046         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22047         #
22048         Other differences between PUT and PATCH are:
22049         #
22050         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22051         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22052         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22053       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
22054       consumes:
22055         - application/json
22056         - application/xml
22057       produces:
22058         - application/json
22059         - application/xml
22060       responses:
22061         "default":
22062           description: Response codes found in [response codes](https://wiki.onap.org/).
22063       parameters:
22064         - name: site-pair-set-id
22065           in: path
22066           description: Unique id of site pair set.
22067           required: true
22068           type: string
22069           example: __SITE-PAIR-SET-ID__
22070         - name: routing-instance-id
22071           in: path
22072           description: Unique id of routing instance
22073           required: true
22074           type: string
22075           example: __ROUTING-INSTANCE-ID__
22076         - name: body
22077           in: body
22078           description: routing-instance object that needs to be updated.
22079           required: true
22080           schema:
22081             $ref: "#/patchDefinitions/routing-instance"
22082     delete:
22083       tags:
22084         - Network
22085       summary: delete an existing routing-instance
22086       description: delete an existing routing-instance
22087       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
22088       consumes:
22089         - application/json
22090         - application/xml
22091       produces:
22092         - application/json
22093         - application/xml
22094       responses:
22095         "default":
22096           description: Response codes found in [response codes](https://wiki.onap.org/).
22097       parameters:
22098         - name: site-pair-set-id
22099           in: path
22100           description: Unique id of site pair set.
22101           required: true
22102           type: string
22103           example: __SITE-PAIR-SET-ID__
22104         - name: routing-instance-id
22105           in: path
22106           description: Unique id of routing instance
22107           required: true
22108           type: string
22109           example: __ROUTING-INSTANCE-ID__
22110         - name: resource-version
22111           in: query
22112           description: resource-version for concurrency
22113           required: true
22114           type: string
22115   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
22116     get:
22117       tags:
22118         - Network
22119       summary: returns routing-instances
22120       description: returns routing-instances
22121       operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
22122       produces:
22123         - application/json
22124         - application/xml
22125       responses:
22126         "200":
22127           description: successful operation
22128           schema:
22129               $ref: "#/getDefinitions/routing-instances"
22130         "default":
22131           description: Response codes found in [response codes](https://wiki.onap.org/).
22132       parameters:
22133         - name: site-pair-set-id
22134           in: path
22135           description: Unique id of site pair set.
22136           required: true
22137           type: string
22138           example: __SITE-PAIR-SET-ID__
22139         - name: routing-instance-id
22140           in: query
22141           description:
22142           required: false
22143           type: string
22144   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
22145     put:
22146       tags:
22147         - Network
22148       summary: see node definition for valid relationships
22149       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
22150       consumes:
22151         - application/json
22152         - application/xml
22153       produces:
22154         - application/json
22155         - application/xml
22156       responses:
22157         "default":
22158           description: Response codes found in [response codes](https://wiki.onap.org/).
22159       parameters:
22160         - name: site-pair-set-id
22161           in: path
22162           description: Unique id of site pair set.
22163           required: true
22164           type: string
22165           example: __SITE-PAIR-SET-ID__
22166         - name: body
22167           in: body
22168           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSet.json)
22169           required: true
22170           schema:
22171             $ref: "#/definitions/relationship"
22172     delete:
22173       tags:
22174         - Network
22175       summary: delete an existing relationship
22176       description: delete an existing relationship
22177       operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
22178       consumes:
22179         - application/json
22180         - application/xml
22181       produces:
22182         - application/json
22183         - application/xml
22184       responses:
22185         "default":
22186           description: Response codes found in [response codes](https://wiki.onap.org/).
22187       parameters:
22188         - name: site-pair-set-id
22189           in: path
22190           description: Unique id of site pair set.
22191           required: true
22192           type: string
22193           example: __SITE-PAIR-SET-ID__
22194   /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
22195     get:
22196       tags:
22197         - Network
22198       summary: returns site-pair-set
22199       description: returns site-pair-set
22200       operationId: getNetworkSitePairSetsSitePairSet
22201       produces:
22202         - application/json
22203         - application/xml
22204       responses:
22205         "200":
22206           description: successful operation
22207           schema:
22208               $ref: "#/getDefinitions/site-pair-set"
22209         "default":
22210           description: Response codes found in [response codes](https://wiki.onap.org/).
22211       parameters:
22212         - name: site-pair-set-id
22213           in: path
22214           description: Unique id of site pair set.
22215           required: true
22216           type: string
22217           example: __SITE-PAIR-SET-ID__
22218     put:
22219       tags:
22220         - Network
22221       summary: create or update an existing site-pair-set
22222       description: |
22223         Create or update an existing site-pair-set.
22224         #
22225         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22226       operationId: createOrUpdateNetworkSitePairSetsSitePairSet
22227       consumes:
22228         - application/json
22229         - application/xml
22230       produces:
22231         - application/json
22232         - application/xml
22233       responses:
22234         "default":
22235           description: Response codes found in [response codes](https://wiki.onap.org/).
22236       parameters:
22237         - name: site-pair-set-id
22238           in: path
22239           description: Unique id of site pair set.
22240           required: true
22241           type: string
22242           example: __SITE-PAIR-SET-ID__
22243         - name: body
22244           in: body
22245           description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkSitePairSetsSitePairSet.json)
22246           required: true
22247           schema:
22248             $ref: "#/definitions/site-pair-set"
22249     patch:
22250       tags:
22251         - Network
22252       summary: update an existing site-pair-set
22253       description: |
22254         Update an existing site-pair-set
22255         #
22256         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22257         The PUT operation will entirely replace an existing object.
22258         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22259         #
22260         Other differences between PUT and PATCH are:
22261         #
22262         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22263         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22264         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22265       operationId: UpdateNetworkSitePairSetsSitePairSet
22266       consumes:
22267         - application/json
22268         - application/xml
22269       produces:
22270         - application/json
22271         - application/xml
22272       responses:
22273         "default":
22274           description: Response codes found in [response codes](https://wiki.onap.org/).
22275       parameters:
22276         - name: site-pair-set-id
22277           in: path
22278           description: Unique id of site pair set.
22279           required: true
22280           type: string
22281           example: __SITE-PAIR-SET-ID__
22282         - name: body
22283           in: body
22284           description: site-pair-set object that needs to be updated.
22285           required: true
22286           schema:
22287             $ref: "#/patchDefinitions/site-pair-set"
22288     delete:
22289       tags:
22290         - Network
22291       summary: delete an existing site-pair-set
22292       description: delete an existing site-pair-set
22293       operationId: deleteNetworkSitePairSetsSitePairSet
22294       consumes:
22295         - application/json
22296         - application/xml
22297       produces:
22298         - application/json
22299         - application/xml
22300       responses:
22301         "default":
22302           description: Response codes found in [response codes](https://wiki.onap.org/).
22303       parameters:
22304         - name: site-pair-set-id
22305           in: path
22306           description: Unique id of site pair set.
22307           required: true
22308           type: string
22309           example: __SITE-PAIR-SET-ID__
22310         - name: resource-version
22311           in: query
22312           description: resource-version for concurrency
22313           required: true
22314           type: string
22315   /network/site-pair-sets:
22316     get:
22317       tags:
22318         - Network
22319       summary: returns site-pair-sets
22320       description: returns site-pair-sets
22321       operationId: getNetworkSitePairSets
22322       produces:
22323         - application/json
22324         - application/xml
22325       responses:
22326         "200":
22327           description: successful operation
22328           schema:
22329               $ref: "#/getDefinitions/site-pair-sets"
22330         "default":
22331           description: Response codes found in [response codes](https://wiki.onap.org/).
22332       parameters:
22333         - name: site-pair-set-id
22334           in: query
22335           description:
22336           required: false
22337           type: string
22338   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
22339     put:
22340       tags:
22341         - Network
22342       summary: see node definition for valid relationships
22343       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
22344       consumes:
22345         - application/json
22346         - application/xml
22347       produces:
22348         - application/json
22349         - application/xml
22350       responses:
22351         "default":
22352           description: Response codes found in [response codes](https://wiki.onap.org/).
22353       parameters:
22354         - name: vpn-id
22355           in: path
22356           description: VPN ID, globally unique within A&AI
22357           required: true
22358           type: string
22359           example: __VPN-ID__
22360         - name: global-route-target
22361           in: path
22362           description: Number used to identify an RT, globally unique in the network
22363           required: true
22364           type: string
22365           example: __GLOBAL-ROUTE-TARGET__
22366         - name: route-target-role
22367           in: path
22368           description: Role assigned to this route target
22369           required: true
22370           type: string
22371           example: __ROUTE-TARGET-ROLE__
22372         - name: body
22373           in: body
22374           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
22375           required: true
22376           schema:
22377             $ref: "#/definitions/relationship"
22378     delete:
22379       tags:
22380         - Network
22381       summary: delete an existing relationship
22382       description: delete an existing relationship
22383       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
22384       consumes:
22385         - application/json
22386         - application/xml
22387       produces:
22388         - application/json
22389         - application/xml
22390       responses:
22391         "default":
22392           description: Response codes found in [response codes](https://wiki.onap.org/).
22393       parameters:
22394         - name: vpn-id
22395           in: path
22396           description: VPN ID, globally unique within A&AI
22397           required: true
22398           type: string
22399           example: __VPN-ID__
22400         - name: global-route-target
22401           in: path
22402           description: Number used to identify an RT, globally unique in the network
22403           required: true
22404           type: string
22405           example: __GLOBAL-ROUTE-TARGET__
22406         - name: route-target-role
22407           in: path
22408           description: Role assigned to this route target
22409           required: true
22410           type: string
22411           example: __ROUTE-TARGET-ROLE__
22412   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
22413     get:
22414       tags:
22415         - Network
22416       summary: returns route-target
22417       description: returns route-target
22418       operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22419       produces:
22420         - application/json
22421         - application/xml
22422       responses:
22423         "200":
22424           description: successful operation
22425           schema:
22426               $ref: "#/getDefinitions/route-target"
22427         "default":
22428           description: Response codes found in [response codes](https://wiki.onap.org/).
22429       parameters:
22430         - name: vpn-id
22431           in: path
22432           description: VPN ID, globally unique within A&AI
22433           required: true
22434           type: string
22435           example: __VPN-ID__
22436         - name: global-route-target
22437           in: path
22438           description: Number used to identify an RT, globally unique in the network
22439           required: true
22440           type: string
22441           example: __GLOBAL-ROUTE-TARGET__
22442         - name: route-target-role
22443           in: path
22444           description: Role assigned to this route target
22445           required: true
22446           type: string
22447           example: __ROUTE-TARGET-ROLE__
22448     put:
22449       tags:
22450         - Network
22451       summary: create or update an existing route-target
22452       description: |
22453         Create or update an existing route-target.
22454         #
22455         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22456       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22457       consumes:
22458         - application/json
22459         - application/xml
22460       produces:
22461         - application/json
22462         - application/xml
22463       responses:
22464         "default":
22465           description: Response codes found in [response codes](https://wiki.onap.org/).
22466       parameters:
22467         - name: vpn-id
22468           in: path
22469           description: VPN ID, globally unique within A&AI
22470           required: true
22471           type: string
22472           example: __VPN-ID__
22473         - name: global-route-target
22474           in: path
22475           description: Number used to identify an RT, globally unique in the network
22476           required: true
22477           type: string
22478           example: __GLOBAL-ROUTE-TARGET__
22479         - name: route-target-role
22480           in: path
22481           description: Role assigned to this route target
22482           required: true
22483           type: string
22484           example: __ROUTE-TARGET-ROLE__
22485         - name: body
22486           in: body
22487           description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
22488           required: true
22489           schema:
22490             $ref: "#/definitions/route-target"
22491     patch:
22492       tags:
22493         - Network
22494       summary: update an existing route-target
22495       description: |
22496         Update an existing route-target
22497         #
22498         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22499         The PUT operation will entirely replace an existing object.
22500         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22501         #
22502         Other differences between PUT and PATCH are:
22503         #
22504         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22505         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22506         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22507       operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22508       consumes:
22509         - application/json
22510         - application/xml
22511       produces:
22512         - application/json
22513         - application/xml
22514       responses:
22515         "default":
22516           description: Response codes found in [response codes](https://wiki.onap.org/).
22517       parameters:
22518         - name: vpn-id
22519           in: path
22520           description: VPN ID, globally unique within A&AI
22521           required: true
22522           type: string
22523           example: __VPN-ID__
22524         - name: global-route-target
22525           in: path
22526           description: Number used to identify an RT, globally unique in the network
22527           required: true
22528           type: string
22529           example: __GLOBAL-ROUTE-TARGET__
22530         - name: route-target-role
22531           in: path
22532           description: Role assigned to this route target
22533           required: true
22534           type: string
22535           example: __ROUTE-TARGET-ROLE__
22536         - name: body
22537           in: body
22538           description: route-target object that needs to be updated.
22539           required: true
22540           schema:
22541             $ref: "#/patchDefinitions/route-target"
22542     delete:
22543       tags:
22544         - Network
22545       summary: delete an existing route-target
22546       description: delete an existing route-target
22547       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
22548       consumes:
22549         - application/json
22550         - application/xml
22551       produces:
22552         - application/json
22553         - application/xml
22554       responses:
22555         "default":
22556           description: Response codes found in [response codes](https://wiki.onap.org/).
22557       parameters:
22558         - name: vpn-id
22559           in: path
22560           description: VPN ID, globally unique within A&AI
22561           required: true
22562           type: string
22563           example: __VPN-ID__
22564         - name: global-route-target
22565           in: path
22566           description: Number used to identify an RT, globally unique in the network
22567           required: true
22568           type: string
22569           example: __GLOBAL-ROUTE-TARGET__
22570         - name: route-target-role
22571           in: path
22572           description: Role assigned to this route target
22573           required: true
22574           type: string
22575           example: __ROUTE-TARGET-ROLE__
22576         - name: resource-version
22577           in: query
22578           description: resource-version for concurrency
22579           required: true
22580           type: string
22581   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
22582     get:
22583       tags:
22584         - Network
22585       summary: returns route-targets
22586       description: returns route-targets
22587       operationId: getNetworkVpnBindingsVpnBindingRouteTargets
22588       produces:
22589         - application/json
22590         - application/xml
22591       responses:
22592         "200":
22593           description: successful operation
22594           schema:
22595               $ref: "#/getDefinitions/route-targets"
22596         "default":
22597           description: Response codes found in [response codes](https://wiki.onap.org/).
22598       parameters:
22599         - name: vpn-id
22600           in: path
22601           description: VPN ID, globally unique within A&AI
22602           required: true
22603           type: string
22604           example: __VPN-ID__
22605   /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
22606     put:
22607       tags:
22608         - Network
22609       summary: see node definition for valid relationships
22610       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
22611       consumes:
22612         - application/json
22613         - application/xml
22614       produces:
22615         - application/json
22616         - application/xml
22617       responses:
22618         "default":
22619           description: Response codes found in [response codes](https://wiki.onap.org/).
22620       parameters:
22621         - name: vpn-id
22622           in: path
22623           description: VPN ID, globally unique within A&AI
22624           required: true
22625           type: string
22626           example: __VPN-ID__
22627         - name: body
22628           in: body
22629           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBinding.json)
22630           required: true
22631           schema:
22632             $ref: "#/definitions/relationship"
22633     delete:
22634       tags:
22635         - Network
22636       summary: delete an existing relationship
22637       description: delete an existing relationship
22638       operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
22639       consumes:
22640         - application/json
22641         - application/xml
22642       produces:
22643         - application/json
22644         - application/xml
22645       responses:
22646         "default":
22647           description: Response codes found in [response codes](https://wiki.onap.org/).
22648       parameters:
22649         - name: vpn-id
22650           in: path
22651           description: VPN ID, globally unique within A&AI
22652           required: true
22653           type: string
22654           example: __VPN-ID__
22655   /network/vpn-bindings/vpn-binding/{vpn-id}:
22656     get:
22657       tags:
22658         - Network
22659       summary: returns vpn-binding
22660       description: returns vpn-binding
22661       operationId: getNetworkVpnBindingsVpnBinding
22662       produces:
22663         - application/json
22664         - application/xml
22665       responses:
22666         "200":
22667           description: successful operation
22668           schema:
22669               $ref: "#/getDefinitions/vpn-binding"
22670         "default":
22671           description: Response codes found in [response codes](https://wiki.onap.org/).
22672       parameters:
22673         - name: vpn-id
22674           in: path
22675           description: VPN ID, globally unique within A&AI
22676           required: true
22677           type: string
22678           example: __VPN-ID__
22679     put:
22680       tags:
22681         - Network
22682       summary: create or update an existing vpn-binding
22683       description: |
22684         Create or update an existing vpn-binding.
22685         #
22686         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22687       operationId: createOrUpdateNetworkVpnBindingsVpnBinding
22688       consumes:
22689         - application/json
22690         - application/xml
22691       produces:
22692         - application/json
22693         - application/xml
22694       responses:
22695         "default":
22696           description: Response codes found in [response codes](https://wiki.onap.org/).
22697       parameters:
22698         - name: vpn-id
22699           in: path
22700           description: VPN ID, globally unique within A&AI
22701           required: true
22702           type: string
22703           example: __VPN-ID__
22704         - name: body
22705           in: body
22706           description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVpnBindingsVpnBinding.json)
22707           required: true
22708           schema:
22709             $ref: "#/definitions/vpn-binding"
22710     patch:
22711       tags:
22712         - Network
22713       summary: update an existing vpn-binding
22714       description: |
22715         Update an existing vpn-binding
22716         #
22717         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22718         The PUT operation will entirely replace an existing object.
22719         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22720         #
22721         Other differences between PUT and PATCH are:
22722         #
22723         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22724         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22725         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22726       operationId: UpdateNetworkVpnBindingsVpnBinding
22727       consumes:
22728         - application/json
22729         - application/xml
22730       produces:
22731         - application/json
22732         - application/xml
22733       responses:
22734         "default":
22735           description: Response codes found in [response codes](https://wiki.onap.org/).
22736       parameters:
22737         - name: vpn-id
22738           in: path
22739           description: VPN ID, globally unique within A&AI
22740           required: true
22741           type: string
22742           example: __VPN-ID__
22743         - name: body
22744           in: body
22745           description: vpn-binding object that needs to be updated.
22746           required: true
22747           schema:
22748             $ref: "#/patchDefinitions/vpn-binding"
22749     delete:
22750       tags:
22751         - Network
22752       summary: delete an existing vpn-binding
22753       description: delete an existing vpn-binding
22754       operationId: deleteNetworkVpnBindingsVpnBinding
22755       consumes:
22756         - application/json
22757         - application/xml
22758       produces:
22759         - application/json
22760         - application/xml
22761       responses:
22762         "default":
22763           description: Response codes found in [response codes](https://wiki.onap.org/).
22764       parameters:
22765         - name: vpn-id
22766           in: path
22767           description: VPN ID, globally unique within A&AI
22768           required: true
22769           type: string
22770           example: __VPN-ID__
22771         - name: resource-version
22772           in: query
22773           description: resource-version for concurrency
22774           required: true
22775           type: string
22776   /network/vpn-bindings:
22777     get:
22778       tags:
22779         - Network
22780       summary: returns vpn-bindings
22781       description: returns vpn-bindings
22782       operationId: getNetworkVpnBindings
22783       produces:
22784         - application/json
22785         - application/xml
22786       responses:
22787         "200":
22788           description: successful operation
22789           schema:
22790               $ref: "#/getDefinitions/vpn-bindings"
22791         "default":
22792           description: Response codes found in [response codes](https://wiki.onap.org/).
22793       parameters:
22794         - name: vpn-id
22795           in: query
22796           description:
22797           required: false
22798           type: string
22799         - name: vpn-name
22800           in: query
22801           description:
22802           required: false
22803           type: string
22804         - name: vpn-type
22805           in: query
22806           description:
22807           required: false
22808           type: string
22809   /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
22810     put:
22811       tags:
22812         - Network
22813       summary: see node definition for valid relationships
22814       operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
22815       consumes:
22816         - application/json
22817         - application/xml
22818       produces:
22819         - application/json
22820         - application/xml
22821       responses:
22822         "default":
22823           description: Response codes found in [response codes](https://wiki.onap.org/).
22824       parameters:
22825         - name: equipment-name
22826           in: path
22827           required: true
22828           type: string
22829           example: __EQUIPMENT-NAME__
22830         - name: body
22831           in: body
22832           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPe.json)
22833           required: true
22834           schema:
22835             $ref: "#/definitions/relationship"
22836     delete:
22837       tags:
22838         - Network
22839       summary: delete an existing relationship
22840       description: delete an existing relationship
22841       operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
22842       consumes:
22843         - application/json
22844         - application/xml
22845       produces:
22846         - application/json
22847         - application/xml
22848       responses:
22849         "default":
22850           description: Response codes found in [response codes](https://wiki.onap.org/).
22851       parameters:
22852         - name: equipment-name
22853           in: path
22854           required: true
22855           type: string
22856           example: __EQUIPMENT-NAME__
22857   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
22858     put:
22859       tags:
22860         - Network
22861       summary: see node definition for valid relationships
22862       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
22863       consumes:
22864         - application/json
22865         - application/xml
22866       produces:
22867         - application/json
22868         - application/xml
22869       responses:
22870         "default":
22871           description: Response codes found in [response codes](https://wiki.onap.org/).
22872       parameters:
22873         - name: equipment-name
22874           in: path
22875           required: true
22876           type: string
22877           example: __EQUIPMENT-NAME__
22878         - name: interface-name
22879           in: path
22880           description: Name that identifies the physical interface
22881           required: true
22882           type: string
22883           example: __INTERFACE-NAME__
22884         - name: body
22885           in: body
22886           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterface.json)
22887           required: true
22888           schema:
22889             $ref: "#/definitions/relationship"
22890     delete:
22891       tags:
22892         - Network
22893       summary: delete an existing relationship
22894       description: delete an existing relationship
22895       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
22896       consumes:
22897         - application/json
22898         - application/xml
22899       produces:
22900         - application/json
22901         - application/xml
22902       responses:
22903         "default":
22904           description: Response codes found in [response codes](https://wiki.onap.org/).
22905       parameters:
22906         - name: equipment-name
22907           in: path
22908           required: true
22909           type: string
22910           example: __EQUIPMENT-NAME__
22911         - name: interface-name
22912           in: path
22913           description: Name that identifies the physical interface
22914           required: true
22915           type: string
22916           example: __INTERFACE-NAME__
22917   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
22918     put:
22919       tags:
22920         - Network
22921       summary: see node definition for valid relationships
22922       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
22923       consumes:
22924         - application/json
22925         - application/xml
22926       produces:
22927         - application/json
22928         - application/xml
22929       responses:
22930         "default":
22931           description: Response codes found in [response codes](https://wiki.onap.org/).
22932       parameters:
22933         - name: equipment-name
22934           in: path
22935           required: true
22936           type: string
22937           example: __EQUIPMENT-NAME__
22938         - name: interface-name
22939           in: path
22940           description: Name that identifies the physical interface
22941           required: true
22942           type: string
22943           example: __INTERFACE-NAME__
22944         - name: pf-pci-id
22945           in: path
22946           description: Identifier for the sriov-pf
22947           required: true
22948           type: string
22949           example: __PF-PCI-ID__
22950         - name: body
22951           in: body
22952           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
22953           required: true
22954           schema:
22955             $ref: "#/definitions/relationship"
22956     delete:
22957       tags:
22958         - Network
22959       summary: delete an existing relationship
22960       description: delete an existing relationship
22961       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
22962       consumes:
22963         - application/json
22964         - application/xml
22965       produces:
22966         - application/json
22967         - application/xml
22968       responses:
22969         "default":
22970           description: Response codes found in [response codes](https://wiki.onap.org/).
22971       parameters:
22972         - name: equipment-name
22973           in: path
22974           required: true
22975           type: string
22976           example: __EQUIPMENT-NAME__
22977         - name: interface-name
22978           in: path
22979           description: Name that identifies the physical interface
22980           required: true
22981           type: string
22982           example: __INTERFACE-NAME__
22983         - name: pf-pci-id
22984           in: path
22985           description: Identifier for the sriov-pf
22986           required: true
22987           type: string
22988           example: __PF-PCI-ID__
22989   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
22990     get:
22991       tags:
22992         - Network
22993       summary: returns sriov-pf
22994       description: returns sriov-pf
22995       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
22996       produces:
22997         - application/json
22998         - application/xml
22999       responses:
23000         "200":
23001           description: successful operation
23002           schema:
23003               $ref: "#/getDefinitions/sriov-pf"
23004         "default":
23005           description: Response codes found in [response codes](https://wiki.onap.org/).
23006       parameters:
23007         - name: equipment-name
23008           in: path
23009           required: true
23010           type: string
23011           example: __EQUIPMENT-NAME__
23012         - name: interface-name
23013           in: path
23014           description: Name that identifies the physical interface
23015           required: true
23016           type: string
23017           example: __INTERFACE-NAME__
23018         - name: pf-pci-id
23019           in: path
23020           description: Identifier for the sriov-pf
23021           required: true
23022           type: string
23023           example: __PF-PCI-ID__
23024     put:
23025       tags:
23026         - Network
23027       summary: create or update an existing sriov-pf
23028       description: |
23029         Create or update an existing sriov-pf.
23030         #
23031         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23032       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
23033       consumes:
23034         - application/json
23035         - application/xml
23036       produces:
23037         - application/json
23038         - application/xml
23039       responses:
23040         "default":
23041           description: Response codes found in [response codes](https://wiki.onap.org/).
23042       parameters:
23043         - name: equipment-name
23044           in: path
23045           required: true
23046           type: string
23047           example: __EQUIPMENT-NAME__
23048         - name: interface-name
23049           in: path
23050           description: Name that identifies the physical interface
23051           required: true
23052           type: string
23053           example: __INTERFACE-NAME__
23054         - name: pf-pci-id
23055           in: path
23056           description: Identifier for the sriov-pf
23057           required: true
23058           type: string
23059           example: __PF-PCI-ID__
23060         - name: body
23061           in: body
23062           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
23063           required: true
23064           schema:
23065             $ref: "#/definitions/sriov-pf"
23066     patch:
23067       tags:
23068         - Network
23069       summary: update an existing sriov-pf
23070       description: |
23071         Update an existing sriov-pf
23072         #
23073         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23074         The PUT operation will entirely replace an existing object.
23075         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23076         #
23077         Other differences between PUT and PATCH are:
23078         #
23079         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23080         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23081         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23082       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
23083       consumes:
23084         - application/json
23085         - application/xml
23086       produces:
23087         - application/json
23088         - application/xml
23089       responses:
23090         "default":
23091           description: Response codes found in [response codes](https://wiki.onap.org/).
23092       parameters:
23093         - name: equipment-name
23094           in: path
23095           required: true
23096           type: string
23097           example: __EQUIPMENT-NAME__
23098         - name: interface-name
23099           in: path
23100           description: Name that identifies the physical interface
23101           required: true
23102           type: string
23103           example: __INTERFACE-NAME__
23104         - name: pf-pci-id
23105           in: path
23106           description: Identifier for the sriov-pf
23107           required: true
23108           type: string
23109           example: __PF-PCI-ID__
23110         - name: body
23111           in: body
23112           description: sriov-pf object that needs to be updated.
23113           required: true
23114           schema:
23115             $ref: "#/patchDefinitions/sriov-pf"
23116     delete:
23117       tags:
23118         - Network
23119       summary: delete an existing sriov-pf
23120       description: delete an existing sriov-pf
23121       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
23122       consumes:
23123         - application/json
23124         - application/xml
23125       produces:
23126         - application/json
23127         - application/xml
23128       responses:
23129         "default":
23130           description: Response codes found in [response codes](https://wiki.onap.org/).
23131       parameters:
23132         - name: equipment-name
23133           in: path
23134           required: true
23135           type: string
23136           example: __EQUIPMENT-NAME__
23137         - name: interface-name
23138           in: path
23139           description: Name that identifies the physical interface
23140           required: true
23141           type: string
23142           example: __INTERFACE-NAME__
23143         - name: pf-pci-id
23144           in: path
23145           description: Identifier for the sriov-pf
23146           required: true
23147           type: string
23148           example: __PF-PCI-ID__
23149         - name: resource-version
23150           in: query
23151           description: resource-version for concurrency
23152           required: true
23153           type: string
23154   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
23155     get:
23156       tags:
23157         - Network
23158       summary: returns sriov-pfs
23159       description: returns sriov-pfs
23160       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
23161       produces:
23162         - application/json
23163         - application/xml
23164       responses:
23165         "200":
23166           description: successful operation
23167           schema:
23168               $ref: "#/getDefinitions/sriov-pfs"
23169         "default":
23170           description: Response codes found in [response codes](https://wiki.onap.org/).
23171       parameters:
23172         - name: equipment-name
23173           in: path
23174           required: true
23175           type: string
23176           example: __EQUIPMENT-NAME__
23177         - name: interface-name
23178           in: path
23179           description: Name that identifies the physical interface
23180           required: true
23181           type: string
23182           example: __INTERFACE-NAME__
23183         - name: pf-pci-id
23184           in: query
23185           description:
23186           required: false
23187           type: string
23188   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
23189     put:
23190       tags:
23191         - Network
23192       summary: see node definition for valid relationships
23193       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
23194       consumes:
23195         - application/json
23196         - application/xml
23197       produces:
23198         - application/json
23199         - application/xml
23200       responses:
23201         "default":
23202           description: Response codes found in [response codes](https://wiki.onap.org/).
23203       parameters:
23204         - name: equipment-name
23205           in: path
23206           required: true
23207           type: string
23208           example: __EQUIPMENT-NAME__
23209         - name: interface-name
23210           in: path
23211           description: Name that identifies the physical interface
23212           required: true
23213           type: string
23214           example: __INTERFACE-NAME__
23215         - name: interface-name
23216           in: path
23217           description: Name given to the interface
23218           required: true
23219           type: string
23220           example: __INTERFACE-NAME__
23221         - name: vlan-interface
23222           in: path
23223           description: String that identifies the interface
23224           required: true
23225           type: string
23226           example: __VLAN-INTERFACE__
23227         - name: body
23228           in: body
23229           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
23230           required: true
23231           schema:
23232             $ref: "#/definitions/relationship"
23233     delete:
23234       tags:
23235         - Network
23236       summary: delete an existing relationship
23237       description: delete an existing relationship
23238       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
23239       consumes:
23240         - application/json
23241         - application/xml
23242       produces:
23243         - application/json
23244         - application/xml
23245       responses:
23246         "default":
23247           description: Response codes found in [response codes](https://wiki.onap.org/).
23248       parameters:
23249         - name: equipment-name
23250           in: path
23251           required: true
23252           type: string
23253           example: __EQUIPMENT-NAME__
23254         - name: interface-name
23255           in: path
23256           description: Name that identifies the physical interface
23257           required: true
23258           type: string
23259           example: __INTERFACE-NAME__
23260         - name: interface-name
23261           in: path
23262           description: Name given to the interface
23263           required: true
23264           type: string
23265           example: __INTERFACE-NAME__
23266         - name: vlan-interface
23267           in: path
23268           description: String that identifies the interface
23269           required: true
23270           type: string
23271           example: __VLAN-INTERFACE__
23272   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
23273     put:
23274       tags:
23275         - Network
23276       summary: see node definition for valid relationships
23277       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
23278       consumes:
23279         - application/json
23280         - application/xml
23281       produces:
23282         - application/json
23283         - application/xml
23284       responses:
23285         "default":
23286           description: Response codes found in [response codes](https://wiki.onap.org/).
23287       parameters:
23288         - name: equipment-name
23289           in: path
23290           required: true
23291           type: string
23292           example: __EQUIPMENT-NAME__
23293         - name: interface-name
23294           in: path
23295           description: Name that identifies the physical interface
23296           required: true
23297           type: string
23298           example: __INTERFACE-NAME__
23299         - name: interface-name
23300           in: path
23301           description: Name given to the interface
23302           required: true
23303           type: string
23304           example: __INTERFACE-NAME__
23305         - name: vlan-interface
23306           in: path
23307           description: String that identifies the interface
23308           required: true
23309           type: string
23310           example: __VLAN-INTERFACE__
23311         - name: l3-interface-ipv4-address
23312           in: path
23313           description: IP address
23314           required: true
23315           type: string
23316           example: __L3-INTERFACE-IPV4-ADDRESS__
23317         - name: body
23318           in: body
23319           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
23320           required: true
23321           schema:
23322             $ref: "#/definitions/relationship"
23323     delete:
23324       tags:
23325         - Network
23326       summary: delete an existing relationship
23327       description: delete an existing relationship
23328       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
23329       consumes:
23330         - application/json
23331         - application/xml
23332       produces:
23333         - application/json
23334         - application/xml
23335       responses:
23336         "default":
23337           description: Response codes found in [response codes](https://wiki.onap.org/).
23338       parameters:
23339         - name: equipment-name
23340           in: path
23341           required: true
23342           type: string
23343           example: __EQUIPMENT-NAME__
23344         - name: interface-name
23345           in: path
23346           description: Name that identifies the physical interface
23347           required: true
23348           type: string
23349           example: __INTERFACE-NAME__
23350         - name: interface-name
23351           in: path
23352           description: Name given to the interface
23353           required: true
23354           type: string
23355           example: __INTERFACE-NAME__
23356         - name: vlan-interface
23357           in: path
23358           description: String that identifies the interface
23359           required: true
23360           type: string
23361           example: __VLAN-INTERFACE__
23362         - name: l3-interface-ipv4-address
23363           in: path
23364           description: IP address
23365           required: true
23366           type: string
23367           example: __L3-INTERFACE-IPV4-ADDRESS__
23368   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
23369     get:
23370       tags:
23371         - Network
23372       summary: returns l3-interface-ipv4-address-list
23373       description: returns l3-interface-ipv4-address-list
23374       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23375       produces:
23376         - application/json
23377         - application/xml
23378       responses:
23379         "200":
23380           description: successful operation
23381           schema:
23382               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23383         "default":
23384           description: Response codes found in [response codes](https://wiki.onap.org/).
23385       parameters:
23386         - name: equipment-name
23387           in: path
23388           required: true
23389           type: string
23390           example: __EQUIPMENT-NAME__
23391         - name: interface-name
23392           in: path
23393           description: Name that identifies the physical interface
23394           required: true
23395           type: string
23396           example: __INTERFACE-NAME__
23397         - name: interface-name
23398           in: path
23399           description: Name given to the interface
23400           required: true
23401           type: string
23402           example: __INTERFACE-NAME__
23403         - name: vlan-interface
23404           in: path
23405           description: String that identifies the interface
23406           required: true
23407           type: string
23408           example: __VLAN-INTERFACE__
23409         - name: l3-interface-ipv4-address
23410           in: path
23411           description: IP address
23412           required: true
23413           type: string
23414           example: __L3-INTERFACE-IPV4-ADDRESS__
23415     put:
23416       tags:
23417         - Network
23418       summary: create or update an existing l3-interface-ipv4-address-list
23419       description: |
23420         Create or update an existing l3-interface-ipv4-address-list.
23421         #
23422         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23423       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23424       consumes:
23425         - application/json
23426         - application/xml
23427       produces:
23428         - application/json
23429         - application/xml
23430       responses:
23431         "default":
23432           description: Response codes found in [response codes](https://wiki.onap.org/).
23433       parameters:
23434         - name: equipment-name
23435           in: path
23436           required: true
23437           type: string
23438           example: __EQUIPMENT-NAME__
23439         - name: interface-name
23440           in: path
23441           description: Name that identifies the physical interface
23442           required: true
23443           type: string
23444           example: __INTERFACE-NAME__
23445         - name: interface-name
23446           in: path
23447           description: Name given to the interface
23448           required: true
23449           type: string
23450           example: __INTERFACE-NAME__
23451         - name: vlan-interface
23452           in: path
23453           description: String that identifies the interface
23454           required: true
23455           type: string
23456           example: __VLAN-INTERFACE__
23457         - name: l3-interface-ipv4-address
23458           in: path
23459           description: IP address
23460           required: true
23461           type: string
23462           example: __L3-INTERFACE-IPV4-ADDRESS__
23463         - name: body
23464           in: body
23465           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
23466           required: true
23467           schema:
23468             $ref: "#/definitions/l3-interface-ipv4-address-list"
23469     patch:
23470       tags:
23471         - Network
23472       summary: update an existing l3-interface-ipv4-address-list
23473       description: |
23474         Update an existing l3-interface-ipv4-address-list
23475         #
23476         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23477         The PUT operation will entirely replace an existing object.
23478         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23479         #
23480         Other differences between PUT and PATCH are:
23481         #
23482         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23483         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23484         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23485       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23486       consumes:
23487         - application/json
23488         - application/xml
23489       produces:
23490         - application/json
23491         - application/xml
23492       responses:
23493         "default":
23494           description: Response codes found in [response codes](https://wiki.onap.org/).
23495       parameters:
23496         - name: equipment-name
23497           in: path
23498           required: true
23499           type: string
23500           example: __EQUIPMENT-NAME__
23501         - name: interface-name
23502           in: path
23503           description: Name that identifies the physical interface
23504           required: true
23505           type: string
23506           example: __INTERFACE-NAME__
23507         - name: interface-name
23508           in: path
23509           description: Name given to the interface
23510           required: true
23511           type: string
23512           example: __INTERFACE-NAME__
23513         - name: vlan-interface
23514           in: path
23515           description: String that identifies the interface
23516           required: true
23517           type: string
23518           example: __VLAN-INTERFACE__
23519         - name: l3-interface-ipv4-address
23520           in: path
23521           description: IP address
23522           required: true
23523           type: string
23524           example: __L3-INTERFACE-IPV4-ADDRESS__
23525         - name: body
23526           in: body
23527           description: l3-interface-ipv4-address-list object that needs to be updated.
23528           required: true
23529           schema:
23530             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23531     delete:
23532       tags:
23533         - Network
23534       summary: delete an existing l3-interface-ipv4-address-list
23535       description: delete an existing l3-interface-ipv4-address-list
23536       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23537       consumes:
23538         - application/json
23539         - application/xml
23540       produces:
23541         - application/json
23542         - application/xml
23543       responses:
23544         "default":
23545           description: Response codes found in [response codes](https://wiki.onap.org/).
23546       parameters:
23547         - name: equipment-name
23548           in: path
23549           required: true
23550           type: string
23551           example: __EQUIPMENT-NAME__
23552         - name: interface-name
23553           in: path
23554           description: Name that identifies the physical interface
23555           required: true
23556           type: string
23557           example: __INTERFACE-NAME__
23558         - name: interface-name
23559           in: path
23560           description: Name given to the interface
23561           required: true
23562           type: string
23563           example: __INTERFACE-NAME__
23564         - name: vlan-interface
23565           in: path
23566           description: String that identifies the interface
23567           required: true
23568           type: string
23569           example: __VLAN-INTERFACE__
23570         - name: l3-interface-ipv4-address
23571           in: path
23572           description: IP address
23573           required: true
23574           type: string
23575           example: __L3-INTERFACE-IPV4-ADDRESS__
23576         - name: resource-version
23577           in: query
23578           description: resource-version for concurrency
23579           required: true
23580           type: string
23581   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
23582     put:
23583       tags:
23584         - Network
23585       summary: see node definition for valid relationships
23586       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
23587       consumes:
23588         - application/json
23589         - application/xml
23590       produces:
23591         - application/json
23592         - application/xml
23593       responses:
23594         "default":
23595           description: Response codes found in [response codes](https://wiki.onap.org/).
23596       parameters:
23597         - name: equipment-name
23598           in: path
23599           required: true
23600           type: string
23601           example: __EQUIPMENT-NAME__
23602         - name: interface-name
23603           in: path
23604           description: Name that identifies the physical interface
23605           required: true
23606           type: string
23607           example: __INTERFACE-NAME__
23608         - name: interface-name
23609           in: path
23610           description: Name given to the interface
23611           required: true
23612           type: string
23613           example: __INTERFACE-NAME__
23614         - name: vlan-interface
23615           in: path
23616           description: String that identifies the interface
23617           required: true
23618           type: string
23619           example: __VLAN-INTERFACE__
23620         - name: l3-interface-ipv6-address
23621           in: path
23622           description: IP address
23623           required: true
23624           type: string
23625           example: __L3-INTERFACE-IPV6-ADDRESS__
23626         - name: body
23627           in: body
23628           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
23629           required: true
23630           schema:
23631             $ref: "#/definitions/relationship"
23632     delete:
23633       tags:
23634         - Network
23635       summary: delete an existing relationship
23636       description: delete an existing relationship
23637       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
23638       consumes:
23639         - application/json
23640         - application/xml
23641       produces:
23642         - application/json
23643         - application/xml
23644       responses:
23645         "default":
23646           description: Response codes found in [response codes](https://wiki.onap.org/).
23647       parameters:
23648         - name: equipment-name
23649           in: path
23650           required: true
23651           type: string
23652           example: __EQUIPMENT-NAME__
23653         - name: interface-name
23654           in: path
23655           description: Name that identifies the physical interface
23656           required: true
23657           type: string
23658           example: __INTERFACE-NAME__
23659         - name: interface-name
23660           in: path
23661           description: Name given to the interface
23662           required: true
23663           type: string
23664           example: __INTERFACE-NAME__
23665         - name: vlan-interface
23666           in: path
23667           description: String that identifies the interface
23668           required: true
23669           type: string
23670           example: __VLAN-INTERFACE__
23671         - name: l3-interface-ipv6-address
23672           in: path
23673           description: IP address
23674           required: true
23675           type: string
23676           example: __L3-INTERFACE-IPV6-ADDRESS__
23677   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
23678     get:
23679       tags:
23680         - Network
23681       summary: returns l3-interface-ipv6-address-list
23682       description: returns l3-interface-ipv6-address-list
23683       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23684       produces:
23685         - application/json
23686         - application/xml
23687       responses:
23688         "200":
23689           description: successful operation
23690           schema:
23691               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23692         "default":
23693           description: Response codes found in [response codes](https://wiki.onap.org/).
23694       parameters:
23695         - name: equipment-name
23696           in: path
23697           required: true
23698           type: string
23699           example: __EQUIPMENT-NAME__
23700         - name: interface-name
23701           in: path
23702           description: Name that identifies the physical interface
23703           required: true
23704           type: string
23705           example: __INTERFACE-NAME__
23706         - name: interface-name
23707           in: path
23708           description: Name given to the interface
23709           required: true
23710           type: string
23711           example: __INTERFACE-NAME__
23712         - name: vlan-interface
23713           in: path
23714           description: String that identifies the interface
23715           required: true
23716           type: string
23717           example: __VLAN-INTERFACE__
23718         - name: l3-interface-ipv6-address
23719           in: path
23720           description: IP address
23721           required: true
23722           type: string
23723           example: __L3-INTERFACE-IPV6-ADDRESS__
23724     put:
23725       tags:
23726         - Network
23727       summary: create or update an existing l3-interface-ipv6-address-list
23728       description: |
23729         Create or update an existing l3-interface-ipv6-address-list.
23730         #
23731         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23732       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23733       consumes:
23734         - application/json
23735         - application/xml
23736       produces:
23737         - application/json
23738         - application/xml
23739       responses:
23740         "default":
23741           description: Response codes found in [response codes](https://wiki.onap.org/).
23742       parameters:
23743         - name: equipment-name
23744           in: path
23745           required: true
23746           type: string
23747           example: __EQUIPMENT-NAME__
23748         - name: interface-name
23749           in: path
23750           description: Name that identifies the physical interface
23751           required: true
23752           type: string
23753           example: __INTERFACE-NAME__
23754         - name: interface-name
23755           in: path
23756           description: Name given to the interface
23757           required: true
23758           type: string
23759           example: __INTERFACE-NAME__
23760         - name: vlan-interface
23761           in: path
23762           description: String that identifies the interface
23763           required: true
23764           type: string
23765           example: __VLAN-INTERFACE__
23766         - name: l3-interface-ipv6-address
23767           in: path
23768           description: IP address
23769           required: true
23770           type: string
23771           example: __L3-INTERFACE-IPV6-ADDRESS__
23772         - name: body
23773           in: body
23774           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
23775           required: true
23776           schema:
23777             $ref: "#/definitions/l3-interface-ipv6-address-list"
23778     patch:
23779       tags:
23780         - Network
23781       summary: update an existing l3-interface-ipv6-address-list
23782       description: |
23783         Update an existing l3-interface-ipv6-address-list
23784         #
23785         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23786         The PUT operation will entirely replace an existing object.
23787         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23788         #
23789         Other differences between PUT and PATCH are:
23790         #
23791         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23792         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23793         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23794       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23795       consumes:
23796         - application/json
23797         - application/xml
23798       produces:
23799         - application/json
23800         - application/xml
23801       responses:
23802         "default":
23803           description: Response codes found in [response codes](https://wiki.onap.org/).
23804       parameters:
23805         - name: equipment-name
23806           in: path
23807           required: true
23808           type: string
23809           example: __EQUIPMENT-NAME__
23810         - name: interface-name
23811           in: path
23812           description: Name that identifies the physical interface
23813           required: true
23814           type: string
23815           example: __INTERFACE-NAME__
23816         - name: interface-name
23817           in: path
23818           description: Name given to the interface
23819           required: true
23820           type: string
23821           example: __INTERFACE-NAME__
23822         - name: vlan-interface
23823           in: path
23824           description: String that identifies the interface
23825           required: true
23826           type: string
23827           example: __VLAN-INTERFACE__
23828         - name: l3-interface-ipv6-address
23829           in: path
23830           description: IP address
23831           required: true
23832           type: string
23833           example: __L3-INTERFACE-IPV6-ADDRESS__
23834         - name: body
23835           in: body
23836           description: l3-interface-ipv6-address-list object that needs to be updated.
23837           required: true
23838           schema:
23839             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23840     delete:
23841       tags:
23842         - Network
23843       summary: delete an existing l3-interface-ipv6-address-list
23844       description: delete an existing l3-interface-ipv6-address-list
23845       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23846       consumes:
23847         - application/json
23848         - application/xml
23849       produces:
23850         - application/json
23851         - application/xml
23852       responses:
23853         "default":
23854           description: Response codes found in [response codes](https://wiki.onap.org/).
23855       parameters:
23856         - name: equipment-name
23857           in: path
23858           required: true
23859           type: string
23860           example: __EQUIPMENT-NAME__
23861         - name: interface-name
23862           in: path
23863           description: Name that identifies the physical interface
23864           required: true
23865           type: string
23866           example: __INTERFACE-NAME__
23867         - name: interface-name
23868           in: path
23869           description: Name given to the interface
23870           required: true
23871           type: string
23872           example: __INTERFACE-NAME__
23873         - name: vlan-interface
23874           in: path
23875           description: String that identifies the interface
23876           required: true
23877           type: string
23878           example: __VLAN-INTERFACE__
23879         - name: l3-interface-ipv6-address
23880           in: path
23881           description: IP address
23882           required: true
23883           type: string
23884           example: __L3-INTERFACE-IPV6-ADDRESS__
23885         - name: resource-version
23886           in: query
23887           description: resource-version for concurrency
23888           required: true
23889           type: string
23890   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
23891     get:
23892       tags:
23893         - Network
23894       summary: returns vlan
23895       description: returns vlan
23896       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
23897       produces:
23898         - application/json
23899         - application/xml
23900       responses:
23901         "200":
23902           description: successful operation
23903           schema:
23904               $ref: "#/getDefinitions/vlan"
23905         "default":
23906           description: Response codes found in [response codes](https://wiki.onap.org/).
23907       parameters:
23908         - name: equipment-name
23909           in: path
23910           required: true
23911           type: string
23912           example: __EQUIPMENT-NAME__
23913         - name: interface-name
23914           in: path
23915           description: Name that identifies the physical interface
23916           required: true
23917           type: string
23918           example: __INTERFACE-NAME__
23919         - name: interface-name
23920           in: path
23921           description: Name given to the interface
23922           required: true
23923           type: string
23924           example: __INTERFACE-NAME__
23925         - name: vlan-interface
23926           in: path
23927           description: String that identifies the interface
23928           required: true
23929           type: string
23930           example: __VLAN-INTERFACE__
23931     put:
23932       tags:
23933         - Network
23934       summary: create or update an existing vlan
23935       description: |
23936         Create or update an existing vlan.
23937         #
23938         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23939       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
23940       consumes:
23941         - application/json
23942         - application/xml
23943       produces:
23944         - application/json
23945         - application/xml
23946       responses:
23947         "default":
23948           description: Response codes found in [response codes](https://wiki.onap.org/).
23949       parameters:
23950         - name: equipment-name
23951           in: path
23952           required: true
23953           type: string
23954           example: __EQUIPMENT-NAME__
23955         - name: interface-name
23956           in: path
23957           description: Name that identifies the physical interface
23958           required: true
23959           type: string
23960           example: __INTERFACE-NAME__
23961         - name: interface-name
23962           in: path
23963           description: Name given to the interface
23964           required: true
23965           type: string
23966           example: __INTERFACE-NAME__
23967         - name: vlan-interface
23968           in: path
23969           description: String that identifies the interface
23970           required: true
23971           type: string
23972           example: __VLAN-INTERFACE__
23973         - name: body
23974           in: body
23975           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
23976           required: true
23977           schema:
23978             $ref: "#/definitions/vlan"
23979     patch:
23980       tags:
23981         - Network
23982       summary: update an existing vlan
23983       description: |
23984         Update an existing vlan
23985         #
23986         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23987         The PUT operation will entirely replace an existing object.
23988         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23989         #
23990         Other differences between PUT and PATCH are:
23991         #
23992         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23993         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23994         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23995       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
23996       consumes:
23997         - application/json
23998         - application/xml
23999       produces:
24000         - application/json
24001         - application/xml
24002       responses:
24003         "default":
24004           description: Response codes found in [response codes](https://wiki.onap.org/).
24005       parameters:
24006         - name: equipment-name
24007           in: path
24008           required: true
24009           type: string
24010           example: __EQUIPMENT-NAME__
24011         - name: interface-name
24012           in: path
24013           description: Name that identifies the physical interface
24014           required: true
24015           type: string
24016           example: __INTERFACE-NAME__
24017         - name: interface-name
24018           in: path
24019           description: Name given to the interface
24020           required: true
24021           type: string
24022           example: __INTERFACE-NAME__
24023         - name: vlan-interface
24024           in: path
24025           description: String that identifies the interface
24026           required: true
24027           type: string
24028           example: __VLAN-INTERFACE__
24029         - name: body
24030           in: body
24031           description: vlan object that needs to be updated.
24032           required: true
24033           schema:
24034             $ref: "#/patchDefinitions/vlan"
24035     delete:
24036       tags:
24037         - Network
24038       summary: delete an existing vlan
24039       description: delete an existing vlan
24040       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
24041       consumes:
24042         - application/json
24043         - application/xml
24044       produces:
24045         - application/json
24046         - application/xml
24047       responses:
24048         "default":
24049           description: Response codes found in [response codes](https://wiki.onap.org/).
24050       parameters:
24051         - name: equipment-name
24052           in: path
24053           required: true
24054           type: string
24055           example: __EQUIPMENT-NAME__
24056         - name: interface-name
24057           in: path
24058           description: Name that identifies the physical interface
24059           required: true
24060           type: string
24061           example: __INTERFACE-NAME__
24062         - name: interface-name
24063           in: path
24064           description: Name given to the interface
24065           required: true
24066           type: string
24067           example: __INTERFACE-NAME__
24068         - name: vlan-interface
24069           in: path
24070           description: String that identifies the interface
24071           required: true
24072           type: string
24073           example: __VLAN-INTERFACE__
24074         - name: resource-version
24075           in: query
24076           description: resource-version for concurrency
24077           required: true
24078           type: string
24079   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
24080     get:
24081       tags:
24082         - Network
24083       summary: returns vlans
24084       description: returns vlans
24085       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
24086       produces:
24087         - application/json
24088         - application/xml
24089       responses:
24090         "200":
24091           description: successful operation
24092           schema:
24093               $ref: "#/getDefinitions/vlans"
24094         "default":
24095           description: Response codes found in [response codes](https://wiki.onap.org/).
24096       parameters:
24097         - name: equipment-name
24098           in: path
24099           required: true
24100           type: string
24101           example: __EQUIPMENT-NAME__
24102         - name: interface-name
24103           in: path
24104           description: Name that identifies the physical interface
24105           required: true
24106           type: string
24107           example: __INTERFACE-NAME__
24108         - name: interface-name
24109           in: path
24110           description: Name given to the interface
24111           required: true
24112           type: string
24113           example: __INTERFACE-NAME__
24114         - name: vlan-interface
24115           in: query
24116           description:
24117           required: false
24118           type: string
24119         - name: vlan-id-inner
24120           in: query
24121           description:
24122           required: false
24123           type: integer
24124           format: int64
24125         - name: vpn-key
24126           in: query
24127           description:
24128           required: false
24129           type: string
24130   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
24131     put:
24132       tags:
24133         - Network
24134       summary: see node definition for valid relationships
24135       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
24136       consumes:
24137         - application/json
24138         - application/xml
24139       produces:
24140         - application/json
24141         - application/xml
24142       responses:
24143         "default":
24144           description: Response codes found in [response codes](https://wiki.onap.org/).
24145       parameters:
24146         - name: equipment-name
24147           in: path
24148           required: true
24149           type: string
24150           example: __EQUIPMENT-NAME__
24151         - name: interface-name
24152           in: path
24153           description: Name that identifies the physical interface
24154           required: true
24155           type: string
24156           example: __INTERFACE-NAME__
24157         - name: interface-name
24158           in: path
24159           description: Name given to the interface
24160           required: true
24161           type: string
24162           example: __INTERFACE-NAME__
24163         - name: pci-id
24164           in: path
24165           description: PCI ID used to identify the sriov-vf
24166           required: true
24167           type: string
24168           example: __PCI-ID__
24169         - name: body
24170           in: body
24171           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
24172           required: true
24173           schema:
24174             $ref: "#/definitions/relationship"
24175     delete:
24176       tags:
24177         - Network
24178       summary: delete an existing relationship
24179       description: delete an existing relationship
24180       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
24181       consumes:
24182         - application/json
24183         - application/xml
24184       produces:
24185         - application/json
24186         - application/xml
24187       responses:
24188         "default":
24189           description: Response codes found in [response codes](https://wiki.onap.org/).
24190       parameters:
24191         - name: equipment-name
24192           in: path
24193           required: true
24194           type: string
24195           example: __EQUIPMENT-NAME__
24196         - name: interface-name
24197           in: path
24198           description: Name that identifies the physical interface
24199           required: true
24200           type: string
24201           example: __INTERFACE-NAME__
24202         - name: interface-name
24203           in: path
24204           description: Name given to the interface
24205           required: true
24206           type: string
24207           example: __INTERFACE-NAME__
24208         - name: pci-id
24209           in: path
24210           description: PCI ID used to identify the sriov-vf
24211           required: true
24212           type: string
24213           example: __PCI-ID__
24214   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
24215     get:
24216       tags:
24217         - Network
24218       summary: returns sriov-vf
24219       description: returns sriov-vf
24220       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
24221       produces:
24222         - application/json
24223         - application/xml
24224       responses:
24225         "200":
24226           description: successful operation
24227           schema:
24228               $ref: "#/getDefinitions/sriov-vf"
24229         "default":
24230           description: Response codes found in [response codes](https://wiki.onap.org/).
24231       parameters:
24232         - name: equipment-name
24233           in: path
24234           required: true
24235           type: string
24236           example: __EQUIPMENT-NAME__
24237         - name: interface-name
24238           in: path
24239           description: Name that identifies the physical interface
24240           required: true
24241           type: string
24242           example: __INTERFACE-NAME__
24243         - name: interface-name
24244           in: path
24245           description: Name given to the interface
24246           required: true
24247           type: string
24248           example: __INTERFACE-NAME__
24249         - name: pci-id
24250           in: path
24251           description: PCI ID used to identify the sriov-vf
24252           required: true
24253           type: string
24254           example: __PCI-ID__
24255     put:
24256       tags:
24257         - Network
24258       summary: create or update an existing sriov-vf
24259       description: |
24260         Create or update an existing sriov-vf.
24261         #
24262         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24263       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
24264       consumes:
24265         - application/json
24266         - application/xml
24267       produces:
24268         - application/json
24269         - application/xml
24270       responses:
24271         "default":
24272           description: Response codes found in [response codes](https://wiki.onap.org/).
24273       parameters:
24274         - name: equipment-name
24275           in: path
24276           required: true
24277           type: string
24278           example: __EQUIPMENT-NAME__
24279         - name: interface-name
24280           in: path
24281           description: Name that identifies the physical interface
24282           required: true
24283           type: string
24284           example: __INTERFACE-NAME__
24285         - name: interface-name
24286           in: path
24287           description: Name given to the interface
24288           required: true
24289           type: string
24290           example: __INTERFACE-NAME__
24291         - name: pci-id
24292           in: path
24293           description: PCI ID used to identify the sriov-vf
24294           required: true
24295           type: string
24296           example: __PCI-ID__
24297         - name: body
24298           in: body
24299           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
24300           required: true
24301           schema:
24302             $ref: "#/definitions/sriov-vf"
24303     patch:
24304       tags:
24305         - Network
24306       summary: update an existing sriov-vf
24307       description: |
24308         Update an existing sriov-vf
24309         #
24310         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24311         The PUT operation will entirely replace an existing object.
24312         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24313         #
24314         Other differences between PUT and PATCH are:
24315         #
24316         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24317         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24318         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24319       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
24320       consumes:
24321         - application/json
24322         - application/xml
24323       produces:
24324         - application/json
24325         - application/xml
24326       responses:
24327         "default":
24328           description: Response codes found in [response codes](https://wiki.onap.org/).
24329       parameters:
24330         - name: equipment-name
24331           in: path
24332           required: true
24333           type: string
24334           example: __EQUIPMENT-NAME__
24335         - name: interface-name
24336           in: path
24337           description: Name that identifies the physical interface
24338           required: true
24339           type: string
24340           example: __INTERFACE-NAME__
24341         - name: interface-name
24342           in: path
24343           description: Name given to the interface
24344           required: true
24345           type: string
24346           example: __INTERFACE-NAME__
24347         - name: pci-id
24348           in: path
24349           description: PCI ID used to identify the sriov-vf
24350           required: true
24351           type: string
24352           example: __PCI-ID__
24353         - name: body
24354           in: body
24355           description: sriov-vf object that needs to be updated.
24356           required: true
24357           schema:
24358             $ref: "#/patchDefinitions/sriov-vf"
24359     delete:
24360       tags:
24361         - Network
24362       summary: delete an existing sriov-vf
24363       description: delete an existing sriov-vf
24364       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
24365       consumes:
24366         - application/json
24367         - application/xml
24368       produces:
24369         - application/json
24370         - application/xml
24371       responses:
24372         "default":
24373           description: Response codes found in [response codes](https://wiki.onap.org/).
24374       parameters:
24375         - name: equipment-name
24376           in: path
24377           required: true
24378           type: string
24379           example: __EQUIPMENT-NAME__
24380         - name: interface-name
24381           in: path
24382           description: Name that identifies the physical interface
24383           required: true
24384           type: string
24385           example: __INTERFACE-NAME__
24386         - name: interface-name
24387           in: path
24388           description: Name given to the interface
24389           required: true
24390           type: string
24391           example: __INTERFACE-NAME__
24392         - name: pci-id
24393           in: path
24394           description: PCI ID used to identify the sriov-vf
24395           required: true
24396           type: string
24397           example: __PCI-ID__
24398         - name: resource-version
24399           in: query
24400           description: resource-version for concurrency
24401           required: true
24402           type: string
24403   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
24404     get:
24405       tags:
24406         - Network
24407       summary: returns sriov-vfs
24408       description: returns sriov-vfs
24409       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
24410       produces:
24411         - application/json
24412         - application/xml
24413       responses:
24414         "200":
24415           description: successful operation
24416           schema:
24417               $ref: "#/getDefinitions/sriov-vfs"
24418         "default":
24419           description: Response codes found in [response codes](https://wiki.onap.org/).
24420       parameters:
24421         - name: equipment-name
24422           in: path
24423           required: true
24424           type: string
24425           example: __EQUIPMENT-NAME__
24426         - name: interface-name
24427           in: path
24428           description: Name that identifies the physical interface
24429           required: true
24430           type: string
24431           example: __INTERFACE-NAME__
24432         - name: interface-name
24433           in: path
24434           description: Name given to the interface
24435           required: true
24436           type: string
24437           example: __INTERFACE-NAME__
24438         - name: pci-id
24439           in: query
24440           description:
24441           required: false
24442           type: string
24443         - name: vf-vlan-filter
24444           in: query
24445           description:
24446           required: false
24447           type: string
24448         - name: vf-mac-filter
24449           in: query
24450           description:
24451           required: false
24452           type: string
24453         - name: vf-vlan-strip
24454           in: query
24455           description:
24456           required: false
24457           type: boolean
24458         - name: neutron-network-id
24459           in: query
24460           description:
24461           required: false
24462           type: string
24463   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
24464     put:
24465       tags:
24466         - Network
24467       summary: see node definition for valid relationships
24468       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
24469       consumes:
24470         - application/json
24471         - application/xml
24472       produces:
24473         - application/json
24474         - application/xml
24475       responses:
24476         "default":
24477           description: Response codes found in [response codes](https://wiki.onap.org/).
24478       parameters:
24479         - name: equipment-name
24480           in: path
24481           required: true
24482           type: string
24483           example: __EQUIPMENT-NAME__
24484         - name: interface-name
24485           in: path
24486           description: Name that identifies the physical interface
24487           required: true
24488           type: string
24489           example: __INTERFACE-NAME__
24490         - name: interface-name
24491           in: path
24492           description: Name given to the interface
24493           required: true
24494           type: string
24495           example: __INTERFACE-NAME__
24496         - name: body
24497           in: body
24498           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
24499           required: true
24500           schema:
24501             $ref: "#/definitions/relationship"
24502     delete:
24503       tags:
24504         - Network
24505       summary: delete an existing relationship
24506       description: delete an existing relationship
24507       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
24508       consumes:
24509         - application/json
24510         - application/xml
24511       produces:
24512         - application/json
24513         - application/xml
24514       responses:
24515         "default":
24516           description: Response codes found in [response codes](https://wiki.onap.org/).
24517       parameters:
24518         - name: equipment-name
24519           in: path
24520           required: true
24521           type: string
24522           example: __EQUIPMENT-NAME__
24523         - name: interface-name
24524           in: path
24525           description: Name that identifies the physical interface
24526           required: true
24527           type: string
24528           example: __INTERFACE-NAME__
24529         - name: interface-name
24530           in: path
24531           description: Name given to the interface
24532           required: true
24533           type: string
24534           example: __INTERFACE-NAME__
24535   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
24536     put:
24537       tags:
24538         - Network
24539       summary: see node definition for valid relationships
24540       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
24541       consumes:
24542         - application/json
24543         - application/xml
24544       produces:
24545         - application/json
24546         - application/xml
24547       responses:
24548         "default":
24549           description: Response codes found in [response codes](https://wiki.onap.org/).
24550       parameters:
24551         - name: equipment-name
24552           in: path
24553           required: true
24554           type: string
24555           example: __EQUIPMENT-NAME__
24556         - name: interface-name
24557           in: path
24558           description: Name that identifies the physical interface
24559           required: true
24560           type: string
24561           example: __INTERFACE-NAME__
24562         - name: interface-name
24563           in: path
24564           description: Name given to the interface
24565           required: true
24566           type: string
24567           example: __INTERFACE-NAME__
24568         - name: l3-interface-ipv4-address
24569           in: path
24570           description: IP address
24571           required: true
24572           type: string
24573           example: __L3-INTERFACE-IPV4-ADDRESS__
24574         - name: body
24575           in: body
24576           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
24577           required: true
24578           schema:
24579             $ref: "#/definitions/relationship"
24580     delete:
24581       tags:
24582         - Network
24583       summary: delete an existing relationship
24584       description: delete an existing relationship
24585       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
24586       consumes:
24587         - application/json
24588         - application/xml
24589       produces:
24590         - application/json
24591         - application/xml
24592       responses:
24593         "default":
24594           description: Response codes found in [response codes](https://wiki.onap.org/).
24595       parameters:
24596         - name: equipment-name
24597           in: path
24598           required: true
24599           type: string
24600           example: __EQUIPMENT-NAME__
24601         - name: interface-name
24602           in: path
24603           description: Name that identifies the physical interface
24604           required: true
24605           type: string
24606           example: __INTERFACE-NAME__
24607         - name: interface-name
24608           in: path
24609           description: Name given to the interface
24610           required: true
24611           type: string
24612           example: __INTERFACE-NAME__
24613         - name: l3-interface-ipv4-address
24614           in: path
24615           description: IP address
24616           required: true
24617           type: string
24618           example: __L3-INTERFACE-IPV4-ADDRESS__
24619   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
24620     get:
24621       tags:
24622         - Network
24623       summary: returns l3-interface-ipv4-address-list
24624       description: returns l3-interface-ipv4-address-list
24625       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24626       produces:
24627         - application/json
24628         - application/xml
24629       responses:
24630         "200":
24631           description: successful operation
24632           schema:
24633               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24634         "default":
24635           description: Response codes found in [response codes](https://wiki.onap.org/).
24636       parameters:
24637         - name: equipment-name
24638           in: path
24639           required: true
24640           type: string
24641           example: __EQUIPMENT-NAME__
24642         - name: interface-name
24643           in: path
24644           description: Name that identifies the physical interface
24645           required: true
24646           type: string
24647           example: __INTERFACE-NAME__
24648         - name: interface-name
24649           in: path
24650           description: Name given to the interface
24651           required: true
24652           type: string
24653           example: __INTERFACE-NAME__
24654         - name: l3-interface-ipv4-address
24655           in: path
24656           description: IP address
24657           required: true
24658           type: string
24659           example: __L3-INTERFACE-IPV4-ADDRESS__
24660     put:
24661       tags:
24662         - Network
24663       summary: create or update an existing l3-interface-ipv4-address-list
24664       description: |
24665         Create or update an existing l3-interface-ipv4-address-list.
24666         #
24667         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24668       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24669       consumes:
24670         - application/json
24671         - application/xml
24672       produces:
24673         - application/json
24674         - application/xml
24675       responses:
24676         "default":
24677           description: Response codes found in [response codes](https://wiki.onap.org/).
24678       parameters:
24679         - name: equipment-name
24680           in: path
24681           required: true
24682           type: string
24683           example: __EQUIPMENT-NAME__
24684         - name: interface-name
24685           in: path
24686           description: Name that identifies the physical interface
24687           required: true
24688           type: string
24689           example: __INTERFACE-NAME__
24690         - name: interface-name
24691           in: path
24692           description: Name given to the interface
24693           required: true
24694           type: string
24695           example: __INTERFACE-NAME__
24696         - name: l3-interface-ipv4-address
24697           in: path
24698           description: IP address
24699           required: true
24700           type: string
24701           example: __L3-INTERFACE-IPV4-ADDRESS__
24702         - name: body
24703           in: body
24704           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
24705           required: true
24706           schema:
24707             $ref: "#/definitions/l3-interface-ipv4-address-list"
24708     patch:
24709       tags:
24710         - Network
24711       summary: update an existing l3-interface-ipv4-address-list
24712       description: |
24713         Update an existing l3-interface-ipv4-address-list
24714         #
24715         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24716         The PUT operation will entirely replace an existing object.
24717         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24718         #
24719         Other differences between PUT and PATCH are:
24720         #
24721         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24722         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24723         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24724       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24725       consumes:
24726         - application/json
24727         - application/xml
24728       produces:
24729         - application/json
24730         - application/xml
24731       responses:
24732         "default":
24733           description: Response codes found in [response codes](https://wiki.onap.org/).
24734       parameters:
24735         - name: equipment-name
24736           in: path
24737           required: true
24738           type: string
24739           example: __EQUIPMENT-NAME__
24740         - name: interface-name
24741           in: path
24742           description: Name that identifies the physical interface
24743           required: true
24744           type: string
24745           example: __INTERFACE-NAME__
24746         - name: interface-name
24747           in: path
24748           description: Name given to the interface
24749           required: true
24750           type: string
24751           example: __INTERFACE-NAME__
24752         - name: l3-interface-ipv4-address
24753           in: path
24754           description: IP address
24755           required: true
24756           type: string
24757           example: __L3-INTERFACE-IPV4-ADDRESS__
24758         - name: body
24759           in: body
24760           description: l3-interface-ipv4-address-list object that needs to be updated.
24761           required: true
24762           schema:
24763             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24764     delete:
24765       tags:
24766         - Network
24767       summary: delete an existing l3-interface-ipv4-address-list
24768       description: delete an existing l3-interface-ipv4-address-list
24769       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24770       consumes:
24771         - application/json
24772         - application/xml
24773       produces:
24774         - application/json
24775         - application/xml
24776       responses:
24777         "default":
24778           description: Response codes found in [response codes](https://wiki.onap.org/).
24779       parameters:
24780         - name: equipment-name
24781           in: path
24782           required: true
24783           type: string
24784           example: __EQUIPMENT-NAME__
24785         - name: interface-name
24786           in: path
24787           description: Name that identifies the physical interface
24788           required: true
24789           type: string
24790           example: __INTERFACE-NAME__
24791         - name: interface-name
24792           in: path
24793           description: Name given to the interface
24794           required: true
24795           type: string
24796           example: __INTERFACE-NAME__
24797         - name: l3-interface-ipv4-address
24798           in: path
24799           description: IP address
24800           required: true
24801           type: string
24802           example: __L3-INTERFACE-IPV4-ADDRESS__
24803         - name: resource-version
24804           in: query
24805           description: resource-version for concurrency
24806           required: true
24807           type: string
24808   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
24809     put:
24810       tags:
24811         - Network
24812       summary: see node definition for valid relationships
24813       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
24814       consumes:
24815         - application/json
24816         - application/xml
24817       produces:
24818         - application/json
24819         - application/xml
24820       responses:
24821         "default":
24822           description: Response codes found in [response codes](https://wiki.onap.org/).
24823       parameters:
24824         - name: equipment-name
24825           in: path
24826           required: true
24827           type: string
24828           example: __EQUIPMENT-NAME__
24829         - name: interface-name
24830           in: path
24831           description: Name that identifies the physical interface
24832           required: true
24833           type: string
24834           example: __INTERFACE-NAME__
24835         - name: interface-name
24836           in: path
24837           description: Name given to the interface
24838           required: true
24839           type: string
24840           example: __INTERFACE-NAME__
24841         - name: l3-interface-ipv6-address
24842           in: path
24843           description: IP address
24844           required: true
24845           type: string
24846           example: __L3-INTERFACE-IPV6-ADDRESS__
24847         - name: body
24848           in: body
24849           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
24850           required: true
24851           schema:
24852             $ref: "#/definitions/relationship"
24853     delete:
24854       tags:
24855         - Network
24856       summary: delete an existing relationship
24857       description: delete an existing relationship
24858       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
24859       consumes:
24860         - application/json
24861         - application/xml
24862       produces:
24863         - application/json
24864         - application/xml
24865       responses:
24866         "default":
24867           description: Response codes found in [response codes](https://wiki.onap.org/).
24868       parameters:
24869         - name: equipment-name
24870           in: path
24871           required: true
24872           type: string
24873           example: __EQUIPMENT-NAME__
24874         - name: interface-name
24875           in: path
24876           description: Name that identifies the physical interface
24877           required: true
24878           type: string
24879           example: __INTERFACE-NAME__
24880         - name: interface-name
24881           in: path
24882           description: Name given to the interface
24883           required: true
24884           type: string
24885           example: __INTERFACE-NAME__
24886         - name: l3-interface-ipv6-address
24887           in: path
24888           description: IP address
24889           required: true
24890           type: string
24891           example: __L3-INTERFACE-IPV6-ADDRESS__
24892   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
24893     get:
24894       tags:
24895         - Network
24896       summary: returns l3-interface-ipv6-address-list
24897       description: returns l3-interface-ipv6-address-list
24898       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24899       produces:
24900         - application/json
24901         - application/xml
24902       responses:
24903         "200":
24904           description: successful operation
24905           schema:
24906               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
24907         "default":
24908           description: Response codes found in [response codes](https://wiki.onap.org/).
24909       parameters:
24910         - name: equipment-name
24911           in: path
24912           required: true
24913           type: string
24914           example: __EQUIPMENT-NAME__
24915         - name: interface-name
24916           in: path
24917           description: Name that identifies the physical interface
24918           required: true
24919           type: string
24920           example: __INTERFACE-NAME__
24921         - name: interface-name
24922           in: path
24923           description: Name given to the interface
24924           required: true
24925           type: string
24926           example: __INTERFACE-NAME__
24927         - name: l3-interface-ipv6-address
24928           in: path
24929           description: IP address
24930           required: true
24931           type: string
24932           example: __L3-INTERFACE-IPV6-ADDRESS__
24933     put:
24934       tags:
24935         - Network
24936       summary: create or update an existing l3-interface-ipv6-address-list
24937       description: |
24938         Create or update an existing l3-interface-ipv6-address-list.
24939         #
24940         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24941       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24942       consumes:
24943         - application/json
24944         - application/xml
24945       produces:
24946         - application/json
24947         - application/xml
24948       responses:
24949         "default":
24950           description: Response codes found in [response codes](https://wiki.onap.org/).
24951       parameters:
24952         - name: equipment-name
24953           in: path
24954           required: true
24955           type: string
24956           example: __EQUIPMENT-NAME__
24957         - name: interface-name
24958           in: path
24959           description: Name that identifies the physical interface
24960           required: true
24961           type: string
24962           example: __INTERFACE-NAME__
24963         - name: interface-name
24964           in: path
24965           description: Name given to the interface
24966           required: true
24967           type: string
24968           example: __INTERFACE-NAME__
24969         - name: l3-interface-ipv6-address
24970           in: path
24971           description: IP address
24972           required: true
24973           type: string
24974           example: __L3-INTERFACE-IPV6-ADDRESS__
24975         - name: body
24976           in: body
24977           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
24978           required: true
24979           schema:
24980             $ref: "#/definitions/l3-interface-ipv6-address-list"
24981     patch:
24982       tags:
24983         - Network
24984       summary: update an existing l3-interface-ipv6-address-list
24985       description: |
24986         Update an existing l3-interface-ipv6-address-list
24987         #
24988         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24989         The PUT operation will entirely replace an existing object.
24990         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24991         #
24992         Other differences between PUT and PATCH are:
24993         #
24994         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24995         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24996         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24997       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24998       consumes:
24999         - application/json
25000         - application/xml
25001       produces:
25002         - application/json
25003         - application/xml
25004       responses:
25005         "default":
25006           description: Response codes found in [response codes](https://wiki.onap.org/).
25007       parameters:
25008         - name: equipment-name
25009           in: path
25010           required: true
25011           type: string
25012           example: __EQUIPMENT-NAME__
25013         - name: interface-name
25014           in: path
25015           description: Name that identifies the physical interface
25016           required: true
25017           type: string
25018           example: __INTERFACE-NAME__
25019         - name: interface-name
25020           in: path
25021           description: Name given to the interface
25022           required: true
25023           type: string
25024           example: __INTERFACE-NAME__
25025         - name: l3-interface-ipv6-address
25026           in: path
25027           description: IP address
25028           required: true
25029           type: string
25030           example: __L3-INTERFACE-IPV6-ADDRESS__
25031         - name: body
25032           in: body
25033           description: l3-interface-ipv6-address-list object that needs to be updated.
25034           required: true
25035           schema:
25036             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25037     delete:
25038       tags:
25039         - Network
25040       summary: delete an existing l3-interface-ipv6-address-list
25041       description: delete an existing l3-interface-ipv6-address-list
25042       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
25043       consumes:
25044         - application/json
25045         - application/xml
25046       produces:
25047         - application/json
25048         - application/xml
25049       responses:
25050         "default":
25051           description: Response codes found in [response codes](https://wiki.onap.org/).
25052       parameters:
25053         - name: equipment-name
25054           in: path
25055           required: true
25056           type: string
25057           example: __EQUIPMENT-NAME__
25058         - name: interface-name
25059           in: path
25060           description: Name that identifies the physical interface
25061           required: true
25062           type: string
25063           example: __INTERFACE-NAME__
25064         - name: interface-name
25065           in: path
25066           description: Name given to the interface
25067           required: true
25068           type: string
25069           example: __INTERFACE-NAME__
25070         - name: l3-interface-ipv6-address
25071           in: path
25072           description: IP address
25073           required: true
25074           type: string
25075           example: __L3-INTERFACE-IPV6-ADDRESS__
25076         - name: resource-version
25077           in: query
25078           description: resource-version for concurrency
25079           required: true
25080           type: string
25081   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
25082     get:
25083       tags:
25084         - Network
25085       summary: returns l-interface
25086       description: returns l-interface
25087       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
25088       produces:
25089         - application/json
25090         - application/xml
25091       responses:
25092         "200":
25093           description: successful operation
25094           schema:
25095               $ref: "#/getDefinitions/l-interface"
25096         "default":
25097           description: Response codes found in [response codes](https://wiki.onap.org/).
25098       parameters:
25099         - name: equipment-name
25100           in: path
25101           required: true
25102           type: string
25103           example: __EQUIPMENT-NAME__
25104         - name: interface-name
25105           in: path
25106           description: Name that identifies the physical interface
25107           required: true
25108           type: string
25109           example: __INTERFACE-NAME__
25110         - name: interface-name
25111           in: path
25112           description: Name given to the interface
25113           required: true
25114           type: string
25115           example: __INTERFACE-NAME__
25116     put:
25117       tags:
25118         - Network
25119       summary: create or update an existing l-interface
25120       description: |
25121         Create or update an existing l-interface.
25122         #
25123         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25124       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
25125       consumes:
25126         - application/json
25127         - application/xml
25128       produces:
25129         - application/json
25130         - application/xml
25131       responses:
25132         "default":
25133           description: Response codes found in [response codes](https://wiki.onap.org/).
25134       parameters:
25135         - name: equipment-name
25136           in: path
25137           required: true
25138           type: string
25139           example: __EQUIPMENT-NAME__
25140         - name: interface-name
25141           in: path
25142           description: Name that identifies the physical interface
25143           required: true
25144           type: string
25145           example: __INTERFACE-NAME__
25146         - name: interface-name
25147           in: path
25148           description: Name given to the interface
25149           required: true
25150           type: string
25151           example: __INTERFACE-NAME__
25152         - name: body
25153           in: body
25154           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
25155           required: true
25156           schema:
25157             $ref: "#/definitions/l-interface"
25158     patch:
25159       tags:
25160         - Network
25161       summary: update an existing l-interface
25162       description: |
25163         Update an existing l-interface
25164         #
25165         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25166         The PUT operation will entirely replace an existing object.
25167         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25168         #
25169         Other differences between PUT and PATCH are:
25170         #
25171         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25172         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25173         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25174       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
25175       consumes:
25176         - application/json
25177         - application/xml
25178       produces:
25179         - application/json
25180         - application/xml
25181       responses:
25182         "default":
25183           description: Response codes found in [response codes](https://wiki.onap.org/).
25184       parameters:
25185         - name: equipment-name
25186           in: path
25187           required: true
25188           type: string
25189           example: __EQUIPMENT-NAME__
25190         - name: interface-name
25191           in: path
25192           description: Name that identifies the physical interface
25193           required: true
25194           type: string
25195           example: __INTERFACE-NAME__
25196         - name: interface-name
25197           in: path
25198           description: Name given to the interface
25199           required: true
25200           type: string
25201           example: __INTERFACE-NAME__
25202         - name: body
25203           in: body
25204           description: l-interface object that needs to be updated.
25205           required: true
25206           schema:
25207             $ref: "#/patchDefinitions/l-interface"
25208     delete:
25209       tags:
25210         - Network
25211       summary: delete an existing l-interface
25212       description: delete an existing l-interface
25213       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
25214       consumes:
25215         - application/json
25216         - application/xml
25217       produces:
25218         - application/json
25219         - application/xml
25220       responses:
25221         "default":
25222           description: Response codes found in [response codes](https://wiki.onap.org/).
25223       parameters:
25224         - name: equipment-name
25225           in: path
25226           required: true
25227           type: string
25228           example: __EQUIPMENT-NAME__
25229         - name: interface-name
25230           in: path
25231           description: Name that identifies the physical interface
25232           required: true
25233           type: string
25234           example: __INTERFACE-NAME__
25235         - name: interface-name
25236           in: path
25237           description: Name given to the interface
25238           required: true
25239           type: string
25240           example: __INTERFACE-NAME__
25241         - name: resource-version
25242           in: query
25243           description: resource-version for concurrency
25244           required: true
25245           type: string
25246   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
25247     get:
25248       tags:
25249         - Network
25250       summary: returns l-interfaces
25251       description: returns l-interfaces
25252       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
25253       produces:
25254         - application/json
25255         - application/xml
25256       responses:
25257         "200":
25258           description: successful operation
25259           schema:
25260               $ref: "#/getDefinitions/l-interfaces"
25261         "default":
25262           description: Response codes found in [response codes](https://wiki.onap.org/).
25263       parameters:
25264         - name: equipment-name
25265           in: path
25266           required: true
25267           type: string
25268           example: __EQUIPMENT-NAME__
25269         - name: interface-name
25270           in: path
25271           description: Name that identifies the physical interface
25272           required: true
25273           type: string
25274           example: __INTERFACE-NAME__
25275         - name: interface-name
25276           in: query
25277           description:
25278           required: false
25279           type: string
25280         - name: interface-id
25281           in: query
25282           description:
25283           required: false
25284           type: string
25285         - name: macaddr
25286           in: query
25287           description:
25288           required: false
25289           type: string
25290         - name: network-name
25291           in: query
25292           description:
25293           required: false
25294           type: string
25295   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
25296     get:
25297       tags:
25298         - Network
25299       summary: returns p-interface
25300       description: returns p-interface
25301       operationId: getNetworkVplsPesVplsPePInterfacesPInterface
25302       produces:
25303         - application/json
25304         - application/xml
25305       responses:
25306         "200":
25307           description: successful operation
25308           schema:
25309               $ref: "#/getDefinitions/p-interface"
25310         "default":
25311           description: Response codes found in [response codes](https://wiki.onap.org/).
25312       parameters:
25313         - name: equipment-name
25314           in: path
25315           required: true
25316           type: string
25317           example: __EQUIPMENT-NAME__
25318         - name: interface-name
25319           in: path
25320           description: Name that identifies the physical interface
25321           required: true
25322           type: string
25323           example: __INTERFACE-NAME__
25324     put:
25325       tags:
25326         - Network
25327       summary: create or update an existing p-interface
25328       description: |
25329         Create or update an existing p-interface.
25330         #
25331         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25332       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
25333       consumes:
25334         - application/json
25335         - application/xml
25336       produces:
25337         - application/json
25338         - application/xml
25339       responses:
25340         "default":
25341           description: Response codes found in [response codes](https://wiki.onap.org/).
25342       parameters:
25343         - name: equipment-name
25344           in: path
25345           required: true
25346           type: string
25347           example: __EQUIPMENT-NAME__
25348         - name: interface-name
25349           in: path
25350           description: Name that identifies the physical interface
25351           required: true
25352           type: string
25353           example: __INTERFACE-NAME__
25354         - name: body
25355           in: body
25356           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPePInterfacesPInterface.json)
25357           required: true
25358           schema:
25359             $ref: "#/definitions/p-interface"
25360     patch:
25361       tags:
25362         - Network
25363       summary: update an existing p-interface
25364       description: |
25365         Update an existing p-interface
25366         #
25367         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25368         The PUT operation will entirely replace an existing object.
25369         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25370         #
25371         Other differences between PUT and PATCH are:
25372         #
25373         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25374         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25375         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25376       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
25377       consumes:
25378         - application/json
25379         - application/xml
25380       produces:
25381         - application/json
25382         - application/xml
25383       responses:
25384         "default":
25385           description: Response codes found in [response codes](https://wiki.onap.org/).
25386       parameters:
25387         - name: equipment-name
25388           in: path
25389           required: true
25390           type: string
25391           example: __EQUIPMENT-NAME__
25392         - name: interface-name
25393           in: path
25394           description: Name that identifies the physical interface
25395           required: true
25396           type: string
25397           example: __INTERFACE-NAME__
25398         - name: body
25399           in: body
25400           description: p-interface object that needs to be updated.
25401           required: true
25402           schema:
25403             $ref: "#/patchDefinitions/p-interface"
25404     delete:
25405       tags:
25406         - Network
25407       summary: delete an existing p-interface
25408       description: delete an existing p-interface
25409       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
25410       consumes:
25411         - application/json
25412         - application/xml
25413       produces:
25414         - application/json
25415         - application/xml
25416       responses:
25417         "default":
25418           description: Response codes found in [response codes](https://wiki.onap.org/).
25419       parameters:
25420         - name: equipment-name
25421           in: path
25422           required: true
25423           type: string
25424           example: __EQUIPMENT-NAME__
25425         - name: interface-name
25426           in: path
25427           description: Name that identifies the physical interface
25428           required: true
25429           type: string
25430           example: __INTERFACE-NAME__
25431         - name: resource-version
25432           in: query
25433           description: resource-version for concurrency
25434           required: true
25435           type: string
25436   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
25437     get:
25438       tags:
25439         - Network
25440       summary: returns p-interfaces
25441       description: returns p-interfaces
25442       operationId: getNetworkVplsPesVplsPePInterfaces
25443       produces:
25444         - application/json
25445         - application/xml
25446       responses:
25447         "200":
25448           description: successful operation
25449           schema:
25450               $ref: "#/getDefinitions/p-interfaces"
25451         "default":
25452           description: Response codes found in [response codes](https://wiki.onap.org/).
25453       parameters:
25454         - name: equipment-name
25455           in: path
25456           required: true
25457           type: string
25458           example: __EQUIPMENT-NAME__
25459         - name: interface-name
25460           in: query
25461           description:
25462           required: false
25463           type: string
25464         - name: prov-status
25465           in: query
25466           description:
25467           required: false
25468           type: string
25469   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
25470     put:
25471       tags:
25472         - Network
25473       summary: see node definition for valid relationships
25474       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
25475       consumes:
25476         - application/json
25477         - application/xml
25478       produces:
25479         - application/json
25480         - application/xml
25481       responses:
25482         "default":
25483           description: Response codes found in [response codes](https://wiki.onap.org/).
25484       parameters:
25485         - name: equipment-name
25486           in: path
25487           required: true
25488           type: string
25489           example: __EQUIPMENT-NAME__
25490         - name: interface-name
25491           in: path
25492           description: Name that identifies the link aggregate interface
25493           required: true
25494           type: string
25495           example: __INTERFACE-NAME__
25496         - name: body
25497           in: body
25498           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
25499           required: true
25500           schema:
25501             $ref: "#/definitions/relationship"
25502     delete:
25503       tags:
25504         - Network
25505       summary: delete an existing relationship
25506       description: delete an existing relationship
25507       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
25508       consumes:
25509         - application/json
25510         - application/xml
25511       produces:
25512         - application/json
25513         - application/xml
25514       responses:
25515         "default":
25516           description: Response codes found in [response codes](https://wiki.onap.org/).
25517       parameters:
25518         - name: equipment-name
25519           in: path
25520           required: true
25521           type: string
25522           example: __EQUIPMENT-NAME__
25523         - name: interface-name
25524           in: path
25525           description: Name that identifies the link aggregate interface
25526           required: true
25527           type: string
25528           example: __INTERFACE-NAME__
25529   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
25530     put:
25531       tags:
25532         - Network
25533       summary: see node definition for valid relationships
25534       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25535       consumes:
25536         - application/json
25537         - application/xml
25538       produces:
25539         - application/json
25540         - application/xml
25541       responses:
25542         "default":
25543           description: Response codes found in [response codes](https://wiki.onap.org/).
25544       parameters:
25545         - name: equipment-name
25546           in: path
25547           required: true
25548           type: string
25549           example: __EQUIPMENT-NAME__
25550         - name: interface-name
25551           in: path
25552           description: Name that identifies the link aggregate interface
25553           required: true
25554           type: string
25555           example: __INTERFACE-NAME__
25556         - name: interface-name
25557           in: path
25558           description: Name given to the interface
25559           required: true
25560           type: string
25561           example: __INTERFACE-NAME__
25562         - name: vlan-interface
25563           in: path
25564           description: String that identifies the interface
25565           required: true
25566           type: string
25567           example: __VLAN-INTERFACE__
25568         - name: body
25569           in: body
25570           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
25571           required: true
25572           schema:
25573             $ref: "#/definitions/relationship"
25574     delete:
25575       tags:
25576         - Network
25577       summary: delete an existing relationship
25578       description: delete an existing relationship
25579       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
25580       consumes:
25581         - application/json
25582         - application/xml
25583       produces:
25584         - application/json
25585         - application/xml
25586       responses:
25587         "default":
25588           description: Response codes found in [response codes](https://wiki.onap.org/).
25589       parameters:
25590         - name: equipment-name
25591           in: path
25592           required: true
25593           type: string
25594           example: __EQUIPMENT-NAME__
25595         - name: interface-name
25596           in: path
25597           description: Name that identifies the link aggregate interface
25598           required: true
25599           type: string
25600           example: __INTERFACE-NAME__
25601         - name: interface-name
25602           in: path
25603           description: Name given to the interface
25604           required: true
25605           type: string
25606           example: __INTERFACE-NAME__
25607         - name: vlan-interface
25608           in: path
25609           description: String that identifies the interface
25610           required: true
25611           type: string
25612           example: __VLAN-INTERFACE__
25613   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
25614     put:
25615       tags:
25616         - Network
25617       summary: see node definition for valid relationships
25618       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25619       consumes:
25620         - application/json
25621         - application/xml
25622       produces:
25623         - application/json
25624         - application/xml
25625       responses:
25626         "default":
25627           description: Response codes found in [response codes](https://wiki.onap.org/).
25628       parameters:
25629         - name: equipment-name
25630           in: path
25631           required: true
25632           type: string
25633           example: __EQUIPMENT-NAME__
25634         - name: interface-name
25635           in: path
25636           description: Name that identifies the link aggregate interface
25637           required: true
25638           type: string
25639           example: __INTERFACE-NAME__
25640         - name: interface-name
25641           in: path
25642           description: Name given to the interface
25643           required: true
25644           type: string
25645           example: __INTERFACE-NAME__
25646         - name: vlan-interface
25647           in: path
25648           description: String that identifies the interface
25649           required: true
25650           type: string
25651           example: __VLAN-INTERFACE__
25652         - name: l3-interface-ipv4-address
25653           in: path
25654           description: IP address
25655           required: true
25656           type: string
25657           example: __L3-INTERFACE-IPV4-ADDRESS__
25658         - name: body
25659           in: body
25660           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25661           required: true
25662           schema:
25663             $ref: "#/definitions/relationship"
25664     delete:
25665       tags:
25666         - Network
25667       summary: delete an existing relationship
25668       description: delete an existing relationship
25669       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
25670       consumes:
25671         - application/json
25672         - application/xml
25673       produces:
25674         - application/json
25675         - application/xml
25676       responses:
25677         "default":
25678           description: Response codes found in [response codes](https://wiki.onap.org/).
25679       parameters:
25680         - name: equipment-name
25681           in: path
25682           required: true
25683           type: string
25684           example: __EQUIPMENT-NAME__
25685         - name: interface-name
25686           in: path
25687           description: Name that identifies the link aggregate interface
25688           required: true
25689           type: string
25690           example: __INTERFACE-NAME__
25691         - name: interface-name
25692           in: path
25693           description: Name given to the interface
25694           required: true
25695           type: string
25696           example: __INTERFACE-NAME__
25697         - name: vlan-interface
25698           in: path
25699           description: String that identifies the interface
25700           required: true
25701           type: string
25702           example: __VLAN-INTERFACE__
25703         - name: l3-interface-ipv4-address
25704           in: path
25705           description: IP address
25706           required: true
25707           type: string
25708           example: __L3-INTERFACE-IPV4-ADDRESS__
25709   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
25710     get:
25711       tags:
25712         - Network
25713       summary: returns l3-interface-ipv4-address-list
25714       description: returns l3-interface-ipv4-address-list
25715       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25716       produces:
25717         - application/json
25718         - application/xml
25719       responses:
25720         "200":
25721           description: successful operation
25722           schema:
25723               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25724         "default":
25725           description: Response codes found in [response codes](https://wiki.onap.org/).
25726       parameters:
25727         - name: equipment-name
25728           in: path
25729           required: true
25730           type: string
25731           example: __EQUIPMENT-NAME__
25732         - name: interface-name
25733           in: path
25734           description: Name that identifies the link aggregate interface
25735           required: true
25736           type: string
25737           example: __INTERFACE-NAME__
25738         - name: interface-name
25739           in: path
25740           description: Name given to the interface
25741           required: true
25742           type: string
25743           example: __INTERFACE-NAME__
25744         - name: vlan-interface
25745           in: path
25746           description: String that identifies the interface
25747           required: true
25748           type: string
25749           example: __VLAN-INTERFACE__
25750         - name: l3-interface-ipv4-address
25751           in: path
25752           description: IP address
25753           required: true
25754           type: string
25755           example: __L3-INTERFACE-IPV4-ADDRESS__
25756     put:
25757       tags:
25758         - Network
25759       summary: create or update an existing l3-interface-ipv4-address-list
25760       description: |
25761         Create or update an existing l3-interface-ipv4-address-list.
25762         #
25763         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25764       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25765       consumes:
25766         - application/json
25767         - application/xml
25768       produces:
25769         - application/json
25770         - application/xml
25771       responses:
25772         "default":
25773           description: Response codes found in [response codes](https://wiki.onap.org/).
25774       parameters:
25775         - name: equipment-name
25776           in: path
25777           required: true
25778           type: string
25779           example: __EQUIPMENT-NAME__
25780         - name: interface-name
25781           in: path
25782           description: Name that identifies the link aggregate interface
25783           required: true
25784           type: string
25785           example: __INTERFACE-NAME__
25786         - name: interface-name
25787           in: path
25788           description: Name given to the interface
25789           required: true
25790           type: string
25791           example: __INTERFACE-NAME__
25792         - name: vlan-interface
25793           in: path
25794           description: String that identifies the interface
25795           required: true
25796           type: string
25797           example: __VLAN-INTERFACE__
25798         - name: l3-interface-ipv4-address
25799           in: path
25800           description: IP address
25801           required: true
25802           type: string
25803           example: __L3-INTERFACE-IPV4-ADDRESS__
25804         - name: body
25805           in: body
25806           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
25807           required: true
25808           schema:
25809             $ref: "#/definitions/l3-interface-ipv4-address-list"
25810     patch:
25811       tags:
25812         - Network
25813       summary: update an existing l3-interface-ipv4-address-list
25814       description: |
25815         Update an existing l3-interface-ipv4-address-list
25816         #
25817         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25818         The PUT operation will entirely replace an existing object.
25819         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25820         #
25821         Other differences between PUT and PATCH are:
25822         #
25823         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25824         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25825         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25826       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25827       consumes:
25828         - application/json
25829         - application/xml
25830       produces:
25831         - application/json
25832         - application/xml
25833       responses:
25834         "default":
25835           description: Response codes found in [response codes](https://wiki.onap.org/).
25836       parameters:
25837         - name: equipment-name
25838           in: path
25839           required: true
25840           type: string
25841           example: __EQUIPMENT-NAME__
25842         - name: interface-name
25843           in: path
25844           description: Name that identifies the link aggregate interface
25845           required: true
25846           type: string
25847           example: __INTERFACE-NAME__
25848         - name: interface-name
25849           in: path
25850           description: Name given to the interface
25851           required: true
25852           type: string
25853           example: __INTERFACE-NAME__
25854         - name: vlan-interface
25855           in: path
25856           description: String that identifies the interface
25857           required: true
25858           type: string
25859           example: __VLAN-INTERFACE__
25860         - name: l3-interface-ipv4-address
25861           in: path
25862           description: IP address
25863           required: true
25864           type: string
25865           example: __L3-INTERFACE-IPV4-ADDRESS__
25866         - name: body
25867           in: body
25868           description: l3-interface-ipv4-address-list object that needs to be updated.
25869           required: true
25870           schema:
25871             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
25872     delete:
25873       tags:
25874         - Network
25875       summary: delete an existing l3-interface-ipv4-address-list
25876       description: delete an existing l3-interface-ipv4-address-list
25877       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
25878       consumes:
25879         - application/json
25880         - application/xml
25881       produces:
25882         - application/json
25883         - application/xml
25884       responses:
25885         "default":
25886           description: Response codes found in [response codes](https://wiki.onap.org/).
25887       parameters:
25888         - name: equipment-name
25889           in: path
25890           required: true
25891           type: string
25892           example: __EQUIPMENT-NAME__
25893         - name: interface-name
25894           in: path
25895           description: Name that identifies the link aggregate interface
25896           required: true
25897           type: string
25898           example: __INTERFACE-NAME__
25899         - name: interface-name
25900           in: path
25901           description: Name given to the interface
25902           required: true
25903           type: string
25904           example: __INTERFACE-NAME__
25905         - name: vlan-interface
25906           in: path
25907           description: String that identifies the interface
25908           required: true
25909           type: string
25910           example: __VLAN-INTERFACE__
25911         - name: l3-interface-ipv4-address
25912           in: path
25913           description: IP address
25914           required: true
25915           type: string
25916           example: __L3-INTERFACE-IPV4-ADDRESS__
25917         - name: resource-version
25918           in: query
25919           description: resource-version for concurrency
25920           required: true
25921           type: string
25922   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
25923     put:
25924       tags:
25925         - Network
25926       summary: see node definition for valid relationships
25927       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25928       consumes:
25929         - application/json
25930         - application/xml
25931       produces:
25932         - application/json
25933         - application/xml
25934       responses:
25935         "default":
25936           description: Response codes found in [response codes](https://wiki.onap.org/).
25937       parameters:
25938         - name: equipment-name
25939           in: path
25940           required: true
25941           type: string
25942           example: __EQUIPMENT-NAME__
25943         - name: interface-name
25944           in: path
25945           description: Name that identifies the link aggregate interface
25946           required: true
25947           type: string
25948           example: __INTERFACE-NAME__
25949         - name: interface-name
25950           in: path
25951           description: Name given to the interface
25952           required: true
25953           type: string
25954           example: __INTERFACE-NAME__
25955         - name: vlan-interface
25956           in: path
25957           description: String that identifies the interface
25958           required: true
25959           type: string
25960           example: __VLAN-INTERFACE__
25961         - name: l3-interface-ipv6-address
25962           in: path
25963           description: IP address
25964           required: true
25965           type: string
25966           example: __L3-INTERFACE-IPV6-ADDRESS__
25967         - name: body
25968           in: body
25969           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25970           required: true
25971           schema:
25972             $ref: "#/definitions/relationship"
25973     delete:
25974       tags:
25975         - Network
25976       summary: delete an existing relationship
25977       description: delete an existing relationship
25978       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25979       consumes:
25980         - application/json
25981         - application/xml
25982       produces:
25983         - application/json
25984         - application/xml
25985       responses:
25986         "default":
25987           description: Response codes found in [response codes](https://wiki.onap.org/).
25988       parameters:
25989         - name: equipment-name
25990           in: path
25991           required: true
25992           type: string
25993           example: __EQUIPMENT-NAME__
25994         - name: interface-name
25995           in: path
25996           description: Name that identifies the link aggregate interface
25997           required: true
25998           type: string
25999           example: __INTERFACE-NAME__
26000         - name: interface-name
26001           in: path
26002           description: Name given to the interface
26003           required: true
26004           type: string
26005           example: __INTERFACE-NAME__
26006         - name: vlan-interface
26007           in: path
26008           description: String that identifies the interface
26009           required: true
26010           type: string
26011           example: __VLAN-INTERFACE__
26012         - name: l3-interface-ipv6-address
26013           in: path
26014           description: IP address
26015           required: true
26016           type: string
26017           example: __L3-INTERFACE-IPV6-ADDRESS__
26018   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
26019     get:
26020       tags:
26021         - Network
26022       summary: returns l3-interface-ipv6-address-list
26023       description: returns l3-interface-ipv6-address-list
26024       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
26025       produces:
26026         - application/json
26027         - application/xml
26028       responses:
26029         "200":
26030           description: successful operation
26031           schema:
26032               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26033         "default":
26034           description: Response codes found in [response codes](https://wiki.onap.org/).
26035       parameters:
26036         - name: equipment-name
26037           in: path
26038           required: true
26039           type: string
26040           example: __EQUIPMENT-NAME__
26041         - name: interface-name
26042           in: path
26043           description: Name that identifies the link aggregate interface
26044           required: true
26045           type: string
26046           example: __INTERFACE-NAME__
26047         - name: interface-name
26048           in: path
26049           description: Name given to the interface
26050           required: true
26051           type: string
26052           example: __INTERFACE-NAME__
26053         - name: vlan-interface
26054           in: path
26055           description: String that identifies the interface
26056           required: true
26057           type: string
26058           example: __VLAN-INTERFACE__
26059         - name: l3-interface-ipv6-address
26060           in: path
26061           description: IP address
26062           required: true
26063           type: string
26064           example: __L3-INTERFACE-IPV6-ADDRESS__
26065     put:
26066       tags:
26067         - Network
26068       summary: create or update an existing l3-interface-ipv6-address-list
26069       description: |
26070         Create or update an existing l3-interface-ipv6-address-list.
26071         #
26072         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26073       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
26074       consumes:
26075         - application/json
26076         - application/xml
26077       produces:
26078         - application/json
26079         - application/xml
26080       responses:
26081         "default":
26082           description: Response codes found in [response codes](https://wiki.onap.org/).
26083       parameters:
26084         - name: equipment-name
26085           in: path
26086           required: true
26087           type: string
26088           example: __EQUIPMENT-NAME__
26089         - name: interface-name
26090           in: path
26091           description: Name that identifies the link aggregate interface
26092           required: true
26093           type: string
26094           example: __INTERFACE-NAME__
26095         - name: interface-name
26096           in: path
26097           description: Name given to the interface
26098           required: true
26099           type: string
26100           example: __INTERFACE-NAME__
26101         - name: vlan-interface
26102           in: path
26103           description: String that identifies the interface
26104           required: true
26105           type: string
26106           example: __VLAN-INTERFACE__
26107         - name: l3-interface-ipv6-address
26108           in: path
26109           description: IP address
26110           required: true
26111           type: string
26112           example: __L3-INTERFACE-IPV6-ADDRESS__
26113         - name: body
26114           in: body
26115           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
26116           required: true
26117           schema:
26118             $ref: "#/definitions/l3-interface-ipv6-address-list"
26119     patch:
26120       tags:
26121         - Network
26122       summary: update an existing l3-interface-ipv6-address-list
26123       description: |
26124         Update an existing l3-interface-ipv6-address-list
26125         #
26126         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26127         The PUT operation will entirely replace an existing object.
26128         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26129         #
26130         Other differences between PUT and PATCH are:
26131         #
26132         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26133         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26134         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26135       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
26136       consumes:
26137         - application/json
26138         - application/xml
26139       produces:
26140         - application/json
26141         - application/xml
26142       responses:
26143         "default":
26144           description: Response codes found in [response codes](https://wiki.onap.org/).
26145       parameters:
26146         - name: equipment-name
26147           in: path
26148           required: true
26149           type: string
26150           example: __EQUIPMENT-NAME__
26151         - name: interface-name
26152           in: path
26153           description: Name that identifies the link aggregate interface
26154           required: true
26155           type: string
26156           example: __INTERFACE-NAME__
26157         - name: interface-name
26158           in: path
26159           description: Name given to the interface
26160           required: true
26161           type: string
26162           example: __INTERFACE-NAME__
26163         - name: vlan-interface
26164           in: path
26165           description: String that identifies the interface
26166           required: true
26167           type: string
26168           example: __VLAN-INTERFACE__
26169         - name: l3-interface-ipv6-address
26170           in: path
26171           description: IP address
26172           required: true
26173           type: string
26174           example: __L3-INTERFACE-IPV6-ADDRESS__
26175         - name: body
26176           in: body
26177           description: l3-interface-ipv6-address-list object that needs to be updated.
26178           required: true
26179           schema:
26180             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
26181     delete:
26182       tags:
26183         - Network
26184       summary: delete an existing l3-interface-ipv6-address-list
26185       description: delete an existing l3-interface-ipv6-address-list
26186       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
26187       consumes:
26188         - application/json
26189         - application/xml
26190       produces:
26191         - application/json
26192         - application/xml
26193       responses:
26194         "default":
26195           description: Response codes found in [response codes](https://wiki.onap.org/).
26196       parameters:
26197         - name: equipment-name
26198           in: path
26199           required: true
26200           type: string
26201           example: __EQUIPMENT-NAME__
26202         - name: interface-name
26203           in: path
26204           description: Name that identifies the link aggregate interface
26205           required: true
26206           type: string
26207           example: __INTERFACE-NAME__
26208         - name: interface-name
26209           in: path
26210           description: Name given to the interface
26211           required: true
26212           type: string
26213           example: __INTERFACE-NAME__
26214         - name: vlan-interface
26215           in: path
26216           description: String that identifies the interface
26217           required: true
26218           type: string
26219           example: __VLAN-INTERFACE__
26220         - name: l3-interface-ipv6-address
26221           in: path
26222           description: IP address
26223           required: true
26224           type: string
26225           example: __L3-INTERFACE-IPV6-ADDRESS__
26226         - name: resource-version
26227           in: query
26228           description: resource-version for concurrency
26229           required: true
26230           type: string
26231   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
26232     get:
26233       tags:
26234         - Network
26235       summary: returns vlan
26236       description: returns vlan
26237       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
26238       produces:
26239         - application/json
26240         - application/xml
26241       responses:
26242         "200":
26243           description: successful operation
26244           schema:
26245               $ref: "#/getDefinitions/vlan"
26246         "default":
26247           description: Response codes found in [response codes](https://wiki.onap.org/).
26248       parameters:
26249         - name: equipment-name
26250           in: path
26251           required: true
26252           type: string
26253           example: __EQUIPMENT-NAME__
26254         - name: interface-name
26255           in: path
26256           description: Name that identifies the link aggregate interface
26257           required: true
26258           type: string
26259           example: __INTERFACE-NAME__
26260         - name: interface-name
26261           in: path
26262           description: Name given to the interface
26263           required: true
26264           type: string
26265           example: __INTERFACE-NAME__
26266         - name: vlan-interface
26267           in: path
26268           description: String that identifies the interface
26269           required: true
26270           type: string
26271           example: __VLAN-INTERFACE__
26272     put:
26273       tags:
26274         - Network
26275       summary: create or update an existing vlan
26276       description: |
26277         Create or update an existing vlan.
26278         #
26279         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26280       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
26281       consumes:
26282         - application/json
26283         - application/xml
26284       produces:
26285         - application/json
26286         - application/xml
26287       responses:
26288         "default":
26289           description: Response codes found in [response codes](https://wiki.onap.org/).
26290       parameters:
26291         - name: equipment-name
26292           in: path
26293           required: true
26294           type: string
26295           example: __EQUIPMENT-NAME__
26296         - name: interface-name
26297           in: path
26298           description: Name that identifies the link aggregate interface
26299           required: true
26300           type: string
26301           example: __INTERFACE-NAME__
26302         - name: interface-name
26303           in: path
26304           description: Name given to the interface
26305           required: true
26306           type: string
26307           example: __INTERFACE-NAME__
26308         - name: vlan-interface
26309           in: path
26310           description: String that identifies the interface
26311           required: true
26312           type: string
26313           example: __VLAN-INTERFACE__
26314         - name: body
26315           in: body
26316           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
26317           required: true
26318           schema:
26319             $ref: "#/definitions/vlan"
26320     patch:
26321       tags:
26322         - Network
26323       summary: update an existing vlan
26324       description: |
26325         Update an existing vlan
26326         #
26327         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26328         The PUT operation will entirely replace an existing object.
26329         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26330         #
26331         Other differences between PUT and PATCH are:
26332         #
26333         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26334         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26335         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26336       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
26337       consumes:
26338         - application/json
26339         - application/xml
26340       produces:
26341         - application/json
26342         - application/xml
26343       responses:
26344         "default":
26345           description: Response codes found in [response codes](https://wiki.onap.org/).
26346       parameters:
26347         - name: equipment-name
26348           in: path
26349           required: true
26350           type: string
26351           example: __EQUIPMENT-NAME__
26352         - name: interface-name
26353           in: path
26354           description: Name that identifies the link aggregate interface
26355           required: true
26356           type: string
26357           example: __INTERFACE-NAME__
26358         - name: interface-name
26359           in: path
26360           description: Name given to the interface
26361           required: true
26362           type: string
26363           example: __INTERFACE-NAME__
26364         - name: vlan-interface
26365           in: path
26366           description: String that identifies the interface
26367           required: true
26368           type: string
26369           example: __VLAN-INTERFACE__
26370         - name: body
26371           in: body
26372           description: vlan object that needs to be updated.
26373           required: true
26374           schema:
26375             $ref: "#/patchDefinitions/vlan"
26376     delete:
26377       tags:
26378         - Network
26379       summary: delete an existing vlan
26380       description: delete an existing vlan
26381       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
26382       consumes:
26383         - application/json
26384         - application/xml
26385       produces:
26386         - application/json
26387         - application/xml
26388       responses:
26389         "default":
26390           description: Response codes found in [response codes](https://wiki.onap.org/).
26391       parameters:
26392         - name: equipment-name
26393           in: path
26394           required: true
26395           type: string
26396           example: __EQUIPMENT-NAME__
26397         - name: interface-name
26398           in: path
26399           description: Name that identifies the link aggregate interface
26400           required: true
26401           type: string
26402           example: __INTERFACE-NAME__
26403         - name: interface-name
26404           in: path
26405           description: Name given to the interface
26406           required: true
26407           type: string
26408           example: __INTERFACE-NAME__
26409         - name: vlan-interface
26410           in: path
26411           description: String that identifies the interface
26412           required: true
26413           type: string
26414           example: __VLAN-INTERFACE__
26415         - name: resource-version
26416           in: query
26417           description: resource-version for concurrency
26418           required: true
26419           type: string
26420   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
26421     get:
26422       tags:
26423         - Network
26424       summary: returns vlans
26425       description: returns vlans
26426       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
26427       produces:
26428         - application/json
26429         - application/xml
26430       responses:
26431         "200":
26432           description: successful operation
26433           schema:
26434               $ref: "#/getDefinitions/vlans"
26435         "default":
26436           description: Response codes found in [response codes](https://wiki.onap.org/).
26437       parameters:
26438         - name: equipment-name
26439           in: path
26440           required: true
26441           type: string
26442           example: __EQUIPMENT-NAME__
26443         - name: interface-name
26444           in: path
26445           description: Name that identifies the link aggregate interface
26446           required: true
26447           type: string
26448           example: __INTERFACE-NAME__
26449         - name: interface-name
26450           in: path
26451           description: Name given to the interface
26452           required: true
26453           type: string
26454           example: __INTERFACE-NAME__
26455         - name: vlan-interface
26456           in: query
26457           description:
26458           required: false
26459           type: string
26460         - name: vlan-id-inner
26461           in: query
26462           description:
26463           required: false
26464           type: integer
26465           format: int64
26466         - name: vpn-key
26467           in: query
26468           description:
26469           required: false
26470           type: string
26471   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
26472     put:
26473       tags:
26474         - Network
26475       summary: see node definition for valid relationships
26476       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26477       consumes:
26478         - application/json
26479         - application/xml
26480       produces:
26481         - application/json
26482         - application/xml
26483       responses:
26484         "default":
26485           description: Response codes found in [response codes](https://wiki.onap.org/).
26486       parameters:
26487         - name: equipment-name
26488           in: path
26489           required: true
26490           type: string
26491           example: __EQUIPMENT-NAME__
26492         - name: interface-name
26493           in: path
26494           description: Name that identifies the link aggregate interface
26495           required: true
26496           type: string
26497           example: __INTERFACE-NAME__
26498         - name: interface-name
26499           in: path
26500           description: Name given to the interface
26501           required: true
26502           type: string
26503           example: __INTERFACE-NAME__
26504         - name: pci-id
26505           in: path
26506           description: PCI ID used to identify the sriov-vf
26507           required: true
26508           type: string
26509           example: __PCI-ID__
26510         - name: body
26511           in: body
26512           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
26513           required: true
26514           schema:
26515             $ref: "#/definitions/relationship"
26516     delete:
26517       tags:
26518         - Network
26519       summary: delete an existing relationship
26520       description: delete an existing relationship
26521       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
26522       consumes:
26523         - application/json
26524         - application/xml
26525       produces:
26526         - application/json
26527         - application/xml
26528       responses:
26529         "default":
26530           description: Response codes found in [response codes](https://wiki.onap.org/).
26531       parameters:
26532         - name: equipment-name
26533           in: path
26534           required: true
26535           type: string
26536           example: __EQUIPMENT-NAME__
26537         - name: interface-name
26538           in: path
26539           description: Name that identifies the link aggregate interface
26540           required: true
26541           type: string
26542           example: __INTERFACE-NAME__
26543         - name: interface-name
26544           in: path
26545           description: Name given to the interface
26546           required: true
26547           type: string
26548           example: __INTERFACE-NAME__
26549         - name: pci-id
26550           in: path
26551           description: PCI ID used to identify the sriov-vf
26552           required: true
26553           type: string
26554           example: __PCI-ID__
26555   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
26556     get:
26557       tags:
26558         - Network
26559       summary: returns sriov-vf
26560       description: returns sriov-vf
26561       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26562       produces:
26563         - application/json
26564         - application/xml
26565       responses:
26566         "200":
26567           description: successful operation
26568           schema:
26569               $ref: "#/getDefinitions/sriov-vf"
26570         "default":
26571           description: Response codes found in [response codes](https://wiki.onap.org/).
26572       parameters:
26573         - name: equipment-name
26574           in: path
26575           required: true
26576           type: string
26577           example: __EQUIPMENT-NAME__
26578         - name: interface-name
26579           in: path
26580           description: Name that identifies the link aggregate interface
26581           required: true
26582           type: string
26583           example: __INTERFACE-NAME__
26584         - name: interface-name
26585           in: path
26586           description: Name given to the interface
26587           required: true
26588           type: string
26589           example: __INTERFACE-NAME__
26590         - name: pci-id
26591           in: path
26592           description: PCI ID used to identify the sriov-vf
26593           required: true
26594           type: string
26595           example: __PCI-ID__
26596     put:
26597       tags:
26598         - Network
26599       summary: create or update an existing sriov-vf
26600       description: |
26601         Create or update an existing sriov-vf.
26602         #
26603         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26604       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26605       consumes:
26606         - application/json
26607         - application/xml
26608       produces:
26609         - application/json
26610         - application/xml
26611       responses:
26612         "default":
26613           description: Response codes found in [response codes](https://wiki.onap.org/).
26614       parameters:
26615         - name: equipment-name
26616           in: path
26617           required: true
26618           type: string
26619           example: __EQUIPMENT-NAME__
26620         - name: interface-name
26621           in: path
26622           description: Name that identifies the link aggregate interface
26623           required: true
26624           type: string
26625           example: __INTERFACE-NAME__
26626         - name: interface-name
26627           in: path
26628           description: Name given to the interface
26629           required: true
26630           type: string
26631           example: __INTERFACE-NAME__
26632         - name: pci-id
26633           in: path
26634           description: PCI ID used to identify the sriov-vf
26635           required: true
26636           type: string
26637           example: __PCI-ID__
26638         - name: body
26639           in: body
26640           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
26641           required: true
26642           schema:
26643             $ref: "#/definitions/sriov-vf"
26644     patch:
26645       tags:
26646         - Network
26647       summary: update an existing sriov-vf
26648       description: |
26649         Update an existing sriov-vf
26650         #
26651         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26652         The PUT operation will entirely replace an existing object.
26653         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26654         #
26655         Other differences between PUT and PATCH are:
26656         #
26657         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26658         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26659         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26660       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26661       consumes:
26662         - application/json
26663         - application/xml
26664       produces:
26665         - application/json
26666         - application/xml
26667       responses:
26668         "default":
26669           description: Response codes found in [response codes](https://wiki.onap.org/).
26670       parameters:
26671         - name: equipment-name
26672           in: path
26673           required: true
26674           type: string
26675           example: __EQUIPMENT-NAME__
26676         - name: interface-name
26677           in: path
26678           description: Name that identifies the link aggregate interface
26679           required: true
26680           type: string
26681           example: __INTERFACE-NAME__
26682         - name: interface-name
26683           in: path
26684           description: Name given to the interface
26685           required: true
26686           type: string
26687           example: __INTERFACE-NAME__
26688         - name: pci-id
26689           in: path
26690           description: PCI ID used to identify the sriov-vf
26691           required: true
26692           type: string
26693           example: __PCI-ID__
26694         - name: body
26695           in: body
26696           description: sriov-vf object that needs to be updated.
26697           required: true
26698           schema:
26699             $ref: "#/patchDefinitions/sriov-vf"
26700     delete:
26701       tags:
26702         - Network
26703       summary: delete an existing sriov-vf
26704       description: delete an existing sriov-vf
26705       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
26706       consumes:
26707         - application/json
26708         - application/xml
26709       produces:
26710         - application/json
26711         - application/xml
26712       responses:
26713         "default":
26714           description: Response codes found in [response codes](https://wiki.onap.org/).
26715       parameters:
26716         - name: equipment-name
26717           in: path
26718           required: true
26719           type: string
26720           example: __EQUIPMENT-NAME__
26721         - name: interface-name
26722           in: path
26723           description: Name that identifies the link aggregate interface
26724           required: true
26725           type: string
26726           example: __INTERFACE-NAME__
26727         - name: interface-name
26728           in: path
26729           description: Name given to the interface
26730           required: true
26731           type: string
26732           example: __INTERFACE-NAME__
26733         - name: pci-id
26734           in: path
26735           description: PCI ID used to identify the sriov-vf
26736           required: true
26737           type: string
26738           example: __PCI-ID__
26739         - name: resource-version
26740           in: query
26741           description: resource-version for concurrency
26742           required: true
26743           type: string
26744   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
26745     get:
26746       tags:
26747         - Network
26748       summary: returns sriov-vfs
26749       description: returns sriov-vfs
26750       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
26751       produces:
26752         - application/json
26753         - application/xml
26754       responses:
26755         "200":
26756           description: successful operation
26757           schema:
26758               $ref: "#/getDefinitions/sriov-vfs"
26759         "default":
26760           description: Response codes found in [response codes](https://wiki.onap.org/).
26761       parameters:
26762         - name: equipment-name
26763           in: path
26764           required: true
26765           type: string
26766           example: __EQUIPMENT-NAME__
26767         - name: interface-name
26768           in: path
26769           description: Name that identifies the link aggregate interface
26770           required: true
26771           type: string
26772           example: __INTERFACE-NAME__
26773         - name: interface-name
26774           in: path
26775           description: Name given to the interface
26776           required: true
26777           type: string
26778           example: __INTERFACE-NAME__
26779         - name: pci-id
26780           in: query
26781           description:
26782           required: false
26783           type: string
26784         - name: vf-vlan-filter
26785           in: query
26786           description:
26787           required: false
26788           type: string
26789         - name: vf-mac-filter
26790           in: query
26791           description:
26792           required: false
26793           type: string
26794         - name: vf-vlan-strip
26795           in: query
26796           description:
26797           required: false
26798           type: boolean
26799         - name: neutron-network-id
26800           in: query
26801           description:
26802           required: false
26803           type: string
26804   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
26805     put:
26806       tags:
26807         - Network
26808       summary: see node definition for valid relationships
26809       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
26810       consumes:
26811         - application/json
26812         - application/xml
26813       produces:
26814         - application/json
26815         - application/xml
26816       responses:
26817         "default":
26818           description: Response codes found in [response codes](https://wiki.onap.org/).
26819       parameters:
26820         - name: equipment-name
26821           in: path
26822           required: true
26823           type: string
26824           example: __EQUIPMENT-NAME__
26825         - name: interface-name
26826           in: path
26827           description: Name that identifies the link aggregate interface
26828           required: true
26829           type: string
26830           example: __INTERFACE-NAME__
26831         - name: interface-name
26832           in: path
26833           description: Name given to the interface
26834           required: true
26835           type: string
26836           example: __INTERFACE-NAME__
26837         - name: body
26838           in: body
26839           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
26840           required: true
26841           schema:
26842             $ref: "#/definitions/relationship"
26843     delete:
26844       tags:
26845         - Network
26846       summary: delete an existing relationship
26847       description: delete an existing relationship
26848       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
26849       consumes:
26850         - application/json
26851         - application/xml
26852       produces:
26853         - application/json
26854         - application/xml
26855       responses:
26856         "default":
26857           description: Response codes found in [response codes](https://wiki.onap.org/).
26858       parameters:
26859         - name: equipment-name
26860           in: path
26861           required: true
26862           type: string
26863           example: __EQUIPMENT-NAME__
26864         - name: interface-name
26865           in: path
26866           description: Name that identifies the link aggregate interface
26867           required: true
26868           type: string
26869           example: __INTERFACE-NAME__
26870         - name: interface-name
26871           in: path
26872           description: Name given to the interface
26873           required: true
26874           type: string
26875           example: __INTERFACE-NAME__
26876   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
26877     put:
26878       tags:
26879         - Network
26880       summary: see node definition for valid relationships
26881       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26882       consumes:
26883         - application/json
26884         - application/xml
26885       produces:
26886         - application/json
26887         - application/xml
26888       responses:
26889         "default":
26890           description: Response codes found in [response codes](https://wiki.onap.org/).
26891       parameters:
26892         - name: equipment-name
26893           in: path
26894           required: true
26895           type: string
26896           example: __EQUIPMENT-NAME__
26897         - name: interface-name
26898           in: path
26899           description: Name that identifies the link aggregate interface
26900           required: true
26901           type: string
26902           example: __INTERFACE-NAME__
26903         - name: interface-name
26904           in: path
26905           description: Name given to the interface
26906           required: true
26907           type: string
26908           example: __INTERFACE-NAME__
26909         - name: l3-interface-ipv4-address
26910           in: path
26911           description: IP address
26912           required: true
26913           type: string
26914           example: __L3-INTERFACE-IPV4-ADDRESS__
26915         - name: body
26916           in: body
26917           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26918           required: true
26919           schema:
26920             $ref: "#/definitions/relationship"
26921     delete:
26922       tags:
26923         - Network
26924       summary: delete an existing relationship
26925       description: delete an existing relationship
26926       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26927       consumes:
26928         - application/json
26929         - application/xml
26930       produces:
26931         - application/json
26932         - application/xml
26933       responses:
26934         "default":
26935           description: Response codes found in [response codes](https://wiki.onap.org/).
26936       parameters:
26937         - name: equipment-name
26938           in: path
26939           required: true
26940           type: string
26941           example: __EQUIPMENT-NAME__
26942         - name: interface-name
26943           in: path
26944           description: Name that identifies the link aggregate interface
26945           required: true
26946           type: string
26947           example: __INTERFACE-NAME__
26948         - name: interface-name
26949           in: path
26950           description: Name given to the interface
26951           required: true
26952           type: string
26953           example: __INTERFACE-NAME__
26954         - name: l3-interface-ipv4-address
26955           in: path
26956           description: IP address
26957           required: true
26958           type: string
26959           example: __L3-INTERFACE-IPV4-ADDRESS__
26960   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
26961     get:
26962       tags:
26963         - Network
26964       summary: returns l3-interface-ipv4-address-list
26965       description: returns l3-interface-ipv4-address-list
26966       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26967       produces:
26968         - application/json
26969         - application/xml
26970       responses:
26971         "200":
26972           description: successful operation
26973           schema:
26974               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
26975         "default":
26976           description: Response codes found in [response codes](https://wiki.onap.org/).
26977       parameters:
26978         - name: equipment-name
26979           in: path
26980           required: true
26981           type: string
26982           example: __EQUIPMENT-NAME__
26983         - name: interface-name
26984           in: path
26985           description: Name that identifies the link aggregate interface
26986           required: true
26987           type: string
26988           example: __INTERFACE-NAME__
26989         - name: interface-name
26990           in: path
26991           description: Name given to the interface
26992           required: true
26993           type: string
26994           example: __INTERFACE-NAME__
26995         - name: l3-interface-ipv4-address
26996           in: path
26997           description: IP address
26998           required: true
26999           type: string
27000           example: __L3-INTERFACE-IPV4-ADDRESS__
27001     put:
27002       tags:
27003         - Network
27004       summary: create or update an existing l3-interface-ipv4-address-list
27005       description: |
27006         Create or update an existing l3-interface-ipv4-address-list.
27007         #
27008         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27009       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
27010       consumes:
27011         - application/json
27012         - application/xml
27013       produces:
27014         - application/json
27015         - application/xml
27016       responses:
27017         "default":
27018           description: Response codes found in [response codes](https://wiki.onap.org/).
27019       parameters:
27020         - name: equipment-name
27021           in: path
27022           required: true
27023           type: string
27024           example: __EQUIPMENT-NAME__
27025         - name: interface-name
27026           in: path
27027           description: Name that identifies the link aggregate interface
27028           required: true
27029           type: string
27030           example: __INTERFACE-NAME__
27031         - name: interface-name
27032           in: path
27033           description: Name given to the interface
27034           required: true
27035           type: string
27036           example: __INTERFACE-NAME__
27037         - name: l3-interface-ipv4-address
27038           in: path
27039           description: IP address
27040           required: true
27041           type: string
27042           example: __L3-INTERFACE-IPV4-ADDRESS__
27043         - name: body
27044           in: body
27045           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
27046           required: true
27047           schema:
27048             $ref: "#/definitions/l3-interface-ipv4-address-list"
27049     patch:
27050       tags:
27051         - Network
27052       summary: update an existing l3-interface-ipv4-address-list
27053       description: |
27054         Update an existing l3-interface-ipv4-address-list
27055         #
27056         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27057         The PUT operation will entirely replace an existing object.
27058         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27059         #
27060         Other differences between PUT and PATCH are:
27061         #
27062         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27063         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27064         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27065       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
27066       consumes:
27067         - application/json
27068         - application/xml
27069       produces:
27070         - application/json
27071         - application/xml
27072       responses:
27073         "default":
27074           description: Response codes found in [response codes](https://wiki.onap.org/).
27075       parameters:
27076         - name: equipment-name
27077           in: path
27078           required: true
27079           type: string
27080           example: __EQUIPMENT-NAME__
27081         - name: interface-name
27082           in: path
27083           description: Name that identifies the link aggregate interface
27084           required: true
27085           type: string
27086           example: __INTERFACE-NAME__
27087         - name: interface-name
27088           in: path
27089           description: Name given to the interface
27090           required: true
27091           type: string
27092           example: __INTERFACE-NAME__
27093         - name: l3-interface-ipv4-address
27094           in: path
27095           description: IP address
27096           required: true
27097           type: string
27098           example: __L3-INTERFACE-IPV4-ADDRESS__
27099         - name: body
27100           in: body
27101           description: l3-interface-ipv4-address-list object that needs to be updated.
27102           required: true
27103           schema:
27104             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
27105     delete:
27106       tags:
27107         - Network
27108       summary: delete an existing l3-interface-ipv4-address-list
27109       description: delete an existing l3-interface-ipv4-address-list
27110       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
27111       consumes:
27112         - application/json
27113         - application/xml
27114       produces:
27115         - application/json
27116         - application/xml
27117       responses:
27118         "default":
27119           description: Response codes found in [response codes](https://wiki.onap.org/).
27120       parameters:
27121         - name: equipment-name
27122           in: path
27123           required: true
27124           type: string
27125           example: __EQUIPMENT-NAME__
27126         - name: interface-name
27127           in: path
27128           description: Name that identifies the link aggregate interface
27129           required: true
27130           type: string
27131           example: __INTERFACE-NAME__
27132         - name: interface-name
27133           in: path
27134           description: Name given to the interface
27135           required: true
27136           type: string
27137           example: __INTERFACE-NAME__
27138         - name: l3-interface-ipv4-address
27139           in: path
27140           description: IP address
27141           required: true
27142           type: string
27143           example: __L3-INTERFACE-IPV4-ADDRESS__
27144         - name: resource-version
27145           in: query
27146           description: resource-version for concurrency
27147           required: true
27148           type: string
27149   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
27150     put:
27151       tags:
27152         - Network
27153       summary: see node definition for valid relationships
27154       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
27155       consumes:
27156         - application/json
27157         - application/xml
27158       produces:
27159         - application/json
27160         - application/xml
27161       responses:
27162         "default":
27163           description: Response codes found in [response codes](https://wiki.onap.org/).
27164       parameters:
27165         - name: equipment-name
27166           in: path
27167           required: true
27168           type: string
27169           example: __EQUIPMENT-NAME__
27170         - name: interface-name
27171           in: path
27172           description: Name that identifies the link aggregate interface
27173           required: true
27174           type: string
27175           example: __INTERFACE-NAME__
27176         - name: interface-name
27177           in: path
27178           description: Name given to the interface
27179           required: true
27180           type: string
27181           example: __INTERFACE-NAME__
27182         - name: l3-interface-ipv6-address
27183           in: path
27184           description: IP address
27185           required: true
27186           type: string
27187           example: __L3-INTERFACE-IPV6-ADDRESS__
27188         - name: body
27189           in: body
27190           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
27191           required: true
27192           schema:
27193             $ref: "#/definitions/relationship"
27194     delete:
27195       tags:
27196         - Network
27197       summary: delete an existing relationship
27198       description: delete an existing relationship
27199       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
27200       consumes:
27201         - application/json
27202         - application/xml
27203       produces:
27204         - application/json
27205         - application/xml
27206       responses:
27207         "default":
27208           description: Response codes found in [response codes](https://wiki.onap.org/).
27209       parameters:
27210         - name: equipment-name
27211           in: path
27212           required: true
27213           type: string
27214           example: __EQUIPMENT-NAME__
27215         - name: interface-name
27216           in: path
27217           description: Name that identifies the link aggregate interface
27218           required: true
27219           type: string
27220           example: __INTERFACE-NAME__
27221         - name: interface-name
27222           in: path
27223           description: Name given to the interface
27224           required: true
27225           type: string
27226           example: __INTERFACE-NAME__
27227         - name: l3-interface-ipv6-address
27228           in: path
27229           description: IP address
27230           required: true
27231           type: string
27232           example: __L3-INTERFACE-IPV6-ADDRESS__
27233   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
27234     get:
27235       tags:
27236         - Network
27237       summary: returns l3-interface-ipv6-address-list
27238       description: returns l3-interface-ipv6-address-list
27239       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27240       produces:
27241         - application/json
27242         - application/xml
27243       responses:
27244         "200":
27245           description: successful operation
27246           schema:
27247               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
27248         "default":
27249           description: Response codes found in [response codes](https://wiki.onap.org/).
27250       parameters:
27251         - name: equipment-name
27252           in: path
27253           required: true
27254           type: string
27255           example: __EQUIPMENT-NAME__
27256         - name: interface-name
27257           in: path
27258           description: Name that identifies the link aggregate interface
27259           required: true
27260           type: string
27261           example: __INTERFACE-NAME__
27262         - name: interface-name
27263           in: path
27264           description: Name given to the interface
27265           required: true
27266           type: string
27267           example: __INTERFACE-NAME__
27268         - name: l3-interface-ipv6-address
27269           in: path
27270           description: IP address
27271           required: true
27272           type: string
27273           example: __L3-INTERFACE-IPV6-ADDRESS__
27274     put:
27275       tags:
27276         - Network
27277       summary: create or update an existing l3-interface-ipv6-address-list
27278       description: |
27279         Create or update an existing l3-interface-ipv6-address-list.
27280         #
27281         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27282       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27283       consumes:
27284         - application/json
27285         - application/xml
27286       produces:
27287         - application/json
27288         - application/xml
27289       responses:
27290         "default":
27291           description: Response codes found in [response codes](https://wiki.onap.org/).
27292       parameters:
27293         - name: equipment-name
27294           in: path
27295           required: true
27296           type: string
27297           example: __EQUIPMENT-NAME__
27298         - name: interface-name
27299           in: path
27300           description: Name that identifies the link aggregate interface
27301           required: true
27302           type: string
27303           example: __INTERFACE-NAME__
27304         - name: interface-name
27305           in: path
27306           description: Name given to the interface
27307           required: true
27308           type: string
27309           example: __INTERFACE-NAME__
27310         - name: l3-interface-ipv6-address
27311           in: path
27312           description: IP address
27313           required: true
27314           type: string
27315           example: __L3-INTERFACE-IPV6-ADDRESS__
27316         - name: body
27317           in: body
27318           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
27319           required: true
27320           schema:
27321             $ref: "#/definitions/l3-interface-ipv6-address-list"
27322     patch:
27323       tags:
27324         - Network
27325       summary: update an existing l3-interface-ipv6-address-list
27326       description: |
27327         Update an existing l3-interface-ipv6-address-list
27328         #
27329         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27330         The PUT operation will entirely replace an existing object.
27331         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27332         #
27333         Other differences between PUT and PATCH are:
27334         #
27335         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27336         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27337         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27338       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27339       consumes:
27340         - application/json
27341         - application/xml
27342       produces:
27343         - application/json
27344         - application/xml
27345       responses:
27346         "default":
27347           description: Response codes found in [response codes](https://wiki.onap.org/).
27348       parameters:
27349         - name: equipment-name
27350           in: path
27351           required: true
27352           type: string
27353           example: __EQUIPMENT-NAME__
27354         - name: interface-name
27355           in: path
27356           description: Name that identifies the link aggregate interface
27357           required: true
27358           type: string
27359           example: __INTERFACE-NAME__
27360         - name: interface-name
27361           in: path
27362           description: Name given to the interface
27363           required: true
27364           type: string
27365           example: __INTERFACE-NAME__
27366         - name: l3-interface-ipv6-address
27367           in: path
27368           description: IP address
27369           required: true
27370           type: string
27371           example: __L3-INTERFACE-IPV6-ADDRESS__
27372         - name: body
27373           in: body
27374           description: l3-interface-ipv6-address-list object that needs to be updated.
27375           required: true
27376           schema:
27377             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27378     delete:
27379       tags:
27380         - Network
27381       summary: delete an existing l3-interface-ipv6-address-list
27382       description: delete an existing l3-interface-ipv6-address-list
27383       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
27384       consumes:
27385         - application/json
27386         - application/xml
27387       produces:
27388         - application/json
27389         - application/xml
27390       responses:
27391         "default":
27392           description: Response codes found in [response codes](https://wiki.onap.org/).
27393       parameters:
27394         - name: equipment-name
27395           in: path
27396           required: true
27397           type: string
27398           example: __EQUIPMENT-NAME__
27399         - name: interface-name
27400           in: path
27401           description: Name that identifies the link aggregate interface
27402           required: true
27403           type: string
27404           example: __INTERFACE-NAME__
27405         - name: interface-name
27406           in: path
27407           description: Name given to the interface
27408           required: true
27409           type: string
27410           example: __INTERFACE-NAME__
27411         - name: l3-interface-ipv6-address
27412           in: path
27413           description: IP address
27414           required: true
27415           type: string
27416           example: __L3-INTERFACE-IPV6-ADDRESS__
27417         - name: resource-version
27418           in: query
27419           description: resource-version for concurrency
27420           required: true
27421           type: string
27422   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
27423     get:
27424       tags:
27425         - Network
27426       summary: returns l-interface
27427       description: returns l-interface
27428       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27429       produces:
27430         - application/json
27431         - application/xml
27432       responses:
27433         "200":
27434           description: successful operation
27435           schema:
27436               $ref: "#/getDefinitions/l-interface"
27437         "default":
27438           description: Response codes found in [response codes](https://wiki.onap.org/).
27439       parameters:
27440         - name: equipment-name
27441           in: path
27442           required: true
27443           type: string
27444           example: __EQUIPMENT-NAME__
27445         - name: interface-name
27446           in: path
27447           description: Name that identifies the link aggregate interface
27448           required: true
27449           type: string
27450           example: __INTERFACE-NAME__
27451         - name: interface-name
27452           in: path
27453           description: Name given to the interface
27454           required: true
27455           type: string
27456           example: __INTERFACE-NAME__
27457     put:
27458       tags:
27459         - Network
27460       summary: create or update an existing l-interface
27461       description: |
27462         Create or update an existing l-interface.
27463         #
27464         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27465       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27466       consumes:
27467         - application/json
27468         - application/xml
27469       produces:
27470         - application/json
27471         - application/xml
27472       responses:
27473         "default":
27474           description: Response codes found in [response codes](https://wiki.onap.org/).
27475       parameters:
27476         - name: equipment-name
27477           in: path
27478           required: true
27479           type: string
27480           example: __EQUIPMENT-NAME__
27481         - name: interface-name
27482           in: path
27483           description: Name that identifies the link aggregate interface
27484           required: true
27485           type: string
27486           example: __INTERFACE-NAME__
27487         - name: interface-name
27488           in: path
27489           description: Name given to the interface
27490           required: true
27491           type: string
27492           example: __INTERFACE-NAME__
27493         - name: body
27494           in: body
27495           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
27496           required: true
27497           schema:
27498             $ref: "#/definitions/l-interface"
27499     patch:
27500       tags:
27501         - Network
27502       summary: update an existing l-interface
27503       description: |
27504         Update an existing l-interface
27505         #
27506         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27507         The PUT operation will entirely replace an existing object.
27508         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27509         #
27510         Other differences between PUT and PATCH are:
27511         #
27512         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27513         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27514         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27515       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27516       consumes:
27517         - application/json
27518         - application/xml
27519       produces:
27520         - application/json
27521         - application/xml
27522       responses:
27523         "default":
27524           description: Response codes found in [response codes](https://wiki.onap.org/).
27525       parameters:
27526         - name: equipment-name
27527           in: path
27528           required: true
27529           type: string
27530           example: __EQUIPMENT-NAME__
27531         - name: interface-name
27532           in: path
27533           description: Name that identifies the link aggregate interface
27534           required: true
27535           type: string
27536           example: __INTERFACE-NAME__
27537         - name: interface-name
27538           in: path
27539           description: Name given to the interface
27540           required: true
27541           type: string
27542           example: __INTERFACE-NAME__
27543         - name: body
27544           in: body
27545           description: l-interface object that needs to be updated.
27546           required: true
27547           schema:
27548             $ref: "#/patchDefinitions/l-interface"
27549     delete:
27550       tags:
27551         - Network
27552       summary: delete an existing l-interface
27553       description: delete an existing l-interface
27554       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
27555       consumes:
27556         - application/json
27557         - application/xml
27558       produces:
27559         - application/json
27560         - application/xml
27561       responses:
27562         "default":
27563           description: Response codes found in [response codes](https://wiki.onap.org/).
27564       parameters:
27565         - name: equipment-name
27566           in: path
27567           required: true
27568           type: string
27569           example: __EQUIPMENT-NAME__
27570         - name: interface-name
27571           in: path
27572           description: Name that identifies the link aggregate interface
27573           required: true
27574           type: string
27575           example: __INTERFACE-NAME__
27576         - name: interface-name
27577           in: path
27578           description: Name given to the interface
27579           required: true
27580           type: string
27581           example: __INTERFACE-NAME__
27582         - name: resource-version
27583           in: query
27584           description: resource-version for concurrency
27585           required: true
27586           type: string
27587   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
27588     get:
27589       tags:
27590         - Network
27591       summary: returns l-interfaces
27592       description: returns l-interfaces
27593       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
27594       produces:
27595         - application/json
27596         - application/xml
27597       responses:
27598         "200":
27599           description: successful operation
27600           schema:
27601               $ref: "#/getDefinitions/l-interfaces"
27602         "default":
27603           description: Response codes found in [response codes](https://wiki.onap.org/).
27604       parameters:
27605         - name: equipment-name
27606           in: path
27607           required: true
27608           type: string
27609           example: __EQUIPMENT-NAME__
27610         - name: interface-name
27611           in: path
27612           description: Name that identifies the link aggregate interface
27613           required: true
27614           type: string
27615           example: __INTERFACE-NAME__
27616         - name: interface-name
27617           in: query
27618           description:
27619           required: false
27620           type: string
27621         - name: interface-id
27622           in: query
27623           description:
27624           required: false
27625           type: string
27626         - name: macaddr
27627           in: query
27628           description:
27629           required: false
27630           type: string
27631         - name: network-name
27632           in: query
27633           description:
27634           required: false
27635           type: string
27636   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
27637     get:
27638       tags:
27639         - Network
27640       summary: returns lag-interface
27641       description: returns lag-interface
27642       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
27643       produces:
27644         - application/json
27645         - application/xml
27646       responses:
27647         "200":
27648           description: successful operation
27649           schema:
27650               $ref: "#/getDefinitions/lag-interface"
27651         "default":
27652           description: Response codes found in [response codes](https://wiki.onap.org/).
27653       parameters:
27654         - name: equipment-name
27655           in: path
27656           required: true
27657           type: string
27658           example: __EQUIPMENT-NAME__
27659         - name: interface-name
27660           in: path
27661           description: Name that identifies the link aggregate interface
27662           required: true
27663           type: string
27664           example: __INTERFACE-NAME__
27665     put:
27666       tags:
27667         - Network
27668       summary: create or update an existing lag-interface
27669       description: |
27670         Create or update an existing lag-interface.
27671         #
27672         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27673       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
27674       consumes:
27675         - application/json
27676         - application/xml
27677       produces:
27678         - application/json
27679         - application/xml
27680       responses:
27681         "default":
27682           description: Response codes found in [response codes](https://wiki.onap.org/).
27683       parameters:
27684         - name: equipment-name
27685           in: path
27686           required: true
27687           type: string
27688           example: __EQUIPMENT-NAME__
27689         - name: interface-name
27690           in: path
27691           description: Name that identifies the link aggregate interface
27692           required: true
27693           type: string
27694           example: __INTERFACE-NAME__
27695         - name: body
27696           in: body
27697           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
27698           required: true
27699           schema:
27700             $ref: "#/definitions/lag-interface"
27701     patch:
27702       tags:
27703         - Network
27704       summary: update an existing lag-interface
27705       description: |
27706         Update an existing lag-interface
27707         #
27708         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27709         The PUT operation will entirely replace an existing object.
27710         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27711         #
27712         Other differences between PUT and PATCH are:
27713         #
27714         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27715         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27716         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27717       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
27718       consumes:
27719         - application/json
27720         - application/xml
27721       produces:
27722         - application/json
27723         - application/xml
27724       responses:
27725         "default":
27726           description: Response codes found in [response codes](https://wiki.onap.org/).
27727       parameters:
27728         - name: equipment-name
27729           in: path
27730           required: true
27731           type: string
27732           example: __EQUIPMENT-NAME__
27733         - name: interface-name
27734           in: path
27735           description: Name that identifies the link aggregate interface
27736           required: true
27737           type: string
27738           example: __INTERFACE-NAME__
27739         - name: body
27740           in: body
27741           description: lag-interface object that needs to be updated.
27742           required: true
27743           schema:
27744             $ref: "#/patchDefinitions/lag-interface"
27745     delete:
27746       tags:
27747         - Network
27748       summary: delete an existing lag-interface
27749       description: delete an existing lag-interface
27750       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
27751       consumes:
27752         - application/json
27753         - application/xml
27754       produces:
27755         - application/json
27756         - application/xml
27757       responses:
27758         "default":
27759           description: Response codes found in [response codes](https://wiki.onap.org/).
27760       parameters:
27761         - name: equipment-name
27762           in: path
27763           required: true
27764           type: string
27765           example: __EQUIPMENT-NAME__
27766         - name: interface-name
27767           in: path
27768           description: Name that identifies the link aggregate interface
27769           required: true
27770           type: string
27771           example: __INTERFACE-NAME__
27772         - name: resource-version
27773           in: query
27774           description: resource-version for concurrency
27775           required: true
27776           type: string
27777   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
27778     get:
27779       tags:
27780         - Network
27781       summary: returns lag-interfaces
27782       description: returns lag-interfaces
27783       operationId: getNetworkVplsPesVplsPeLagInterfaces
27784       produces:
27785         - application/json
27786         - application/xml
27787       responses:
27788         "200":
27789           description: successful operation
27790           schema:
27791               $ref: "#/getDefinitions/lag-interfaces"
27792         "default":
27793           description: Response codes found in [response codes](https://wiki.onap.org/).
27794       parameters:
27795         - name: equipment-name
27796           in: path
27797           required: true
27798           type: string
27799           example: __EQUIPMENT-NAME__
27800         - name: interface-name
27801           in: query
27802           description:
27803           required: false
27804           type: string
27805         - name: interface-id
27806           in: query
27807           description:
27808           required: false
27809           type: string
27810         - name: interface-role
27811           in: query
27812           description:
27813           required: false
27814           type: string
27815   /network/vpls-pes/vpls-pe/{equipment-name}:
27816     get:
27817       tags:
27818         - Network
27819       summary: returns vpls-pe
27820       description: returns vpls-pe
27821       operationId: getNetworkVplsPesVplsPe
27822       produces:
27823         - application/json
27824         - application/xml
27825       responses:
27826         "200":
27827           description: successful operation
27828           schema:
27829               $ref: "#/getDefinitions/vpls-pe"
27830         "default":
27831           description: Response codes found in [response codes](https://wiki.onap.org/).
27832       parameters:
27833         - name: equipment-name
27834           in: path
27835           required: true
27836           type: string
27837           example: __EQUIPMENT-NAME__
27838     put:
27839       tags:
27840         - Network
27841       summary: create or update an existing vpls-pe
27842       description: |
27843         Create or update an existing vpls-pe.
27844         #
27845         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27846       operationId: createOrUpdateNetworkVplsPesVplsPe
27847       consumes:
27848         - application/json
27849         - application/xml
27850       produces:
27851         - application/json
27852         - application/xml
27853       responses:
27854         "default":
27855           description: Response codes found in [response codes](https://wiki.onap.org/).
27856       parameters:
27857         - name: equipment-name
27858           in: path
27859           required: true
27860           type: string
27861           example: __EQUIPMENT-NAME__
27862         - name: body
27863           in: body
27864           description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVplsPesVplsPe.json)
27865           required: true
27866           schema:
27867             $ref: "#/definitions/vpls-pe"
27868     patch:
27869       tags:
27870         - Network
27871       summary: update an existing vpls-pe
27872       description: |
27873         Update an existing vpls-pe
27874         #
27875         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27876         The PUT operation will entirely replace an existing object.
27877         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27878         #
27879         Other differences between PUT and PATCH are:
27880         #
27881         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27882         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27883         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27884       operationId: UpdateNetworkVplsPesVplsPe
27885       consumes:
27886         - application/json
27887         - application/xml
27888       produces:
27889         - application/json
27890         - application/xml
27891       responses:
27892         "default":
27893           description: Response codes found in [response codes](https://wiki.onap.org/).
27894       parameters:
27895         - name: equipment-name
27896           in: path
27897           required: true
27898           type: string
27899           example: __EQUIPMENT-NAME__
27900         - name: body
27901           in: body
27902           description: vpls-pe object that needs to be updated.
27903           required: true
27904           schema:
27905             $ref: "#/patchDefinitions/vpls-pe"
27906     delete:
27907       tags:
27908         - Network
27909       summary: delete an existing vpls-pe
27910       description: delete an existing vpls-pe
27911       operationId: deleteNetworkVplsPesVplsPe
27912       consumes:
27913         - application/json
27914         - application/xml
27915       produces:
27916         - application/json
27917         - application/xml
27918       responses:
27919         "default":
27920           description: Response codes found in [response codes](https://wiki.onap.org/).
27921       parameters:
27922         - name: equipment-name
27923           in: path
27924           required: true
27925           type: string
27926           example: __EQUIPMENT-NAME__
27927         - name: resource-version
27928           in: query
27929           description: resource-version for concurrency
27930           required: true
27931           type: string
27932   /network/vpls-pes:
27933     get:
27934       tags:
27935         - Network
27936       summary: returns vpls-pes
27937       description: returns vpls-pes
27938       operationId: getNetworkVplsPes
27939       produces:
27940         - application/json
27941         - application/xml
27942       responses:
27943         "200":
27944           description: successful operation
27945           schema:
27946               $ref: "#/getDefinitions/vpls-pes"
27947         "default":
27948           description: Response codes found in [response codes](https://wiki.onap.org/).
27949       parameters:
27950         - name: equipment-name
27951           in: query
27952           description:
27953           required: false
27954           type: string
27955         - name: prov-status
27956           in: query
27957           description:
27958           required: false
27959           type: string
27960   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
27961     put:
27962       tags:
27963         - Network
27964       summary: see node definition for valid relationships
27965       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27966       consumes:
27967         - application/json
27968         - application/xml
27969       produces:
27970         - application/json
27971         - application/xml
27972       responses:
27973         "default":
27974           description: Response codes found in [response codes](https://wiki.onap.org/).
27975       parameters:
27976         - name: multicast-configuration-id
27977           in: path
27978           description: Unique id of multicast configuration.
27979           required: true
27980           type: string
27981           example: __MULTICAST-CONFIGURATION-ID__
27982         - name: body
27983           in: body
27984           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkMulticastConfigurationsMulticastConfiguration.json)
27985           required: true
27986           schema:
27987             $ref: "#/definitions/relationship"
27988     delete:
27989       tags:
27990         - Network
27991       summary: delete an existing relationship
27992       description: delete an existing relationship
27993       operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27994       consumes:
27995         - application/json
27996         - application/xml
27997       produces:
27998         - application/json
27999         - application/xml
28000       responses:
28001         "default":
28002           description: Response codes found in [response codes](https://wiki.onap.org/).
28003       parameters:
28004         - name: multicast-configuration-id
28005           in: path
28006           description: Unique id of multicast configuration.
28007           required: true
28008           type: string
28009           example: __MULTICAST-CONFIGURATION-ID__
28010   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
28011     get:
28012       tags:
28013         - Network
28014       summary: returns multicast-configuration
28015       description: returns multicast-configuration
28016       operationId: getNetworkMulticastConfigurationsMulticastConfiguration
28017       produces:
28018         - application/json
28019         - application/xml
28020       responses:
28021         "200":
28022           description: successful operation
28023           schema:
28024               $ref: "#/getDefinitions/multicast-configuration"
28025         "default":
28026           description: Response codes found in [response codes](https://wiki.onap.org/).
28027       parameters:
28028         - name: multicast-configuration-id
28029           in: path
28030           description: Unique id of multicast configuration.
28031           required: true
28032           type: string
28033           example: __MULTICAST-CONFIGURATION-ID__
28034     put:
28035       tags:
28036         - Network
28037       summary: create or update an existing multicast-configuration
28038       description: |
28039         Create or update an existing multicast-configuration.
28040         #
28041         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28042       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
28043       consumes:
28044         - application/json
28045         - application/xml
28046       produces:
28047         - application/json
28048         - application/xml
28049       responses:
28050         "default":
28051           description: Response codes found in [response codes](https://wiki.onap.org/).
28052       parameters:
28053         - name: multicast-configuration-id
28054           in: path
28055           description: Unique id of multicast configuration.
28056           required: true
28057           type: string
28058           example: __MULTICAST-CONFIGURATION-ID__
28059         - name: body
28060           in: body
28061           description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkMulticastConfigurationsMulticastConfiguration.json)
28062           required: true
28063           schema:
28064             $ref: "#/definitions/multicast-configuration"
28065     patch:
28066       tags:
28067         - Network
28068       summary: update an existing multicast-configuration
28069       description: |
28070         Update an existing multicast-configuration
28071         #
28072         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28073         The PUT operation will entirely replace an existing object.
28074         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28075         #
28076         Other differences between PUT and PATCH are:
28077         #
28078         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28079         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28080         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28081       operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
28082       consumes:
28083         - application/json
28084         - application/xml
28085       produces:
28086         - application/json
28087         - application/xml
28088       responses:
28089         "default":
28090           description: Response codes found in [response codes](https://wiki.onap.org/).
28091       parameters:
28092         - name: multicast-configuration-id
28093           in: path
28094           description: Unique id of multicast configuration.
28095           required: true
28096           type: string
28097           example: __MULTICAST-CONFIGURATION-ID__
28098         - name: body
28099           in: body
28100           description: multicast-configuration object that needs to be updated.
28101           required: true
28102           schema:
28103             $ref: "#/patchDefinitions/multicast-configuration"
28104     delete:
28105       tags:
28106         - Network
28107       summary: delete an existing multicast-configuration
28108       description: delete an existing multicast-configuration
28109       operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
28110       consumes:
28111         - application/json
28112         - application/xml
28113       produces:
28114         - application/json
28115         - application/xml
28116       responses:
28117         "default":
28118           description: Response codes found in [response codes](https://wiki.onap.org/).
28119       parameters:
28120         - name: multicast-configuration-id
28121           in: path
28122           description: Unique id of multicast configuration.
28123           required: true
28124           type: string
28125           example: __MULTICAST-CONFIGURATION-ID__
28126         - name: resource-version
28127           in: query
28128           description: resource-version for concurrency
28129           required: true
28130           type: string
28131   /network/multicast-configurations:
28132     get:
28133       tags:
28134         - Network
28135       summary: returns multicast-configurations
28136       description: returns multicast-configurations
28137       operationId: getNetworkMulticastConfigurations
28138       produces:
28139         - application/json
28140         - application/xml
28141       responses:
28142         "200":
28143           description: successful operation
28144           schema:
28145               $ref: "#/getDefinitions/multicast-configurations"
28146         "default":
28147           description: Response codes found in [response codes](https://wiki.onap.org/).
28148       parameters:
28149         - name: multicast-configuration-id
28150           in: query
28151           description:
28152           required: false
28153           type: string
28154   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
28155     put:
28156       tags:
28157         - Network
28158       summary: see node definition for valid relationships
28159       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
28160       consumes:
28161         - application/json
28162         - application/xml
28163       produces:
28164         - application/json
28165         - application/xml
28166       responses:
28167         "default":
28168           description: Response codes found in [response codes](https://wiki.onap.org/).
28169       parameters:
28170         - name: vnf-id
28171           in: path
28172           description: Unique id of VNF.  This is unique across the graph.
28173           required: true
28174           type: string
28175           example: __VNF-ID__
28176         - name: interface-id
28177           in: path
28178           description: Unique ID of the interface
28179           required: true
28180           type: string
28181           example: __INTERFACE-ID__
28182         - name: cvlan-tag
28183           in: path
28184           description: See mis-na-virtualization-platform.yang
28185           required: true
28186           type: integer
28187           format: int64
28188           example: __CVLAN-TAG__
28189         - name: body
28190           in: body
28191           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
28192           required: true
28193           schema:
28194             $ref: "#/definitions/relationship"
28195     delete:
28196       tags:
28197         - Network
28198       summary: delete an existing relationship
28199       description: delete an existing relationship
28200       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
28201       consumes:
28202         - application/json
28203         - application/xml
28204       produces:
28205         - application/json
28206         - application/xml
28207       responses:
28208         "default":
28209           description: Response codes found in [response codes](https://wiki.onap.org/).
28210       parameters:
28211         - name: vnf-id
28212           in: path
28213           description: Unique id of VNF.  This is unique across the graph.
28214           required: true
28215           type: string
28216           example: __VNF-ID__
28217         - name: interface-id
28218           in: path
28219           description: Unique ID of the interface
28220           required: true
28221           type: string
28222           example: __INTERFACE-ID__
28223         - name: cvlan-tag
28224           in: path
28225           description: See mis-na-virtualization-platform.yang
28226           required: true
28227           type: integer
28228           format: int64
28229           example: __CVLAN-TAG__
28230   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
28231     get:
28232       tags:
28233         - Network
28234       summary: returns cvlan-tag-entry
28235       description: returns cvlan-tag-entry
28236       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
28237       produces:
28238         - application/json
28239         - application/xml
28240       responses:
28241         "200":
28242           description: successful operation
28243           schema:
28244               $ref: "#/getDefinitions/cvlan-tag-entry"
28245         "default":
28246           description: Response codes found in [response codes](https://wiki.onap.org/).
28247       parameters:
28248         - name: vnf-id
28249           in: path
28250           description: Unique id of VNF.  This is unique across the graph.
28251           required: true
28252           type: string
28253           example: __VNF-ID__
28254         - name: interface-id
28255           in: path
28256           description: Unique ID of the interface
28257           required: true
28258           type: string
28259           example: __INTERFACE-ID__
28260         - name: cvlan-tag
28261           in: path
28262           description: See mis-na-virtualization-platform.yang
28263           required: true
28264           type: integer
28265           format: int64
28266           example: __CVLAN-TAG__
28267     put:
28268       tags:
28269         - Network
28270       summary: create or update an existing cvlan-tag-entry
28271       description: |
28272         Create or update an existing cvlan-tag-entry.
28273         #
28274         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28275       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
28276       consumes:
28277         - application/json
28278         - application/xml
28279       produces:
28280         - application/json
28281         - application/xml
28282       responses:
28283         "default":
28284           description: Response codes found in [response codes](https://wiki.onap.org/).
28285       parameters:
28286         - name: vnf-id
28287           in: path
28288           description: Unique id of VNF.  This is unique across the graph.
28289           required: true
28290           type: string
28291           example: __VNF-ID__
28292         - name: interface-id
28293           in: path
28294           description: Unique ID of the interface
28295           required: true
28296           type: string
28297           example: __INTERFACE-ID__
28298         - name: cvlan-tag
28299           in: path
28300           description: See mis-na-virtualization-platform.yang
28301           required: true
28302           type: integer
28303           format: int64
28304           example: __CVLAN-TAG__
28305         - name: body
28306           in: body
28307           description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
28308           required: true
28309           schema:
28310             $ref: "#/definitions/cvlan-tag-entry"
28311     patch:
28312       tags:
28313         - Network
28314       summary: update an existing cvlan-tag-entry
28315       description: |
28316         Update an existing cvlan-tag-entry
28317         #
28318         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28319         The PUT operation will entirely replace an existing object.
28320         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28321         #
28322         Other differences between PUT and PATCH are:
28323         #
28324         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28325         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28326         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28327       operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
28328       consumes:
28329         - application/json
28330         - application/xml
28331       produces:
28332         - application/json
28333         - application/xml
28334       responses:
28335         "default":
28336           description: Response codes found in [response codes](https://wiki.onap.org/).
28337       parameters:
28338         - name: vnf-id
28339           in: path
28340           description: Unique id of VNF.  This is unique across the graph.
28341           required: true
28342           type: string
28343           example: __VNF-ID__
28344         - name: interface-id
28345           in: path
28346           description: Unique ID of the interface
28347           required: true
28348           type: string
28349           example: __INTERFACE-ID__
28350         - name: cvlan-tag
28351           in: path
28352           description: See mis-na-virtualization-platform.yang
28353           required: true
28354           type: integer
28355           format: int64
28356           example: __CVLAN-TAG__
28357         - name: body
28358           in: body
28359           description: cvlan-tag-entry object that needs to be updated.
28360           required: true
28361           schema:
28362             $ref: "#/patchDefinitions/cvlan-tag-entry"
28363     delete:
28364       tags:
28365         - Network
28366       summary: delete an existing cvlan-tag-entry
28367       description: delete an existing cvlan-tag-entry
28368       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
28369       consumes:
28370         - application/json
28371         - application/xml
28372       produces:
28373         - application/json
28374         - application/xml
28375       responses:
28376         "default":
28377           description: Response codes found in [response codes](https://wiki.onap.org/).
28378       parameters:
28379         - name: vnf-id
28380           in: path
28381           description: Unique id of VNF.  This is unique across the graph.
28382           required: true
28383           type: string
28384           example: __VNF-ID__
28385         - name: interface-id
28386           in: path
28387           description: Unique ID of the interface
28388           required: true
28389           type: string
28390           example: __INTERFACE-ID__
28391         - name: cvlan-tag
28392           in: path
28393           description: See mis-na-virtualization-platform.yang
28394           required: true
28395           type: integer
28396           format: int64
28397           example: __CVLAN-TAG__
28398         - name: resource-version
28399           in: query
28400           description: resource-version for concurrency
28401           required: true
28402           type: string
28403   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
28404     get:
28405       tags:
28406         - Network
28407       summary: returns cvlan-tags
28408       description: returns cvlan-tags
28409       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
28410       produces:
28411         - application/json
28412         - application/xml
28413       responses:
28414         "200":
28415           description: successful operation
28416           schema:
28417               $ref: "#/getDefinitions/cvlan-tags"
28418         "default":
28419           description: Response codes found in [response codes](https://wiki.onap.org/).
28420       parameters:
28421         - name: vnf-id
28422           in: path
28423           description: Unique id of VNF.  This is unique across the graph.
28424           required: true
28425           type: string
28426           example: __VNF-ID__
28427         - name: interface-id
28428           in: path
28429           description: Unique ID of the interface
28430           required: true
28431           type: string
28432           example: __INTERFACE-ID__
28433         - name: cvlan-tag
28434           in: query
28435           description:
28436           required: false
28437           type: integer
28438           format: int64
28439   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
28440     put:
28441       tags:
28442         - Network
28443       summary: see node definition for valid relationships
28444       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
28445       consumes:
28446         - application/json
28447         - application/xml
28448       produces:
28449         - application/json
28450         - application/xml
28451       responses:
28452         "default":
28453           description: Response codes found in [response codes](https://wiki.onap.org/).
28454       parameters:
28455         - name: vnf-id
28456           in: path
28457           description: Unique id of VNF.  This is unique across the graph.
28458           required: true
28459           type: string
28460           example: __VNF-ID__
28461         - name: interface-id
28462           in: path
28463           description: Unique ID of the interface
28464           required: true
28465           type: string
28466           example: __INTERFACE-ID__
28467         - name: body
28468           in: body
28469           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroup.json)
28470           required: true
28471           schema:
28472             $ref: "#/definitions/relationship"
28473     delete:
28474       tags:
28475         - Network
28476       summary: delete an existing relationship
28477       description: delete an existing relationship
28478       operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
28479       consumes:
28480         - application/json
28481         - application/xml
28482       produces:
28483         - application/json
28484         - application/xml
28485       responses:
28486         "default":
28487           description: Response codes found in [response codes](https://wiki.onap.org/).
28488       parameters:
28489         - name: vnf-id
28490           in: path
28491           description: Unique id of VNF.  This is unique across the graph.
28492           required: true
28493           type: string
28494           example: __VNF-ID__
28495         - name: interface-id
28496           in: path
28497           description: Unique ID of the interface
28498           required: true
28499           type: string
28500           example: __INTERFACE-ID__
28501   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
28502     get:
28503       tags:
28504         - Network
28505       summary: returns port-group
28506       description: returns port-group
28507       operationId: getNetworkVcesVcePortGroupsPortGroup
28508       produces:
28509         - application/json
28510         - application/xml
28511       responses:
28512         "200":
28513           description: successful operation
28514           schema:
28515               $ref: "#/getDefinitions/port-group"
28516         "default":
28517           description: Response codes found in [response codes](https://wiki.onap.org/).
28518       parameters:
28519         - name: vnf-id
28520           in: path
28521           description: Unique id of VNF.  This is unique across the graph.
28522           required: true
28523           type: string
28524           example: __VNF-ID__
28525         - name: interface-id
28526           in: path
28527           description: Unique ID of the interface
28528           required: true
28529           type: string
28530           example: __INTERFACE-ID__
28531     put:
28532       tags:
28533         - Network
28534       summary: create or update an existing port-group
28535       description: |
28536         Create or update an existing port-group.
28537         #
28538         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28539       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
28540       consumes:
28541         - application/json
28542         - application/xml
28543       produces:
28544         - application/json
28545         - application/xml
28546       responses:
28547         "default":
28548           description: Response codes found in [response codes](https://wiki.onap.org/).
28549       parameters:
28550         - name: vnf-id
28551           in: path
28552           description: Unique id of VNF.  This is unique across the graph.
28553           required: true
28554           type: string
28555           example: __VNF-ID__
28556         - name: interface-id
28557           in: path
28558           description: Unique ID of the interface
28559           required: true
28560           type: string
28561           example: __INTERFACE-ID__
28562         - name: body
28563           in: body
28564           description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVcePortGroupsPortGroup.json)
28565           required: true
28566           schema:
28567             $ref: "#/definitions/port-group"
28568     patch:
28569       tags:
28570         - Network
28571       summary: update an existing port-group
28572       description: |
28573         Update an existing port-group
28574         #
28575         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28576         The PUT operation will entirely replace an existing object.
28577         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28578         #
28579         Other differences between PUT and PATCH are:
28580         #
28581         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28582         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28583         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28584       operationId: UpdateNetworkVcesVcePortGroupsPortGroup
28585       consumes:
28586         - application/json
28587         - application/xml
28588       produces:
28589         - application/json
28590         - application/xml
28591       responses:
28592         "default":
28593           description: Response codes found in [response codes](https://wiki.onap.org/).
28594       parameters:
28595         - name: vnf-id
28596           in: path
28597           description: Unique id of VNF.  This is unique across the graph.
28598           required: true
28599           type: string
28600           example: __VNF-ID__
28601         - name: interface-id
28602           in: path
28603           description: Unique ID of the interface
28604           required: true
28605           type: string
28606           example: __INTERFACE-ID__
28607         - name: body
28608           in: body
28609           description: port-group object that needs to be updated.
28610           required: true
28611           schema:
28612             $ref: "#/patchDefinitions/port-group"
28613     delete:
28614       tags:
28615         - Network
28616       summary: delete an existing port-group
28617       description: delete an existing port-group
28618       operationId: deleteNetworkVcesVcePortGroupsPortGroup
28619       consumes:
28620         - application/json
28621         - application/xml
28622       produces:
28623         - application/json
28624         - application/xml
28625       responses:
28626         "default":
28627           description: Response codes found in [response codes](https://wiki.onap.org/).
28628       parameters:
28629         - name: vnf-id
28630           in: path
28631           description: Unique id of VNF.  This is unique across the graph.
28632           required: true
28633           type: string
28634           example: __VNF-ID__
28635         - name: interface-id
28636           in: path
28637           description: Unique ID of the interface
28638           required: true
28639           type: string
28640           example: __INTERFACE-ID__
28641         - name: resource-version
28642           in: query
28643           description: resource-version for concurrency
28644           required: true
28645           type: string
28646   /network/vces/vce/{vnf-id}/port-groups:
28647     get:
28648       tags:
28649         - Network
28650       summary: returns port-groups
28651       description: returns port-groups
28652       operationId: getNetworkVcesVcePortGroups
28653       produces:
28654         - application/json
28655         - application/xml
28656       responses:
28657         "200":
28658           description: successful operation
28659           schema:
28660               $ref: "#/getDefinitions/port-groups"
28661         "default":
28662           description: Response codes found in [response codes](https://wiki.onap.org/).
28663       parameters:
28664         - name: vnf-id
28665           in: path
28666           description: Unique id of VNF.  This is unique across the graph.
28667           required: true
28668           type: string
28669           example: __VNF-ID__
28670         - name: interface-id
28671           in: query
28672           description:
28673           required: false
28674           type: string
28675         - name: port-group-id
28676           in: query
28677           description:
28678           required: false
28679           type: string
28680         - name: switch-name
28681           in: query
28682           description:
28683           required: false
28684           type: string
28685         - name: heat-stack-id
28686           in: query
28687           description:
28688           required: false
28689           type: string
28690   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28691     put:
28692       tags:
28693         - Network
28694       summary: see node definition for valid relationships
28695       operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
28696       consumes:
28697         - application/json
28698         - application/xml
28699       produces:
28700         - application/json
28701         - application/xml
28702       responses:
28703         "default":
28704           description: Response codes found in [response codes](https://wiki.onap.org/).
28705       parameters:
28706         - name: vnf-id
28707           in: path
28708           description: Unique id of VNF.  This is unique across the graph.
28709           required: true
28710           type: string
28711           example: __VNF-ID__
28712         - name: group-uuid
28713           in: path
28714           description: Unique ID for the license group the resource belongs to, should be uuid.
28715           required: true
28716           type: string
28717           example: __GROUP-UUID__
28718         - name: resource-uuid
28719           in: path
28720           description: Unique ID of a license resource.
28721           required: true
28722           type: string
28723           example: __RESOURCE-UUID__
28724         - name: body
28725           in: body
28726           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceLicensesLicense.json)
28727           required: true
28728           schema:
28729             $ref: "#/definitions/relationship"
28730     delete:
28731       tags:
28732         - Network
28733       summary: delete an existing relationship
28734       description: delete an existing relationship
28735       operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
28736       consumes:
28737         - application/json
28738         - application/xml
28739       produces:
28740         - application/json
28741         - application/xml
28742       responses:
28743         "default":
28744           description: Response codes found in [response codes](https://wiki.onap.org/).
28745       parameters:
28746         - name: vnf-id
28747           in: path
28748           description: Unique id of VNF.  This is unique across the graph.
28749           required: true
28750           type: string
28751           example: __VNF-ID__
28752         - name: group-uuid
28753           in: path
28754           description: Unique ID for the license group the resource belongs to, should be uuid.
28755           required: true
28756           type: string
28757           example: __GROUP-UUID__
28758         - name: resource-uuid
28759           in: path
28760           description: Unique ID of a license resource.
28761           required: true
28762           type: string
28763           example: __RESOURCE-UUID__
28764   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
28765     get:
28766       tags:
28767         - Network
28768       summary: returns license
28769       description: returns license
28770       operationId: getNetworkVcesVceLicensesLicense
28771       produces:
28772         - application/json
28773         - application/xml
28774       responses:
28775         "200":
28776           description: successful operation
28777           schema:
28778               $ref: "#/getDefinitions/license"
28779         "default":
28780           description: Response codes found in [response codes](https://wiki.onap.org/).
28781       parameters:
28782         - name: vnf-id
28783           in: path
28784           description: Unique id of VNF.  This is unique across the graph.
28785           required: true
28786           type: string
28787           example: __VNF-ID__
28788         - name: group-uuid
28789           in: path
28790           description: Unique ID for the license group the resource belongs to, should be uuid.
28791           required: true
28792           type: string
28793           example: __GROUP-UUID__
28794         - name: resource-uuid
28795           in: path
28796           description: Unique ID of a license resource.
28797           required: true
28798           type: string
28799           example: __RESOURCE-UUID__
28800     put:
28801       tags:
28802         - Network
28803       summary: create or update an existing license
28804       description: |
28805         Create or update an existing license.
28806         #
28807         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28808       operationId: createOrUpdateNetworkVcesVceLicensesLicense
28809       consumes:
28810         - application/json
28811         - application/xml
28812       produces:
28813         - application/json
28814         - application/xml
28815       responses:
28816         "default":
28817           description: Response codes found in [response codes](https://wiki.onap.org/).
28818       parameters:
28819         - name: vnf-id
28820           in: path
28821           description: Unique id of VNF.  This is unique across the graph.
28822           required: true
28823           type: string
28824           example: __VNF-ID__
28825         - name: group-uuid
28826           in: path
28827           description: Unique ID for the license group the resource belongs to, should be uuid.
28828           required: true
28829           type: string
28830           example: __GROUP-UUID__
28831         - name: resource-uuid
28832           in: path
28833           description: Unique ID of a license resource.
28834           required: true
28835           type: string
28836           example: __RESOURCE-UUID__
28837         - name: body
28838           in: body
28839           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceLicensesLicense.json)
28840           required: true
28841           schema:
28842             $ref: "#/definitions/license"
28843     patch:
28844       tags:
28845         - Network
28846       summary: update an existing license
28847       description: |
28848         Update an existing license
28849         #
28850         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28851         The PUT operation will entirely replace an existing object.
28852         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28853         #
28854         Other differences between PUT and PATCH are:
28855         #
28856         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28857         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28858         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28859       operationId: UpdateNetworkVcesVceLicensesLicense
28860       consumes:
28861         - application/json
28862         - application/xml
28863       produces:
28864         - application/json
28865         - application/xml
28866       responses:
28867         "default":
28868           description: Response codes found in [response codes](https://wiki.onap.org/).
28869       parameters:
28870         - name: vnf-id
28871           in: path
28872           description: Unique id of VNF.  This is unique across the graph.
28873           required: true
28874           type: string
28875           example: __VNF-ID__
28876         - name: group-uuid
28877           in: path
28878           description: Unique ID for the license group the resource belongs to, should be uuid.
28879           required: true
28880           type: string
28881           example: __GROUP-UUID__
28882         - name: resource-uuid
28883           in: path
28884           description: Unique ID of a license resource.
28885           required: true
28886           type: string
28887           example: __RESOURCE-UUID__
28888         - name: body
28889           in: body
28890           description: license object that needs to be updated.
28891           required: true
28892           schema:
28893             $ref: "#/patchDefinitions/license"
28894     delete:
28895       tags:
28896         - Network
28897       summary: delete an existing license
28898       description: delete an existing license
28899       operationId: deleteNetworkVcesVceLicensesLicense
28900       consumes:
28901         - application/json
28902         - application/xml
28903       produces:
28904         - application/json
28905         - application/xml
28906       responses:
28907         "default":
28908           description: Response codes found in [response codes](https://wiki.onap.org/).
28909       parameters:
28910         - name: vnf-id
28911           in: path
28912           description: Unique id of VNF.  This is unique across the graph.
28913           required: true
28914           type: string
28915           example: __VNF-ID__
28916         - name: group-uuid
28917           in: path
28918           description: Unique ID for the license group the resource belongs to, should be uuid.
28919           required: true
28920           type: string
28921           example: __GROUP-UUID__
28922         - name: resource-uuid
28923           in: path
28924           description: Unique ID of a license resource.
28925           required: true
28926           type: string
28927           example: __RESOURCE-UUID__
28928         - name: resource-version
28929           in: query
28930           description: resource-version for concurrency
28931           required: true
28932           type: string
28933   /network/vces/vce/{vnf-id}/licenses:
28934     get:
28935       tags:
28936         - Network
28937       summary: returns licenses
28938       description: returns licenses
28939       operationId: getNetworkVcesVceLicenses
28940       produces:
28941         - application/json
28942         - application/xml
28943       responses:
28944         "200":
28945           description: successful operation
28946           schema:
28947               $ref: "#/getDefinitions/licenses"
28948         "default":
28949           description: Response codes found in [response codes](https://wiki.onap.org/).
28950       parameters:
28951         - name: vnf-id
28952           in: path
28953           description: Unique id of VNF.  This is unique across the graph.
28954           required: true
28955           type: string
28956           example: __VNF-ID__
28957         - name: group-uuid
28958           in: query
28959           description:
28960           required: false
28961           type: string
28962         - name: resource-uuid
28963           in: query
28964           description:
28965           required: false
28966           type: string
28967   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28968     put:
28969       tags:
28970         - Network
28971       summary: see node definition for valid relationships
28972       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28973       consumes:
28974         - application/json
28975         - application/xml
28976       produces:
28977         - application/json
28978         - application/xml
28979       responses:
28980         "default":
28981           description: Response codes found in [response codes](https://wiki.onap.org/).
28982       parameters:
28983         - name: vnf-id
28984           in: path
28985           description: Unique id of VNF.  This is unique across the graph.
28986           required: true
28987           type: string
28988           example: __VNF-ID__
28989         - name: group-uuid
28990           in: path
28991           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28992           required: true
28993           type: string
28994           example: __GROUP-UUID__
28995         - name: resource-uuid
28996           in: path
28997           description: Unique ID of an entitlement resource.
28998           required: true
28999           type: string
29000           example: __RESOURCE-UUID__
29001         - name: body
29002           in: body
29003           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceEntitlementsEntitlement.json)
29004           required: true
29005           schema:
29006             $ref: "#/definitions/relationship"
29007     delete:
29008       tags:
29009         - Network
29010       summary: delete an existing relationship
29011       description: delete an existing relationship
29012       operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
29013       consumes:
29014         - application/json
29015         - application/xml
29016       produces:
29017         - application/json
29018         - application/xml
29019       responses:
29020         "default":
29021           description: Response codes found in [response codes](https://wiki.onap.org/).
29022       parameters:
29023         - name: vnf-id
29024           in: path
29025           description: Unique id of VNF.  This is unique across the graph.
29026           required: true
29027           type: string
29028           example: __VNF-ID__
29029         - name: group-uuid
29030           in: path
29031           description: Unique ID for the entitlement group the resource comes from, should be uuid.
29032           required: true
29033           type: string
29034           example: __GROUP-UUID__
29035         - name: resource-uuid
29036           in: path
29037           description: Unique ID of an entitlement resource.
29038           required: true
29039           type: string
29040           example: __RESOURCE-UUID__
29041   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
29042     get:
29043       tags:
29044         - Network
29045       summary: returns entitlement
29046       description: returns entitlement
29047       operationId: getNetworkVcesVceEntitlementsEntitlement
29048       produces:
29049         - application/json
29050         - application/xml
29051       responses:
29052         "200":
29053           description: successful operation
29054           schema:
29055               $ref: "#/getDefinitions/entitlement"
29056         "default":
29057           description: Response codes found in [response codes](https://wiki.onap.org/).
29058       parameters:
29059         - name: vnf-id
29060           in: path
29061           description: Unique id of VNF.  This is unique across the graph.
29062           required: true
29063           type: string
29064           example: __VNF-ID__
29065         - name: group-uuid
29066           in: path
29067           description: Unique ID for the entitlement group the resource comes from, should be uuid.
29068           required: true
29069           type: string
29070           example: __GROUP-UUID__
29071         - name: resource-uuid
29072           in: path
29073           description: Unique ID of an entitlement resource.
29074           required: true
29075           type: string
29076           example: __RESOURCE-UUID__
29077     put:
29078       tags:
29079         - Network
29080       summary: create or update an existing entitlement
29081       description: |
29082         Create or update an existing entitlement.
29083         #
29084         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29085       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
29086       consumes:
29087         - application/json
29088         - application/xml
29089       produces:
29090         - application/json
29091         - application/xml
29092       responses:
29093         "default":
29094           description: Response codes found in [response codes](https://wiki.onap.org/).
29095       parameters:
29096         - name: vnf-id
29097           in: path
29098           description: Unique id of VNF.  This is unique across the graph.
29099           required: true
29100           type: string
29101           example: __VNF-ID__
29102         - name: group-uuid
29103           in: path
29104           description: Unique ID for the entitlement group the resource comes from, should be uuid.
29105           required: true
29106           type: string
29107           example: __GROUP-UUID__
29108         - name: resource-uuid
29109           in: path
29110           description: Unique ID of an entitlement resource.
29111           required: true
29112           type: string
29113           example: __RESOURCE-UUID__
29114         - name: body
29115           in: body
29116           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVceEntitlementsEntitlement.json)
29117           required: true
29118           schema:
29119             $ref: "#/definitions/entitlement"
29120     patch:
29121       tags:
29122         - Network
29123       summary: update an existing entitlement
29124       description: |
29125         Update an existing entitlement
29126         #
29127         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29128         The PUT operation will entirely replace an existing object.
29129         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29130         #
29131         Other differences between PUT and PATCH are:
29132         #
29133         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29134         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29135         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29136       operationId: UpdateNetworkVcesVceEntitlementsEntitlement
29137       consumes:
29138         - application/json
29139         - application/xml
29140       produces:
29141         - application/json
29142         - application/xml
29143       responses:
29144         "default":
29145           description: Response codes found in [response codes](https://wiki.onap.org/).
29146       parameters:
29147         - name: vnf-id
29148           in: path
29149           description: Unique id of VNF.  This is unique across the graph.
29150           required: true
29151           type: string
29152           example: __VNF-ID__
29153         - name: group-uuid
29154           in: path
29155           description: Unique ID for the entitlement group the resource comes from, should be uuid.
29156           required: true
29157           type: string
29158           example: __GROUP-UUID__
29159         - name: resource-uuid
29160           in: path
29161           description: Unique ID of an entitlement resource.
29162           required: true
29163           type: string
29164           example: __RESOURCE-UUID__
29165         - name: body
29166           in: body
29167           description: entitlement object that needs to be updated.
29168           required: true
29169           schema:
29170             $ref: "#/patchDefinitions/entitlement"
29171     delete:
29172       tags:
29173         - Network
29174       summary: delete an existing entitlement
29175       description: delete an existing entitlement
29176       operationId: deleteNetworkVcesVceEntitlementsEntitlement
29177       consumes:
29178         - application/json
29179         - application/xml
29180       produces:
29181         - application/json
29182         - application/xml
29183       responses:
29184         "default":
29185           description: Response codes found in [response codes](https://wiki.onap.org/).
29186       parameters:
29187         - name: vnf-id
29188           in: path
29189           description: Unique id of VNF.  This is unique across the graph.
29190           required: true
29191           type: string
29192           example: __VNF-ID__
29193         - name: group-uuid
29194           in: path
29195           description: Unique ID for the entitlement group the resource comes from, should be uuid.
29196           required: true
29197           type: string
29198           example: __GROUP-UUID__
29199         - name: resource-uuid
29200           in: path
29201           description: Unique ID of an entitlement resource.
29202           required: true
29203           type: string
29204           example: __RESOURCE-UUID__
29205         - name: resource-version
29206           in: query
29207           description: resource-version for concurrency
29208           required: true
29209           type: string
29210   /network/vces/vce/{vnf-id}/entitlements:
29211     get:
29212       tags:
29213         - Network
29214       summary: returns entitlements
29215       description: returns entitlements
29216       operationId: getNetworkVcesVceEntitlements
29217       produces:
29218         - application/json
29219         - application/xml
29220       responses:
29221         "200":
29222           description: successful operation
29223           schema:
29224               $ref: "#/getDefinitions/entitlements"
29225         "default":
29226           description: Response codes found in [response codes](https://wiki.onap.org/).
29227       parameters:
29228         - name: vnf-id
29229           in: path
29230           description: Unique id of VNF.  This is unique across the graph.
29231           required: true
29232           type: string
29233           example: __VNF-ID__
29234         - name: group-uuid
29235           in: query
29236           description:
29237           required: false
29238           type: string
29239         - name: resource-uuid
29240           in: query
29241           description:
29242           required: false
29243           type: string
29244   /network/vces/vce/{vnf-id}/relationship-list/relationship:
29245     put:
29246       tags:
29247         - Network
29248       summary: see node definition for valid relationships
29249       operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
29250       consumes:
29251         - application/json
29252         - application/xml
29253       produces:
29254         - application/json
29255         - application/xml
29256       responses:
29257         "default":
29258           description: Response codes found in [response codes](https://wiki.onap.org/).
29259       parameters:
29260         - name: vnf-id
29261           in: path
29262           description: Unique id of VNF.  This is unique across the graph.
29263           required: true
29264           type: string
29265           example: __VNF-ID__
29266         - name: body
29267           in: body
29268           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVce.json)
29269           required: true
29270           schema:
29271             $ref: "#/definitions/relationship"
29272     delete:
29273       tags:
29274         - Network
29275       summary: delete an existing relationship
29276       description: delete an existing relationship
29277       operationId: deleteNetworkVcesVceRelationshipListRelationship
29278       consumes:
29279         - application/json
29280         - application/xml
29281       produces:
29282         - application/json
29283         - application/xml
29284       responses:
29285         "default":
29286           description: Response codes found in [response codes](https://wiki.onap.org/).
29287       parameters:
29288         - name: vnf-id
29289           in: path
29290           description: Unique id of VNF.  This is unique across the graph.
29291           required: true
29292           type: string
29293           example: __VNF-ID__
29294   /network/vces/vce/{vnf-id}:
29295     get:
29296       tags:
29297         - Network
29298       summary: returns vce
29299       description: returns vce
29300       operationId: getNetworkVcesVce
29301       produces:
29302         - application/json
29303         - application/xml
29304       responses:
29305         "200":
29306           description: successful operation
29307           schema:
29308               $ref: "#/getDefinitions/vce"
29309         "default":
29310           description: Response codes found in [response codes](https://wiki.onap.org/).
29311       parameters:
29312         - name: vnf-id
29313           in: path
29314           description: Unique id of VNF.  This is unique across the graph.
29315           required: true
29316           type: string
29317           example: __VNF-ID__
29318     put:
29319       tags:
29320         - Network
29321       summary: create or update an existing vce
29322       description: |
29323         Create or update an existing vce.
29324         #
29325         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29326       operationId: createOrUpdateNetworkVcesVce
29327       consumes:
29328         - application/json
29329         - application/xml
29330       produces:
29331         - application/json
29332         - application/xml
29333       responses:
29334         "default":
29335           description: Response codes found in [response codes](https://wiki.onap.org/).
29336       parameters:
29337         - name: vnf-id
29338           in: path
29339           description: Unique id of VNF.  This is unique across the graph.
29340           required: true
29341           type: string
29342           example: __VNF-ID__
29343         - name: body
29344           in: body
29345           description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVcesVce.json)
29346           required: true
29347           schema:
29348             $ref: "#/definitions/vce"
29349     patch:
29350       tags:
29351         - Network
29352       summary: update an existing vce
29353       description: |
29354         Update an existing vce
29355         #
29356         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29357         The PUT operation will entirely replace an existing object.
29358         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29359         #
29360         Other differences between PUT and PATCH are:
29361         #
29362         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29363         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29364         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29365       operationId: UpdateNetworkVcesVce
29366       consumes:
29367         - application/json
29368         - application/xml
29369       produces:
29370         - application/json
29371         - application/xml
29372       responses:
29373         "default":
29374           description: Response codes found in [response codes](https://wiki.onap.org/).
29375       parameters:
29376         - name: vnf-id
29377           in: path
29378           description: Unique id of VNF.  This is unique across the graph.
29379           required: true
29380           type: string
29381           example: __VNF-ID__
29382         - name: body
29383           in: body
29384           description: vce object that needs to be updated.
29385           required: true
29386           schema:
29387             $ref: "#/patchDefinitions/vce"
29388     delete:
29389       tags:
29390         - Network
29391       summary: delete an existing vce
29392       description: delete an existing vce
29393       operationId: deleteNetworkVcesVce
29394       consumes:
29395         - application/json
29396         - application/xml
29397       produces:
29398         - application/json
29399         - application/xml
29400       responses:
29401         "default":
29402           description: Response codes found in [response codes](https://wiki.onap.org/).
29403       parameters:
29404         - name: vnf-id
29405           in: path
29406           description: Unique id of VNF.  This is unique across the graph.
29407           required: true
29408           type: string
29409           example: __VNF-ID__
29410         - name: resource-version
29411           in: query
29412           description: resource-version for concurrency
29413           required: true
29414           type: string
29415   /network/vces:
29416     get:
29417       tags:
29418         - Network
29419       summary: returns vces
29420       description: returns vces
29421       operationId: getNetworkVces
29422       produces:
29423         - application/json
29424         - application/xml
29425       responses:
29426         "200":
29427           description: successful operation
29428           schema:
29429               $ref: "#/getDefinitions/vces"
29430         "default":
29431           description: Response codes found in [response codes](https://wiki.onap.org/).
29432       parameters:
29433         - name: vnf-id
29434           in: query
29435           description:
29436           required: false
29437           type: string
29438         - name: vnf-name
29439           in: query
29440           description:
29441           required: false
29442           type: string
29443         - name: vnf-name2
29444           in: query
29445           description:
29446           required: false
29447           type: string
29448         - name: vnf-type
29449           in: query
29450           description:
29451           required: false
29452           type: string
29453         - name: service-id
29454           in: query
29455           description:
29456           required: false
29457           type: string
29458         - name: regional-resource-zone
29459           in: query
29460           description:
29461           required: false
29462           type: string
29463         - name: prov-status
29464           in: query
29465           description:
29466           required: false
29467           type: string
29468         - name: heat-stack-id
29469           in: query
29470           description:
29471           required: false
29472           type: string
29473         - name: vpe-id
29474           in: query
29475           description:
29476           required: false
29477           type: string
29478   /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
29479     put:
29480       tags:
29481         - Network
29482       summary: see node definition for valid relationships
29483       operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
29484       consumes:
29485         - application/json
29486         - application/xml
29487       produces:
29488         - application/json
29489         - application/xml
29490       responses:
29491         "default":
29492           description: Response codes found in [response codes](https://wiki.onap.org/).
29493       parameters:
29494         - name: vnfc-name
29495           in: path
29496           description: Unique ID of vnfc.
29497           required: true
29498           type: string
29499           example: __VNFC-NAME__
29500         - name: body
29501           in: body
29502           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfc.json)
29503           required: true
29504           schema:
29505             $ref: "#/definitions/relationship"
29506     delete:
29507       tags:
29508         - Network
29509       summary: delete an existing relationship
29510       description: delete an existing relationship
29511       operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
29512       consumes:
29513         - application/json
29514         - application/xml
29515       produces:
29516         - application/json
29517         - application/xml
29518       responses:
29519         "default":
29520           description: Response codes found in [response codes](https://wiki.onap.org/).
29521       parameters:
29522         - name: vnfc-name
29523           in: path
29524           description: Unique ID of vnfc.
29525           required: true
29526           type: string
29527           example: __VNFC-NAME__
29528   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
29529     put:
29530       tags:
29531         - Network
29532       summary: see node definition for valid relationships
29533       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
29534       consumes:
29535         - application/json
29536         - application/xml
29537       produces:
29538         - application/json
29539         - application/xml
29540       responses:
29541         "default":
29542           description: Response codes found in [response codes](https://wiki.onap.org/).
29543       parameters:
29544         - name: vnfc-name
29545           in: path
29546           description: Unique ID of vnfc.
29547           required: true
29548           type: string
29549           example: __VNFC-NAME__
29550         - name: l3-interface-ipv4-address
29551           in: path
29552           description: IP address
29553           required: true
29554           type: string
29555           example: __L3-INTERFACE-IPV4-ADDRESS__
29556         - name: body
29557           in: body
29558           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
29559           required: true
29560           schema:
29561             $ref: "#/definitions/relationship"
29562     delete:
29563       tags:
29564         - Network
29565       summary: delete an existing relationship
29566       description: delete an existing relationship
29567       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
29568       consumes:
29569         - application/json
29570         - application/xml
29571       produces:
29572         - application/json
29573         - application/xml
29574       responses:
29575         "default":
29576           description: Response codes found in [response codes](https://wiki.onap.org/).
29577       parameters:
29578         - name: vnfc-name
29579           in: path
29580           description: Unique ID of vnfc.
29581           required: true
29582           type: string
29583           example: __VNFC-NAME__
29584         - name: l3-interface-ipv4-address
29585           in: path
29586           description: IP address
29587           required: true
29588           type: string
29589           example: __L3-INTERFACE-IPV4-ADDRESS__
29590   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
29591     get:
29592       tags:
29593         - Network
29594       summary: returns l3-interface-ipv4-address-list
29595       description: returns l3-interface-ipv4-address-list
29596       operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29597       produces:
29598         - application/json
29599         - application/xml
29600       responses:
29601         "200":
29602           description: successful operation
29603           schema:
29604               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
29605         "default":
29606           description: Response codes found in [response codes](https://wiki.onap.org/).
29607       parameters:
29608         - name: vnfc-name
29609           in: path
29610           description: Unique ID of vnfc.
29611           required: true
29612           type: string
29613           example: __VNFC-NAME__
29614         - name: l3-interface-ipv4-address
29615           in: path
29616           description: IP address
29617           required: true
29618           type: string
29619           example: __L3-INTERFACE-IPV4-ADDRESS__
29620     put:
29621       tags:
29622         - Network
29623       summary: create or update an existing l3-interface-ipv4-address-list
29624       description: |
29625         Create or update an existing l3-interface-ipv4-address-list.
29626         #
29627         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29628       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29629       consumes:
29630         - application/json
29631         - application/xml
29632       produces:
29633         - application/json
29634         - application/xml
29635       responses:
29636         "default":
29637           description: Response codes found in [response codes](https://wiki.onap.org/).
29638       parameters:
29639         - name: vnfc-name
29640           in: path
29641           description: Unique ID of vnfc.
29642           required: true
29643           type: string
29644           example: __VNFC-NAME__
29645         - name: l3-interface-ipv4-address
29646           in: path
29647           description: IP address
29648           required: true
29649           type: string
29650           example: __L3-INTERFACE-IPV4-ADDRESS__
29651         - name: body
29652           in: body
29653           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
29654           required: true
29655           schema:
29656             $ref: "#/definitions/l3-interface-ipv4-address-list"
29657     patch:
29658       tags:
29659         - Network
29660       summary: update an existing l3-interface-ipv4-address-list
29661       description: |
29662         Update an existing l3-interface-ipv4-address-list
29663         #
29664         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29665         The PUT operation will entirely replace an existing object.
29666         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29667         #
29668         Other differences between PUT and PATCH are:
29669         #
29670         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29671         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29672         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29673       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29674       consumes:
29675         - application/json
29676         - application/xml
29677       produces:
29678         - application/json
29679         - application/xml
29680       responses:
29681         "default":
29682           description: Response codes found in [response codes](https://wiki.onap.org/).
29683       parameters:
29684         - name: vnfc-name
29685           in: path
29686           description: Unique ID of vnfc.
29687           required: true
29688           type: string
29689           example: __VNFC-NAME__
29690         - name: l3-interface-ipv4-address
29691           in: path
29692           description: IP address
29693           required: true
29694           type: string
29695           example: __L3-INTERFACE-IPV4-ADDRESS__
29696         - name: body
29697           in: body
29698           description: l3-interface-ipv4-address-list object that needs to be updated.
29699           required: true
29700           schema:
29701             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
29702     delete:
29703       tags:
29704         - Network
29705       summary: delete an existing l3-interface-ipv4-address-list
29706       description: delete an existing l3-interface-ipv4-address-list
29707       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
29708       consumes:
29709         - application/json
29710         - application/xml
29711       produces:
29712         - application/json
29713         - application/xml
29714       responses:
29715         "default":
29716           description: Response codes found in [response codes](https://wiki.onap.org/).
29717       parameters:
29718         - name: vnfc-name
29719           in: path
29720           description: Unique ID of vnfc.
29721           required: true
29722           type: string
29723           example: __VNFC-NAME__
29724         - name: l3-interface-ipv4-address
29725           in: path
29726           description: IP address
29727           required: true
29728           type: string
29729           example: __L3-INTERFACE-IPV4-ADDRESS__
29730         - name: resource-version
29731           in: query
29732           description: resource-version for concurrency
29733           required: true
29734           type: string
29735   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
29736     put:
29737       tags:
29738         - Network
29739       summary: see node definition for valid relationships
29740       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
29741       consumes:
29742         - application/json
29743         - application/xml
29744       produces:
29745         - application/json
29746         - application/xml
29747       responses:
29748         "default":
29749           description: Response codes found in [response codes](https://wiki.onap.org/).
29750       parameters:
29751         - name: vnfc-name
29752           in: path
29753           description: Unique ID of vnfc.
29754           required: true
29755           type: string
29756           example: __VNFC-NAME__
29757         - name: l3-interface-ipv6-address
29758           in: path
29759           description: IP address
29760           required: true
29761           type: string
29762           example: __L3-INTERFACE-IPV6-ADDRESS__
29763         - name: body
29764           in: body
29765           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
29766           required: true
29767           schema:
29768             $ref: "#/definitions/relationship"
29769     delete:
29770       tags:
29771         - Network
29772       summary: delete an existing relationship
29773       description: delete an existing relationship
29774       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
29775       consumes:
29776         - application/json
29777         - application/xml
29778       produces:
29779         - application/json
29780         - application/xml
29781       responses:
29782         "default":
29783           description: Response codes found in [response codes](https://wiki.onap.org/).
29784       parameters:
29785         - name: vnfc-name
29786           in: path
29787           description: Unique ID of vnfc.
29788           required: true
29789           type: string
29790           example: __VNFC-NAME__
29791         - name: l3-interface-ipv6-address
29792           in: path
29793           description: IP address
29794           required: true
29795           type: string
29796           example: __L3-INTERFACE-IPV6-ADDRESS__
29797   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
29798     get:
29799       tags:
29800         - Network
29801       summary: returns l3-interface-ipv6-address-list
29802       description: returns l3-interface-ipv6-address-list
29803       operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29804       produces:
29805         - application/json
29806         - application/xml
29807       responses:
29808         "200":
29809           description: successful operation
29810           schema:
29811               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
29812         "default":
29813           description: Response codes found in [response codes](https://wiki.onap.org/).
29814       parameters:
29815         - name: vnfc-name
29816           in: path
29817           description: Unique ID of vnfc.
29818           required: true
29819           type: string
29820           example: __VNFC-NAME__
29821         - name: l3-interface-ipv6-address
29822           in: path
29823           description: IP address
29824           required: true
29825           type: string
29826           example: __L3-INTERFACE-IPV6-ADDRESS__
29827     put:
29828       tags:
29829         - Network
29830       summary: create or update an existing l3-interface-ipv6-address-list
29831       description: |
29832         Create or update an existing l3-interface-ipv6-address-list.
29833         #
29834         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29835       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29836       consumes:
29837         - application/json
29838         - application/xml
29839       produces:
29840         - application/json
29841         - application/xml
29842       responses:
29843         "default":
29844           description: Response codes found in [response codes](https://wiki.onap.org/).
29845       parameters:
29846         - name: vnfc-name
29847           in: path
29848           description: Unique ID of vnfc.
29849           required: true
29850           type: string
29851           example: __VNFC-NAME__
29852         - name: l3-interface-ipv6-address
29853           in: path
29854           description: IP address
29855           required: true
29856           type: string
29857           example: __L3-INTERFACE-IPV6-ADDRESS__
29858         - name: body
29859           in: body
29860           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
29861           required: true
29862           schema:
29863             $ref: "#/definitions/l3-interface-ipv6-address-list"
29864     patch:
29865       tags:
29866         - Network
29867       summary: update an existing l3-interface-ipv6-address-list
29868       description: |
29869         Update an existing l3-interface-ipv6-address-list
29870         #
29871         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29872         The PUT operation will entirely replace an existing object.
29873         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29874         #
29875         Other differences between PUT and PATCH are:
29876         #
29877         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29878         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29879         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29880       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29881       consumes:
29882         - application/json
29883         - application/xml
29884       produces:
29885         - application/json
29886         - application/xml
29887       responses:
29888         "default":
29889           description: Response codes found in [response codes](https://wiki.onap.org/).
29890       parameters:
29891         - name: vnfc-name
29892           in: path
29893           description: Unique ID of vnfc.
29894           required: true
29895           type: string
29896           example: __VNFC-NAME__
29897         - name: l3-interface-ipv6-address
29898           in: path
29899           description: IP address
29900           required: true
29901           type: string
29902           example: __L3-INTERFACE-IPV6-ADDRESS__
29903         - name: body
29904           in: body
29905           description: l3-interface-ipv6-address-list object that needs to be updated.
29906           required: true
29907           schema:
29908             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29909     delete:
29910       tags:
29911         - Network
29912       summary: delete an existing l3-interface-ipv6-address-list
29913       description: delete an existing l3-interface-ipv6-address-list
29914       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
29915       consumes:
29916         - application/json
29917         - application/xml
29918       produces:
29919         - application/json
29920         - application/xml
29921       responses:
29922         "default":
29923           description: Response codes found in [response codes](https://wiki.onap.org/).
29924       parameters:
29925         - name: vnfc-name
29926           in: path
29927           description: Unique ID of vnfc.
29928           required: true
29929           type: string
29930           example: __VNFC-NAME__
29931         - name: l3-interface-ipv6-address
29932           in: path
29933           description: IP address
29934           required: true
29935           type: string
29936           example: __L3-INTERFACE-IPV6-ADDRESS__
29937         - name: resource-version
29938           in: query
29939           description: resource-version for concurrency
29940           required: true
29941           type: string
29942   /network/vnfcs/vnfc/{vnfc-name}:
29943     get:
29944       tags:
29945         - Network
29946       summary: returns vnfc
29947       description: returns vnfc
29948       operationId: getNetworkVnfcsVnfc
29949       produces:
29950         - application/json
29951         - application/xml
29952       responses:
29953         "200":
29954           description: successful operation
29955           schema:
29956               $ref: "#/getDefinitions/vnfc"
29957         "default":
29958           description: Response codes found in [response codes](https://wiki.onap.org/).
29959       parameters:
29960         - name: vnfc-name
29961           in: path
29962           description: Unique ID of vnfc.
29963           required: true
29964           type: string
29965           example: __VNFC-NAME__
29966     put:
29967       tags:
29968         - Network
29969       summary: create or update an existing vnfc
29970       description: |
29971         Create or update an existing vnfc.
29972         #
29973         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29974       operationId: createOrUpdateNetworkVnfcsVnfc
29975       consumes:
29976         - application/json
29977         - application/xml
29978       produces:
29979         - application/json
29980         - application/xml
29981       responses:
29982         "default":
29983           description: Response codes found in [response codes](https://wiki.onap.org/).
29984       parameters:
29985         - name: vnfc-name
29986           in: path
29987           description: Unique ID of vnfc.
29988           required: true
29989           type: string
29990           example: __VNFC-NAME__
29991         - name: body
29992           in: body
29993           description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkVnfcsVnfc.json)
29994           required: true
29995           schema:
29996             $ref: "#/definitions/vnfc"
29997     patch:
29998       tags:
29999         - Network
30000       summary: update an existing vnfc
30001       description: |
30002         Update an existing vnfc
30003         #
30004         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30005         The PUT operation will entirely replace an existing object.
30006         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30007         #
30008         Other differences between PUT and PATCH are:
30009         #
30010         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30011         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30012         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30013       operationId: UpdateNetworkVnfcsVnfc
30014       consumes:
30015         - application/json
30016         - application/xml
30017       produces:
30018         - application/json
30019         - application/xml
30020       responses:
30021         "default":
30022           description: Response codes found in [response codes](https://wiki.onap.org/).
30023       parameters:
30024         - name: vnfc-name
30025           in: path
30026           description: Unique ID of vnfc.
30027           required: true
30028           type: string
30029           example: __VNFC-NAME__
30030         - name: body
30031           in: body
30032           description: vnfc object that needs to be updated.
30033           required: true
30034           schema:
30035             $ref: "#/patchDefinitions/vnfc"
30036     delete:
30037       tags:
30038         - Network
30039       summary: delete an existing vnfc
30040       description: delete an existing vnfc
30041       operationId: deleteNetworkVnfcsVnfc
30042       consumes:
30043         - application/json
30044         - application/xml
30045       produces:
30046         - application/json
30047         - application/xml
30048       responses:
30049         "default":
30050           description: Response codes found in [response codes](https://wiki.onap.org/).
30051       parameters:
30052         - name: vnfc-name
30053           in: path
30054           description: Unique ID of vnfc.
30055           required: true
30056           type: string
30057           example: __VNFC-NAME__
30058         - name: resource-version
30059           in: query
30060           description: resource-version for concurrency
30061           required: true
30062           type: string
30063   /network/vnfcs:
30064     get:
30065       tags:
30066         - Network
30067       summary: returns vnfcs
30068       description: returns vnfcs
30069       operationId: getNetworkVnfcs
30070       produces:
30071         - application/json
30072         - application/xml
30073       responses:
30074         "200":
30075           description: successful operation
30076           schema:
30077               $ref: "#/getDefinitions/vnfcs"
30078         "default":
30079           description: Response codes found in [response codes](https://wiki.onap.org/).
30080       parameters:
30081         - name: vnfc-name
30082           in: query
30083           description:
30084           required: false
30085           type: string
30086         - name: nfc-naming-code
30087           in: query
30088           description:
30089           required: false
30090           type: string
30091         - name: nfc-function
30092           in: query
30093           description:
30094           required: false
30095           type: string
30096         - name: prov-status
30097           in: query
30098           description:
30099           required: false
30100           type: string
30101         - name: ipaddress-v4-oam-vip
30102           in: query
30103           description:
30104           required: false
30105           type: string
30106         - name: in-maint
30107           in: query
30108           description:
30109           required: false
30110           type: boolean
30111         - name: is-closed-loop-disabled
30112           in: query
30113           description:
30114           required: false
30115           type: boolean
30116         - name: group-notation
30117           in: query
30118           description:
30119           required: false
30120           type: string
30121         - name: model-invariant-id
30122           in: query
30123           description:
30124           required: false
30125           type: string
30126         - name: model-version-id
30127           in: query
30128           description:
30129           required: false
30130           type: string
30131   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
30132     put:
30133       tags:
30134         - Network
30135       summary: see node definition for valid relationships
30136       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
30137       consumes:
30138         - application/json
30139         - application/xml
30140       produces:
30141         - application/json
30142         - application/xml
30143       responses:
30144         "default":
30145           description: Response codes found in [response codes](https://wiki.onap.org/).
30146       parameters:
30147         - name: network-id
30148           in: path
30149           description: Network ID, should be uuid. Unique across A&AI.
30150           required: true
30151           type: string
30152           example: __NETWORK-ID__
30153         - name: subnet-id
30154           in: path
30155           description: Subnet ID, should be UUID.
30156           required: true
30157           type: string
30158           example: __SUBNET-ID__
30159         - name: host-route-id
30160           in: path
30161           description: host-route id
30162           required: true
30163           type: string
30164           example: __HOST-ROUTE-ID__
30165         - name: body
30166           in: body
30167           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
30168           required: true
30169           schema:
30170             $ref: "#/definitions/relationship"
30171     delete:
30172       tags:
30173         - Network
30174       summary: delete an existing relationship
30175       description: delete an existing relationship
30176       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
30177       consumes:
30178         - application/json
30179         - application/xml
30180       produces:
30181         - application/json
30182         - application/xml
30183       responses:
30184         "default":
30185           description: Response codes found in [response codes](https://wiki.onap.org/).
30186       parameters:
30187         - name: network-id
30188           in: path
30189           description: Network ID, should be uuid. Unique across A&AI.
30190           required: true
30191           type: string
30192           example: __NETWORK-ID__
30193         - name: subnet-id
30194           in: path
30195           description: Subnet ID, should be UUID.
30196           required: true
30197           type: string
30198           example: __SUBNET-ID__
30199         - name: host-route-id
30200           in: path
30201           description: host-route id
30202           required: true
30203           type: string
30204           example: __HOST-ROUTE-ID__
30205   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
30206     get:
30207       tags:
30208         - Network
30209       summary: returns host-route
30210       description: returns host-route
30211       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
30212       produces:
30213         - application/json
30214         - application/xml
30215       responses:
30216         "200":
30217           description: successful operation
30218           schema:
30219               $ref: "#/getDefinitions/host-route"
30220         "default":
30221           description: Response codes found in [response codes](https://wiki.onap.org/).
30222       parameters:
30223         - name: network-id
30224           in: path
30225           description: Network ID, should be uuid. Unique across A&AI.
30226           required: true
30227           type: string
30228           example: __NETWORK-ID__
30229         - name: subnet-id
30230           in: path
30231           description: Subnet ID, should be UUID.
30232           required: true
30233           type: string
30234           example: __SUBNET-ID__
30235         - name: host-route-id
30236           in: path
30237           description: host-route id
30238           required: true
30239           type: string
30240           example: __HOST-ROUTE-ID__
30241     put:
30242       tags:
30243         - Network
30244       summary: create or update an existing host-route
30245       description: |
30246         Create or update an existing host-route.
30247         #
30248         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30249       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
30250       consumes:
30251         - application/json
30252         - application/xml
30253       produces:
30254         - application/json
30255         - application/xml
30256       responses:
30257         "default":
30258           description: Response codes found in [response codes](https://wiki.onap.org/).
30259       parameters:
30260         - name: network-id
30261           in: path
30262           description: Network ID, should be uuid. Unique across A&AI.
30263           required: true
30264           type: string
30265           example: __NETWORK-ID__
30266         - name: subnet-id
30267           in: path
30268           description: Subnet ID, should be UUID.
30269           required: true
30270           type: string
30271           example: __SUBNET-ID__
30272         - name: host-route-id
30273           in: path
30274           description: host-route id
30275           required: true
30276           type: string
30277           example: __HOST-ROUTE-ID__
30278         - name: body
30279           in: body
30280           description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
30281           required: true
30282           schema:
30283             $ref: "#/definitions/host-route"
30284     patch:
30285       tags:
30286         - Network
30287       summary: update an existing host-route
30288       description: |
30289         Update an existing host-route
30290         #
30291         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30292         The PUT operation will entirely replace an existing object.
30293         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30294         #
30295         Other differences between PUT and PATCH are:
30296         #
30297         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30298         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30299         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30300       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
30301       consumes:
30302         - application/json
30303         - application/xml
30304       produces:
30305         - application/json
30306         - application/xml
30307       responses:
30308         "default":
30309           description: Response codes found in [response codes](https://wiki.onap.org/).
30310       parameters:
30311         - name: network-id
30312           in: path
30313           description: Network ID, should be uuid. Unique across A&AI.
30314           required: true
30315           type: string
30316           example: __NETWORK-ID__
30317         - name: subnet-id
30318           in: path
30319           description: Subnet ID, should be UUID.
30320           required: true
30321           type: string
30322           example: __SUBNET-ID__
30323         - name: host-route-id
30324           in: path
30325           description: host-route id
30326           required: true
30327           type: string
30328           example: __HOST-ROUTE-ID__
30329         - name: body
30330           in: body
30331           description: host-route object that needs to be updated.
30332           required: true
30333           schema:
30334             $ref: "#/patchDefinitions/host-route"
30335     delete:
30336       tags:
30337         - Network
30338       summary: delete an existing host-route
30339       description: delete an existing host-route
30340       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
30341       consumes:
30342         - application/json
30343         - application/xml
30344       produces:
30345         - application/json
30346         - application/xml
30347       responses:
30348         "default":
30349           description: Response codes found in [response codes](https://wiki.onap.org/).
30350       parameters:
30351         - name: network-id
30352           in: path
30353           description: Network ID, should be uuid. Unique across A&AI.
30354           required: true
30355           type: string
30356           example: __NETWORK-ID__
30357         - name: subnet-id
30358           in: path
30359           description: Subnet ID, should be UUID.
30360           required: true
30361           type: string
30362           example: __SUBNET-ID__
30363         - name: host-route-id
30364           in: path
30365           description: host-route id
30366           required: true
30367           type: string
30368           example: __HOST-ROUTE-ID__
30369         - name: resource-version
30370           in: query
30371           description: resource-version for concurrency
30372           required: true
30373           type: string
30374   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
30375     get:
30376       tags:
30377         - Network
30378       summary: returns host-routes
30379       description: returns host-routes
30380       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
30381       produces:
30382         - application/json
30383         - application/xml
30384       responses:
30385         "200":
30386           description: successful operation
30387           schema:
30388               $ref: "#/getDefinitions/host-routes"
30389         "default":
30390           description: Response codes found in [response codes](https://wiki.onap.org/).
30391       parameters:
30392         - name: network-id
30393           in: path
30394           description: Network ID, should be uuid. Unique across A&AI.
30395           required: true
30396           type: string
30397           example: __NETWORK-ID__
30398         - name: subnet-id
30399           in: path
30400           description: Subnet ID, should be UUID.
30401           required: true
30402           type: string
30403           example: __SUBNET-ID__
30404         - name: host-route-id
30405           in: query
30406           description:
30407           required: false
30408           type: string
30409   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
30410     put:
30411       tags:
30412         - Network
30413       summary: see node definition for valid relationships
30414       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
30415       consumes:
30416         - application/json
30417         - application/xml
30418       produces:
30419         - application/json
30420         - application/xml
30421       responses:
30422         "default":
30423           description: Response codes found in [response codes](https://wiki.onap.org/).
30424       parameters:
30425         - name: network-id
30426           in: path
30427           description: Network ID, should be uuid. Unique across A&AI.
30428           required: true
30429           type: string
30430           example: __NETWORK-ID__
30431         - name: subnet-id
30432           in: path
30433           description: Subnet ID, should be UUID.
30434           required: true
30435           type: string
30436           example: __SUBNET-ID__
30437         - name: body
30438           in: body
30439           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
30440           required: true
30441           schema:
30442             $ref: "#/definitions/relationship"
30443     delete:
30444       tags:
30445         - Network
30446       summary: delete an existing relationship
30447       description: delete an existing relationship
30448       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
30449       consumes:
30450         - application/json
30451         - application/xml
30452       produces:
30453         - application/json
30454         - application/xml
30455       responses:
30456         "default":
30457           description: Response codes found in [response codes](https://wiki.onap.org/).
30458       parameters:
30459         - name: network-id
30460           in: path
30461           description: Network ID, should be uuid. Unique across A&AI.
30462           required: true
30463           type: string
30464           example: __NETWORK-ID__
30465         - name: subnet-id
30466           in: path
30467           description: Subnet ID, should be UUID.
30468           required: true
30469           type: string
30470           example: __SUBNET-ID__
30471   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
30472     get:
30473       tags:
30474         - Network
30475       summary: returns subnet
30476       description: returns subnet
30477       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
30478       produces:
30479         - application/json
30480         - application/xml
30481       responses:
30482         "200":
30483           description: successful operation
30484           schema:
30485               $ref: "#/getDefinitions/subnet"
30486         "default":
30487           description: Response codes found in [response codes](https://wiki.onap.org/).
30488       parameters:
30489         - name: network-id
30490           in: path
30491           description: Network ID, should be uuid. Unique across A&AI.
30492           required: true
30493           type: string
30494           example: __NETWORK-ID__
30495         - name: subnet-id
30496           in: path
30497           description: Subnet ID, should be UUID.
30498           required: true
30499           type: string
30500           example: __SUBNET-ID__
30501     put:
30502       tags:
30503         - Network
30504       summary: create or update an existing subnet
30505       description: |
30506         Create or update an existing subnet.
30507         #
30508         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30509       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
30510       consumes:
30511         - application/json
30512         - application/xml
30513       produces:
30514         - application/json
30515         - application/xml
30516       responses:
30517         "default":
30518           description: Response codes found in [response codes](https://wiki.onap.org/).
30519       parameters:
30520         - name: network-id
30521           in: path
30522           description: Network ID, should be uuid. Unique across A&AI.
30523           required: true
30524           type: string
30525           example: __NETWORK-ID__
30526         - name: subnet-id
30527           in: path
30528           description: Subnet ID, should be UUID.
30529           required: true
30530           type: string
30531           example: __SUBNET-ID__
30532         - name: body
30533           in: body
30534           description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
30535           required: true
30536           schema:
30537             $ref: "#/definitions/subnet"
30538     patch:
30539       tags:
30540         - Network
30541       summary: update an existing subnet
30542       description: |
30543         Update an existing subnet
30544         #
30545         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30546         The PUT operation will entirely replace an existing object.
30547         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30548         #
30549         Other differences between PUT and PATCH are:
30550         #
30551         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30552         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30553         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30554       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
30555       consumes:
30556         - application/json
30557         - application/xml
30558       produces:
30559         - application/json
30560         - application/xml
30561       responses:
30562         "default":
30563           description: Response codes found in [response codes](https://wiki.onap.org/).
30564       parameters:
30565         - name: network-id
30566           in: path
30567           description: Network ID, should be uuid. Unique across A&AI.
30568           required: true
30569           type: string
30570           example: __NETWORK-ID__
30571         - name: subnet-id
30572           in: path
30573           description: Subnet ID, should be UUID.
30574           required: true
30575           type: string
30576           example: __SUBNET-ID__
30577         - name: body
30578           in: body
30579           description: subnet object that needs to be updated.
30580           required: true
30581           schema:
30582             $ref: "#/patchDefinitions/subnet"
30583     delete:
30584       tags:
30585         - Network
30586       summary: delete an existing subnet
30587       description: delete an existing subnet
30588       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
30589       consumes:
30590         - application/json
30591         - application/xml
30592       produces:
30593         - application/json
30594         - application/xml
30595       responses:
30596         "default":
30597           description: Response codes found in [response codes](https://wiki.onap.org/).
30598       parameters:
30599         - name: network-id
30600           in: path
30601           description: Network ID, should be uuid. Unique across A&AI.
30602           required: true
30603           type: string
30604           example: __NETWORK-ID__
30605         - name: subnet-id
30606           in: path
30607           description: Subnet ID, should be UUID.
30608           required: true
30609           type: string
30610           example: __SUBNET-ID__
30611         - name: resource-version
30612           in: query
30613           description: resource-version for concurrency
30614           required: true
30615           type: string
30616   /network/l3-networks/l3-network/{network-id}/subnets:
30617     get:
30618       tags:
30619         - Network
30620       summary: returns subnets
30621       description: returns subnets
30622       operationId: getNetworkL3NetworksL3NetworkSubnets
30623       produces:
30624         - application/json
30625         - application/xml
30626       responses:
30627         "200":
30628           description: successful operation
30629           schema:
30630               $ref: "#/getDefinitions/subnets"
30631         "default":
30632           description: Response codes found in [response codes](https://wiki.onap.org/).
30633       parameters:
30634         - name: network-id
30635           in: path
30636           description: Network ID, should be uuid. Unique across A&AI.
30637           required: true
30638           type: string
30639           example: __NETWORK-ID__
30640         - name: subnet-id
30641           in: query
30642           description:
30643           required: false
30644           type: string
30645         - name: subnet-name
30646           in: query
30647           description:
30648           required: false
30649           type: string
30650   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
30651     put:
30652       tags:
30653         - Network
30654       summary: see node definition for valid relationships
30655       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
30656       consumes:
30657         - application/json
30658         - application/xml
30659       produces:
30660         - application/json
30661         - application/xml
30662       responses:
30663         "default":
30664           description: Response codes found in [response codes](https://wiki.onap.org/).
30665       parameters:
30666         - name: network-id
30667           in: path
30668           description: Network ID, should be uuid. Unique across A&AI.
30669           required: true
30670           type: string
30671           example: __NETWORK-ID__
30672         - name: vlan-id-inner
30673           in: path
30674           description: id.
30675           required: true
30676           type: integer
30677           format: int64
30678           example: __VLAN-ID-INNER__
30679         - name: body
30680           in: body
30681           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
30682           required: true
30683           schema:
30684             $ref: "#/definitions/relationship"
30685     delete:
30686       tags:
30687         - Network
30688       summary: delete an existing relationship
30689       description: delete an existing relationship
30690       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
30691       consumes:
30692         - application/json
30693         - application/xml
30694       produces:
30695         - application/json
30696         - application/xml
30697       responses:
30698         "default":
30699           description: Response codes found in [response codes](https://wiki.onap.org/).
30700       parameters:
30701         - name: network-id
30702           in: path
30703           description: Network ID, should be uuid. Unique across A&AI.
30704           required: true
30705           type: string
30706           example: __NETWORK-ID__
30707         - name: vlan-id-inner
30708           in: path
30709           description: id.
30710           required: true
30711           type: integer
30712           format: int64
30713           example: __VLAN-ID-INNER__
30714   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
30715     get:
30716       tags:
30717         - Network
30718       summary: returns ctag-assignment
30719       description: returns ctag-assignment
30720       operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30721       produces:
30722         - application/json
30723         - application/xml
30724       responses:
30725         "200":
30726           description: successful operation
30727           schema:
30728               $ref: "#/getDefinitions/ctag-assignment"
30729         "default":
30730           description: Response codes found in [response codes](https://wiki.onap.org/).
30731       parameters:
30732         - name: network-id
30733           in: path
30734           description: Network ID, should be uuid. Unique across A&AI.
30735           required: true
30736           type: string
30737           example: __NETWORK-ID__
30738         - name: vlan-id-inner
30739           in: path
30740           description: id.
30741           required: true
30742           type: integer
30743           format: int64
30744           example: __VLAN-ID-INNER__
30745     put:
30746       tags:
30747         - Network
30748       summary: create or update an existing ctag-assignment
30749       description: |
30750         Create or update an existing ctag-assignment.
30751         #
30752         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30753       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30754       consumes:
30755         - application/json
30756         - application/xml
30757       produces:
30758         - application/json
30759         - application/xml
30760       responses:
30761         "default":
30762           description: Response codes found in [response codes](https://wiki.onap.org/).
30763       parameters:
30764         - name: network-id
30765           in: path
30766           description: Network ID, should be uuid. Unique across A&AI.
30767           required: true
30768           type: string
30769           example: __NETWORK-ID__
30770         - name: vlan-id-inner
30771           in: path
30772           description: id.
30773           required: true
30774           type: integer
30775           format: int64
30776           example: __VLAN-ID-INNER__
30777         - name: body
30778           in: body
30779           description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
30780           required: true
30781           schema:
30782             $ref: "#/definitions/ctag-assignment"
30783     patch:
30784       tags:
30785         - Network
30786       summary: update an existing ctag-assignment
30787       description: |
30788         Update an existing ctag-assignment
30789         #
30790         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30791         The PUT operation will entirely replace an existing object.
30792         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30793         #
30794         Other differences between PUT and PATCH are:
30795         #
30796         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30797         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30798         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30799       operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30800       consumes:
30801         - application/json
30802         - application/xml
30803       produces:
30804         - application/json
30805         - application/xml
30806       responses:
30807         "default":
30808           description: Response codes found in [response codes](https://wiki.onap.org/).
30809       parameters:
30810         - name: network-id
30811           in: path
30812           description: Network ID, should be uuid. Unique across A&AI.
30813           required: true
30814           type: string
30815           example: __NETWORK-ID__
30816         - name: vlan-id-inner
30817           in: path
30818           description: id.
30819           required: true
30820           type: integer
30821           format: int64
30822           example: __VLAN-ID-INNER__
30823         - name: body
30824           in: body
30825           description: ctag-assignment object that needs to be updated.
30826           required: true
30827           schema:
30828             $ref: "#/patchDefinitions/ctag-assignment"
30829     delete:
30830       tags:
30831         - Network
30832       summary: delete an existing ctag-assignment
30833       description: delete an existing ctag-assignment
30834       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
30835       consumes:
30836         - application/json
30837         - application/xml
30838       produces:
30839         - application/json
30840         - application/xml
30841       responses:
30842         "default":
30843           description: Response codes found in [response codes](https://wiki.onap.org/).
30844       parameters:
30845         - name: network-id
30846           in: path
30847           description: Network ID, should be uuid. Unique across A&AI.
30848           required: true
30849           type: string
30850           example: __NETWORK-ID__
30851         - name: vlan-id-inner
30852           in: path
30853           description: id.
30854           required: true
30855           type: integer
30856           format: int64
30857           example: __VLAN-ID-INNER__
30858         - name: resource-version
30859           in: query
30860           description: resource-version for concurrency
30861           required: true
30862           type: string
30863   /network/l3-networks/l3-network/{network-id}/ctag-assignments:
30864     get:
30865       tags:
30866         - Network
30867       summary: returns ctag-assignments
30868       description: returns ctag-assignments
30869       operationId: getNetworkL3NetworksL3NetworkCtagAssignments
30870       produces:
30871         - application/json
30872         - application/xml
30873       responses:
30874         "200":
30875           description: successful operation
30876           schema:
30877               $ref: "#/getDefinitions/ctag-assignments"
30878         "default":
30879           description: Response codes found in [response codes](https://wiki.onap.org/).
30880       parameters:
30881         - name: network-id
30882           in: path
30883           description: Network ID, should be uuid. Unique across A&AI.
30884           required: true
30885           type: string
30886           example: __NETWORK-ID__
30887         - name: vlan-id-inner
30888           in: query
30889           description:
30890           required: false
30891           type: integer
30892           format: int64
30893   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
30894     put:
30895       tags:
30896         - Network
30897       summary: see node definition for valid relationships
30898       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
30899       consumes:
30900         - application/json
30901         - application/xml
30902       produces:
30903         - application/json
30904         - application/xml
30905       responses:
30906         "default":
30907           description: Response codes found in [response codes](https://wiki.onap.org/).
30908       parameters:
30909         - name: network-id
30910           in: path
30911           description: Network ID, should be uuid. Unique across A&AI.
30912           required: true
30913           type: string
30914           example: __NETWORK-ID__
30915         - name: segmentation-id
30916           in: path
30917           description: Route Table Reference id, UUID assigned to this instance.
30918           required: true
30919           type: string
30920           example: __SEGMENTATION-ID__
30921         - name: body
30922           in: body
30923           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
30924           required: true
30925           schema:
30926             $ref: "#/definitions/relationship"
30927     delete:
30928       tags:
30929         - Network
30930       summary: delete an existing relationship
30931       description: delete an existing relationship
30932       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
30933       consumes:
30934         - application/json
30935         - application/xml
30936       produces:
30937         - application/json
30938         - application/xml
30939       responses:
30940         "default":
30941           description: Response codes found in [response codes](https://wiki.onap.org/).
30942       parameters:
30943         - name: network-id
30944           in: path
30945           description: Network ID, should be uuid. Unique across A&AI.
30946           required: true
30947           type: string
30948           example: __NETWORK-ID__
30949         - name: segmentation-id
30950           in: path
30951           description: Route Table Reference id, UUID assigned to this instance.
30952           required: true
30953           type: string
30954           example: __SEGMENTATION-ID__
30955   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
30956     get:
30957       tags:
30958         - Network
30959       summary: returns segmentation-assignment
30960       description: returns segmentation-assignment
30961       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30962       produces:
30963         - application/json
30964         - application/xml
30965       responses:
30966         "200":
30967           description: successful operation
30968           schema:
30969               $ref: "#/getDefinitions/segmentation-assignment"
30970         "default":
30971           description: Response codes found in [response codes](https://wiki.onap.org/).
30972       parameters:
30973         - name: network-id
30974           in: path
30975           description: Network ID, should be uuid. Unique across A&AI.
30976           required: true
30977           type: string
30978           example: __NETWORK-ID__
30979         - name: segmentation-id
30980           in: path
30981           description: Route Table Reference id, UUID assigned to this instance.
30982           required: true
30983           type: string
30984           example: __SEGMENTATION-ID__
30985     put:
30986       tags:
30987         - Network
30988       summary: create or update an existing segmentation-assignment
30989       description: |
30990         Create or update an existing segmentation-assignment.
30991         #
30992         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30993       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30994       consumes:
30995         - application/json
30996         - application/xml
30997       produces:
30998         - application/json
30999         - application/xml
31000       responses:
31001         "default":
31002           description: Response codes found in [response codes](https://wiki.onap.org/).
31003       parameters:
31004         - name: network-id
31005           in: path
31006           description: Network ID, should be uuid. Unique across A&AI.
31007           required: true
31008           type: string
31009           example: __NETWORK-ID__
31010         - name: segmentation-id
31011           in: path
31012           description: Route Table Reference id, UUID assigned to this instance.
31013           required: true
31014           type: string
31015           example: __SEGMENTATION-ID__
31016         - name: body
31017           in: body
31018           description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
31019           required: true
31020           schema:
31021             $ref: "#/definitions/segmentation-assignment"
31022     patch:
31023       tags:
31024         - Network
31025       summary: update an existing segmentation-assignment
31026       description: |
31027         Update an existing segmentation-assignment
31028         #
31029         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31030         The PUT operation will entirely replace an existing object.
31031         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31032         #
31033         Other differences between PUT and PATCH are:
31034         #
31035         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31036         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31037         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31038       operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
31039       consumes:
31040         - application/json
31041         - application/xml
31042       produces:
31043         - application/json
31044         - application/xml
31045       responses:
31046         "default":
31047           description: Response codes found in [response codes](https://wiki.onap.org/).
31048       parameters:
31049         - name: network-id
31050           in: path
31051           description: Network ID, should be uuid. Unique across A&AI.
31052           required: true
31053           type: string
31054           example: __NETWORK-ID__
31055         - name: segmentation-id
31056           in: path
31057           description: Route Table Reference id, UUID assigned to this instance.
31058           required: true
31059           type: string
31060           example: __SEGMENTATION-ID__
31061         - name: body
31062           in: body
31063           description: segmentation-assignment object that needs to be updated.
31064           required: true
31065           schema:
31066             $ref: "#/patchDefinitions/segmentation-assignment"
31067     delete:
31068       tags:
31069         - Network
31070       summary: delete an existing segmentation-assignment
31071       description: delete an existing segmentation-assignment
31072       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
31073       consumes:
31074         - application/json
31075         - application/xml
31076       produces:
31077         - application/json
31078         - application/xml
31079       responses:
31080         "default":
31081           description: Response codes found in [response codes](https://wiki.onap.org/).
31082       parameters:
31083         - name: network-id
31084           in: path
31085           description: Network ID, should be uuid. Unique across A&AI.
31086           required: true
31087           type: string
31088           example: __NETWORK-ID__
31089         - name: segmentation-id
31090           in: path
31091           description: Route Table Reference id, UUID assigned to this instance.
31092           required: true
31093           type: string
31094           example: __SEGMENTATION-ID__
31095         - name: resource-version
31096           in: query
31097           description: resource-version for concurrency
31098           required: true
31099           type: string
31100   /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
31101     get:
31102       tags:
31103         - Network
31104       summary: returns segmentation-assignments
31105       description: returns segmentation-assignments
31106       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
31107       produces:
31108         - application/json
31109         - application/xml
31110       responses:
31111         "200":
31112           description: successful operation
31113           schema:
31114               $ref: "#/getDefinitions/segmentation-assignments"
31115         "default":
31116           description: Response codes found in [response codes](https://wiki.onap.org/).
31117       parameters:
31118         - name: network-id
31119           in: path
31120           description: Network ID, should be uuid. Unique across A&AI.
31121           required: true
31122           type: string
31123           example: __NETWORK-ID__
31124         - name: segmentation-id
31125           in: query
31126           description:
31127           required: false
31128           type: string
31129   /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
31130     put:
31131       tags:
31132         - Network
31133       summary: see node definition for valid relationships
31134       operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
31135       consumes:
31136         - application/json
31137         - application/xml
31138       produces:
31139         - application/json
31140         - application/xml
31141       responses:
31142         "default":
31143           description: Response codes found in [response codes](https://wiki.onap.org/).
31144       parameters:
31145         - name: network-id
31146           in: path
31147           description: Network ID, should be uuid. Unique across A&AI.
31148           required: true
31149           type: string
31150           example: __NETWORK-ID__
31151         - name: body
31152           in: body
31153           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3Network.json)
31154           required: true
31155           schema:
31156             $ref: "#/definitions/relationship"
31157     delete:
31158       tags:
31159         - Network
31160       summary: delete an existing relationship
31161       description: delete an existing relationship
31162       operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
31163       consumes:
31164         - application/json
31165         - application/xml
31166       produces:
31167         - application/json
31168         - application/xml
31169       responses:
31170         "default":
31171           description: Response codes found in [response codes](https://wiki.onap.org/).
31172       parameters:
31173         - name: network-id
31174           in: path
31175           description: Network ID, should be uuid. Unique across A&AI.
31176           required: true
31177           type: string
31178           example: __NETWORK-ID__
31179   /network/l3-networks/l3-network/{network-id}:
31180     get:
31181       tags:
31182         - Network
31183       summary: returns l3-network
31184       description: returns l3-network
31185       operationId: getNetworkL3NetworksL3Network
31186       produces:
31187         - application/json
31188         - application/xml
31189       responses:
31190         "200":
31191           description: successful operation
31192           schema:
31193               $ref: "#/getDefinitions/l3-network"
31194         "default":
31195           description: Response codes found in [response codes](https://wiki.onap.org/).
31196       parameters:
31197         - name: network-id
31198           in: path
31199           description: Network ID, should be uuid. Unique across A&AI.
31200           required: true
31201           type: string
31202           example: __NETWORK-ID__
31203     put:
31204       tags:
31205         - Network
31206       summary: create or update an existing l3-network
31207       description: |
31208         Create or update an existing l3-network.
31209         #
31210         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31211       operationId: createOrUpdateNetworkL3NetworksL3Network
31212       consumes:
31213         - application/json
31214         - application/xml
31215       produces:
31216         - application/json
31217         - application/xml
31218       responses:
31219         "default":
31220           description: Response codes found in [response codes](https://wiki.onap.org/).
31221       parameters:
31222         - name: network-id
31223           in: path
31224           description: Network ID, should be uuid. Unique across A&AI.
31225           required: true
31226           type: string
31227           example: __NETWORK-ID__
31228         - name: body
31229           in: body
31230           description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3Network.json)
31231           required: true
31232           schema:
31233             $ref: "#/definitions/l3-network"
31234     patch:
31235       tags:
31236         - Network
31237       summary: update an existing l3-network
31238       description: |
31239         Update an existing l3-network
31240         #
31241         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31242         The PUT operation will entirely replace an existing object.
31243         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31244         #
31245         Other differences between PUT and PATCH are:
31246         #
31247         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31248         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31249         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31250       operationId: UpdateNetworkL3NetworksL3Network
31251       consumes:
31252         - application/json
31253         - application/xml
31254       produces:
31255         - application/json
31256         - application/xml
31257       responses:
31258         "default":
31259           description: Response codes found in [response codes](https://wiki.onap.org/).
31260       parameters:
31261         - name: network-id
31262           in: path
31263           description: Network ID, should be uuid. Unique across A&AI.
31264           required: true
31265           type: string
31266           example: __NETWORK-ID__
31267         - name: body
31268           in: body
31269           description: l3-network object that needs to be updated.
31270           required: true
31271           schema:
31272             $ref: "#/patchDefinitions/l3-network"
31273     delete:
31274       tags:
31275         - Network
31276       summary: delete an existing l3-network
31277       description: delete an existing l3-network
31278       operationId: deleteNetworkL3NetworksL3Network
31279       consumes:
31280         - application/json
31281         - application/xml
31282       produces:
31283         - application/json
31284         - application/xml
31285       responses:
31286         "default":
31287           description: Response codes found in [response codes](https://wiki.onap.org/).
31288       parameters:
31289         - name: network-id
31290           in: path
31291           description: Network ID, should be uuid. Unique across A&AI.
31292           required: true
31293           type: string
31294           example: __NETWORK-ID__
31295         - name: resource-version
31296           in: query
31297           description: resource-version for concurrency
31298           required: true
31299           type: string
31300   /network/l3-networks:
31301     get:
31302       tags:
31303         - Network
31304       summary: returns l3-networks
31305       description: returns l3-networks
31306       operationId: getNetworkL3Networks
31307       produces:
31308         - application/json
31309         - application/xml
31310       responses:
31311         "200":
31312           description: successful operation
31313           schema:
31314               $ref: "#/getDefinitions/l3-networks"
31315         "default":
31316           description: Response codes found in [response codes](https://wiki.onap.org/).
31317       parameters:
31318         - name: network-id
31319           in: query
31320           description:
31321           required: false
31322           type: string
31323         - name: network-name
31324           in: query
31325           description:
31326           required: false
31327           type: string
31328         - name: network-role
31329           in: query
31330           description:
31331           required: false
31332           type: string
31333         - name: service-id
31334           in: query
31335           description:
31336           required: false
31337           type: string
31338         - name: heat-stack-id
31339           in: query
31340           description:
31341           required: false
31342           type: string
31343         - name: contrail-network-fqdn
31344           in: query
31345           description:
31346           required: false
31347           type: string
31348         - name: model-invariant-id
31349           in: query
31350           description:
31351           required: false
31352           type: string
31353         - name: model-version-id
31354           in: query
31355           description:
31356           required: false
31357           type: string
31358         - name: widget-model-id
31359           in: query
31360           description:
31361           required: false
31362           type: string
31363         - name: widget-model-version
31364           in: query
31365           description:
31366           required: false
31367           type: string
31368   /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
31369     put:
31370       tags:
31371         - Network
31372       summary: see node definition for valid relationships
31373       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
31374       consumes:
31375         - application/json
31376         - application/xml
31377       produces:
31378         - application/json
31379         - application/xml
31380       responses:
31381         "default":
31382           description: Response codes found in [response codes](https://wiki.onap.org/).
31383       parameters:
31384         - name: network-policy-id
31385           in: path
31386           description: UUID representing unique key to this instance
31387           required: true
31388           type: string
31389           example: __NETWORK-POLICY-ID__
31390         - name: body
31391           in: body
31392           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNetworkPoliciesNetworkPolicy.json)
31393           required: true
31394           schema:
31395             $ref: "#/definitions/relationship"
31396     delete:
31397       tags:
31398         - Network
31399       summary: delete an existing relationship
31400       description: delete an existing relationship
31401       operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
31402       consumes:
31403         - application/json
31404         - application/xml
31405       produces:
31406         - application/json
31407         - application/xml
31408       responses:
31409         "default":
31410           description: Response codes found in [response codes](https://wiki.onap.org/).
31411       parameters:
31412         - name: network-policy-id
31413           in: path
31414           description: UUID representing unique key to this instance
31415           required: true
31416           type: string
31417           example: __NETWORK-POLICY-ID__
31418   /network/network-policies/network-policy/{network-policy-id}:
31419     get:
31420       tags:
31421         - Network
31422       summary: returns network-policy
31423       description: returns network-policy
31424       operationId: getNetworkNetworkPoliciesNetworkPolicy
31425       produces:
31426         - application/json
31427         - application/xml
31428       responses:
31429         "200":
31430           description: successful operation
31431           schema:
31432               $ref: "#/getDefinitions/network-policy"
31433         "default":
31434           description: Response codes found in [response codes](https://wiki.onap.org/).
31435       parameters:
31436         - name: network-policy-id
31437           in: path
31438           description: UUID representing unique key to this instance
31439           required: true
31440           type: string
31441           example: __NETWORK-POLICY-ID__
31442     put:
31443       tags:
31444         - Network
31445       summary: create or update an existing network-policy
31446       description: |
31447         Create or update an existing network-policy.
31448         #
31449         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31450       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
31451       consumes:
31452         - application/json
31453         - application/xml
31454       produces:
31455         - application/json
31456         - application/xml
31457       responses:
31458         "default":
31459           description: Response codes found in [response codes](https://wiki.onap.org/).
31460       parameters:
31461         - name: network-policy-id
31462           in: path
31463           description: UUID representing unique key to this instance
31464           required: true
31465           type: string
31466           example: __NETWORK-POLICY-ID__
31467         - name: body
31468           in: body
31469           description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNetworkPoliciesNetworkPolicy.json)
31470           required: true
31471           schema:
31472             $ref: "#/definitions/network-policy"
31473     patch:
31474       tags:
31475         - Network
31476       summary: update an existing network-policy
31477       description: |
31478         Update an existing network-policy
31479         #
31480         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31481         The PUT operation will entirely replace an existing object.
31482         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31483         #
31484         Other differences between PUT and PATCH are:
31485         #
31486         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31487         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31488         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31489       operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
31490       consumes:
31491         - application/json
31492         - application/xml
31493       produces:
31494         - application/json
31495         - application/xml
31496       responses:
31497         "default":
31498           description: Response codes found in [response codes](https://wiki.onap.org/).
31499       parameters:
31500         - name: network-policy-id
31501           in: path
31502           description: UUID representing unique key to this instance
31503           required: true
31504           type: string
31505           example: __NETWORK-POLICY-ID__
31506         - name: body
31507           in: body
31508           description: network-policy object that needs to be updated.
31509           required: true
31510           schema:
31511             $ref: "#/patchDefinitions/network-policy"
31512     delete:
31513       tags:
31514         - Network
31515       summary: delete an existing network-policy
31516       description: delete an existing network-policy
31517       operationId: deleteNetworkNetworkPoliciesNetworkPolicy
31518       consumes:
31519         - application/json
31520         - application/xml
31521       produces:
31522         - application/json
31523         - application/xml
31524       responses:
31525         "default":
31526           description: Response codes found in [response codes](https://wiki.onap.org/).
31527       parameters:
31528         - name: network-policy-id
31529           in: path
31530           description: UUID representing unique key to this instance
31531           required: true
31532           type: string
31533           example: __NETWORK-POLICY-ID__
31534         - name: resource-version
31535           in: query
31536           description: resource-version for concurrency
31537           required: true
31538           type: string
31539   /network/network-policies:
31540     get:
31541       tags:
31542         - Network
31543       summary: returns network-policies
31544       description: returns network-policies
31545       operationId: getNetworkNetworkPolicies
31546       produces:
31547         - application/json
31548         - application/xml
31549       responses:
31550         "200":
31551           description: successful operation
31552           schema:
31553               $ref: "#/getDefinitions/network-policies"
31554         "default":
31555           description: Response codes found in [response codes](https://wiki.onap.org/).
31556       parameters:
31557         - name: network-policy-id
31558           in: query
31559           description:
31560           required: false
31561           type: string
31562         - name: network-policy-fqdn
31563           in: query
31564           description:
31565           required: false
31566           type: string
31567   /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
31568     put:
31569       tags:
31570         - Network
31571       summary: see node definition for valid relationships
31572       operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
31573       consumes:
31574         - application/json
31575         - application/xml
31576       produces:
31577         - application/json
31578         - application/xml
31579       responses:
31580         "default":
31581           description: Response codes found in [response codes](https://wiki.onap.org/).
31582       parameters:
31583         - name: vnf-id
31584           in: path
31585           description: Unique id of VNF.  This is unique across the graph.
31586           required: true
31587           type: string
31588           example: __VNF-ID__
31589         - name: body
31590           in: body
31591           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnf.json)
31592           required: true
31593           schema:
31594             $ref: "#/definitions/relationship"
31595     delete:
31596       tags:
31597         - Network
31598       summary: delete an existing relationship
31599       description: delete an existing relationship
31600       operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
31601       consumes:
31602         - application/json
31603         - application/xml
31604       produces:
31605         - application/json
31606         - application/xml
31607       responses:
31608         "default":
31609           description: Response codes found in [response codes](https://wiki.onap.org/).
31610       parameters:
31611         - name: vnf-id
31612           in: path
31613           description: Unique id of VNF.  This is unique across the graph.
31614           required: true
31615           type: string
31616           example: __VNF-ID__
31617   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
31618     put:
31619       tags:
31620         - Network
31621       summary: see node definition for valid relationships
31622       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
31623       consumes:
31624         - application/json
31625         - application/xml
31626       produces:
31627         - application/json
31628         - application/xml
31629       responses:
31630         "default":
31631           description: Response codes found in [response codes](https://wiki.onap.org/).
31632       parameters:
31633         - name: vnf-id
31634           in: path
31635           description: Unique id of VNF.  This is unique across the graph.
31636           required: true
31637           type: string
31638           example: __VNF-ID__
31639         - name: interface-name
31640           in: path
31641           description: Name given to the interface
31642           required: true
31643           type: string
31644           example: __INTERFACE-NAME__
31645         - name: vlan-interface
31646           in: path
31647           description: String that identifies the interface
31648           required: true
31649           type: string
31650           example: __VLAN-INTERFACE__
31651         - name: body
31652           in: body
31653           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
31654           required: true
31655           schema:
31656             $ref: "#/definitions/relationship"
31657     delete:
31658       tags:
31659         - Network
31660       summary: delete an existing relationship
31661       description: delete an existing relationship
31662       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
31663       consumes:
31664         - application/json
31665         - application/xml
31666       produces:
31667         - application/json
31668         - application/xml
31669       responses:
31670         "default":
31671           description: Response codes found in [response codes](https://wiki.onap.org/).
31672       parameters:
31673         - name: vnf-id
31674           in: path
31675           description: Unique id of VNF.  This is unique across the graph.
31676           required: true
31677           type: string
31678           example: __VNF-ID__
31679         - name: interface-name
31680           in: path
31681           description: Name given to the interface
31682           required: true
31683           type: string
31684           example: __INTERFACE-NAME__
31685         - name: vlan-interface
31686           in: path
31687           description: String that identifies the interface
31688           required: true
31689           type: string
31690           example: __VLAN-INTERFACE__
31691   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
31692     put:
31693       tags:
31694         - Network
31695       summary: see node definition for valid relationships
31696       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
31697       consumes:
31698         - application/json
31699         - application/xml
31700       produces:
31701         - application/json
31702         - application/xml
31703       responses:
31704         "default":
31705           description: Response codes found in [response codes](https://wiki.onap.org/).
31706       parameters:
31707         - name: vnf-id
31708           in: path
31709           description: Unique id of VNF.  This is unique across the graph.
31710           required: true
31711           type: string
31712           example: __VNF-ID__
31713         - name: interface-name
31714           in: path
31715           description: Name given to the interface
31716           required: true
31717           type: string
31718           example: __INTERFACE-NAME__
31719         - name: vlan-interface
31720           in: path
31721           description: String that identifies the interface
31722           required: true
31723           type: string
31724           example: __VLAN-INTERFACE__
31725         - name: l3-interface-ipv4-address
31726           in: path
31727           description: IP address
31728           required: true
31729           type: string
31730           example: __L3-INTERFACE-IPV4-ADDRESS__
31731         - name: body
31732           in: body
31733           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
31734           required: true
31735           schema:
31736             $ref: "#/definitions/relationship"
31737     delete:
31738       tags:
31739         - Network
31740       summary: delete an existing relationship
31741       description: delete an existing relationship
31742       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
31743       consumes:
31744         - application/json
31745         - application/xml
31746       produces:
31747         - application/json
31748         - application/xml
31749       responses:
31750         "default":
31751           description: Response codes found in [response codes](https://wiki.onap.org/).
31752       parameters:
31753         - name: vnf-id
31754           in: path
31755           description: Unique id of VNF.  This is unique across the graph.
31756           required: true
31757           type: string
31758           example: __VNF-ID__
31759         - name: interface-name
31760           in: path
31761           description: Name given to the interface
31762           required: true
31763           type: string
31764           example: __INTERFACE-NAME__
31765         - name: vlan-interface
31766           in: path
31767           description: String that identifies the interface
31768           required: true
31769           type: string
31770           example: __VLAN-INTERFACE__
31771         - name: l3-interface-ipv4-address
31772           in: path
31773           description: IP address
31774           required: true
31775           type: string
31776           example: __L3-INTERFACE-IPV4-ADDRESS__
31777   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
31778     get:
31779       tags:
31780         - Network
31781       summary: returns l3-interface-ipv4-address-list
31782       description: returns l3-interface-ipv4-address-list
31783       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31784       produces:
31785         - application/json
31786         - application/xml
31787       responses:
31788         "200":
31789           description: successful operation
31790           schema:
31791               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31792         "default":
31793           description: Response codes found in [response codes](https://wiki.onap.org/).
31794       parameters:
31795         - name: vnf-id
31796           in: path
31797           description: Unique id of VNF.  This is unique across the graph.
31798           required: true
31799           type: string
31800           example: __VNF-ID__
31801         - name: interface-name
31802           in: path
31803           description: Name given to the interface
31804           required: true
31805           type: string
31806           example: __INTERFACE-NAME__
31807         - name: vlan-interface
31808           in: path
31809           description: String that identifies the interface
31810           required: true
31811           type: string
31812           example: __VLAN-INTERFACE__
31813         - name: l3-interface-ipv4-address
31814           in: path
31815           description: IP address
31816           required: true
31817           type: string
31818           example: __L3-INTERFACE-IPV4-ADDRESS__
31819     put:
31820       tags:
31821         - Network
31822       summary: create or update an existing l3-interface-ipv4-address-list
31823       description: |
31824         Create or update an existing l3-interface-ipv4-address-list.
31825         #
31826         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31827       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31828       consumes:
31829         - application/json
31830         - application/xml
31831       produces:
31832         - application/json
31833         - application/xml
31834       responses:
31835         "default":
31836           description: Response codes found in [response codes](https://wiki.onap.org/).
31837       parameters:
31838         - name: vnf-id
31839           in: path
31840           description: Unique id of VNF.  This is unique across the graph.
31841           required: true
31842           type: string
31843           example: __VNF-ID__
31844         - name: interface-name
31845           in: path
31846           description: Name given to the interface
31847           required: true
31848           type: string
31849           example: __INTERFACE-NAME__
31850         - name: vlan-interface
31851           in: path
31852           description: String that identifies the interface
31853           required: true
31854           type: string
31855           example: __VLAN-INTERFACE__
31856         - name: l3-interface-ipv4-address
31857           in: path
31858           description: IP address
31859           required: true
31860           type: string
31861           example: __L3-INTERFACE-IPV4-ADDRESS__
31862         - name: body
31863           in: body
31864           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
31865           required: true
31866           schema:
31867             $ref: "#/definitions/l3-interface-ipv4-address-list"
31868     patch:
31869       tags:
31870         - Network
31871       summary: update an existing l3-interface-ipv4-address-list
31872       description: |
31873         Update an existing l3-interface-ipv4-address-list
31874         #
31875         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31876         The PUT operation will entirely replace an existing object.
31877         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31878         #
31879         Other differences between PUT and PATCH are:
31880         #
31881         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31882         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31883         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31884       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31885       consumes:
31886         - application/json
31887         - application/xml
31888       produces:
31889         - application/json
31890         - application/xml
31891       responses:
31892         "default":
31893           description: Response codes found in [response codes](https://wiki.onap.org/).
31894       parameters:
31895         - name: vnf-id
31896           in: path
31897           description: Unique id of VNF.  This is unique across the graph.
31898           required: true
31899           type: string
31900           example: __VNF-ID__
31901         - name: interface-name
31902           in: path
31903           description: Name given to the interface
31904           required: true
31905           type: string
31906           example: __INTERFACE-NAME__
31907         - name: vlan-interface
31908           in: path
31909           description: String that identifies the interface
31910           required: true
31911           type: string
31912           example: __VLAN-INTERFACE__
31913         - name: l3-interface-ipv4-address
31914           in: path
31915           description: IP address
31916           required: true
31917           type: string
31918           example: __L3-INTERFACE-IPV4-ADDRESS__
31919         - name: body
31920           in: body
31921           description: l3-interface-ipv4-address-list object that needs to be updated.
31922           required: true
31923           schema:
31924             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31925     delete:
31926       tags:
31927         - Network
31928       summary: delete an existing l3-interface-ipv4-address-list
31929       description: delete an existing l3-interface-ipv4-address-list
31930       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31931       consumes:
31932         - application/json
31933         - application/xml
31934       produces:
31935         - application/json
31936         - application/xml
31937       responses:
31938         "default":
31939           description: Response codes found in [response codes](https://wiki.onap.org/).
31940       parameters:
31941         - name: vnf-id
31942           in: path
31943           description: Unique id of VNF.  This is unique across the graph.
31944           required: true
31945           type: string
31946           example: __VNF-ID__
31947         - name: interface-name
31948           in: path
31949           description: Name given to the interface
31950           required: true
31951           type: string
31952           example: __INTERFACE-NAME__
31953         - name: vlan-interface
31954           in: path
31955           description: String that identifies the interface
31956           required: true
31957           type: string
31958           example: __VLAN-INTERFACE__
31959         - name: l3-interface-ipv4-address
31960           in: path
31961           description: IP address
31962           required: true
31963           type: string
31964           example: __L3-INTERFACE-IPV4-ADDRESS__
31965         - name: resource-version
31966           in: query
31967           description: resource-version for concurrency
31968           required: true
31969           type: string
31970   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
31971     put:
31972       tags:
31973         - Network
31974       summary: see node definition for valid relationships
31975       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31976       consumes:
31977         - application/json
31978         - application/xml
31979       produces:
31980         - application/json
31981         - application/xml
31982       responses:
31983         "default":
31984           description: Response codes found in [response codes](https://wiki.onap.org/).
31985       parameters:
31986         - name: vnf-id
31987           in: path
31988           description: Unique id of VNF.  This is unique across the graph.
31989           required: true
31990           type: string
31991           example: __VNF-ID__
31992         - name: interface-name
31993           in: path
31994           description: Name given to the interface
31995           required: true
31996           type: string
31997           example: __INTERFACE-NAME__
31998         - name: vlan-interface
31999           in: path
32000           description: String that identifies the interface
32001           required: true
32002           type: string
32003           example: __VLAN-INTERFACE__
32004         - name: l3-interface-ipv6-address
32005           in: path
32006           description: IP address
32007           required: true
32008           type: string
32009           example: __L3-INTERFACE-IPV6-ADDRESS__
32010         - name: body
32011           in: body
32012           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
32013           required: true
32014           schema:
32015             $ref: "#/definitions/relationship"
32016     delete:
32017       tags:
32018         - Network
32019       summary: delete an existing relationship
32020       description: delete an existing relationship
32021       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
32022       consumes:
32023         - application/json
32024         - application/xml
32025       produces:
32026         - application/json
32027         - application/xml
32028       responses:
32029         "default":
32030           description: Response codes found in [response codes](https://wiki.onap.org/).
32031       parameters:
32032         - name: vnf-id
32033           in: path
32034           description: Unique id of VNF.  This is unique across the graph.
32035           required: true
32036           type: string
32037           example: __VNF-ID__
32038         - name: interface-name
32039           in: path
32040           description: Name given to the interface
32041           required: true
32042           type: string
32043           example: __INTERFACE-NAME__
32044         - name: vlan-interface
32045           in: path
32046           description: String that identifies the interface
32047           required: true
32048           type: string
32049           example: __VLAN-INTERFACE__
32050         - name: l3-interface-ipv6-address
32051           in: path
32052           description: IP address
32053           required: true
32054           type: string
32055           example: __L3-INTERFACE-IPV6-ADDRESS__
32056   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
32057     get:
32058       tags:
32059         - Network
32060       summary: returns l3-interface-ipv6-address-list
32061       description: returns l3-interface-ipv6-address-list
32062       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32063       produces:
32064         - application/json
32065         - application/xml
32066       responses:
32067         "200":
32068           description: successful operation
32069           schema:
32070               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
32071         "default":
32072           description: Response codes found in [response codes](https://wiki.onap.org/).
32073       parameters:
32074         - name: vnf-id
32075           in: path
32076           description: Unique id of VNF.  This is unique across the graph.
32077           required: true
32078           type: string
32079           example: __VNF-ID__
32080         - name: interface-name
32081           in: path
32082           description: Name given to the interface
32083           required: true
32084           type: string
32085           example: __INTERFACE-NAME__
32086         - name: vlan-interface
32087           in: path
32088           description: String that identifies the interface
32089           required: true
32090           type: string
32091           example: __VLAN-INTERFACE__
32092         - name: l3-interface-ipv6-address
32093           in: path
32094           description: IP address
32095           required: true
32096           type: string
32097           example: __L3-INTERFACE-IPV6-ADDRESS__
32098     put:
32099       tags:
32100         - Network
32101       summary: create or update an existing l3-interface-ipv6-address-list
32102       description: |
32103         Create or update an existing l3-interface-ipv6-address-list.
32104         #
32105         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32106       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32107       consumes:
32108         - application/json
32109         - application/xml
32110       produces:
32111         - application/json
32112         - application/xml
32113       responses:
32114         "default":
32115           description: Response codes found in [response codes](https://wiki.onap.org/).
32116       parameters:
32117         - name: vnf-id
32118           in: path
32119           description: Unique id of VNF.  This is unique across the graph.
32120           required: true
32121           type: string
32122           example: __VNF-ID__
32123         - name: interface-name
32124           in: path
32125           description: Name given to the interface
32126           required: true
32127           type: string
32128           example: __INTERFACE-NAME__
32129         - name: vlan-interface
32130           in: path
32131           description: String that identifies the interface
32132           required: true
32133           type: string
32134           example: __VLAN-INTERFACE__
32135         - name: l3-interface-ipv6-address
32136           in: path
32137           description: IP address
32138           required: true
32139           type: string
32140           example: __L3-INTERFACE-IPV6-ADDRESS__
32141         - name: body
32142           in: body
32143           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
32144           required: true
32145           schema:
32146             $ref: "#/definitions/l3-interface-ipv6-address-list"
32147     patch:
32148       tags:
32149         - Network
32150       summary: update an existing l3-interface-ipv6-address-list
32151       description: |
32152         Update an existing l3-interface-ipv6-address-list
32153         #
32154         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32155         The PUT operation will entirely replace an existing object.
32156         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32157         #
32158         Other differences between PUT and PATCH are:
32159         #
32160         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32161         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32162         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32163       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32164       consumes:
32165         - application/json
32166         - application/xml
32167       produces:
32168         - application/json
32169         - application/xml
32170       responses:
32171         "default":
32172           description: Response codes found in [response codes](https://wiki.onap.org/).
32173       parameters:
32174         - name: vnf-id
32175           in: path
32176           description: Unique id of VNF.  This is unique across the graph.
32177           required: true
32178           type: string
32179           example: __VNF-ID__
32180         - name: interface-name
32181           in: path
32182           description: Name given to the interface
32183           required: true
32184           type: string
32185           example: __INTERFACE-NAME__
32186         - name: vlan-interface
32187           in: path
32188           description: String that identifies the interface
32189           required: true
32190           type: string
32191           example: __VLAN-INTERFACE__
32192         - name: l3-interface-ipv6-address
32193           in: path
32194           description: IP address
32195           required: true
32196           type: string
32197           example: __L3-INTERFACE-IPV6-ADDRESS__
32198         - name: body
32199           in: body
32200           description: l3-interface-ipv6-address-list object that needs to be updated.
32201           required: true
32202           schema:
32203             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
32204     delete:
32205       tags:
32206         - Network
32207       summary: delete an existing l3-interface-ipv6-address-list
32208       description: delete an existing l3-interface-ipv6-address-list
32209       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
32210       consumes:
32211         - application/json
32212         - application/xml
32213       produces:
32214         - application/json
32215         - application/xml
32216       responses:
32217         "default":
32218           description: Response codes found in [response codes](https://wiki.onap.org/).
32219       parameters:
32220         - name: vnf-id
32221           in: path
32222           description: Unique id of VNF.  This is unique across the graph.
32223           required: true
32224           type: string
32225           example: __VNF-ID__
32226         - name: interface-name
32227           in: path
32228           description: Name given to the interface
32229           required: true
32230           type: string
32231           example: __INTERFACE-NAME__
32232         - name: vlan-interface
32233           in: path
32234           description: String that identifies the interface
32235           required: true
32236           type: string
32237           example: __VLAN-INTERFACE__
32238         - name: l3-interface-ipv6-address
32239           in: path
32240           description: IP address
32241           required: true
32242           type: string
32243           example: __L3-INTERFACE-IPV6-ADDRESS__
32244         - name: resource-version
32245           in: query
32246           description: resource-version for concurrency
32247           required: true
32248           type: string
32249   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
32250     get:
32251       tags:
32252         - Network
32253       summary: returns vlan
32254       description: returns vlan
32255       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
32256       produces:
32257         - application/json
32258         - application/xml
32259       responses:
32260         "200":
32261           description: successful operation
32262           schema:
32263               $ref: "#/getDefinitions/vlan"
32264         "default":
32265           description: Response codes found in [response codes](https://wiki.onap.org/).
32266       parameters:
32267         - name: vnf-id
32268           in: path
32269           description: Unique id of VNF.  This is unique across the graph.
32270           required: true
32271           type: string
32272           example: __VNF-ID__
32273         - name: interface-name
32274           in: path
32275           description: Name given to the interface
32276           required: true
32277           type: string
32278           example: __INTERFACE-NAME__
32279         - name: vlan-interface
32280           in: path
32281           description: String that identifies the interface
32282           required: true
32283           type: string
32284           example: __VLAN-INTERFACE__
32285     put:
32286       tags:
32287         - Network
32288       summary: create or update an existing vlan
32289       description: |
32290         Create or update an existing vlan.
32291         #
32292         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32293       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
32294       consumes:
32295         - application/json
32296         - application/xml
32297       produces:
32298         - application/json
32299         - application/xml
32300       responses:
32301         "default":
32302           description: Response codes found in [response codes](https://wiki.onap.org/).
32303       parameters:
32304         - name: vnf-id
32305           in: path
32306           description: Unique id of VNF.  This is unique across the graph.
32307           required: true
32308           type: string
32309           example: __VNF-ID__
32310         - name: interface-name
32311           in: path
32312           description: Name given to the interface
32313           required: true
32314           type: string
32315           example: __INTERFACE-NAME__
32316         - name: vlan-interface
32317           in: path
32318           description: String that identifies the interface
32319           required: true
32320           type: string
32321           example: __VLAN-INTERFACE__
32322         - name: body
32323           in: body
32324           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
32325           required: true
32326           schema:
32327             $ref: "#/definitions/vlan"
32328     patch:
32329       tags:
32330         - Network
32331       summary: update an existing vlan
32332       description: |
32333         Update an existing vlan
32334         #
32335         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32336         The PUT operation will entirely replace an existing object.
32337         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32338         #
32339         Other differences between PUT and PATCH are:
32340         #
32341         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32342         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32343         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32344       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
32345       consumes:
32346         - application/json
32347         - application/xml
32348       produces:
32349         - application/json
32350         - application/xml
32351       responses:
32352         "default":
32353           description: Response codes found in [response codes](https://wiki.onap.org/).
32354       parameters:
32355         - name: vnf-id
32356           in: path
32357           description: Unique id of VNF.  This is unique across the graph.
32358           required: true
32359           type: string
32360           example: __VNF-ID__
32361         - name: interface-name
32362           in: path
32363           description: Name given to the interface
32364           required: true
32365           type: string
32366           example: __INTERFACE-NAME__
32367         - name: vlan-interface
32368           in: path
32369           description: String that identifies the interface
32370           required: true
32371           type: string
32372           example: __VLAN-INTERFACE__
32373         - name: body
32374           in: body
32375           description: vlan object that needs to be updated.
32376           required: true
32377           schema:
32378             $ref: "#/patchDefinitions/vlan"
32379     delete:
32380       tags:
32381         - Network
32382       summary: delete an existing vlan
32383       description: delete an existing vlan
32384       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
32385       consumes:
32386         - application/json
32387         - application/xml
32388       produces:
32389         - application/json
32390         - application/xml
32391       responses:
32392         "default":
32393           description: Response codes found in [response codes](https://wiki.onap.org/).
32394       parameters:
32395         - name: vnf-id
32396           in: path
32397           description: Unique id of VNF.  This is unique across the graph.
32398           required: true
32399           type: string
32400           example: __VNF-ID__
32401         - name: interface-name
32402           in: path
32403           description: Name given to the interface
32404           required: true
32405           type: string
32406           example: __INTERFACE-NAME__
32407         - name: vlan-interface
32408           in: path
32409           description: String that identifies the interface
32410           required: true
32411           type: string
32412           example: __VLAN-INTERFACE__
32413         - name: resource-version
32414           in: query
32415           description: resource-version for concurrency
32416           required: true
32417           type: string
32418   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
32419     get:
32420       tags:
32421         - Network
32422       summary: returns vlans
32423       description: returns vlans
32424       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
32425       produces:
32426         - application/json
32427         - application/xml
32428       responses:
32429         "200":
32430           description: successful operation
32431           schema:
32432               $ref: "#/getDefinitions/vlans"
32433         "default":
32434           description: Response codes found in [response codes](https://wiki.onap.org/).
32435       parameters:
32436         - name: vnf-id
32437           in: path
32438           description: Unique id of VNF.  This is unique across the graph.
32439           required: true
32440           type: string
32441           example: __VNF-ID__
32442         - name: interface-name
32443           in: path
32444           description: Name given to the interface
32445           required: true
32446           type: string
32447           example: __INTERFACE-NAME__
32448         - name: vlan-interface
32449           in: query
32450           description:
32451           required: false
32452           type: string
32453         - name: vlan-id-inner
32454           in: query
32455           description:
32456           required: false
32457           type: integer
32458           format: int64
32459         - name: vpn-key
32460           in: query
32461           description:
32462           required: false
32463           type: string
32464   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
32465     put:
32466       tags:
32467         - Network
32468       summary: see node definition for valid relationships
32469       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32470       consumes:
32471         - application/json
32472         - application/xml
32473       produces:
32474         - application/json
32475         - application/xml
32476       responses:
32477         "default":
32478           description: Response codes found in [response codes](https://wiki.onap.org/).
32479       parameters:
32480         - name: vnf-id
32481           in: path
32482           description: Unique id of VNF.  This is unique across the graph.
32483           required: true
32484           type: string
32485           example: __VNF-ID__
32486         - name: interface-name
32487           in: path
32488           description: Name given to the interface
32489           required: true
32490           type: string
32491           example: __INTERFACE-NAME__
32492         - name: pci-id
32493           in: path
32494           description: PCI ID used to identify the sriov-vf
32495           required: true
32496           type: string
32497           example: __PCI-ID__
32498         - name: body
32499           in: body
32500           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
32501           required: true
32502           schema:
32503             $ref: "#/definitions/relationship"
32504     delete:
32505       tags:
32506         - Network
32507       summary: delete an existing relationship
32508       description: delete an existing relationship
32509       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32510       consumes:
32511         - application/json
32512         - application/xml
32513       produces:
32514         - application/json
32515         - application/xml
32516       responses:
32517         "default":
32518           description: Response codes found in [response codes](https://wiki.onap.org/).
32519       parameters:
32520         - name: vnf-id
32521           in: path
32522           description: Unique id of VNF.  This is unique across the graph.
32523           required: true
32524           type: string
32525           example: __VNF-ID__
32526         - name: interface-name
32527           in: path
32528           description: Name given to the interface
32529           required: true
32530           type: string
32531           example: __INTERFACE-NAME__
32532         - name: pci-id
32533           in: path
32534           description: PCI ID used to identify the sriov-vf
32535           required: true
32536           type: string
32537           example: __PCI-ID__
32538   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
32539     get:
32540       tags:
32541         - Network
32542       summary: returns sriov-vf
32543       description: returns sriov-vf
32544       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32545       produces:
32546         - application/json
32547         - application/xml
32548       responses:
32549         "200":
32550           description: successful operation
32551           schema:
32552               $ref: "#/getDefinitions/sriov-vf"
32553         "default":
32554           description: Response codes found in [response codes](https://wiki.onap.org/).
32555       parameters:
32556         - name: vnf-id
32557           in: path
32558           description: Unique id of VNF.  This is unique across the graph.
32559           required: true
32560           type: string
32561           example: __VNF-ID__
32562         - name: interface-name
32563           in: path
32564           description: Name given to the interface
32565           required: true
32566           type: string
32567           example: __INTERFACE-NAME__
32568         - name: pci-id
32569           in: path
32570           description: PCI ID used to identify the sriov-vf
32571           required: true
32572           type: string
32573           example: __PCI-ID__
32574     put:
32575       tags:
32576         - Network
32577       summary: create or update an existing sriov-vf
32578       description: |
32579         Create or update an existing sriov-vf.
32580         #
32581         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32582       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32583       consumes:
32584         - application/json
32585         - application/xml
32586       produces:
32587         - application/json
32588         - application/xml
32589       responses:
32590         "default":
32591           description: Response codes found in [response codes](https://wiki.onap.org/).
32592       parameters:
32593         - name: vnf-id
32594           in: path
32595           description: Unique id of VNF.  This is unique across the graph.
32596           required: true
32597           type: string
32598           example: __VNF-ID__
32599         - name: interface-name
32600           in: path
32601           description: Name given to the interface
32602           required: true
32603           type: string
32604           example: __INTERFACE-NAME__
32605         - name: pci-id
32606           in: path
32607           description: PCI ID used to identify the sriov-vf
32608           required: true
32609           type: string
32610           example: __PCI-ID__
32611         - name: body
32612           in: body
32613           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
32614           required: true
32615           schema:
32616             $ref: "#/definitions/sriov-vf"
32617     patch:
32618       tags:
32619         - Network
32620       summary: update an existing sriov-vf
32621       description: |
32622         Update an existing sriov-vf
32623         #
32624         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32625         The PUT operation will entirely replace an existing object.
32626         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32627         #
32628         Other differences between PUT and PATCH are:
32629         #
32630         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32631         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32632         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32633       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32634       consumes:
32635         - application/json
32636         - application/xml
32637       produces:
32638         - application/json
32639         - application/xml
32640       responses:
32641         "default":
32642           description: Response codes found in [response codes](https://wiki.onap.org/).
32643       parameters:
32644         - name: vnf-id
32645           in: path
32646           description: Unique id of VNF.  This is unique across the graph.
32647           required: true
32648           type: string
32649           example: __VNF-ID__
32650         - name: interface-name
32651           in: path
32652           description: Name given to the interface
32653           required: true
32654           type: string
32655           example: __INTERFACE-NAME__
32656         - name: pci-id
32657           in: path
32658           description: PCI ID used to identify the sriov-vf
32659           required: true
32660           type: string
32661           example: __PCI-ID__
32662         - name: body
32663           in: body
32664           description: sriov-vf object that needs to be updated.
32665           required: true
32666           schema:
32667             $ref: "#/patchDefinitions/sriov-vf"
32668     delete:
32669       tags:
32670         - Network
32671       summary: delete an existing sriov-vf
32672       description: delete an existing sriov-vf
32673       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32674       consumes:
32675         - application/json
32676         - application/xml
32677       produces:
32678         - application/json
32679         - application/xml
32680       responses:
32681         "default":
32682           description: Response codes found in [response codes](https://wiki.onap.org/).
32683       parameters:
32684         - name: vnf-id
32685           in: path
32686           description: Unique id of VNF.  This is unique across the graph.
32687           required: true
32688           type: string
32689           example: __VNF-ID__
32690         - name: interface-name
32691           in: path
32692           description: Name given to the interface
32693           required: true
32694           type: string
32695           example: __INTERFACE-NAME__
32696         - name: pci-id
32697           in: path
32698           description: PCI ID used to identify the sriov-vf
32699           required: true
32700           type: string
32701           example: __PCI-ID__
32702         - name: resource-version
32703           in: query
32704           description: resource-version for concurrency
32705           required: true
32706           type: string
32707   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
32708     get:
32709       tags:
32710         - Network
32711       summary: returns sriov-vfs
32712       description: returns sriov-vfs
32713       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
32714       produces:
32715         - application/json
32716         - application/xml
32717       responses:
32718         "200":
32719           description: successful operation
32720           schema:
32721               $ref: "#/getDefinitions/sriov-vfs"
32722         "default":
32723           description: Response codes found in [response codes](https://wiki.onap.org/).
32724       parameters:
32725         - name: vnf-id
32726           in: path
32727           description: Unique id of VNF.  This is unique across the graph.
32728           required: true
32729           type: string
32730           example: __VNF-ID__
32731         - name: interface-name
32732           in: path
32733           description: Name given to the interface
32734           required: true
32735           type: string
32736           example: __INTERFACE-NAME__
32737         - name: pci-id
32738           in: query
32739           description:
32740           required: false
32741           type: string
32742         - name: vf-vlan-filter
32743           in: query
32744           description:
32745           required: false
32746           type: string
32747         - name: vf-mac-filter
32748           in: query
32749           description:
32750           required: false
32751           type: string
32752         - name: vf-vlan-strip
32753           in: query
32754           description:
32755           required: false
32756           type: boolean
32757         - name: neutron-network-id
32758           in: query
32759           description:
32760           required: false
32761           type: string
32762   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
32763     put:
32764       tags:
32765         - Network
32766       summary: see node definition for valid relationships
32767       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32768       consumes:
32769         - application/json
32770         - application/xml
32771       produces:
32772         - application/json
32773         - application/xml
32774       responses:
32775         "default":
32776           description: Response codes found in [response codes](https://wiki.onap.org/).
32777       parameters:
32778         - name: vnf-id
32779           in: path
32780           description: Unique id of VNF.  This is unique across the graph.
32781           required: true
32782           type: string
32783           example: __VNF-ID__
32784         - name: interface-name
32785           in: path
32786           description: Name given to the interface
32787           required: true
32788           type: string
32789           example: __INTERFACE-NAME__
32790         - name: body
32791           in: body
32792           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
32793           required: true
32794           schema:
32795             $ref: "#/definitions/relationship"
32796     delete:
32797       tags:
32798         - Network
32799       summary: delete an existing relationship
32800       description: delete an existing relationship
32801       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32802       consumes:
32803         - application/json
32804         - application/xml
32805       produces:
32806         - application/json
32807         - application/xml
32808       responses:
32809         "default":
32810           description: Response codes found in [response codes](https://wiki.onap.org/).
32811       parameters:
32812         - name: vnf-id
32813           in: path
32814           description: Unique id of VNF.  This is unique across the graph.
32815           required: true
32816           type: string
32817           example: __VNF-ID__
32818         - name: interface-name
32819           in: path
32820           description: Name given to the interface
32821           required: true
32822           type: string
32823           example: __INTERFACE-NAME__
32824   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
32825     put:
32826       tags:
32827         - Network
32828       summary: see node definition for valid relationships
32829       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32830       consumes:
32831         - application/json
32832         - application/xml
32833       produces:
32834         - application/json
32835         - application/xml
32836       responses:
32837         "default":
32838           description: Response codes found in [response codes](https://wiki.onap.org/).
32839       parameters:
32840         - name: vnf-id
32841           in: path
32842           description: Unique id of VNF.  This is unique across the graph.
32843           required: true
32844           type: string
32845           example: __VNF-ID__
32846         - name: interface-name
32847           in: path
32848           description: Name given to the interface
32849           required: true
32850           type: string
32851           example: __INTERFACE-NAME__
32852         - name: l3-interface-ipv4-address
32853           in: path
32854           description: IP address
32855           required: true
32856           type: string
32857           example: __L3-INTERFACE-IPV4-ADDRESS__
32858         - name: body
32859           in: body
32860           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32861           required: true
32862           schema:
32863             $ref: "#/definitions/relationship"
32864     delete:
32865       tags:
32866         - Network
32867       summary: delete an existing relationship
32868       description: delete an existing relationship
32869       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32870       consumes:
32871         - application/json
32872         - application/xml
32873       produces:
32874         - application/json
32875         - application/xml
32876       responses:
32877         "default":
32878           description: Response codes found in [response codes](https://wiki.onap.org/).
32879       parameters:
32880         - name: vnf-id
32881           in: path
32882           description: Unique id of VNF.  This is unique across the graph.
32883           required: true
32884           type: string
32885           example: __VNF-ID__
32886         - name: interface-name
32887           in: path
32888           description: Name given to the interface
32889           required: true
32890           type: string
32891           example: __INTERFACE-NAME__
32892         - name: l3-interface-ipv4-address
32893           in: path
32894           description: IP address
32895           required: true
32896           type: string
32897           example: __L3-INTERFACE-IPV4-ADDRESS__
32898   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32899     get:
32900       tags:
32901         - Network
32902       summary: returns l3-interface-ipv4-address-list
32903       description: returns l3-interface-ipv4-address-list
32904       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32905       produces:
32906         - application/json
32907         - application/xml
32908       responses:
32909         "200":
32910           description: successful operation
32911           schema:
32912               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32913         "default":
32914           description: Response codes found in [response codes](https://wiki.onap.org/).
32915       parameters:
32916         - name: vnf-id
32917           in: path
32918           description: Unique id of VNF.  This is unique across the graph.
32919           required: true
32920           type: string
32921           example: __VNF-ID__
32922         - name: interface-name
32923           in: path
32924           description: Name given to the interface
32925           required: true
32926           type: string
32927           example: __INTERFACE-NAME__
32928         - name: l3-interface-ipv4-address
32929           in: path
32930           description: IP address
32931           required: true
32932           type: string
32933           example: __L3-INTERFACE-IPV4-ADDRESS__
32934     put:
32935       tags:
32936         - Network
32937       summary: create or update an existing l3-interface-ipv4-address-list
32938       description: |
32939         Create or update an existing l3-interface-ipv4-address-list.
32940         #
32941         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32942       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32943       consumes:
32944         - application/json
32945         - application/xml
32946       produces:
32947         - application/json
32948         - application/xml
32949       responses:
32950         "default":
32951           description: Response codes found in [response codes](https://wiki.onap.org/).
32952       parameters:
32953         - name: vnf-id
32954           in: path
32955           description: Unique id of VNF.  This is unique across the graph.
32956           required: true
32957           type: string
32958           example: __VNF-ID__
32959         - name: interface-name
32960           in: path
32961           description: Name given to the interface
32962           required: true
32963           type: string
32964           example: __INTERFACE-NAME__
32965         - name: l3-interface-ipv4-address
32966           in: path
32967           description: IP address
32968           required: true
32969           type: string
32970           example: __L3-INTERFACE-IPV4-ADDRESS__
32971         - name: body
32972           in: body
32973           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32974           required: true
32975           schema:
32976             $ref: "#/definitions/l3-interface-ipv4-address-list"
32977     patch:
32978       tags:
32979         - Network
32980       summary: update an existing l3-interface-ipv4-address-list
32981       description: |
32982         Update an existing l3-interface-ipv4-address-list
32983         #
32984         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32985         The PUT operation will entirely replace an existing object.
32986         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32987         #
32988         Other differences between PUT and PATCH are:
32989         #
32990         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32991         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32992         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32993       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32994       consumes:
32995         - application/json
32996         - application/xml
32997       produces:
32998         - application/json
32999         - application/xml
33000       responses:
33001         "default":
33002           description: Response codes found in [response codes](https://wiki.onap.org/).
33003       parameters:
33004         - name: vnf-id
33005           in: path
33006           description: Unique id of VNF.  This is unique across the graph.
33007           required: true
33008           type: string
33009           example: __VNF-ID__
33010         - name: interface-name
33011           in: path
33012           description: Name given to the interface
33013           required: true
33014           type: string
33015           example: __INTERFACE-NAME__
33016         - name: l3-interface-ipv4-address
33017           in: path
33018           description: IP address
33019           required: true
33020           type: string
33021           example: __L3-INTERFACE-IPV4-ADDRESS__
33022         - name: body
33023           in: body
33024           description: l3-interface-ipv4-address-list object that needs to be updated.
33025           required: true
33026           schema:
33027             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33028     delete:
33029       tags:
33030         - Network
33031       summary: delete an existing l3-interface-ipv4-address-list
33032       description: delete an existing l3-interface-ipv4-address-list
33033       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
33034       consumes:
33035         - application/json
33036         - application/xml
33037       produces:
33038         - application/json
33039         - application/xml
33040       responses:
33041         "default":
33042           description: Response codes found in [response codes](https://wiki.onap.org/).
33043       parameters:
33044         - name: vnf-id
33045           in: path
33046           description: Unique id of VNF.  This is unique across the graph.
33047           required: true
33048           type: string
33049           example: __VNF-ID__
33050         - name: interface-name
33051           in: path
33052           description: Name given to the interface
33053           required: true
33054           type: string
33055           example: __INTERFACE-NAME__
33056         - name: l3-interface-ipv4-address
33057           in: path
33058           description: IP address
33059           required: true
33060           type: string
33061           example: __L3-INTERFACE-IPV4-ADDRESS__
33062         - name: resource-version
33063           in: query
33064           description: resource-version for concurrency
33065           required: true
33066           type: string
33067   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
33068     put:
33069       tags:
33070         - Network
33071       summary: see node definition for valid relationships
33072       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33073       consumes:
33074         - application/json
33075         - application/xml
33076       produces:
33077         - application/json
33078         - application/xml
33079       responses:
33080         "default":
33081           description: Response codes found in [response codes](https://wiki.onap.org/).
33082       parameters:
33083         - name: vnf-id
33084           in: path
33085           description: Unique id of VNF.  This is unique across the graph.
33086           required: true
33087           type: string
33088           example: __VNF-ID__
33089         - name: interface-name
33090           in: path
33091           description: Name given to the interface
33092           required: true
33093           type: string
33094           example: __INTERFACE-NAME__
33095         - name: l3-interface-ipv6-address
33096           in: path
33097           description: IP address
33098           required: true
33099           type: string
33100           example: __L3-INTERFACE-IPV6-ADDRESS__
33101         - name: body
33102           in: body
33103           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33104           required: true
33105           schema:
33106             $ref: "#/definitions/relationship"
33107     delete:
33108       tags:
33109         - Network
33110       summary: delete an existing relationship
33111       description: delete an existing relationship
33112       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33113       consumes:
33114         - application/json
33115         - application/xml
33116       produces:
33117         - application/json
33118         - application/xml
33119       responses:
33120         "default":
33121           description: Response codes found in [response codes](https://wiki.onap.org/).
33122       parameters:
33123         - name: vnf-id
33124           in: path
33125           description: Unique id of VNF.  This is unique across the graph.
33126           required: true
33127           type: string
33128           example: __VNF-ID__
33129         - name: interface-name
33130           in: path
33131           description: Name given to the interface
33132           required: true
33133           type: string
33134           example: __INTERFACE-NAME__
33135         - name: l3-interface-ipv6-address
33136           in: path
33137           description: IP address
33138           required: true
33139           type: string
33140           example: __L3-INTERFACE-IPV6-ADDRESS__
33141   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
33142     get:
33143       tags:
33144         - Network
33145       summary: returns l3-interface-ipv6-address-list
33146       description: returns l3-interface-ipv6-address-list
33147       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33148       produces:
33149         - application/json
33150         - application/xml
33151       responses:
33152         "200":
33153           description: successful operation
33154           schema:
33155               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33156         "default":
33157           description: Response codes found in [response codes](https://wiki.onap.org/).
33158       parameters:
33159         - name: vnf-id
33160           in: path
33161           description: Unique id of VNF.  This is unique across the graph.
33162           required: true
33163           type: string
33164           example: __VNF-ID__
33165         - name: interface-name
33166           in: path
33167           description: Name given to the interface
33168           required: true
33169           type: string
33170           example: __INTERFACE-NAME__
33171         - name: l3-interface-ipv6-address
33172           in: path
33173           description: IP address
33174           required: true
33175           type: string
33176           example: __L3-INTERFACE-IPV6-ADDRESS__
33177     put:
33178       tags:
33179         - Network
33180       summary: create or update an existing l3-interface-ipv6-address-list
33181       description: |
33182         Create or update an existing l3-interface-ipv6-address-list.
33183         #
33184         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33185       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33186       consumes:
33187         - application/json
33188         - application/xml
33189       produces:
33190         - application/json
33191         - application/xml
33192       responses:
33193         "default":
33194           description: Response codes found in [response codes](https://wiki.onap.org/).
33195       parameters:
33196         - name: vnf-id
33197           in: path
33198           description: Unique id of VNF.  This is unique across the graph.
33199           required: true
33200           type: string
33201           example: __VNF-ID__
33202         - name: interface-name
33203           in: path
33204           description: Name given to the interface
33205           required: true
33206           type: string
33207           example: __INTERFACE-NAME__
33208         - name: l3-interface-ipv6-address
33209           in: path
33210           description: IP address
33211           required: true
33212           type: string
33213           example: __L3-INTERFACE-IPV6-ADDRESS__
33214         - name: body
33215           in: body
33216           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33217           required: true
33218           schema:
33219             $ref: "#/definitions/l3-interface-ipv6-address-list"
33220     patch:
33221       tags:
33222         - Network
33223       summary: update an existing l3-interface-ipv6-address-list
33224       description: |
33225         Update an existing l3-interface-ipv6-address-list
33226         #
33227         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33228         The PUT operation will entirely replace an existing object.
33229         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33230         #
33231         Other differences between PUT and PATCH are:
33232         #
33233         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33234         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33235         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33236       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33237       consumes:
33238         - application/json
33239         - application/xml
33240       produces:
33241         - application/json
33242         - application/xml
33243       responses:
33244         "default":
33245           description: Response codes found in [response codes](https://wiki.onap.org/).
33246       parameters:
33247         - name: vnf-id
33248           in: path
33249           description: Unique id of VNF.  This is unique across the graph.
33250           required: true
33251           type: string
33252           example: __VNF-ID__
33253         - name: interface-name
33254           in: path
33255           description: Name given to the interface
33256           required: true
33257           type: string
33258           example: __INTERFACE-NAME__
33259         - name: l3-interface-ipv6-address
33260           in: path
33261           description: IP address
33262           required: true
33263           type: string
33264           example: __L3-INTERFACE-IPV6-ADDRESS__
33265         - name: body
33266           in: body
33267           description: l3-interface-ipv6-address-list object that needs to be updated.
33268           required: true
33269           schema:
33270             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33271     delete:
33272       tags:
33273         - Network
33274       summary: delete an existing l3-interface-ipv6-address-list
33275       description: delete an existing l3-interface-ipv6-address-list
33276       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33277       consumes:
33278         - application/json
33279         - application/xml
33280       produces:
33281         - application/json
33282         - application/xml
33283       responses:
33284         "default":
33285           description: Response codes found in [response codes](https://wiki.onap.org/).
33286       parameters:
33287         - name: vnf-id
33288           in: path
33289           description: Unique id of VNF.  This is unique across the graph.
33290           required: true
33291           type: string
33292           example: __VNF-ID__
33293         - name: interface-name
33294           in: path
33295           description: Name given to the interface
33296           required: true
33297           type: string
33298           example: __INTERFACE-NAME__
33299         - name: l3-interface-ipv6-address
33300           in: path
33301           description: IP address
33302           required: true
33303           type: string
33304           example: __L3-INTERFACE-IPV6-ADDRESS__
33305         - name: resource-version
33306           in: query
33307           description: resource-version for concurrency
33308           required: true
33309           type: string
33310   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
33311     get:
33312       tags:
33313         - Network
33314       summary: returns l-interface
33315       description: returns l-interface
33316       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
33317       produces:
33318         - application/json
33319         - application/xml
33320       responses:
33321         "200":
33322           description: successful operation
33323           schema:
33324               $ref: "#/getDefinitions/l-interface"
33325         "default":
33326           description: Response codes found in [response codes](https://wiki.onap.org/).
33327       parameters:
33328         - name: vnf-id
33329           in: path
33330           description: Unique id of VNF.  This is unique across the graph.
33331           required: true
33332           type: string
33333           example: __VNF-ID__
33334         - name: interface-name
33335           in: path
33336           description: Name given to the interface
33337           required: true
33338           type: string
33339           example: __INTERFACE-NAME__
33340     put:
33341       tags:
33342         - Network
33343       summary: create or update an existing l-interface
33344       description: |
33345         Create or update an existing l-interface.
33346         #
33347         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33348       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33349       consumes:
33350         - application/json
33351         - application/xml
33352       produces:
33353         - application/json
33354         - application/xml
33355       responses:
33356         "default":
33357           description: Response codes found in [response codes](https://wiki.onap.org/).
33358       parameters:
33359         - name: vnf-id
33360           in: path
33361           description: Unique id of VNF.  This is unique across the graph.
33362           required: true
33363           type: string
33364           example: __VNF-ID__
33365         - name: interface-name
33366           in: path
33367           description: Name given to the interface
33368           required: true
33369           type: string
33370           example: __INTERFACE-NAME__
33371         - name: body
33372           in: body
33373           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
33374           required: true
33375           schema:
33376             $ref: "#/definitions/l-interface"
33377     patch:
33378       tags:
33379         - Network
33380       summary: update an existing l-interface
33381       description: |
33382         Update an existing l-interface
33383         #
33384         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33385         The PUT operation will entirely replace an existing object.
33386         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33387         #
33388         Other differences between PUT and PATCH are:
33389         #
33390         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33391         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33392         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33393       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33394       consumes:
33395         - application/json
33396         - application/xml
33397       produces:
33398         - application/json
33399         - application/xml
33400       responses:
33401         "default":
33402           description: Response codes found in [response codes](https://wiki.onap.org/).
33403       parameters:
33404         - name: vnf-id
33405           in: path
33406           description: Unique id of VNF.  This is unique across the graph.
33407           required: true
33408           type: string
33409           example: __VNF-ID__
33410         - name: interface-name
33411           in: path
33412           description: Name given to the interface
33413           required: true
33414           type: string
33415           example: __INTERFACE-NAME__
33416         - name: body
33417           in: body
33418           description: l-interface object that needs to be updated.
33419           required: true
33420           schema:
33421             $ref: "#/patchDefinitions/l-interface"
33422     delete:
33423       tags:
33424         - Network
33425       summary: delete an existing l-interface
33426       description: delete an existing l-interface
33427       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
33428       consumes:
33429         - application/json
33430         - application/xml
33431       produces:
33432         - application/json
33433         - application/xml
33434       responses:
33435         "default":
33436           description: Response codes found in [response codes](https://wiki.onap.org/).
33437       parameters:
33438         - name: vnf-id
33439           in: path
33440           description: Unique id of VNF.  This is unique across the graph.
33441           required: true
33442           type: string
33443           example: __VNF-ID__
33444         - name: interface-name
33445           in: path
33446           description: Name given to the interface
33447           required: true
33448           type: string
33449           example: __INTERFACE-NAME__
33450         - name: resource-version
33451           in: query
33452           description: resource-version for concurrency
33453           required: true
33454           type: string
33455   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
33456     get:
33457       tags:
33458         - Network
33459       summary: returns l-interfaces
33460       description: returns l-interfaces
33461       operationId: getNetworkGenericVnfsGenericVnfLInterfaces
33462       produces:
33463         - application/json
33464         - application/xml
33465       responses:
33466         "200":
33467           description: successful operation
33468           schema:
33469               $ref: "#/getDefinitions/l-interfaces"
33470         "default":
33471           description: Response codes found in [response codes](https://wiki.onap.org/).
33472       parameters:
33473         - name: vnf-id
33474           in: path
33475           description: Unique id of VNF.  This is unique across the graph.
33476           required: true
33477           type: string
33478           example: __VNF-ID__
33479         - name: interface-name
33480           in: query
33481           description:
33482           required: false
33483           type: string
33484         - name: interface-id
33485           in: query
33486           description:
33487           required: false
33488           type: string
33489         - name: macaddr
33490           in: query
33491           description:
33492           required: false
33493           type: string
33494         - name: network-name
33495           in: query
33496           description:
33497           required: false
33498           type: string
33499   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
33500     put:
33501       tags:
33502         - Network
33503       summary: see node definition for valid relationships
33504       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33505       consumes:
33506         - application/json
33507         - application/xml
33508       produces:
33509         - application/json
33510         - application/xml
33511       responses:
33512         "default":
33513           description: Response codes found in [response codes](https://wiki.onap.org/).
33514       parameters:
33515         - name: vnf-id
33516           in: path
33517           description: Unique id of VNF.  This is unique across the graph.
33518           required: true
33519           type: string
33520           example: __VNF-ID__
33521         - name: interface-name
33522           in: path
33523           description: Name that identifies the link aggregate interface
33524           required: true
33525           type: string
33526           example: __INTERFACE-NAME__
33527         - name: body
33528           in: body
33529           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
33530           required: true
33531           schema:
33532             $ref: "#/definitions/relationship"
33533     delete:
33534       tags:
33535         - Network
33536       summary: delete an existing relationship
33537       description: delete an existing relationship
33538       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33539       consumes:
33540         - application/json
33541         - application/xml
33542       produces:
33543         - application/json
33544         - application/xml
33545       responses:
33546         "default":
33547           description: Response codes found in [response codes](https://wiki.onap.org/).
33548       parameters:
33549         - name: vnf-id
33550           in: path
33551           description: Unique id of VNF.  This is unique across the graph.
33552           required: true
33553           type: string
33554           example: __VNF-ID__
33555         - name: interface-name
33556           in: path
33557           description: Name that identifies the link aggregate interface
33558           required: true
33559           type: string
33560           example: __INTERFACE-NAME__
33561   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
33562     put:
33563       tags:
33564         - Network
33565       summary: see node definition for valid relationships
33566       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33567       consumes:
33568         - application/json
33569         - application/xml
33570       produces:
33571         - application/json
33572         - application/xml
33573       responses:
33574         "default":
33575           description: Response codes found in [response codes](https://wiki.onap.org/).
33576       parameters:
33577         - name: vnf-id
33578           in: path
33579           description: Unique id of VNF.  This is unique across the graph.
33580           required: true
33581           type: string
33582           example: __VNF-ID__
33583         - name: interface-name
33584           in: path
33585           description: Name that identifies the link aggregate interface
33586           required: true
33587           type: string
33588           example: __INTERFACE-NAME__
33589         - name: interface-name
33590           in: path
33591           description: Name given to the interface
33592           required: true
33593           type: string
33594           example: __INTERFACE-NAME__
33595         - name: vlan-interface
33596           in: path
33597           description: String that identifies the interface
33598           required: true
33599           type: string
33600           example: __VLAN-INTERFACE__
33601         - name: body
33602           in: body
33603           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
33604           required: true
33605           schema:
33606             $ref: "#/definitions/relationship"
33607     delete:
33608       tags:
33609         - Network
33610       summary: delete an existing relationship
33611       description: delete an existing relationship
33612       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33613       consumes:
33614         - application/json
33615         - application/xml
33616       produces:
33617         - application/json
33618         - application/xml
33619       responses:
33620         "default":
33621           description: Response codes found in [response codes](https://wiki.onap.org/).
33622       parameters:
33623         - name: vnf-id
33624           in: path
33625           description: Unique id of VNF.  This is unique across the graph.
33626           required: true
33627           type: string
33628           example: __VNF-ID__
33629         - name: interface-name
33630           in: path
33631           description: Name that identifies the link aggregate interface
33632           required: true
33633           type: string
33634           example: __INTERFACE-NAME__
33635         - name: interface-name
33636           in: path
33637           description: Name given to the interface
33638           required: true
33639           type: string
33640           example: __INTERFACE-NAME__
33641         - name: vlan-interface
33642           in: path
33643           description: String that identifies the interface
33644           required: true
33645           type: string
33646           example: __VLAN-INTERFACE__
33647   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
33648     put:
33649       tags:
33650         - Network
33651       summary: see node definition for valid relationships
33652       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33653       consumes:
33654         - application/json
33655         - application/xml
33656       produces:
33657         - application/json
33658         - application/xml
33659       responses:
33660         "default":
33661           description: Response codes found in [response codes](https://wiki.onap.org/).
33662       parameters:
33663         - name: vnf-id
33664           in: path
33665           description: Unique id of VNF.  This is unique across the graph.
33666           required: true
33667           type: string
33668           example: __VNF-ID__
33669         - name: interface-name
33670           in: path
33671           description: Name that identifies the link aggregate interface
33672           required: true
33673           type: string
33674           example: __INTERFACE-NAME__
33675         - name: interface-name
33676           in: path
33677           description: Name given to the interface
33678           required: true
33679           type: string
33680           example: __INTERFACE-NAME__
33681         - name: vlan-interface
33682           in: path
33683           description: String that identifies the interface
33684           required: true
33685           type: string
33686           example: __VLAN-INTERFACE__
33687         - name: l3-interface-ipv4-address
33688           in: path
33689           description: IP address
33690           required: true
33691           type: string
33692           example: __L3-INTERFACE-IPV4-ADDRESS__
33693         - name: body
33694           in: body
33695           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33696           required: true
33697           schema:
33698             $ref: "#/definitions/relationship"
33699     delete:
33700       tags:
33701         - Network
33702       summary: delete an existing relationship
33703       description: delete an existing relationship
33704       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33705       consumes:
33706         - application/json
33707         - application/xml
33708       produces:
33709         - application/json
33710         - application/xml
33711       responses:
33712         "default":
33713           description: Response codes found in [response codes](https://wiki.onap.org/).
33714       parameters:
33715         - name: vnf-id
33716           in: path
33717           description: Unique id of VNF.  This is unique across the graph.
33718           required: true
33719           type: string
33720           example: __VNF-ID__
33721         - name: interface-name
33722           in: path
33723           description: Name that identifies the link aggregate interface
33724           required: true
33725           type: string
33726           example: __INTERFACE-NAME__
33727         - name: interface-name
33728           in: path
33729           description: Name given to the interface
33730           required: true
33731           type: string
33732           example: __INTERFACE-NAME__
33733         - name: vlan-interface
33734           in: path
33735           description: String that identifies the interface
33736           required: true
33737           type: string
33738           example: __VLAN-INTERFACE__
33739         - name: l3-interface-ipv4-address
33740           in: path
33741           description: IP address
33742           required: true
33743           type: string
33744           example: __L3-INTERFACE-IPV4-ADDRESS__
33745   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
33746     get:
33747       tags:
33748         - Network
33749       summary: returns l3-interface-ipv4-address-list
33750       description: returns l3-interface-ipv4-address-list
33751       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33752       produces:
33753         - application/json
33754         - application/xml
33755       responses:
33756         "200":
33757           description: successful operation
33758           schema:
33759               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33760         "default":
33761           description: Response codes found in [response codes](https://wiki.onap.org/).
33762       parameters:
33763         - name: vnf-id
33764           in: path
33765           description: Unique id of VNF.  This is unique across the graph.
33766           required: true
33767           type: string
33768           example: __VNF-ID__
33769         - name: interface-name
33770           in: path
33771           description: Name that identifies the link aggregate interface
33772           required: true
33773           type: string
33774           example: __INTERFACE-NAME__
33775         - name: interface-name
33776           in: path
33777           description: Name given to the interface
33778           required: true
33779           type: string
33780           example: __INTERFACE-NAME__
33781         - name: vlan-interface
33782           in: path
33783           description: String that identifies the interface
33784           required: true
33785           type: string
33786           example: __VLAN-INTERFACE__
33787         - name: l3-interface-ipv4-address
33788           in: path
33789           description: IP address
33790           required: true
33791           type: string
33792           example: __L3-INTERFACE-IPV4-ADDRESS__
33793     put:
33794       tags:
33795         - Network
33796       summary: create or update an existing l3-interface-ipv4-address-list
33797       description: |
33798         Create or update an existing l3-interface-ipv4-address-list.
33799         #
33800         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33801       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33802       consumes:
33803         - application/json
33804         - application/xml
33805       produces:
33806         - application/json
33807         - application/xml
33808       responses:
33809         "default":
33810           description: Response codes found in [response codes](https://wiki.onap.org/).
33811       parameters:
33812         - name: vnf-id
33813           in: path
33814           description: Unique id of VNF.  This is unique across the graph.
33815           required: true
33816           type: string
33817           example: __VNF-ID__
33818         - name: interface-name
33819           in: path
33820           description: Name that identifies the link aggregate interface
33821           required: true
33822           type: string
33823           example: __INTERFACE-NAME__
33824         - name: interface-name
33825           in: path
33826           description: Name given to the interface
33827           required: true
33828           type: string
33829           example: __INTERFACE-NAME__
33830         - name: vlan-interface
33831           in: path
33832           description: String that identifies the interface
33833           required: true
33834           type: string
33835           example: __VLAN-INTERFACE__
33836         - name: l3-interface-ipv4-address
33837           in: path
33838           description: IP address
33839           required: true
33840           type: string
33841           example: __L3-INTERFACE-IPV4-ADDRESS__
33842         - name: body
33843           in: body
33844           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33845           required: true
33846           schema:
33847             $ref: "#/definitions/l3-interface-ipv4-address-list"
33848     patch:
33849       tags:
33850         - Network
33851       summary: update an existing l3-interface-ipv4-address-list
33852       description: |
33853         Update an existing l3-interface-ipv4-address-list
33854         #
33855         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33856         The PUT operation will entirely replace an existing object.
33857         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33858         #
33859         Other differences between PUT and PATCH are:
33860         #
33861         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33862         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33863         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33864       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33865       consumes:
33866         - application/json
33867         - application/xml
33868       produces:
33869         - application/json
33870         - application/xml
33871       responses:
33872         "default":
33873           description: Response codes found in [response codes](https://wiki.onap.org/).
33874       parameters:
33875         - name: vnf-id
33876           in: path
33877           description: Unique id of VNF.  This is unique across the graph.
33878           required: true
33879           type: string
33880           example: __VNF-ID__
33881         - name: interface-name
33882           in: path
33883           description: Name that identifies the link aggregate interface
33884           required: true
33885           type: string
33886           example: __INTERFACE-NAME__
33887         - name: interface-name
33888           in: path
33889           description: Name given to the interface
33890           required: true
33891           type: string
33892           example: __INTERFACE-NAME__
33893         - name: vlan-interface
33894           in: path
33895           description: String that identifies the interface
33896           required: true
33897           type: string
33898           example: __VLAN-INTERFACE__
33899         - name: l3-interface-ipv4-address
33900           in: path
33901           description: IP address
33902           required: true
33903           type: string
33904           example: __L3-INTERFACE-IPV4-ADDRESS__
33905         - name: body
33906           in: body
33907           description: l3-interface-ipv4-address-list object that needs to be updated.
33908           required: true
33909           schema:
33910             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33911     delete:
33912       tags:
33913         - Network
33914       summary: delete an existing l3-interface-ipv4-address-list
33915       description: delete an existing l3-interface-ipv4-address-list
33916       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33917       consumes:
33918         - application/json
33919         - application/xml
33920       produces:
33921         - application/json
33922         - application/xml
33923       responses:
33924         "default":
33925           description: Response codes found in [response codes](https://wiki.onap.org/).
33926       parameters:
33927         - name: vnf-id
33928           in: path
33929           description: Unique id of VNF.  This is unique across the graph.
33930           required: true
33931           type: string
33932           example: __VNF-ID__
33933         - name: interface-name
33934           in: path
33935           description: Name that identifies the link aggregate interface
33936           required: true
33937           type: string
33938           example: __INTERFACE-NAME__
33939         - name: interface-name
33940           in: path
33941           description: Name given to the interface
33942           required: true
33943           type: string
33944           example: __INTERFACE-NAME__
33945         - name: vlan-interface
33946           in: path
33947           description: String that identifies the interface
33948           required: true
33949           type: string
33950           example: __VLAN-INTERFACE__
33951         - name: l3-interface-ipv4-address
33952           in: path
33953           description: IP address
33954           required: true
33955           type: string
33956           example: __L3-INTERFACE-IPV4-ADDRESS__
33957         - name: resource-version
33958           in: query
33959           description: resource-version for concurrency
33960           required: true
33961           type: string
33962   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
33963     put:
33964       tags:
33965         - Network
33966       summary: see node definition for valid relationships
33967       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
33968       consumes:
33969         - application/json
33970         - application/xml
33971       produces:
33972         - application/json
33973         - application/xml
33974       responses:
33975         "default":
33976           description: Response codes found in [response codes](https://wiki.onap.org/).
33977       parameters:
33978         - name: vnf-id
33979           in: path
33980           description: Unique id of VNF.  This is unique across the graph.
33981           required: true
33982           type: string
33983           example: __VNF-ID__
33984         - name: interface-name
33985           in: path
33986           description: Name that identifies the link aggregate interface
33987           required: true
33988           type: string
33989           example: __INTERFACE-NAME__
33990         - name: interface-name
33991           in: path
33992           description: Name given to the interface
33993           required: true
33994           type: string
33995           example: __INTERFACE-NAME__
33996         - name: vlan-interface
33997           in: path
33998           description: String that identifies the interface
33999           required: true
34000           type: string
34001           example: __VLAN-INTERFACE__
34002         - name: l3-interface-ipv6-address
34003           in: path
34004           description: IP address
34005           required: true
34006           type: string
34007           example: __L3-INTERFACE-IPV6-ADDRESS__
34008         - name: body
34009           in: body
34010           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34011           required: true
34012           schema:
34013             $ref: "#/definitions/relationship"
34014     delete:
34015       tags:
34016         - Network
34017       summary: delete an existing relationship
34018       description: delete an existing relationship
34019       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
34020       consumes:
34021         - application/json
34022         - application/xml
34023       produces:
34024         - application/json
34025         - application/xml
34026       responses:
34027         "default":
34028           description: Response codes found in [response codes](https://wiki.onap.org/).
34029       parameters:
34030         - name: vnf-id
34031           in: path
34032           description: Unique id of VNF.  This is unique across the graph.
34033           required: true
34034           type: string
34035           example: __VNF-ID__
34036         - name: interface-name
34037           in: path
34038           description: Name that identifies the link aggregate interface
34039           required: true
34040           type: string
34041           example: __INTERFACE-NAME__
34042         - name: interface-name
34043           in: path
34044           description: Name given to the interface
34045           required: true
34046           type: string
34047           example: __INTERFACE-NAME__
34048         - name: vlan-interface
34049           in: path
34050           description: String that identifies the interface
34051           required: true
34052           type: string
34053           example: __VLAN-INTERFACE__
34054         - name: l3-interface-ipv6-address
34055           in: path
34056           description: IP address
34057           required: true
34058           type: string
34059           example: __L3-INTERFACE-IPV6-ADDRESS__
34060   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
34061     get:
34062       tags:
34063         - Network
34064       summary: returns l3-interface-ipv6-address-list
34065       description: returns l3-interface-ipv6-address-list
34066       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34067       produces:
34068         - application/json
34069         - application/xml
34070       responses:
34071         "200":
34072           description: successful operation
34073           schema:
34074               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
34075         "default":
34076           description: Response codes found in [response codes](https://wiki.onap.org/).
34077       parameters:
34078         - name: vnf-id
34079           in: path
34080           description: Unique id of VNF.  This is unique across the graph.
34081           required: true
34082           type: string
34083           example: __VNF-ID__
34084         - name: interface-name
34085           in: path
34086           description: Name that identifies the link aggregate interface
34087           required: true
34088           type: string
34089           example: __INTERFACE-NAME__
34090         - name: interface-name
34091           in: path
34092           description: Name given to the interface
34093           required: true
34094           type: string
34095           example: __INTERFACE-NAME__
34096         - name: vlan-interface
34097           in: path
34098           description: String that identifies the interface
34099           required: true
34100           type: string
34101           example: __VLAN-INTERFACE__
34102         - name: l3-interface-ipv6-address
34103           in: path
34104           description: IP address
34105           required: true
34106           type: string
34107           example: __L3-INTERFACE-IPV6-ADDRESS__
34108     put:
34109       tags:
34110         - Network
34111       summary: create or update an existing l3-interface-ipv6-address-list
34112       description: |
34113         Create or update an existing l3-interface-ipv6-address-list.
34114         #
34115         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34116       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34117       consumes:
34118         - application/json
34119         - application/xml
34120       produces:
34121         - application/json
34122         - application/xml
34123       responses:
34124         "default":
34125           description: Response codes found in [response codes](https://wiki.onap.org/).
34126       parameters:
34127         - name: vnf-id
34128           in: path
34129           description: Unique id of VNF.  This is unique across the graph.
34130           required: true
34131           type: string
34132           example: __VNF-ID__
34133         - name: interface-name
34134           in: path
34135           description: Name that identifies the link aggregate interface
34136           required: true
34137           type: string
34138           example: __INTERFACE-NAME__
34139         - name: interface-name
34140           in: path
34141           description: Name given to the interface
34142           required: true
34143           type: string
34144           example: __INTERFACE-NAME__
34145         - name: vlan-interface
34146           in: path
34147           description: String that identifies the interface
34148           required: true
34149           type: string
34150           example: __VLAN-INTERFACE__
34151         - name: l3-interface-ipv6-address
34152           in: path
34153           description: IP address
34154           required: true
34155           type: string
34156           example: __L3-INTERFACE-IPV6-ADDRESS__
34157         - name: body
34158           in: body
34159           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34160           required: true
34161           schema:
34162             $ref: "#/definitions/l3-interface-ipv6-address-list"
34163     patch:
34164       tags:
34165         - Network
34166       summary: update an existing l3-interface-ipv6-address-list
34167       description: |
34168         Update an existing l3-interface-ipv6-address-list
34169         #
34170         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34171         The PUT operation will entirely replace an existing object.
34172         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34173         #
34174         Other differences between PUT and PATCH are:
34175         #
34176         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34177         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34178         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34179       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34180       consumes:
34181         - application/json
34182         - application/xml
34183       produces:
34184         - application/json
34185         - application/xml
34186       responses:
34187         "default":
34188           description: Response codes found in [response codes](https://wiki.onap.org/).
34189       parameters:
34190         - name: vnf-id
34191           in: path
34192           description: Unique id of VNF.  This is unique across the graph.
34193           required: true
34194           type: string
34195           example: __VNF-ID__
34196         - name: interface-name
34197           in: path
34198           description: Name that identifies the link aggregate interface
34199           required: true
34200           type: string
34201           example: __INTERFACE-NAME__
34202         - name: interface-name
34203           in: path
34204           description: Name given to the interface
34205           required: true
34206           type: string
34207           example: __INTERFACE-NAME__
34208         - name: vlan-interface
34209           in: path
34210           description: String that identifies the interface
34211           required: true
34212           type: string
34213           example: __VLAN-INTERFACE__
34214         - name: l3-interface-ipv6-address
34215           in: path
34216           description: IP address
34217           required: true
34218           type: string
34219           example: __L3-INTERFACE-IPV6-ADDRESS__
34220         - name: body
34221           in: body
34222           description: l3-interface-ipv6-address-list object that needs to be updated.
34223           required: true
34224           schema:
34225             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34226     delete:
34227       tags:
34228         - Network
34229       summary: delete an existing l3-interface-ipv6-address-list
34230       description: delete an existing l3-interface-ipv6-address-list
34231       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34232       consumes:
34233         - application/json
34234         - application/xml
34235       produces:
34236         - application/json
34237         - application/xml
34238       responses:
34239         "default":
34240           description: Response codes found in [response codes](https://wiki.onap.org/).
34241       parameters:
34242         - name: vnf-id
34243           in: path
34244           description: Unique id of VNF.  This is unique across the graph.
34245           required: true
34246           type: string
34247           example: __VNF-ID__
34248         - name: interface-name
34249           in: path
34250           description: Name that identifies the link aggregate interface
34251           required: true
34252           type: string
34253           example: __INTERFACE-NAME__
34254         - name: interface-name
34255           in: path
34256           description: Name given to the interface
34257           required: true
34258           type: string
34259           example: __INTERFACE-NAME__
34260         - name: vlan-interface
34261           in: path
34262           description: String that identifies the interface
34263           required: true
34264           type: string
34265           example: __VLAN-INTERFACE__
34266         - name: l3-interface-ipv6-address
34267           in: path
34268           description: IP address
34269           required: true
34270           type: string
34271           example: __L3-INTERFACE-IPV6-ADDRESS__
34272         - name: resource-version
34273           in: query
34274           description: resource-version for concurrency
34275           required: true
34276           type: string
34277   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
34278     get:
34279       tags:
34280         - Network
34281       summary: returns vlan
34282       description: returns vlan
34283       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34284       produces:
34285         - application/json
34286         - application/xml
34287       responses:
34288         "200":
34289           description: successful operation
34290           schema:
34291               $ref: "#/getDefinitions/vlan"
34292         "default":
34293           description: Response codes found in [response codes](https://wiki.onap.org/).
34294       parameters:
34295         - name: vnf-id
34296           in: path
34297           description: Unique id of VNF.  This is unique across the graph.
34298           required: true
34299           type: string
34300           example: __VNF-ID__
34301         - name: interface-name
34302           in: path
34303           description: Name that identifies the link aggregate interface
34304           required: true
34305           type: string
34306           example: __INTERFACE-NAME__
34307         - name: interface-name
34308           in: path
34309           description: Name given to the interface
34310           required: true
34311           type: string
34312           example: __INTERFACE-NAME__
34313         - name: vlan-interface
34314           in: path
34315           description: String that identifies the interface
34316           required: true
34317           type: string
34318           example: __VLAN-INTERFACE__
34319     put:
34320       tags:
34321         - Network
34322       summary: create or update an existing vlan
34323       description: |
34324         Create or update an existing vlan.
34325         #
34326         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34327       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34328       consumes:
34329         - application/json
34330         - application/xml
34331       produces:
34332         - application/json
34333         - application/xml
34334       responses:
34335         "default":
34336           description: Response codes found in [response codes](https://wiki.onap.org/).
34337       parameters:
34338         - name: vnf-id
34339           in: path
34340           description: Unique id of VNF.  This is unique across the graph.
34341           required: true
34342           type: string
34343           example: __VNF-ID__
34344         - name: interface-name
34345           in: path
34346           description: Name that identifies the link aggregate interface
34347           required: true
34348           type: string
34349           example: __INTERFACE-NAME__
34350         - name: interface-name
34351           in: path
34352           description: Name given to the interface
34353           required: true
34354           type: string
34355           example: __INTERFACE-NAME__
34356         - name: vlan-interface
34357           in: path
34358           description: String that identifies the interface
34359           required: true
34360           type: string
34361           example: __VLAN-INTERFACE__
34362         - name: body
34363           in: body
34364           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
34365           required: true
34366           schema:
34367             $ref: "#/definitions/vlan"
34368     patch:
34369       tags:
34370         - Network
34371       summary: update an existing vlan
34372       description: |
34373         Update an existing vlan
34374         #
34375         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34376         The PUT operation will entirely replace an existing object.
34377         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34378         #
34379         Other differences between PUT and PATCH are:
34380         #
34381         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34382         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34383         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34384       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34385       consumes:
34386         - application/json
34387         - application/xml
34388       produces:
34389         - application/json
34390         - application/xml
34391       responses:
34392         "default":
34393           description: Response codes found in [response codes](https://wiki.onap.org/).
34394       parameters:
34395         - name: vnf-id
34396           in: path
34397           description: Unique id of VNF.  This is unique across the graph.
34398           required: true
34399           type: string
34400           example: __VNF-ID__
34401         - name: interface-name
34402           in: path
34403           description: Name that identifies the link aggregate interface
34404           required: true
34405           type: string
34406           example: __INTERFACE-NAME__
34407         - name: interface-name
34408           in: path
34409           description: Name given to the interface
34410           required: true
34411           type: string
34412           example: __INTERFACE-NAME__
34413         - name: vlan-interface
34414           in: path
34415           description: String that identifies the interface
34416           required: true
34417           type: string
34418           example: __VLAN-INTERFACE__
34419         - name: body
34420           in: body
34421           description: vlan object that needs to be updated.
34422           required: true
34423           schema:
34424             $ref: "#/patchDefinitions/vlan"
34425     delete:
34426       tags:
34427         - Network
34428       summary: delete an existing vlan
34429       description: delete an existing vlan
34430       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34431       consumes:
34432         - application/json
34433         - application/xml
34434       produces:
34435         - application/json
34436         - application/xml
34437       responses:
34438         "default":
34439           description: Response codes found in [response codes](https://wiki.onap.org/).
34440       parameters:
34441         - name: vnf-id
34442           in: path
34443           description: Unique id of VNF.  This is unique across the graph.
34444           required: true
34445           type: string
34446           example: __VNF-ID__
34447         - name: interface-name
34448           in: path
34449           description: Name that identifies the link aggregate interface
34450           required: true
34451           type: string
34452           example: __INTERFACE-NAME__
34453         - name: interface-name
34454           in: path
34455           description: Name given to the interface
34456           required: true
34457           type: string
34458           example: __INTERFACE-NAME__
34459         - name: vlan-interface
34460           in: path
34461           description: String that identifies the interface
34462           required: true
34463           type: string
34464           example: __VLAN-INTERFACE__
34465         - name: resource-version
34466           in: query
34467           description: resource-version for concurrency
34468           required: true
34469           type: string
34470   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
34471     get:
34472       tags:
34473         - Network
34474       summary: returns vlans
34475       description: returns vlans
34476       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
34477       produces:
34478         - application/json
34479         - application/xml
34480       responses:
34481         "200":
34482           description: successful operation
34483           schema:
34484               $ref: "#/getDefinitions/vlans"
34485         "default":
34486           description: Response codes found in [response codes](https://wiki.onap.org/).
34487       parameters:
34488         - name: vnf-id
34489           in: path
34490           description: Unique id of VNF.  This is unique across the graph.
34491           required: true
34492           type: string
34493           example: __VNF-ID__
34494         - name: interface-name
34495           in: path
34496           description: Name that identifies the link aggregate interface
34497           required: true
34498           type: string
34499           example: __INTERFACE-NAME__
34500         - name: interface-name
34501           in: path
34502           description: Name given to the interface
34503           required: true
34504           type: string
34505           example: __INTERFACE-NAME__
34506         - name: vlan-interface
34507           in: query
34508           description:
34509           required: false
34510           type: string
34511         - name: vlan-id-inner
34512           in: query
34513           description:
34514           required: false
34515           type: integer
34516           format: int64
34517         - name: vpn-key
34518           in: query
34519           description:
34520           required: false
34521           type: string
34522   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
34523     put:
34524       tags:
34525         - Network
34526       summary: see node definition for valid relationships
34527       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
34528       consumes:
34529         - application/json
34530         - application/xml
34531       produces:
34532         - application/json
34533         - application/xml
34534       responses:
34535         "default":
34536           description: Response codes found in [response codes](https://wiki.onap.org/).
34537       parameters:
34538         - name: vnf-id
34539           in: path
34540           description: Unique id of VNF.  This is unique across the graph.
34541           required: true
34542           type: string
34543           example: __VNF-ID__
34544         - name: interface-name
34545           in: path
34546           description: Name that identifies the link aggregate interface
34547           required: true
34548           type: string
34549           example: __INTERFACE-NAME__
34550         - name: interface-name
34551           in: path
34552           description: Name given to the interface
34553           required: true
34554           type: string
34555           example: __INTERFACE-NAME__
34556         - name: pci-id
34557           in: path
34558           description: PCI ID used to identify the sriov-vf
34559           required: true
34560           type: string
34561           example: __PCI-ID__
34562         - name: body
34563           in: body
34564           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
34565           required: true
34566           schema:
34567             $ref: "#/definitions/relationship"
34568     delete:
34569       tags:
34570         - Network
34571       summary: delete an existing relationship
34572       description: delete an existing relationship
34573       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
34574       consumes:
34575         - application/json
34576         - application/xml
34577       produces:
34578         - application/json
34579         - application/xml
34580       responses:
34581         "default":
34582           description: Response codes found in [response codes](https://wiki.onap.org/).
34583       parameters:
34584         - name: vnf-id
34585           in: path
34586           description: Unique id of VNF.  This is unique across the graph.
34587           required: true
34588           type: string
34589           example: __VNF-ID__
34590         - name: interface-name
34591           in: path
34592           description: Name that identifies the link aggregate interface
34593           required: true
34594           type: string
34595           example: __INTERFACE-NAME__
34596         - name: interface-name
34597           in: path
34598           description: Name given to the interface
34599           required: true
34600           type: string
34601           example: __INTERFACE-NAME__
34602         - name: pci-id
34603           in: path
34604           description: PCI ID used to identify the sriov-vf
34605           required: true
34606           type: string
34607           example: __PCI-ID__
34608   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
34609     get:
34610       tags:
34611         - Network
34612       summary: returns sriov-vf
34613       description: returns sriov-vf
34614       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34615       produces:
34616         - application/json
34617         - application/xml
34618       responses:
34619         "200":
34620           description: successful operation
34621           schema:
34622               $ref: "#/getDefinitions/sriov-vf"
34623         "default":
34624           description: Response codes found in [response codes](https://wiki.onap.org/).
34625       parameters:
34626         - name: vnf-id
34627           in: path
34628           description: Unique id of VNF.  This is unique across the graph.
34629           required: true
34630           type: string
34631           example: __VNF-ID__
34632         - name: interface-name
34633           in: path
34634           description: Name that identifies the link aggregate interface
34635           required: true
34636           type: string
34637           example: __INTERFACE-NAME__
34638         - name: interface-name
34639           in: path
34640           description: Name given to the interface
34641           required: true
34642           type: string
34643           example: __INTERFACE-NAME__
34644         - name: pci-id
34645           in: path
34646           description: PCI ID used to identify the sriov-vf
34647           required: true
34648           type: string
34649           example: __PCI-ID__
34650     put:
34651       tags:
34652         - Network
34653       summary: create or update an existing sriov-vf
34654       description: |
34655         Create or update an existing sriov-vf.
34656         #
34657         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34658       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34659       consumes:
34660         - application/json
34661         - application/xml
34662       produces:
34663         - application/json
34664         - application/xml
34665       responses:
34666         "default":
34667           description: Response codes found in [response codes](https://wiki.onap.org/).
34668       parameters:
34669         - name: vnf-id
34670           in: path
34671           description: Unique id of VNF.  This is unique across the graph.
34672           required: true
34673           type: string
34674           example: __VNF-ID__
34675         - name: interface-name
34676           in: path
34677           description: Name that identifies the link aggregate interface
34678           required: true
34679           type: string
34680           example: __INTERFACE-NAME__
34681         - name: interface-name
34682           in: path
34683           description: Name given to the interface
34684           required: true
34685           type: string
34686           example: __INTERFACE-NAME__
34687         - name: pci-id
34688           in: path
34689           description: PCI ID used to identify the sriov-vf
34690           required: true
34691           type: string
34692           example: __PCI-ID__
34693         - name: body
34694           in: body
34695           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
34696           required: true
34697           schema:
34698             $ref: "#/definitions/sriov-vf"
34699     patch:
34700       tags:
34701         - Network
34702       summary: update an existing sriov-vf
34703       description: |
34704         Update an existing sriov-vf
34705         #
34706         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34707         The PUT operation will entirely replace an existing object.
34708         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34709         #
34710         Other differences between PUT and PATCH are:
34711         #
34712         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34713         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34714         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34715       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34716       consumes:
34717         - application/json
34718         - application/xml
34719       produces:
34720         - application/json
34721         - application/xml
34722       responses:
34723         "default":
34724           description: Response codes found in [response codes](https://wiki.onap.org/).
34725       parameters:
34726         - name: vnf-id
34727           in: path
34728           description: Unique id of VNF.  This is unique across the graph.
34729           required: true
34730           type: string
34731           example: __VNF-ID__
34732         - name: interface-name
34733           in: path
34734           description: Name that identifies the link aggregate interface
34735           required: true
34736           type: string
34737           example: __INTERFACE-NAME__
34738         - name: interface-name
34739           in: path
34740           description: Name given to the interface
34741           required: true
34742           type: string
34743           example: __INTERFACE-NAME__
34744         - name: pci-id
34745           in: path
34746           description: PCI ID used to identify the sriov-vf
34747           required: true
34748           type: string
34749           example: __PCI-ID__
34750         - name: body
34751           in: body
34752           description: sriov-vf object that needs to be updated.
34753           required: true
34754           schema:
34755             $ref: "#/patchDefinitions/sriov-vf"
34756     delete:
34757       tags:
34758         - Network
34759       summary: delete an existing sriov-vf
34760       description: delete an existing sriov-vf
34761       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
34762       consumes:
34763         - application/json
34764         - application/xml
34765       produces:
34766         - application/json
34767         - application/xml
34768       responses:
34769         "default":
34770           description: Response codes found in [response codes](https://wiki.onap.org/).
34771       parameters:
34772         - name: vnf-id
34773           in: path
34774           description: Unique id of VNF.  This is unique across the graph.
34775           required: true
34776           type: string
34777           example: __VNF-ID__
34778         - name: interface-name
34779           in: path
34780           description: Name that identifies the link aggregate interface
34781           required: true
34782           type: string
34783           example: __INTERFACE-NAME__
34784         - name: interface-name
34785           in: path
34786           description: Name given to the interface
34787           required: true
34788           type: string
34789           example: __INTERFACE-NAME__
34790         - name: pci-id
34791           in: path
34792           description: PCI ID used to identify the sriov-vf
34793           required: true
34794           type: string
34795           example: __PCI-ID__
34796         - name: resource-version
34797           in: query
34798           description: resource-version for concurrency
34799           required: true
34800           type: string
34801   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
34802     get:
34803       tags:
34804         - Network
34805       summary: returns sriov-vfs
34806       description: returns sriov-vfs
34807       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
34808       produces:
34809         - application/json
34810         - application/xml
34811       responses:
34812         "200":
34813           description: successful operation
34814           schema:
34815               $ref: "#/getDefinitions/sriov-vfs"
34816         "default":
34817           description: Response codes found in [response codes](https://wiki.onap.org/).
34818       parameters:
34819         - name: vnf-id
34820           in: path
34821           description: Unique id of VNF.  This is unique across the graph.
34822           required: true
34823           type: string
34824           example: __VNF-ID__
34825         - name: interface-name
34826           in: path
34827           description: Name that identifies the link aggregate interface
34828           required: true
34829           type: string
34830           example: __INTERFACE-NAME__
34831         - name: interface-name
34832           in: path
34833           description: Name given to the interface
34834           required: true
34835           type: string
34836           example: __INTERFACE-NAME__
34837         - name: pci-id
34838           in: query
34839           description:
34840           required: false
34841           type: string
34842         - name: vf-vlan-filter
34843           in: query
34844           description:
34845           required: false
34846           type: string
34847         - name: vf-mac-filter
34848           in: query
34849           description:
34850           required: false
34851           type: string
34852         - name: vf-vlan-strip
34853           in: query
34854           description:
34855           required: false
34856           type: boolean
34857         - name: neutron-network-id
34858           in: query
34859           description:
34860           required: false
34861           type: string
34862   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
34863     put:
34864       tags:
34865         - Network
34866       summary: see node definition for valid relationships
34867       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
34868       consumes:
34869         - application/json
34870         - application/xml
34871       produces:
34872         - application/json
34873         - application/xml
34874       responses:
34875         "default":
34876           description: Response codes found in [response codes](https://wiki.onap.org/).
34877       parameters:
34878         - name: vnf-id
34879           in: path
34880           description: Unique id of VNF.  This is unique across the graph.
34881           required: true
34882           type: string
34883           example: __VNF-ID__
34884         - name: interface-name
34885           in: path
34886           description: Name that identifies the link aggregate interface
34887           required: true
34888           type: string
34889           example: __INTERFACE-NAME__
34890         - name: interface-name
34891           in: path
34892           description: Name given to the interface
34893           required: true
34894           type: string
34895           example: __INTERFACE-NAME__
34896         - name: body
34897           in: body
34898           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
34899           required: true
34900           schema:
34901             $ref: "#/definitions/relationship"
34902     delete:
34903       tags:
34904         - Network
34905       summary: delete an existing relationship
34906       description: delete an existing relationship
34907       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
34908       consumes:
34909         - application/json
34910         - application/xml
34911       produces:
34912         - application/json
34913         - application/xml
34914       responses:
34915         "default":
34916           description: Response codes found in [response codes](https://wiki.onap.org/).
34917       parameters:
34918         - name: vnf-id
34919           in: path
34920           description: Unique id of VNF.  This is unique across the graph.
34921           required: true
34922           type: string
34923           example: __VNF-ID__
34924         - name: interface-name
34925           in: path
34926           description: Name that identifies the link aggregate interface
34927           required: true
34928           type: string
34929           example: __INTERFACE-NAME__
34930         - name: interface-name
34931           in: path
34932           description: Name given to the interface
34933           required: true
34934           type: string
34935           example: __INTERFACE-NAME__
34936   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
34937     put:
34938       tags:
34939         - Network
34940       summary: see node definition for valid relationships
34941       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
34942       consumes:
34943         - application/json
34944         - application/xml
34945       produces:
34946         - application/json
34947         - application/xml
34948       responses:
34949         "default":
34950           description: Response codes found in [response codes](https://wiki.onap.org/).
34951       parameters:
34952         - name: vnf-id
34953           in: path
34954           description: Unique id of VNF.  This is unique across the graph.
34955           required: true
34956           type: string
34957           example: __VNF-ID__
34958         - name: interface-name
34959           in: path
34960           description: Name that identifies the link aggregate interface
34961           required: true
34962           type: string
34963           example: __INTERFACE-NAME__
34964         - name: interface-name
34965           in: path
34966           description: Name given to the interface
34967           required: true
34968           type: string
34969           example: __INTERFACE-NAME__
34970         - name: l3-interface-ipv4-address
34971           in: path
34972           description: IP address
34973           required: true
34974           type: string
34975           example: __L3-INTERFACE-IPV4-ADDRESS__
34976         - name: body
34977           in: body
34978           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
34979           required: true
34980           schema:
34981             $ref: "#/definitions/relationship"
34982     delete:
34983       tags:
34984         - Network
34985       summary: delete an existing relationship
34986       description: delete an existing relationship
34987       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
34988       consumes:
34989         - application/json
34990         - application/xml
34991       produces:
34992         - application/json
34993         - application/xml
34994       responses:
34995         "default":
34996           description: Response codes found in [response codes](https://wiki.onap.org/).
34997       parameters:
34998         - name: vnf-id
34999           in: path
35000           description: Unique id of VNF.  This is unique across the graph.
35001           required: true
35002           type: string
35003           example: __VNF-ID__
35004         - name: interface-name
35005           in: path
35006           description: Name that identifies the link aggregate interface
35007           required: true
35008           type: string
35009           example: __INTERFACE-NAME__
35010         - name: interface-name
35011           in: path
35012           description: Name given to the interface
35013           required: true
35014           type: string
35015           example: __INTERFACE-NAME__
35016         - name: l3-interface-ipv4-address
35017           in: path
35018           description: IP address
35019           required: true
35020           type: string
35021           example: __L3-INTERFACE-IPV4-ADDRESS__
35022   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
35023     get:
35024       tags:
35025         - Network
35026       summary: returns l3-interface-ipv4-address-list
35027       description: returns l3-interface-ipv4-address-list
35028       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35029       produces:
35030         - application/json
35031         - application/xml
35032       responses:
35033         "200":
35034           description: successful operation
35035           schema:
35036               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35037         "default":
35038           description: Response codes found in [response codes](https://wiki.onap.org/).
35039       parameters:
35040         - name: vnf-id
35041           in: path
35042           description: Unique id of VNF.  This is unique across the graph.
35043           required: true
35044           type: string
35045           example: __VNF-ID__
35046         - name: interface-name
35047           in: path
35048           description: Name that identifies the link aggregate interface
35049           required: true
35050           type: string
35051           example: __INTERFACE-NAME__
35052         - name: interface-name
35053           in: path
35054           description: Name given to the interface
35055           required: true
35056           type: string
35057           example: __INTERFACE-NAME__
35058         - name: l3-interface-ipv4-address
35059           in: path
35060           description: IP address
35061           required: true
35062           type: string
35063           example: __L3-INTERFACE-IPV4-ADDRESS__
35064     put:
35065       tags:
35066         - Network
35067       summary: create or update an existing l3-interface-ipv4-address-list
35068       description: |
35069         Create or update an existing l3-interface-ipv4-address-list.
35070         #
35071         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35072       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35073       consumes:
35074         - application/json
35075         - application/xml
35076       produces:
35077         - application/json
35078         - application/xml
35079       responses:
35080         "default":
35081           description: Response codes found in [response codes](https://wiki.onap.org/).
35082       parameters:
35083         - name: vnf-id
35084           in: path
35085           description: Unique id of VNF.  This is unique across the graph.
35086           required: true
35087           type: string
35088           example: __VNF-ID__
35089         - name: interface-name
35090           in: path
35091           description: Name that identifies the link aggregate interface
35092           required: true
35093           type: string
35094           example: __INTERFACE-NAME__
35095         - name: interface-name
35096           in: path
35097           description: Name given to the interface
35098           required: true
35099           type: string
35100           example: __INTERFACE-NAME__
35101         - name: l3-interface-ipv4-address
35102           in: path
35103           description: IP address
35104           required: true
35105           type: string
35106           example: __L3-INTERFACE-IPV4-ADDRESS__
35107         - name: body
35108           in: body
35109           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
35110           required: true
35111           schema:
35112             $ref: "#/definitions/l3-interface-ipv4-address-list"
35113     patch:
35114       tags:
35115         - Network
35116       summary: update an existing l3-interface-ipv4-address-list
35117       description: |
35118         Update an existing l3-interface-ipv4-address-list
35119         #
35120         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35121         The PUT operation will entirely replace an existing object.
35122         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35123         #
35124         Other differences between PUT and PATCH are:
35125         #
35126         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35127         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35128         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35129       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35130       consumes:
35131         - application/json
35132         - application/xml
35133       produces:
35134         - application/json
35135         - application/xml
35136       responses:
35137         "default":
35138           description: Response codes found in [response codes](https://wiki.onap.org/).
35139       parameters:
35140         - name: vnf-id
35141           in: path
35142           description: Unique id of VNF.  This is unique across the graph.
35143           required: true
35144           type: string
35145           example: __VNF-ID__
35146         - name: interface-name
35147           in: path
35148           description: Name that identifies the link aggregate interface
35149           required: true
35150           type: string
35151           example: __INTERFACE-NAME__
35152         - name: interface-name
35153           in: path
35154           description: Name given to the interface
35155           required: true
35156           type: string
35157           example: __INTERFACE-NAME__
35158         - name: l3-interface-ipv4-address
35159           in: path
35160           description: IP address
35161           required: true
35162           type: string
35163           example: __L3-INTERFACE-IPV4-ADDRESS__
35164         - name: body
35165           in: body
35166           description: l3-interface-ipv4-address-list object that needs to be updated.
35167           required: true
35168           schema:
35169             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35170     delete:
35171       tags:
35172         - Network
35173       summary: delete an existing l3-interface-ipv4-address-list
35174       description: delete an existing l3-interface-ipv4-address-list
35175       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35176       consumes:
35177         - application/json
35178         - application/xml
35179       produces:
35180         - application/json
35181         - application/xml
35182       responses:
35183         "default":
35184           description: Response codes found in [response codes](https://wiki.onap.org/).
35185       parameters:
35186         - name: vnf-id
35187           in: path
35188           description: Unique id of VNF.  This is unique across the graph.
35189           required: true
35190           type: string
35191           example: __VNF-ID__
35192         - name: interface-name
35193           in: path
35194           description: Name that identifies the link aggregate interface
35195           required: true
35196           type: string
35197           example: __INTERFACE-NAME__
35198         - name: interface-name
35199           in: path
35200           description: Name given to the interface
35201           required: true
35202           type: string
35203           example: __INTERFACE-NAME__
35204         - name: l3-interface-ipv4-address
35205           in: path
35206           description: IP address
35207           required: true
35208           type: string
35209           example: __L3-INTERFACE-IPV4-ADDRESS__
35210         - name: resource-version
35211           in: query
35212           description: resource-version for concurrency
35213           required: true
35214           type: string
35215   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
35216     put:
35217       tags:
35218         - Network
35219       summary: see node definition for valid relationships
35220       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
35221       consumes:
35222         - application/json
35223         - application/xml
35224       produces:
35225         - application/json
35226         - application/xml
35227       responses:
35228         "default":
35229           description: Response codes found in [response codes](https://wiki.onap.org/).
35230       parameters:
35231         - name: vnf-id
35232           in: path
35233           description: Unique id of VNF.  This is unique across the graph.
35234           required: true
35235           type: string
35236           example: __VNF-ID__
35237         - name: interface-name
35238           in: path
35239           description: Name that identifies the link aggregate interface
35240           required: true
35241           type: string
35242           example: __INTERFACE-NAME__
35243         - name: interface-name
35244           in: path
35245           description: Name given to the interface
35246           required: true
35247           type: string
35248           example: __INTERFACE-NAME__
35249         - name: l3-interface-ipv6-address
35250           in: path
35251           description: IP address
35252           required: true
35253           type: string
35254           example: __L3-INTERFACE-IPV6-ADDRESS__
35255         - name: body
35256           in: body
35257           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
35258           required: true
35259           schema:
35260             $ref: "#/definitions/relationship"
35261     delete:
35262       tags:
35263         - Network
35264       summary: delete an existing relationship
35265       description: delete an existing relationship
35266       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
35267       consumes:
35268         - application/json
35269         - application/xml
35270       produces:
35271         - application/json
35272         - application/xml
35273       responses:
35274         "default":
35275           description: Response codes found in [response codes](https://wiki.onap.org/).
35276       parameters:
35277         - name: vnf-id
35278           in: path
35279           description: Unique id of VNF.  This is unique across the graph.
35280           required: true
35281           type: string
35282           example: __VNF-ID__
35283         - name: interface-name
35284           in: path
35285           description: Name that identifies the link aggregate interface
35286           required: true
35287           type: string
35288           example: __INTERFACE-NAME__
35289         - name: interface-name
35290           in: path
35291           description: Name given to the interface
35292           required: true
35293           type: string
35294           example: __INTERFACE-NAME__
35295         - name: l3-interface-ipv6-address
35296           in: path
35297           description: IP address
35298           required: true
35299           type: string
35300           example: __L3-INTERFACE-IPV6-ADDRESS__
35301   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
35302     get:
35303       tags:
35304         - Network
35305       summary: returns l3-interface-ipv6-address-list
35306       description: returns l3-interface-ipv6-address-list
35307       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35308       produces:
35309         - application/json
35310         - application/xml
35311       responses:
35312         "200":
35313           description: successful operation
35314           schema:
35315               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35316         "default":
35317           description: Response codes found in [response codes](https://wiki.onap.org/).
35318       parameters:
35319         - name: vnf-id
35320           in: path
35321           description: Unique id of VNF.  This is unique across the graph.
35322           required: true
35323           type: string
35324           example: __VNF-ID__
35325         - name: interface-name
35326           in: path
35327           description: Name that identifies the link aggregate interface
35328           required: true
35329           type: string
35330           example: __INTERFACE-NAME__
35331         - name: interface-name
35332           in: path
35333           description: Name given to the interface
35334           required: true
35335           type: string
35336           example: __INTERFACE-NAME__
35337         - name: l3-interface-ipv6-address
35338           in: path
35339           description: IP address
35340           required: true
35341           type: string
35342           example: __L3-INTERFACE-IPV6-ADDRESS__
35343     put:
35344       tags:
35345         - Network
35346       summary: create or update an existing l3-interface-ipv6-address-list
35347       description: |
35348         Create or update an existing l3-interface-ipv6-address-list.
35349         #
35350         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35351       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35352       consumes:
35353         - application/json
35354         - application/xml
35355       produces:
35356         - application/json
35357         - application/xml
35358       responses:
35359         "default":
35360           description: Response codes found in [response codes](https://wiki.onap.org/).
35361       parameters:
35362         - name: vnf-id
35363           in: path
35364           description: Unique id of VNF.  This is unique across the graph.
35365           required: true
35366           type: string
35367           example: __VNF-ID__
35368         - name: interface-name
35369           in: path
35370           description: Name that identifies the link aggregate interface
35371           required: true
35372           type: string
35373           example: __INTERFACE-NAME__
35374         - name: interface-name
35375           in: path
35376           description: Name given to the interface
35377           required: true
35378           type: string
35379           example: __INTERFACE-NAME__
35380         - name: l3-interface-ipv6-address
35381           in: path
35382           description: IP address
35383           required: true
35384           type: string
35385           example: __L3-INTERFACE-IPV6-ADDRESS__
35386         - name: body
35387           in: body
35388           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
35389           required: true
35390           schema:
35391             $ref: "#/definitions/l3-interface-ipv6-address-list"
35392     patch:
35393       tags:
35394         - Network
35395       summary: update an existing l3-interface-ipv6-address-list
35396       description: |
35397         Update an existing l3-interface-ipv6-address-list
35398         #
35399         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35400         The PUT operation will entirely replace an existing object.
35401         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35402         #
35403         Other differences between PUT and PATCH are:
35404         #
35405         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35406         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35407         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35408       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35409       consumes:
35410         - application/json
35411         - application/xml
35412       produces:
35413         - application/json
35414         - application/xml
35415       responses:
35416         "default":
35417           description: Response codes found in [response codes](https://wiki.onap.org/).
35418       parameters:
35419         - name: vnf-id
35420           in: path
35421           description: Unique id of VNF.  This is unique across the graph.
35422           required: true
35423           type: string
35424           example: __VNF-ID__
35425         - name: interface-name
35426           in: path
35427           description: Name that identifies the link aggregate interface
35428           required: true
35429           type: string
35430           example: __INTERFACE-NAME__
35431         - name: interface-name
35432           in: path
35433           description: Name given to the interface
35434           required: true
35435           type: string
35436           example: __INTERFACE-NAME__
35437         - name: l3-interface-ipv6-address
35438           in: path
35439           description: IP address
35440           required: true
35441           type: string
35442           example: __L3-INTERFACE-IPV6-ADDRESS__
35443         - name: body
35444           in: body
35445           description: l3-interface-ipv6-address-list object that needs to be updated.
35446           required: true
35447           schema:
35448             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35449     delete:
35450       tags:
35451         - Network
35452       summary: delete an existing l3-interface-ipv6-address-list
35453       description: delete an existing l3-interface-ipv6-address-list
35454       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
35455       consumes:
35456         - application/json
35457         - application/xml
35458       produces:
35459         - application/json
35460         - application/xml
35461       responses:
35462         "default":
35463           description: Response codes found in [response codes](https://wiki.onap.org/).
35464       parameters:
35465         - name: vnf-id
35466           in: path
35467           description: Unique id of VNF.  This is unique across the graph.
35468           required: true
35469           type: string
35470           example: __VNF-ID__
35471         - name: interface-name
35472           in: path
35473           description: Name that identifies the link aggregate interface
35474           required: true
35475           type: string
35476           example: __INTERFACE-NAME__
35477         - name: interface-name
35478           in: path
35479           description: Name given to the interface
35480           required: true
35481           type: string
35482           example: __INTERFACE-NAME__
35483         - name: l3-interface-ipv6-address
35484           in: path
35485           description: IP address
35486           required: true
35487           type: string
35488           example: __L3-INTERFACE-IPV6-ADDRESS__
35489         - name: resource-version
35490           in: query
35491           description: resource-version for concurrency
35492           required: true
35493           type: string
35494   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
35495     get:
35496       tags:
35497         - Network
35498       summary: returns l-interface
35499       description: returns l-interface
35500       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35501       produces:
35502         - application/json
35503         - application/xml
35504       responses:
35505         "200":
35506           description: successful operation
35507           schema:
35508               $ref: "#/getDefinitions/l-interface"
35509         "default":
35510           description: Response codes found in [response codes](https://wiki.onap.org/).
35511       parameters:
35512         - name: vnf-id
35513           in: path
35514           description: Unique id of VNF.  This is unique across the graph.
35515           required: true
35516           type: string
35517           example: __VNF-ID__
35518         - name: interface-name
35519           in: path
35520           description: Name that identifies the link aggregate interface
35521           required: true
35522           type: string
35523           example: __INTERFACE-NAME__
35524         - name: interface-name
35525           in: path
35526           description: Name given to the interface
35527           required: true
35528           type: string
35529           example: __INTERFACE-NAME__
35530     put:
35531       tags:
35532         - Network
35533       summary: create or update an existing l-interface
35534       description: |
35535         Create or update an existing l-interface.
35536         #
35537         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35538       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35539       consumes:
35540         - application/json
35541         - application/xml
35542       produces:
35543         - application/json
35544         - application/xml
35545       responses:
35546         "default":
35547           description: Response codes found in [response codes](https://wiki.onap.org/).
35548       parameters:
35549         - name: vnf-id
35550           in: path
35551           description: Unique id of VNF.  This is unique across the graph.
35552           required: true
35553           type: string
35554           example: __VNF-ID__
35555         - name: interface-name
35556           in: path
35557           description: Name that identifies the link aggregate interface
35558           required: true
35559           type: string
35560           example: __INTERFACE-NAME__
35561         - name: interface-name
35562           in: path
35563           description: Name given to the interface
35564           required: true
35565           type: string
35566           example: __INTERFACE-NAME__
35567         - name: body
35568           in: body
35569           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
35570           required: true
35571           schema:
35572             $ref: "#/definitions/l-interface"
35573     patch:
35574       tags:
35575         - Network
35576       summary: update an existing l-interface
35577       description: |
35578         Update an existing l-interface
35579         #
35580         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35581         The PUT operation will entirely replace an existing object.
35582         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35583         #
35584         Other differences between PUT and PATCH are:
35585         #
35586         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35587         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35588         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35589       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35590       consumes:
35591         - application/json
35592         - application/xml
35593       produces:
35594         - application/json
35595         - application/xml
35596       responses:
35597         "default":
35598           description: Response codes found in [response codes](https://wiki.onap.org/).
35599       parameters:
35600         - name: vnf-id
35601           in: path
35602           description: Unique id of VNF.  This is unique across the graph.
35603           required: true
35604           type: string
35605           example: __VNF-ID__
35606         - name: interface-name
35607           in: path
35608           description: Name that identifies the link aggregate interface
35609           required: true
35610           type: string
35611           example: __INTERFACE-NAME__
35612         - name: interface-name
35613           in: path
35614           description: Name given to the interface
35615           required: true
35616           type: string
35617           example: __INTERFACE-NAME__
35618         - name: body
35619           in: body
35620           description: l-interface object that needs to be updated.
35621           required: true
35622           schema:
35623             $ref: "#/patchDefinitions/l-interface"
35624     delete:
35625       tags:
35626         - Network
35627       summary: delete an existing l-interface
35628       description: delete an existing l-interface
35629       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
35630       consumes:
35631         - application/json
35632         - application/xml
35633       produces:
35634         - application/json
35635         - application/xml
35636       responses:
35637         "default":
35638           description: Response codes found in [response codes](https://wiki.onap.org/).
35639       parameters:
35640         - name: vnf-id
35641           in: path
35642           description: Unique id of VNF.  This is unique across the graph.
35643           required: true
35644           type: string
35645           example: __VNF-ID__
35646         - name: interface-name
35647           in: path
35648           description: Name that identifies the link aggregate interface
35649           required: true
35650           type: string
35651           example: __INTERFACE-NAME__
35652         - name: interface-name
35653           in: path
35654           description: Name given to the interface
35655           required: true
35656           type: string
35657           example: __INTERFACE-NAME__
35658         - name: resource-version
35659           in: query
35660           description: resource-version for concurrency
35661           required: true
35662           type: string
35663   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
35664     get:
35665       tags:
35666         - Network
35667       summary: returns l-interfaces
35668       description: returns l-interfaces
35669       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
35670       produces:
35671         - application/json
35672         - application/xml
35673       responses:
35674         "200":
35675           description: successful operation
35676           schema:
35677               $ref: "#/getDefinitions/l-interfaces"
35678         "default":
35679           description: Response codes found in [response codes](https://wiki.onap.org/).
35680       parameters:
35681         - name: vnf-id
35682           in: path
35683           description: Unique id of VNF.  This is unique across the graph.
35684           required: true
35685           type: string
35686           example: __VNF-ID__
35687         - name: interface-name
35688           in: path
35689           description: Name that identifies the link aggregate interface
35690           required: true
35691           type: string
35692           example: __INTERFACE-NAME__
35693         - name: interface-name
35694           in: query
35695           description:
35696           required: false
35697           type: string
35698         - name: interface-id
35699           in: query
35700           description:
35701           required: false
35702           type: string
35703         - name: macaddr
35704           in: query
35705           description:
35706           required: false
35707           type: string
35708         - name: network-name
35709           in: query
35710           description:
35711           required: false
35712           type: string
35713   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
35714     get:
35715       tags:
35716         - Network
35717       summary: returns lag-interface
35718       description: returns lag-interface
35719       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35720       produces:
35721         - application/json
35722         - application/xml
35723       responses:
35724         "200":
35725           description: successful operation
35726           schema:
35727               $ref: "#/getDefinitions/lag-interface"
35728         "default":
35729           description: Response codes found in [response codes](https://wiki.onap.org/).
35730       parameters:
35731         - name: vnf-id
35732           in: path
35733           description: Unique id of VNF.  This is unique across the graph.
35734           required: true
35735           type: string
35736           example: __VNF-ID__
35737         - name: interface-name
35738           in: path
35739           description: Name that identifies the link aggregate interface
35740           required: true
35741           type: string
35742           example: __INTERFACE-NAME__
35743     put:
35744       tags:
35745         - Network
35746       summary: create or update an existing lag-interface
35747       description: |
35748         Create or update an existing lag-interface.
35749         #
35750         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35751       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35752       consumes:
35753         - application/json
35754         - application/xml
35755       produces:
35756         - application/json
35757         - application/xml
35758       responses:
35759         "default":
35760           description: Response codes found in [response codes](https://wiki.onap.org/).
35761       parameters:
35762         - name: vnf-id
35763           in: path
35764           description: Unique id of VNF.  This is unique across the graph.
35765           required: true
35766           type: string
35767           example: __VNF-ID__
35768         - name: interface-name
35769           in: path
35770           description: Name that identifies the link aggregate interface
35771           required: true
35772           type: string
35773           example: __INTERFACE-NAME__
35774         - name: body
35775           in: body
35776           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
35777           required: true
35778           schema:
35779             $ref: "#/definitions/lag-interface"
35780     patch:
35781       tags:
35782         - Network
35783       summary: update an existing lag-interface
35784       description: |
35785         Update an existing lag-interface
35786         #
35787         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35788         The PUT operation will entirely replace an existing object.
35789         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35790         #
35791         Other differences between PUT and PATCH are:
35792         #
35793         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35794         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35795         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35796       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35797       consumes:
35798         - application/json
35799         - application/xml
35800       produces:
35801         - application/json
35802         - application/xml
35803       responses:
35804         "default":
35805           description: Response codes found in [response codes](https://wiki.onap.org/).
35806       parameters:
35807         - name: vnf-id
35808           in: path
35809           description: Unique id of VNF.  This is unique across the graph.
35810           required: true
35811           type: string
35812           example: __VNF-ID__
35813         - name: interface-name
35814           in: path
35815           description: Name that identifies the link aggregate interface
35816           required: true
35817           type: string
35818           example: __INTERFACE-NAME__
35819         - name: body
35820           in: body
35821           description: lag-interface object that needs to be updated.
35822           required: true
35823           schema:
35824             $ref: "#/patchDefinitions/lag-interface"
35825     delete:
35826       tags:
35827         - Network
35828       summary: delete an existing lag-interface
35829       description: delete an existing lag-interface
35830       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
35831       consumes:
35832         - application/json
35833         - application/xml
35834       produces:
35835         - application/json
35836         - application/xml
35837       responses:
35838         "default":
35839           description: Response codes found in [response codes](https://wiki.onap.org/).
35840       parameters:
35841         - name: vnf-id
35842           in: path
35843           description: Unique id of VNF.  This is unique across the graph.
35844           required: true
35845           type: string
35846           example: __VNF-ID__
35847         - name: interface-name
35848           in: path
35849           description: Name that identifies the link aggregate interface
35850           required: true
35851           type: string
35852           example: __INTERFACE-NAME__
35853         - name: resource-version
35854           in: query
35855           description: resource-version for concurrency
35856           required: true
35857           type: string
35858   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
35859     get:
35860       tags:
35861         - Network
35862       summary: returns lag-interfaces
35863       description: returns lag-interfaces
35864       operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
35865       produces:
35866         - application/json
35867         - application/xml
35868       responses:
35869         "200":
35870           description: successful operation
35871           schema:
35872               $ref: "#/getDefinitions/lag-interfaces"
35873         "default":
35874           description: Response codes found in [response codes](https://wiki.onap.org/).
35875       parameters:
35876         - name: vnf-id
35877           in: path
35878           description: Unique id of VNF.  This is unique across the graph.
35879           required: true
35880           type: string
35881           example: __VNF-ID__
35882         - name: interface-name
35883           in: query
35884           description:
35885           required: false
35886           type: string
35887         - name: interface-id
35888           in: query
35889           description:
35890           required: false
35891           type: string
35892         - name: interface-role
35893           in: query
35894           description:
35895           required: false
35896           type: string
35897   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
35898     put:
35899       tags:
35900         - Network
35901       summary: see node definition for valid relationships
35902       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
35903       consumes:
35904         - application/json
35905         - application/xml
35906       produces:
35907         - application/json
35908         - application/xml
35909       responses:
35910         "default":
35911           description: Response codes found in [response codes](https://wiki.onap.org/).
35912       parameters:
35913         - name: vnf-id
35914           in: path
35915           description: Unique id of VNF.  This is unique across the graph.
35916           required: true
35917           type: string
35918           example: __VNF-ID__
35919         - name: vf-module-id
35920           in: path
35921           description: Unique ID of vf-module.
35922           required: true
35923           type: string
35924           example: __VF-MODULE-ID__
35925         - name: body
35926           in: body
35927           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
35928           required: true
35929           schema:
35930             $ref: "#/definitions/relationship"
35931     delete:
35932       tags:
35933         - Network
35934       summary: delete an existing relationship
35935       description: delete an existing relationship
35936       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
35937       consumes:
35938         - application/json
35939         - application/xml
35940       produces:
35941         - application/json
35942         - application/xml
35943       responses:
35944         "default":
35945           description: Response codes found in [response codes](https://wiki.onap.org/).
35946       parameters:
35947         - name: vnf-id
35948           in: path
35949           description: Unique id of VNF.  This is unique across the graph.
35950           required: true
35951           type: string
35952           example: __VNF-ID__
35953         - name: vf-module-id
35954           in: path
35955           description: Unique ID of vf-module.
35956           required: true
35957           type: string
35958           example: __VF-MODULE-ID__
35959   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
35960     get:
35961       tags:
35962         - Network
35963       summary: returns vf-module
35964       description: returns vf-module
35965       operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
35966       produces:
35967         - application/json
35968         - application/xml
35969       responses:
35970         "200":
35971           description: successful operation
35972           schema:
35973               $ref: "#/getDefinitions/vf-module"
35974         "default":
35975           description: Response codes found in [response codes](https://wiki.onap.org/).
35976       parameters:
35977         - name: vnf-id
35978           in: path
35979           description: Unique id of VNF.  This is unique across the graph.
35980           required: true
35981           type: string
35982           example: __VNF-ID__
35983         - name: vf-module-id
35984           in: path
35985           description: Unique ID of vf-module.
35986           required: true
35987           type: string
35988           example: __VF-MODULE-ID__
35989     put:
35990       tags:
35991         - Network
35992       summary: create or update an existing vf-module
35993       description: |
35994         Create or update an existing vf-module.
35995         #
35996         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35997       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
35998       consumes:
35999         - application/json
36000         - application/xml
36001       produces:
36002         - application/json
36003         - application/xml
36004       responses:
36005         "default":
36006           description: Response codes found in [response codes](https://wiki.onap.org/).
36007       parameters:
36008         - name: vnf-id
36009           in: path
36010           description: Unique id of VNF.  This is unique across the graph.
36011           required: true
36012           type: string
36013           example: __VNF-ID__
36014         - name: vf-module-id
36015           in: path
36016           description: Unique ID of vf-module.
36017           required: true
36018           type: string
36019           example: __VF-MODULE-ID__
36020         - name: body
36021           in: body
36022           description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
36023           required: true
36024           schema:
36025             $ref: "#/definitions/vf-module"
36026     patch:
36027       tags:
36028         - Network
36029       summary: update an existing vf-module
36030       description: |
36031         Update an existing vf-module
36032         #
36033         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36034         The PUT operation will entirely replace an existing object.
36035         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36036         #
36037         Other differences between PUT and PATCH are:
36038         #
36039         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36040         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36041         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36042       operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
36043       consumes:
36044         - application/json
36045         - application/xml
36046       produces:
36047         - application/json
36048         - application/xml
36049       responses:
36050         "default":
36051           description: Response codes found in [response codes](https://wiki.onap.org/).
36052       parameters:
36053         - name: vnf-id
36054           in: path
36055           description: Unique id of VNF.  This is unique across the graph.
36056           required: true
36057           type: string
36058           example: __VNF-ID__
36059         - name: vf-module-id
36060           in: path
36061           description: Unique ID of vf-module.
36062           required: true
36063           type: string
36064           example: __VF-MODULE-ID__
36065         - name: body
36066           in: body
36067           description: vf-module object that needs to be updated.
36068           required: true
36069           schema:
36070             $ref: "#/patchDefinitions/vf-module"
36071     delete:
36072       tags:
36073         - Network
36074       summary: delete an existing vf-module
36075       description: delete an existing vf-module
36076       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
36077       consumes:
36078         - application/json
36079         - application/xml
36080       produces:
36081         - application/json
36082         - application/xml
36083       responses:
36084         "default":
36085           description: Response codes found in [response codes](https://wiki.onap.org/).
36086       parameters:
36087         - name: vnf-id
36088           in: path
36089           description: Unique id of VNF.  This is unique across the graph.
36090           required: true
36091           type: string
36092           example: __VNF-ID__
36093         - name: vf-module-id
36094           in: path
36095           description: Unique ID of vf-module.
36096           required: true
36097           type: string
36098           example: __VF-MODULE-ID__
36099         - name: resource-version
36100           in: query
36101           description: resource-version for concurrency
36102           required: true
36103           type: string
36104   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
36105     get:
36106       tags:
36107         - Network
36108       summary: returns vf-modules
36109       description: returns vf-modules
36110       operationId: getNetworkGenericVnfsGenericVnfVfModules
36111       produces:
36112         - application/json
36113         - application/xml
36114       responses:
36115         "200":
36116           description: successful operation
36117           schema:
36118               $ref: "#/getDefinitions/vf-modules"
36119         "default":
36120           description: Response codes found in [response codes](https://wiki.onap.org/).
36121       parameters:
36122         - name: vnf-id
36123           in: path
36124           description: Unique id of VNF.  This is unique across the graph.
36125           required: true
36126           type: string
36127           example: __VNF-ID__
36128         - name: vf-module-id
36129           in: query
36130           description:
36131           required: false
36132           type: string
36133         - name: vf-module-name
36134           in: query
36135           description:
36136           required: false
36137           type: string
36138         - name: heat-stack-id
36139           in: query
36140           description:
36141           required: false
36142           type: string
36143         - name: model-invariant-id
36144           in: query
36145           description:
36146           required: false
36147           type: string
36148         - name: model-version-id
36149           in: query
36150           description:
36151           required: false
36152           type: string
36153         - name: widget-model-id
36154           in: query
36155           description:
36156           required: false
36157           type: string
36158         - name: widget-model-version
36159           in: query
36160           description:
36161           required: false
36162           type: string
36163         - name: contrail-service-instance-fqdn
36164           in: query
36165           description:
36166           required: false
36167           type: string
36168   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
36169     put:
36170       tags:
36171         - Network
36172       summary: see node definition for valid relationships
36173       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
36174       consumes:
36175         - application/json
36176         - application/xml
36177       produces:
36178         - application/json
36179         - application/xml
36180       responses:
36181         "default":
36182           description: Response codes found in [response codes](https://wiki.onap.org/).
36183       parameters:
36184         - name: vnf-id
36185           in: path
36186           description: Unique id of VNF.  This is unique across the graph.
36187           required: true
36188           type: string
36189           example: __VNF-ID__
36190         - name: group-uuid
36191           in: path
36192           description: Unique ID for the license group the resource belongs to, should be uuid.
36193           required: true
36194           type: string
36195           example: __GROUP-UUID__
36196         - name: resource-uuid
36197           in: path
36198           description: Unique ID of a license resource.
36199           required: true
36200           type: string
36201           example: __RESOURCE-UUID__
36202         - name: body
36203           in: body
36204           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLicensesLicense.json)
36205           required: true
36206           schema:
36207             $ref: "#/definitions/relationship"
36208     delete:
36209       tags:
36210         - Network
36211       summary: delete an existing relationship
36212       description: delete an existing relationship
36213       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
36214       consumes:
36215         - application/json
36216         - application/xml
36217       produces:
36218         - application/json
36219         - application/xml
36220       responses:
36221         "default":
36222           description: Response codes found in [response codes](https://wiki.onap.org/).
36223       parameters:
36224         - name: vnf-id
36225           in: path
36226           description: Unique id of VNF.  This is unique across the graph.
36227           required: true
36228           type: string
36229           example: __VNF-ID__
36230         - name: group-uuid
36231           in: path
36232           description: Unique ID for the license group the resource belongs to, should be uuid.
36233           required: true
36234           type: string
36235           example: __GROUP-UUID__
36236         - name: resource-uuid
36237           in: path
36238           description: Unique ID of a license resource.
36239           required: true
36240           type: string
36241           example: __RESOURCE-UUID__
36242   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
36243     get:
36244       tags:
36245         - Network
36246       summary: returns license
36247       description: returns license
36248       operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
36249       produces:
36250         - application/json
36251         - application/xml
36252       responses:
36253         "200":
36254           description: successful operation
36255           schema:
36256               $ref: "#/getDefinitions/license"
36257         "default":
36258           description: Response codes found in [response codes](https://wiki.onap.org/).
36259       parameters:
36260         - name: vnf-id
36261           in: path
36262           description: Unique id of VNF.  This is unique across the graph.
36263           required: true
36264           type: string
36265           example: __VNF-ID__
36266         - name: group-uuid
36267           in: path
36268           description: Unique ID for the license group the resource belongs to, should be uuid.
36269           required: true
36270           type: string
36271           example: __GROUP-UUID__
36272         - name: resource-uuid
36273           in: path
36274           description: Unique ID of a license resource.
36275           required: true
36276           type: string
36277           example: __RESOURCE-UUID__
36278     put:
36279       tags:
36280         - Network
36281       summary: create or update an existing license
36282       description: |
36283         Create or update an existing license.
36284         #
36285         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36286       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
36287       consumes:
36288         - application/json
36289         - application/xml
36290       produces:
36291         - application/json
36292         - application/xml
36293       responses:
36294         "default":
36295           description: Response codes found in [response codes](https://wiki.onap.org/).
36296       parameters:
36297         - name: vnf-id
36298           in: path
36299           description: Unique id of VNF.  This is unique across the graph.
36300           required: true
36301           type: string
36302           example: __VNF-ID__
36303         - name: group-uuid
36304           in: path
36305           description: Unique ID for the license group the resource belongs to, should be uuid.
36306           required: true
36307           type: string
36308           example: __GROUP-UUID__
36309         - name: resource-uuid
36310           in: path
36311           description: Unique ID of a license resource.
36312           required: true
36313           type: string
36314           example: __RESOURCE-UUID__
36315         - name: body
36316           in: body
36317           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfLicensesLicense.json)
36318           required: true
36319           schema:
36320             $ref: "#/definitions/license"
36321     patch:
36322       tags:
36323         - Network
36324       summary: update an existing license
36325       description: |
36326         Update an existing license
36327         #
36328         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36329         The PUT operation will entirely replace an existing object.
36330         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36331         #
36332         Other differences between PUT and PATCH are:
36333         #
36334         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36335         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36336         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36337       operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
36338       consumes:
36339         - application/json
36340         - application/xml
36341       produces:
36342         - application/json
36343         - application/xml
36344       responses:
36345         "default":
36346           description: Response codes found in [response codes](https://wiki.onap.org/).
36347       parameters:
36348         - name: vnf-id
36349           in: path
36350           description: Unique id of VNF.  This is unique across the graph.
36351           required: true
36352           type: string
36353           example: __VNF-ID__
36354         - name: group-uuid
36355           in: path
36356           description: Unique ID for the license group the resource belongs to, should be uuid.
36357           required: true
36358           type: string
36359           example: __GROUP-UUID__
36360         - name: resource-uuid
36361           in: path
36362           description: Unique ID of a license resource.
36363           required: true
36364           type: string
36365           example: __RESOURCE-UUID__
36366         - name: body
36367           in: body
36368           description: license object that needs to be updated.
36369           required: true
36370           schema:
36371             $ref: "#/patchDefinitions/license"
36372     delete:
36373       tags:
36374         - Network
36375       summary: delete an existing license
36376       description: delete an existing license
36377       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
36378       consumes:
36379         - application/json
36380         - application/xml
36381       produces:
36382         - application/json
36383         - application/xml
36384       responses:
36385         "default":
36386           description: Response codes found in [response codes](https://wiki.onap.org/).
36387       parameters:
36388         - name: vnf-id
36389           in: path
36390           description: Unique id of VNF.  This is unique across the graph.
36391           required: true
36392           type: string
36393           example: __VNF-ID__
36394         - name: group-uuid
36395           in: path
36396           description: Unique ID for the license group the resource belongs to, should be uuid.
36397           required: true
36398           type: string
36399           example: __GROUP-UUID__
36400         - name: resource-uuid
36401           in: path
36402           description: Unique ID of a license resource.
36403           required: true
36404           type: string
36405           example: __RESOURCE-UUID__
36406         - name: resource-version
36407           in: query
36408           description: resource-version for concurrency
36409           required: true
36410           type: string
36411   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
36412     get:
36413       tags:
36414         - Network
36415       summary: returns licenses
36416       description: returns licenses
36417       operationId: getNetworkGenericVnfsGenericVnfLicenses
36418       produces:
36419         - application/json
36420         - application/xml
36421       responses:
36422         "200":
36423           description: successful operation
36424           schema:
36425               $ref: "#/getDefinitions/licenses"
36426         "default":
36427           description: Response codes found in [response codes](https://wiki.onap.org/).
36428       parameters:
36429         - name: vnf-id
36430           in: path
36431           description: Unique id of VNF.  This is unique across the graph.
36432           required: true
36433           type: string
36434           example: __VNF-ID__
36435         - name: group-uuid
36436           in: query
36437           description:
36438           required: false
36439           type: string
36440         - name: resource-uuid
36441           in: query
36442           description:
36443           required: false
36444           type: string
36445   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
36446     put:
36447       tags:
36448         - Network
36449       summary: see node definition for valid relationships
36450       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
36451       consumes:
36452         - application/json
36453         - application/xml
36454       produces:
36455         - application/json
36456         - application/xml
36457       responses:
36458         "default":
36459           description: Response codes found in [response codes](https://wiki.onap.org/).
36460       parameters:
36461         - name: vnf-id
36462           in: path
36463           description: Unique id of VNF.  This is unique across the graph.
36464           required: true
36465           type: string
36466           example: __VNF-ID__
36467         - name: group-uuid
36468           in: path
36469           description: Unique ID for the entitlement group the resource comes from, should be uuid.
36470           required: true
36471           type: string
36472           example: __GROUP-UUID__
36473         - name: resource-uuid
36474           in: path
36475           description: Unique ID of an entitlement resource.
36476           required: true
36477           type: string
36478           example: __RESOURCE-UUID__
36479         - name: body
36480           in: body
36481           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
36482           required: true
36483           schema:
36484             $ref: "#/definitions/relationship"
36485     delete:
36486       tags:
36487         - Network
36488       summary: delete an existing relationship
36489       description: delete an existing relationship
36490       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
36491       consumes:
36492         - application/json
36493         - application/xml
36494       produces:
36495         - application/json
36496         - application/xml
36497       responses:
36498         "default":
36499           description: Response codes found in [response codes](https://wiki.onap.org/).
36500       parameters:
36501         - name: vnf-id
36502           in: path
36503           description: Unique id of VNF.  This is unique across the graph.
36504           required: true
36505           type: string
36506           example: __VNF-ID__
36507         - name: group-uuid
36508           in: path
36509           description: Unique ID for the entitlement group the resource comes from, should be uuid.
36510           required: true
36511           type: string
36512           example: __GROUP-UUID__
36513         - name: resource-uuid
36514           in: path
36515           description: Unique ID of an entitlement resource.
36516           required: true
36517           type: string
36518           example: __RESOURCE-UUID__
36519   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
36520     get:
36521       tags:
36522         - Network
36523       summary: returns entitlement
36524       description: returns entitlement
36525       operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36526       produces:
36527         - application/json
36528         - application/xml
36529       responses:
36530         "200":
36531           description: successful operation
36532           schema:
36533               $ref: "#/getDefinitions/entitlement"
36534         "default":
36535           description: Response codes found in [response codes](https://wiki.onap.org/).
36536       parameters:
36537         - name: vnf-id
36538           in: path
36539           description: Unique id of VNF.  This is unique across the graph.
36540           required: true
36541           type: string
36542           example: __VNF-ID__
36543         - name: group-uuid
36544           in: path
36545           description: Unique ID for the entitlement group the resource comes from, should be uuid.
36546           required: true
36547           type: string
36548           example: __GROUP-UUID__
36549         - name: resource-uuid
36550           in: path
36551           description: Unique ID of an entitlement resource.
36552           required: true
36553           type: string
36554           example: __RESOURCE-UUID__
36555     put:
36556       tags:
36557         - Network
36558       summary: create or update an existing entitlement
36559       description: |
36560         Create or update an existing entitlement.
36561         #
36562         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36563       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36564       consumes:
36565         - application/json
36566         - application/xml
36567       produces:
36568         - application/json
36569         - application/xml
36570       responses:
36571         "default":
36572           description: Response codes found in [response codes](https://wiki.onap.org/).
36573       parameters:
36574         - name: vnf-id
36575           in: path
36576           description: Unique id of VNF.  This is unique across the graph.
36577           required: true
36578           type: string
36579           example: __VNF-ID__
36580         - name: group-uuid
36581           in: path
36582           description: Unique ID for the entitlement group the resource comes from, should be uuid.
36583           required: true
36584           type: string
36585           example: __GROUP-UUID__
36586         - name: resource-uuid
36587           in: path
36588           description: Unique ID of an entitlement resource.
36589           required: true
36590           type: string
36591           example: __RESOURCE-UUID__
36592         - name: body
36593           in: body
36594           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
36595           required: true
36596           schema:
36597             $ref: "#/definitions/entitlement"
36598     patch:
36599       tags:
36600         - Network
36601       summary: update an existing entitlement
36602       description: |
36603         Update an existing entitlement
36604         #
36605         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36606         The PUT operation will entirely replace an existing object.
36607         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36608         #
36609         Other differences between PUT and PATCH are:
36610         #
36611         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36612         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36613         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36614       operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36615       consumes:
36616         - application/json
36617         - application/xml
36618       produces:
36619         - application/json
36620         - application/xml
36621       responses:
36622         "default":
36623           description: Response codes found in [response codes](https://wiki.onap.org/).
36624       parameters:
36625         - name: vnf-id
36626           in: path
36627           description: Unique id of VNF.  This is unique across the graph.
36628           required: true
36629           type: string
36630           example: __VNF-ID__
36631         - name: group-uuid
36632           in: path
36633           description: Unique ID for the entitlement group the resource comes from, should be uuid.
36634           required: true
36635           type: string
36636           example: __GROUP-UUID__
36637         - name: resource-uuid
36638           in: path
36639           description: Unique ID of an entitlement resource.
36640           required: true
36641           type: string
36642           example: __RESOURCE-UUID__
36643         - name: body
36644           in: body
36645           description: entitlement object that needs to be updated.
36646           required: true
36647           schema:
36648             $ref: "#/patchDefinitions/entitlement"
36649     delete:
36650       tags:
36651         - Network
36652       summary: delete an existing entitlement
36653       description: delete an existing entitlement
36654       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
36655       consumes:
36656         - application/json
36657         - application/xml
36658       produces:
36659         - application/json
36660         - application/xml
36661       responses:
36662         "default":
36663           description: Response codes found in [response codes](https://wiki.onap.org/).
36664       parameters:
36665         - name: vnf-id
36666           in: path
36667           description: Unique id of VNF.  This is unique across the graph.
36668           required: true
36669           type: string
36670           example: __VNF-ID__
36671         - name: group-uuid
36672           in: path
36673           description: Unique ID for the entitlement group the resource comes from, should be uuid.
36674           required: true
36675           type: string
36676           example: __GROUP-UUID__
36677         - name: resource-uuid
36678           in: path
36679           description: Unique ID of an entitlement resource.
36680           required: true
36681           type: string
36682           example: __RESOURCE-UUID__
36683         - name: resource-version
36684           in: query
36685           description: resource-version for concurrency
36686           required: true
36687           type: string
36688   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
36689     get:
36690       tags:
36691         - Network
36692       summary: returns entitlements
36693       description: returns entitlements
36694       operationId: getNetworkGenericVnfsGenericVnfEntitlements
36695       produces:
36696         - application/json
36697         - application/xml
36698       responses:
36699         "200":
36700           description: successful operation
36701           schema:
36702               $ref: "#/getDefinitions/entitlements"
36703         "default":
36704           description: Response codes found in [response codes](https://wiki.onap.org/).
36705       parameters:
36706         - name: vnf-id
36707           in: path
36708           description: Unique id of VNF.  This is unique across the graph.
36709           required: true
36710           type: string
36711           example: __VNF-ID__
36712         - name: group-uuid
36713           in: query
36714           description:
36715           required: false
36716           type: string
36717         - name: resource-uuid
36718           in: query
36719           description:
36720           required: false
36721           type: string
36722   /network/generic-vnfs/generic-vnf/{vnf-id}:
36723     get:
36724       tags:
36725         - Network
36726       summary: returns generic-vnf
36727       description: returns generic-vnf
36728       operationId: getNetworkGenericVnfsGenericVnf
36729       produces:
36730         - application/json
36731         - application/xml
36732       responses:
36733         "200":
36734           description: successful operation
36735           schema:
36736               $ref: "#/getDefinitions/generic-vnf"
36737         "default":
36738           description: Response codes found in [response codes](https://wiki.onap.org/).
36739       parameters:
36740         - name: vnf-id
36741           in: path
36742           description: Unique id of VNF.  This is unique across the graph.
36743           required: true
36744           type: string
36745           example: __VNF-ID__
36746     put:
36747       tags:
36748         - Network
36749       summary: create or update an existing generic-vnf
36750       description: |
36751         Create or update an existing generic-vnf.
36752         #
36753         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36754       operationId: createOrUpdateNetworkGenericVnfsGenericVnf
36755       consumes:
36756         - application/json
36757         - application/xml
36758       produces:
36759         - application/json
36760         - application/xml
36761       responses:
36762         "default":
36763           description: Response codes found in [response codes](https://wiki.onap.org/).
36764       parameters:
36765         - name: vnf-id
36766           in: path
36767           description: Unique id of VNF.  This is unique across the graph.
36768           required: true
36769           type: string
36770           example: __VNF-ID__
36771         - name: body
36772           in: body
36773           description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnf.json)
36774           required: true
36775           schema:
36776             $ref: "#/definitions/generic-vnf"
36777     patch:
36778       tags:
36779         - Network
36780       summary: update an existing generic-vnf
36781       description: |
36782         Update an existing generic-vnf
36783         #
36784         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36785         The PUT operation will entirely replace an existing object.
36786         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36787         #
36788         Other differences between PUT and PATCH are:
36789         #
36790         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36791         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36792         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36793       operationId: UpdateNetworkGenericVnfsGenericVnf
36794       consumes:
36795         - application/json
36796         - application/xml
36797       produces:
36798         - application/json
36799         - application/xml
36800       responses:
36801         "default":
36802           description: Response codes found in [response codes](https://wiki.onap.org/).
36803       parameters:
36804         - name: vnf-id
36805           in: path
36806           description: Unique id of VNF.  This is unique across the graph.
36807           required: true
36808           type: string
36809           example: __VNF-ID__
36810         - name: body
36811           in: body
36812           description: generic-vnf object that needs to be updated.
36813           required: true
36814           schema:
36815             $ref: "#/patchDefinitions/generic-vnf"
36816     delete:
36817       tags:
36818         - Network
36819       summary: delete an existing generic-vnf
36820       description: delete an existing generic-vnf
36821       operationId: deleteNetworkGenericVnfsGenericVnf
36822       consumes:
36823         - application/json
36824         - application/xml
36825       produces:
36826         - application/json
36827         - application/xml
36828       responses:
36829         "default":
36830           description: Response codes found in [response codes](https://wiki.onap.org/).
36831       parameters:
36832         - name: vnf-id
36833           in: path
36834           description: Unique id of VNF.  This is unique across the graph.
36835           required: true
36836           type: string
36837           example: __VNF-ID__
36838         - name: resource-version
36839           in: query
36840           description: resource-version for concurrency
36841           required: true
36842           type: string
36843   /network/generic-vnfs:
36844     get:
36845       tags:
36846         - Network
36847       summary: returns generic-vnfs
36848       description: returns generic-vnfs
36849       operationId: getNetworkGenericVnfs
36850       produces:
36851         - application/json
36852         - application/xml
36853       responses:
36854         "200":
36855           description: successful operation
36856           schema:
36857               $ref: "#/getDefinitions/generic-vnfs"
36858         "default":
36859           description: Response codes found in [response codes](https://wiki.onap.org/).
36860       parameters:
36861         - name: vnf-id
36862           in: query
36863           description:
36864           required: false
36865           type: string
36866         - name: vnf-name
36867           in: query
36868           description:
36869           required: false
36870           type: string
36871         - name: vnf-name2
36872           in: query
36873           description:
36874           required: false
36875           type: string
36876         - name: vnf-type
36877           in: query
36878           description:
36879           required: false
36880           type: string
36881         - name: service-id
36882           in: query
36883           description:
36884           required: false
36885           type: string
36886         - name: regional-resource-zone
36887           in: query
36888           description:
36889           required: false
36890           type: string
36891         - name: prov-status
36892           in: query
36893           description:
36894           required: false
36895           type: string
36896         - name: heat-stack-id
36897           in: query
36898           description:
36899           required: false
36900           type: string
36901         - name: in-maint
36902           in: query
36903           description:
36904           required: false
36905           type: boolean
36906         - name: is-closed-loop-disabled
36907           in: query
36908           description:
36909           required: false
36910           type: boolean
36911         - name: model-invariant-id
36912           in: query
36913           description:
36914           required: false
36915           type: string
36916         - name: model-version-id
36917           in: query
36918           description:
36919           required: false
36920           type: string
36921         - name: widget-model-id
36922           in: query
36923           description:
36924           required: false
36925           type: string
36926         - name: widget-model-version
36927           in: query
36928           description:
36929           required: false
36930           type: string
36931         - name: nf-type
36932           in: query
36933           description:
36934           required: false
36935           type: string
36936         - name: nf-function
36937           in: query
36938           description:
36939           required: false
36940           type: string
36941         - name: nf-role
36942           in: query
36943           description:
36944           required: false
36945           type: string
36946         - name: nf-naming-code
36947           in: query
36948           description:
36949           required: false
36950           type: string
36951   /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
36952     put:
36953       tags:
36954         - Network
36955       summary: see node definition for valid relationships
36956       operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
36957       consumes:
36958         - application/json
36959         - application/xml
36960       produces:
36961         - application/json
36962         - application/xml
36963       responses:
36964         "default":
36965           description: Response codes found in [response codes](https://wiki.onap.org/).
36966       parameters:
36967         - name: link-name
36968           in: path
36969           description: Alphabetical concatenation of lag-interface names
36970           required: true
36971           type: string
36972           example: __LINK-NAME__
36973         - name: body
36974           in: body
36975           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLagLinksLagLink.json)
36976           required: true
36977           schema:
36978             $ref: "#/definitions/relationship"
36979     delete:
36980       tags:
36981         - Network
36982       summary: delete an existing relationship
36983       description: delete an existing relationship
36984       operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
36985       consumes:
36986         - application/json
36987         - application/xml
36988       produces:
36989         - application/json
36990         - application/xml
36991       responses:
36992         "default":
36993           description: Response codes found in [response codes](https://wiki.onap.org/).
36994       parameters:
36995         - name: link-name
36996           in: path
36997           description: Alphabetical concatenation of lag-interface names
36998           required: true
36999           type: string
37000           example: __LINK-NAME__
37001   /network/lag-links/lag-link/{link-name}:
37002     get:
37003       tags:
37004         - Network
37005       summary: returns lag-link
37006       description: returns lag-link
37007       operationId: getNetworkLagLinksLagLink
37008       produces:
37009         - application/json
37010         - application/xml
37011       responses:
37012         "200":
37013           description: successful operation
37014           schema:
37015               $ref: "#/getDefinitions/lag-link"
37016         "default":
37017           description: Response codes found in [response codes](https://wiki.onap.org/).
37018       parameters:
37019         - name: link-name
37020           in: path
37021           description: Alphabetical concatenation of lag-interface names
37022           required: true
37023           type: string
37024           example: __LINK-NAME__
37025     put:
37026       tags:
37027         - Network
37028       summary: create or update an existing lag-link
37029       description: |
37030         Create or update an existing lag-link.
37031         #
37032         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37033       operationId: createOrUpdateNetworkLagLinksLagLink
37034       consumes:
37035         - application/json
37036         - application/xml
37037       produces:
37038         - application/json
37039         - application/xml
37040       responses:
37041         "default":
37042           description: Response codes found in [response codes](https://wiki.onap.org/).
37043       parameters:
37044         - name: link-name
37045           in: path
37046           description: Alphabetical concatenation of lag-interface names
37047           required: true
37048           type: string
37049           example: __LINK-NAME__
37050         - name: body
37051           in: body
37052           description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkLagLinksLagLink.json)
37053           required: true
37054           schema:
37055             $ref: "#/definitions/lag-link"
37056     patch:
37057       tags:
37058         - Network
37059       summary: update an existing lag-link
37060       description: |
37061         Update an existing lag-link
37062         #
37063         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37064         The PUT operation will entirely replace an existing object.
37065         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37066         #
37067         Other differences between PUT and PATCH are:
37068         #
37069         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37070         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37071         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37072       operationId: UpdateNetworkLagLinksLagLink
37073       consumes:
37074         - application/json
37075         - application/xml
37076       produces:
37077         - application/json
37078         - application/xml
37079       responses:
37080         "default":
37081           description: Response codes found in [response codes](https://wiki.onap.org/).
37082       parameters:
37083         - name: link-name
37084           in: path
37085           description: Alphabetical concatenation of lag-interface names
37086           required: true
37087           type: string
37088           example: __LINK-NAME__
37089         - name: body
37090           in: body
37091           description: lag-link object that needs to be updated.
37092           required: true
37093           schema:
37094             $ref: "#/patchDefinitions/lag-link"
37095     delete:
37096       tags:
37097         - Network
37098       summary: delete an existing lag-link
37099       description: delete an existing lag-link
37100       operationId: deleteNetworkLagLinksLagLink
37101       consumes:
37102         - application/json
37103         - application/xml
37104       produces:
37105         - application/json
37106         - application/xml
37107       responses:
37108         "default":
37109           description: Response codes found in [response codes](https://wiki.onap.org/).
37110       parameters:
37111         - name: link-name
37112           in: path
37113           description: Alphabetical concatenation of lag-interface names
37114           required: true
37115           type: string
37116           example: __LINK-NAME__
37117         - name: resource-version
37118           in: query
37119           description: resource-version for concurrency
37120           required: true
37121           type: string
37122   /network/lag-links:
37123     get:
37124       tags:
37125         - Network
37126       summary: returns lag-links
37127       description: returns lag-links
37128       operationId: getNetworkLagLinks
37129       produces:
37130         - application/json
37131         - application/xml
37132       responses:
37133         "200":
37134           description: successful operation
37135           schema:
37136               $ref: "#/getDefinitions/lag-links"
37137         "default":
37138           description: Response codes found in [response codes](https://wiki.onap.org/).
37139       parameters:
37140         - name: link-name
37141           in: query
37142           description:
37143           required: false
37144           type: string
37145   /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
37146     put:
37147       tags:
37148         - Network
37149       summary: see node definition for valid relationships
37150       operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
37151       consumes:
37152         - application/json
37153         - application/xml
37154       produces:
37155         - application/json
37156         - application/xml
37157       responses:
37158         "default":
37159           description: Response codes found in [response codes](https://wiki.onap.org/).
37160       parameters:
37161         - name: vnf-id2
37162           in: path
37163           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37164           required: true
37165           type: string
37166           example: __VNF-ID2__
37167         - name: body
37168           in: body
37169           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvce.json)
37170           required: true
37171           schema:
37172             $ref: "#/definitions/relationship"
37173     delete:
37174       tags:
37175         - Network
37176       summary: delete an existing relationship
37177       description: delete an existing relationship
37178       operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
37179       consumes:
37180         - application/json
37181         - application/xml
37182       produces:
37183         - application/json
37184         - application/xml
37185       responses:
37186         "default":
37187           description: Response codes found in [response codes](https://wiki.onap.org/).
37188       parameters:
37189         - name: vnf-id2
37190           in: path
37191           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37192           required: true
37193           type: string
37194           example: __VNF-ID2__
37195   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
37196     put:
37197       tags:
37198         - Network
37199       summary: see node definition for valid relationships
37200       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37201       consumes:
37202         - application/json
37203         - application/xml
37204       produces:
37205         - application/json
37206         - application/xml
37207       responses:
37208         "default":
37209           description: Response codes found in [response codes](https://wiki.onap.org/).
37210       parameters:
37211         - name: vnf-id2
37212           in: path
37213           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37214           required: true
37215           type: string
37216           example: __VNF-ID2__
37217         - name: interface-name
37218           in: path
37219           description: Name given to the interface
37220           required: true
37221           type: string
37222           example: __INTERFACE-NAME__
37223         - name: vlan-interface
37224           in: path
37225           description: String that identifies the interface
37226           required: true
37227           type: string
37228           example: __VLAN-INTERFACE__
37229         - name: body
37230           in: body
37231           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
37232           required: true
37233           schema:
37234             $ref: "#/definitions/relationship"
37235     delete:
37236       tags:
37237         - Network
37238       summary: delete an existing relationship
37239       description: delete an existing relationship
37240       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37241       consumes:
37242         - application/json
37243         - application/xml
37244       produces:
37245         - application/json
37246         - application/xml
37247       responses:
37248         "default":
37249           description: Response codes found in [response codes](https://wiki.onap.org/).
37250       parameters:
37251         - name: vnf-id2
37252           in: path
37253           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37254           required: true
37255           type: string
37256           example: __VNF-ID2__
37257         - name: interface-name
37258           in: path
37259           description: Name given to the interface
37260           required: true
37261           type: string
37262           example: __INTERFACE-NAME__
37263         - name: vlan-interface
37264           in: path
37265           description: String that identifies the interface
37266           required: true
37267           type: string
37268           example: __VLAN-INTERFACE__
37269   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
37270     put:
37271       tags:
37272         - Network
37273       summary: see node definition for valid relationships
37274       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37275       consumes:
37276         - application/json
37277         - application/xml
37278       produces:
37279         - application/json
37280         - application/xml
37281       responses:
37282         "default":
37283           description: Response codes found in [response codes](https://wiki.onap.org/).
37284       parameters:
37285         - name: vnf-id2
37286           in: path
37287           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37288           required: true
37289           type: string
37290           example: __VNF-ID2__
37291         - name: interface-name
37292           in: path
37293           description: Name given to the interface
37294           required: true
37295           type: string
37296           example: __INTERFACE-NAME__
37297         - name: vlan-interface
37298           in: path
37299           description: String that identifies the interface
37300           required: true
37301           type: string
37302           example: __VLAN-INTERFACE__
37303         - name: l3-interface-ipv4-address
37304           in: path
37305           description: IP address
37306           required: true
37307           type: string
37308           example: __L3-INTERFACE-IPV4-ADDRESS__
37309         - name: body
37310           in: body
37311           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37312           required: true
37313           schema:
37314             $ref: "#/definitions/relationship"
37315     delete:
37316       tags:
37317         - Network
37318       summary: delete an existing relationship
37319       description: delete an existing relationship
37320       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37321       consumes:
37322         - application/json
37323         - application/xml
37324       produces:
37325         - application/json
37326         - application/xml
37327       responses:
37328         "default":
37329           description: Response codes found in [response codes](https://wiki.onap.org/).
37330       parameters:
37331         - name: vnf-id2
37332           in: path
37333           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37334           required: true
37335           type: string
37336           example: __VNF-ID2__
37337         - name: interface-name
37338           in: path
37339           description: Name given to the interface
37340           required: true
37341           type: string
37342           example: __INTERFACE-NAME__
37343         - name: vlan-interface
37344           in: path
37345           description: String that identifies the interface
37346           required: true
37347           type: string
37348           example: __VLAN-INTERFACE__
37349         - name: l3-interface-ipv4-address
37350           in: path
37351           description: IP address
37352           required: true
37353           type: string
37354           example: __L3-INTERFACE-IPV4-ADDRESS__
37355   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
37356     get:
37357       tags:
37358         - Network
37359       summary: returns l3-interface-ipv4-address-list
37360       description: returns l3-interface-ipv4-address-list
37361       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37362       produces:
37363         - application/json
37364         - application/xml
37365       responses:
37366         "200":
37367           description: successful operation
37368           schema:
37369               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37370         "default":
37371           description: Response codes found in [response codes](https://wiki.onap.org/).
37372       parameters:
37373         - name: vnf-id2
37374           in: path
37375           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37376           required: true
37377           type: string
37378           example: __VNF-ID2__
37379         - name: interface-name
37380           in: path
37381           description: Name given to the interface
37382           required: true
37383           type: string
37384           example: __INTERFACE-NAME__
37385         - name: vlan-interface
37386           in: path
37387           description: String that identifies the interface
37388           required: true
37389           type: string
37390           example: __VLAN-INTERFACE__
37391         - name: l3-interface-ipv4-address
37392           in: path
37393           description: IP address
37394           required: true
37395           type: string
37396           example: __L3-INTERFACE-IPV4-ADDRESS__
37397     put:
37398       tags:
37399         - Network
37400       summary: create or update an existing l3-interface-ipv4-address-list
37401       description: |
37402         Create or update an existing l3-interface-ipv4-address-list.
37403         #
37404         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37405       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37406       consumes:
37407         - application/json
37408         - application/xml
37409       produces:
37410         - application/json
37411         - application/xml
37412       responses:
37413         "default":
37414           description: Response codes found in [response codes](https://wiki.onap.org/).
37415       parameters:
37416         - name: vnf-id2
37417           in: path
37418           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37419           required: true
37420           type: string
37421           example: __VNF-ID2__
37422         - name: interface-name
37423           in: path
37424           description: Name given to the interface
37425           required: true
37426           type: string
37427           example: __INTERFACE-NAME__
37428         - name: vlan-interface
37429           in: path
37430           description: String that identifies the interface
37431           required: true
37432           type: string
37433           example: __VLAN-INTERFACE__
37434         - name: l3-interface-ipv4-address
37435           in: path
37436           description: IP address
37437           required: true
37438           type: string
37439           example: __L3-INTERFACE-IPV4-ADDRESS__
37440         - name: body
37441           in: body
37442           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37443           required: true
37444           schema:
37445             $ref: "#/definitions/l3-interface-ipv4-address-list"
37446     patch:
37447       tags:
37448         - Network
37449       summary: update an existing l3-interface-ipv4-address-list
37450       description: |
37451         Update an existing l3-interface-ipv4-address-list
37452         #
37453         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37454         The PUT operation will entirely replace an existing object.
37455         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37456         #
37457         Other differences between PUT and PATCH are:
37458         #
37459         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37460         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37461         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37462       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37463       consumes:
37464         - application/json
37465         - application/xml
37466       produces:
37467         - application/json
37468         - application/xml
37469       responses:
37470         "default":
37471           description: Response codes found in [response codes](https://wiki.onap.org/).
37472       parameters:
37473         - name: vnf-id2
37474           in: path
37475           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37476           required: true
37477           type: string
37478           example: __VNF-ID2__
37479         - name: interface-name
37480           in: path
37481           description: Name given to the interface
37482           required: true
37483           type: string
37484           example: __INTERFACE-NAME__
37485         - name: vlan-interface
37486           in: path
37487           description: String that identifies the interface
37488           required: true
37489           type: string
37490           example: __VLAN-INTERFACE__
37491         - name: l3-interface-ipv4-address
37492           in: path
37493           description: IP address
37494           required: true
37495           type: string
37496           example: __L3-INTERFACE-IPV4-ADDRESS__
37497         - name: body
37498           in: body
37499           description: l3-interface-ipv4-address-list object that needs to be updated.
37500           required: true
37501           schema:
37502             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37503     delete:
37504       tags:
37505         - Network
37506       summary: delete an existing l3-interface-ipv4-address-list
37507       description: delete an existing l3-interface-ipv4-address-list
37508       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37509       consumes:
37510         - application/json
37511         - application/xml
37512       produces:
37513         - application/json
37514         - application/xml
37515       responses:
37516         "default":
37517           description: Response codes found in [response codes](https://wiki.onap.org/).
37518       parameters:
37519         - name: vnf-id2
37520           in: path
37521           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37522           required: true
37523           type: string
37524           example: __VNF-ID2__
37525         - name: interface-name
37526           in: path
37527           description: Name given to the interface
37528           required: true
37529           type: string
37530           example: __INTERFACE-NAME__
37531         - name: vlan-interface
37532           in: path
37533           description: String that identifies the interface
37534           required: true
37535           type: string
37536           example: __VLAN-INTERFACE__
37537         - name: l3-interface-ipv4-address
37538           in: path
37539           description: IP address
37540           required: true
37541           type: string
37542           example: __L3-INTERFACE-IPV4-ADDRESS__
37543         - name: resource-version
37544           in: query
37545           description: resource-version for concurrency
37546           required: true
37547           type: string
37548   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
37549     put:
37550       tags:
37551         - Network
37552       summary: see node definition for valid relationships
37553       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37554       consumes:
37555         - application/json
37556         - application/xml
37557       produces:
37558         - application/json
37559         - application/xml
37560       responses:
37561         "default":
37562           description: Response codes found in [response codes](https://wiki.onap.org/).
37563       parameters:
37564         - name: vnf-id2
37565           in: path
37566           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37567           required: true
37568           type: string
37569           example: __VNF-ID2__
37570         - name: interface-name
37571           in: path
37572           description: Name given to the interface
37573           required: true
37574           type: string
37575           example: __INTERFACE-NAME__
37576         - name: vlan-interface
37577           in: path
37578           description: String that identifies the interface
37579           required: true
37580           type: string
37581           example: __VLAN-INTERFACE__
37582         - name: l3-interface-ipv6-address
37583           in: path
37584           description: IP address
37585           required: true
37586           type: string
37587           example: __L3-INTERFACE-IPV6-ADDRESS__
37588         - name: body
37589           in: body
37590           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37591           required: true
37592           schema:
37593             $ref: "#/definitions/relationship"
37594     delete:
37595       tags:
37596         - Network
37597       summary: delete an existing relationship
37598       description: delete an existing relationship
37599       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37600       consumes:
37601         - application/json
37602         - application/xml
37603       produces:
37604         - application/json
37605         - application/xml
37606       responses:
37607         "default":
37608           description: Response codes found in [response codes](https://wiki.onap.org/).
37609       parameters:
37610         - name: vnf-id2
37611           in: path
37612           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37613           required: true
37614           type: string
37615           example: __VNF-ID2__
37616         - name: interface-name
37617           in: path
37618           description: Name given to the interface
37619           required: true
37620           type: string
37621           example: __INTERFACE-NAME__
37622         - name: vlan-interface
37623           in: path
37624           description: String that identifies the interface
37625           required: true
37626           type: string
37627           example: __VLAN-INTERFACE__
37628         - name: l3-interface-ipv6-address
37629           in: path
37630           description: IP address
37631           required: true
37632           type: string
37633           example: __L3-INTERFACE-IPV6-ADDRESS__
37634   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
37635     get:
37636       tags:
37637         - Network
37638       summary: returns l3-interface-ipv6-address-list
37639       description: returns l3-interface-ipv6-address-list
37640       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37641       produces:
37642         - application/json
37643         - application/xml
37644       responses:
37645         "200":
37646           description: successful operation
37647           schema:
37648               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
37649         "default":
37650           description: Response codes found in [response codes](https://wiki.onap.org/).
37651       parameters:
37652         - name: vnf-id2
37653           in: path
37654           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37655           required: true
37656           type: string
37657           example: __VNF-ID2__
37658         - name: interface-name
37659           in: path
37660           description: Name given to the interface
37661           required: true
37662           type: string
37663           example: __INTERFACE-NAME__
37664         - name: vlan-interface
37665           in: path
37666           description: String that identifies the interface
37667           required: true
37668           type: string
37669           example: __VLAN-INTERFACE__
37670         - name: l3-interface-ipv6-address
37671           in: path
37672           description: IP address
37673           required: true
37674           type: string
37675           example: __L3-INTERFACE-IPV6-ADDRESS__
37676     put:
37677       tags:
37678         - Network
37679       summary: create or update an existing l3-interface-ipv6-address-list
37680       description: |
37681         Create or update an existing l3-interface-ipv6-address-list.
37682         #
37683         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37684       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37685       consumes:
37686         - application/json
37687         - application/xml
37688       produces:
37689         - application/json
37690         - application/xml
37691       responses:
37692         "default":
37693           description: Response codes found in [response codes](https://wiki.onap.org/).
37694       parameters:
37695         - name: vnf-id2
37696           in: path
37697           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37698           required: true
37699           type: string
37700           example: __VNF-ID2__
37701         - name: interface-name
37702           in: path
37703           description: Name given to the interface
37704           required: true
37705           type: string
37706           example: __INTERFACE-NAME__
37707         - name: vlan-interface
37708           in: path
37709           description: String that identifies the interface
37710           required: true
37711           type: string
37712           example: __VLAN-INTERFACE__
37713         - name: l3-interface-ipv6-address
37714           in: path
37715           description: IP address
37716           required: true
37717           type: string
37718           example: __L3-INTERFACE-IPV6-ADDRESS__
37719         - name: body
37720           in: body
37721           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37722           required: true
37723           schema:
37724             $ref: "#/definitions/l3-interface-ipv6-address-list"
37725     patch:
37726       tags:
37727         - Network
37728       summary: update an existing l3-interface-ipv6-address-list
37729       description: |
37730         Update an existing l3-interface-ipv6-address-list
37731         #
37732         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37733         The PUT operation will entirely replace an existing object.
37734         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37735         #
37736         Other differences between PUT and PATCH are:
37737         #
37738         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37739         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37740         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37741       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37742       consumes:
37743         - application/json
37744         - application/xml
37745       produces:
37746         - application/json
37747         - application/xml
37748       responses:
37749         "default":
37750           description: Response codes found in [response codes](https://wiki.onap.org/).
37751       parameters:
37752         - name: vnf-id2
37753           in: path
37754           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37755           required: true
37756           type: string
37757           example: __VNF-ID2__
37758         - name: interface-name
37759           in: path
37760           description: Name given to the interface
37761           required: true
37762           type: string
37763           example: __INTERFACE-NAME__
37764         - name: vlan-interface
37765           in: path
37766           description: String that identifies the interface
37767           required: true
37768           type: string
37769           example: __VLAN-INTERFACE__
37770         - name: l3-interface-ipv6-address
37771           in: path
37772           description: IP address
37773           required: true
37774           type: string
37775           example: __L3-INTERFACE-IPV6-ADDRESS__
37776         - name: body
37777           in: body
37778           description: l3-interface-ipv6-address-list object that needs to be updated.
37779           required: true
37780           schema:
37781             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37782     delete:
37783       tags:
37784         - Network
37785       summary: delete an existing l3-interface-ipv6-address-list
37786       description: delete an existing l3-interface-ipv6-address-list
37787       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37788       consumes:
37789         - application/json
37790         - application/xml
37791       produces:
37792         - application/json
37793         - application/xml
37794       responses:
37795         "default":
37796           description: Response codes found in [response codes](https://wiki.onap.org/).
37797       parameters:
37798         - name: vnf-id2
37799           in: path
37800           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37801           required: true
37802           type: string
37803           example: __VNF-ID2__
37804         - name: interface-name
37805           in: path
37806           description: Name given to the interface
37807           required: true
37808           type: string
37809           example: __INTERFACE-NAME__
37810         - name: vlan-interface
37811           in: path
37812           description: String that identifies the interface
37813           required: true
37814           type: string
37815           example: __VLAN-INTERFACE__
37816         - name: l3-interface-ipv6-address
37817           in: path
37818           description: IP address
37819           required: true
37820           type: string
37821           example: __L3-INTERFACE-IPV6-ADDRESS__
37822         - name: resource-version
37823           in: query
37824           description: resource-version for concurrency
37825           required: true
37826           type: string
37827   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
37828     get:
37829       tags:
37830         - Network
37831       summary: returns vlan
37832       description: returns vlan
37833       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37834       produces:
37835         - application/json
37836         - application/xml
37837       responses:
37838         "200":
37839           description: successful operation
37840           schema:
37841               $ref: "#/getDefinitions/vlan"
37842         "default":
37843           description: Response codes found in [response codes](https://wiki.onap.org/).
37844       parameters:
37845         - name: vnf-id2
37846           in: path
37847           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37848           required: true
37849           type: string
37850           example: __VNF-ID2__
37851         - name: interface-name
37852           in: path
37853           description: Name given to the interface
37854           required: true
37855           type: string
37856           example: __INTERFACE-NAME__
37857         - name: vlan-interface
37858           in: path
37859           description: String that identifies the interface
37860           required: true
37861           type: string
37862           example: __VLAN-INTERFACE__
37863     put:
37864       tags:
37865         - Network
37866       summary: create or update an existing vlan
37867       description: |
37868         Create or update an existing vlan.
37869         #
37870         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37871       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37872       consumes:
37873         - application/json
37874         - application/xml
37875       produces:
37876         - application/json
37877         - application/xml
37878       responses:
37879         "default":
37880           description: Response codes found in [response codes](https://wiki.onap.org/).
37881       parameters:
37882         - name: vnf-id2
37883           in: path
37884           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37885           required: true
37886           type: string
37887           example: __VNF-ID2__
37888         - name: interface-name
37889           in: path
37890           description: Name given to the interface
37891           required: true
37892           type: string
37893           example: __INTERFACE-NAME__
37894         - name: vlan-interface
37895           in: path
37896           description: String that identifies the interface
37897           required: true
37898           type: string
37899           example: __VLAN-INTERFACE__
37900         - name: body
37901           in: body
37902           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
37903           required: true
37904           schema:
37905             $ref: "#/definitions/vlan"
37906     patch:
37907       tags:
37908         - Network
37909       summary: update an existing vlan
37910       description: |
37911         Update an existing vlan
37912         #
37913         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37914         The PUT operation will entirely replace an existing object.
37915         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37916         #
37917         Other differences between PUT and PATCH are:
37918         #
37919         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37920         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37921         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37922       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37923       consumes:
37924         - application/json
37925         - application/xml
37926       produces:
37927         - application/json
37928         - application/xml
37929       responses:
37930         "default":
37931           description: Response codes found in [response codes](https://wiki.onap.org/).
37932       parameters:
37933         - name: vnf-id2
37934           in: path
37935           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37936           required: true
37937           type: string
37938           example: __VNF-ID2__
37939         - name: interface-name
37940           in: path
37941           description: Name given to the interface
37942           required: true
37943           type: string
37944           example: __INTERFACE-NAME__
37945         - name: vlan-interface
37946           in: path
37947           description: String that identifies the interface
37948           required: true
37949           type: string
37950           example: __VLAN-INTERFACE__
37951         - name: body
37952           in: body
37953           description: vlan object that needs to be updated.
37954           required: true
37955           schema:
37956             $ref: "#/patchDefinitions/vlan"
37957     delete:
37958       tags:
37959         - Network
37960       summary: delete an existing vlan
37961       description: delete an existing vlan
37962       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
37963       consumes:
37964         - application/json
37965         - application/xml
37966       produces:
37967         - application/json
37968         - application/xml
37969       responses:
37970         "default":
37971           description: Response codes found in [response codes](https://wiki.onap.org/).
37972       parameters:
37973         - name: vnf-id2
37974           in: path
37975           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37976           required: true
37977           type: string
37978           example: __VNF-ID2__
37979         - name: interface-name
37980           in: path
37981           description: Name given to the interface
37982           required: true
37983           type: string
37984           example: __INTERFACE-NAME__
37985         - name: vlan-interface
37986           in: path
37987           description: String that identifies the interface
37988           required: true
37989           type: string
37990           example: __VLAN-INTERFACE__
37991         - name: resource-version
37992           in: query
37993           description: resource-version for concurrency
37994           required: true
37995           type: string
37996   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
37997     get:
37998       tags:
37999         - Network
38000       summary: returns vlans
38001       description: returns vlans
38002       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
38003       produces:
38004         - application/json
38005         - application/xml
38006       responses:
38007         "200":
38008           description: successful operation
38009           schema:
38010               $ref: "#/getDefinitions/vlans"
38011         "default":
38012           description: Response codes found in [response codes](https://wiki.onap.org/).
38013       parameters:
38014         - name: vnf-id2
38015           in: path
38016           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38017           required: true
38018           type: string
38019           example: __VNF-ID2__
38020         - name: interface-name
38021           in: path
38022           description: Name given to the interface
38023           required: true
38024           type: string
38025           example: __INTERFACE-NAME__
38026         - name: vlan-interface
38027           in: query
38028           description:
38029           required: false
38030           type: string
38031         - name: vlan-id-inner
38032           in: query
38033           description:
38034           required: false
38035           type: integer
38036           format: int64
38037         - name: vpn-key
38038           in: query
38039           description:
38040           required: false
38041           type: string
38042   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
38043     put:
38044       tags:
38045         - Network
38046       summary: see node definition for valid relationships
38047       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38048       consumes:
38049         - application/json
38050         - application/xml
38051       produces:
38052         - application/json
38053         - application/xml
38054       responses:
38055         "default":
38056           description: Response codes found in [response codes](https://wiki.onap.org/).
38057       parameters:
38058         - name: vnf-id2
38059           in: path
38060           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38061           required: true
38062           type: string
38063           example: __VNF-ID2__
38064         - name: interface-name
38065           in: path
38066           description: Name given to the interface
38067           required: true
38068           type: string
38069           example: __INTERFACE-NAME__
38070         - name: pci-id
38071           in: path
38072           description: PCI ID used to identify the sriov-vf
38073           required: true
38074           type: string
38075           example: __PCI-ID__
38076         - name: body
38077           in: body
38078           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
38079           required: true
38080           schema:
38081             $ref: "#/definitions/relationship"
38082     delete:
38083       tags:
38084         - Network
38085       summary: delete an existing relationship
38086       description: delete an existing relationship
38087       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38088       consumes:
38089         - application/json
38090         - application/xml
38091       produces:
38092         - application/json
38093         - application/xml
38094       responses:
38095         "default":
38096           description: Response codes found in [response codes](https://wiki.onap.org/).
38097       parameters:
38098         - name: vnf-id2
38099           in: path
38100           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38101           required: true
38102           type: string
38103           example: __VNF-ID2__
38104         - name: interface-name
38105           in: path
38106           description: Name given to the interface
38107           required: true
38108           type: string
38109           example: __INTERFACE-NAME__
38110         - name: pci-id
38111           in: path
38112           description: PCI ID used to identify the sriov-vf
38113           required: true
38114           type: string
38115           example: __PCI-ID__
38116   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
38117     get:
38118       tags:
38119         - Network
38120       summary: returns sriov-vf
38121       description: returns sriov-vf
38122       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
38123       produces:
38124         - application/json
38125         - application/xml
38126       responses:
38127         "200":
38128           description: successful operation
38129           schema:
38130               $ref: "#/getDefinitions/sriov-vf"
38131         "default":
38132           description: Response codes found in [response codes](https://wiki.onap.org/).
38133       parameters:
38134         - name: vnf-id2
38135           in: path
38136           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38137           required: true
38138           type: string
38139           example: __VNF-ID2__
38140         - name: interface-name
38141           in: path
38142           description: Name given to the interface
38143           required: true
38144           type: string
38145           example: __INTERFACE-NAME__
38146         - name: pci-id
38147           in: path
38148           description: PCI ID used to identify the sriov-vf
38149           required: true
38150           type: string
38151           example: __PCI-ID__
38152     put:
38153       tags:
38154         - Network
38155       summary: create or update an existing sriov-vf
38156       description: |
38157         Create or update an existing sriov-vf.
38158         #
38159         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38160       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
38161       consumes:
38162         - application/json
38163         - application/xml
38164       produces:
38165         - application/json
38166         - application/xml
38167       responses:
38168         "default":
38169           description: Response codes found in [response codes](https://wiki.onap.org/).
38170       parameters:
38171         - name: vnf-id2
38172           in: path
38173           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38174           required: true
38175           type: string
38176           example: __VNF-ID2__
38177         - name: interface-name
38178           in: path
38179           description: Name given to the interface
38180           required: true
38181           type: string
38182           example: __INTERFACE-NAME__
38183         - name: pci-id
38184           in: path
38185           description: PCI ID used to identify the sriov-vf
38186           required: true
38187           type: string
38188           example: __PCI-ID__
38189         - name: body
38190           in: body
38191           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
38192           required: true
38193           schema:
38194             $ref: "#/definitions/sriov-vf"
38195     patch:
38196       tags:
38197         - Network
38198       summary: update an existing sriov-vf
38199       description: |
38200         Update an existing sriov-vf
38201         #
38202         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38203         The PUT operation will entirely replace an existing object.
38204         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38205         #
38206         Other differences between PUT and PATCH are:
38207         #
38208         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38209         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38210         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38211       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
38212       consumes:
38213         - application/json
38214         - application/xml
38215       produces:
38216         - application/json
38217         - application/xml
38218       responses:
38219         "default":
38220           description: Response codes found in [response codes](https://wiki.onap.org/).
38221       parameters:
38222         - name: vnf-id2
38223           in: path
38224           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38225           required: true
38226           type: string
38227           example: __VNF-ID2__
38228         - name: interface-name
38229           in: path
38230           description: Name given to the interface
38231           required: true
38232           type: string
38233           example: __INTERFACE-NAME__
38234         - name: pci-id
38235           in: path
38236           description: PCI ID used to identify the sriov-vf
38237           required: true
38238           type: string
38239           example: __PCI-ID__
38240         - name: body
38241           in: body
38242           description: sriov-vf object that needs to be updated.
38243           required: true
38244           schema:
38245             $ref: "#/patchDefinitions/sriov-vf"
38246     delete:
38247       tags:
38248         - Network
38249       summary: delete an existing sriov-vf
38250       description: delete an existing sriov-vf
38251       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
38252       consumes:
38253         - application/json
38254         - application/xml
38255       produces:
38256         - application/json
38257         - application/xml
38258       responses:
38259         "default":
38260           description: Response codes found in [response codes](https://wiki.onap.org/).
38261       parameters:
38262         - name: vnf-id2
38263           in: path
38264           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38265           required: true
38266           type: string
38267           example: __VNF-ID2__
38268         - name: interface-name
38269           in: path
38270           description: Name given to the interface
38271           required: true
38272           type: string
38273           example: __INTERFACE-NAME__
38274         - name: pci-id
38275           in: path
38276           description: PCI ID used to identify the sriov-vf
38277           required: true
38278           type: string
38279           example: __PCI-ID__
38280         - name: resource-version
38281           in: query
38282           description: resource-version for concurrency
38283           required: true
38284           type: string
38285   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
38286     get:
38287       tags:
38288         - Network
38289       summary: returns sriov-vfs
38290       description: returns sriov-vfs
38291       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
38292       produces:
38293         - application/json
38294         - application/xml
38295       responses:
38296         "200":
38297           description: successful operation
38298           schema:
38299               $ref: "#/getDefinitions/sriov-vfs"
38300         "default":
38301           description: Response codes found in [response codes](https://wiki.onap.org/).
38302       parameters:
38303         - name: vnf-id2
38304           in: path
38305           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38306           required: true
38307           type: string
38308           example: __VNF-ID2__
38309         - name: interface-name
38310           in: path
38311           description: Name given to the interface
38312           required: true
38313           type: string
38314           example: __INTERFACE-NAME__
38315         - name: pci-id
38316           in: query
38317           description:
38318           required: false
38319           type: string
38320         - name: vf-vlan-filter
38321           in: query
38322           description:
38323           required: false
38324           type: string
38325         - name: vf-mac-filter
38326           in: query
38327           description:
38328           required: false
38329           type: string
38330         - name: vf-vlan-strip
38331           in: query
38332           description:
38333           required: false
38334           type: boolean
38335         - name: neutron-network-id
38336           in: query
38337           description:
38338           required: false
38339           type: string
38340   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
38341     put:
38342       tags:
38343         - Network
38344       summary: see node definition for valid relationships
38345       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
38346       consumes:
38347         - application/json
38348         - application/xml
38349       produces:
38350         - application/json
38351         - application/xml
38352       responses:
38353         "default":
38354           description: Response codes found in [response codes](https://wiki.onap.org/).
38355       parameters:
38356         - name: vnf-id2
38357           in: path
38358           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38359           required: true
38360           type: string
38361           example: __VNF-ID2__
38362         - name: interface-name
38363           in: path
38364           description: Name given to the interface
38365           required: true
38366           type: string
38367           example: __INTERFACE-NAME__
38368         - name: body
38369           in: body
38370           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterface.json)
38371           required: true
38372           schema:
38373             $ref: "#/definitions/relationship"
38374     delete:
38375       tags:
38376         - Network
38377       summary: delete an existing relationship
38378       description: delete an existing relationship
38379       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
38380       consumes:
38381         - application/json
38382         - application/xml
38383       produces:
38384         - application/json
38385         - application/xml
38386       responses:
38387         "default":
38388           description: Response codes found in [response codes](https://wiki.onap.org/).
38389       parameters:
38390         - name: vnf-id2
38391           in: path
38392           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38393           required: true
38394           type: string
38395           example: __VNF-ID2__
38396         - name: interface-name
38397           in: path
38398           description: Name given to the interface
38399           required: true
38400           type: string
38401           example: __INTERFACE-NAME__
38402   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
38403     put:
38404       tags:
38405         - Network
38406       summary: see node definition for valid relationships
38407       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38408       consumes:
38409         - application/json
38410         - application/xml
38411       produces:
38412         - application/json
38413         - application/xml
38414       responses:
38415         "default":
38416           description: Response codes found in [response codes](https://wiki.onap.org/).
38417       parameters:
38418         - name: vnf-id2
38419           in: path
38420           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38421           required: true
38422           type: string
38423           example: __VNF-ID2__
38424         - name: interface-name
38425           in: path
38426           description: Name given to the interface
38427           required: true
38428           type: string
38429           example: __INTERFACE-NAME__
38430         - name: l3-interface-ipv4-address
38431           in: path
38432           description: IP address
38433           required: true
38434           type: string
38435           example: __L3-INTERFACE-IPV4-ADDRESS__
38436         - name: body
38437           in: body
38438           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38439           required: true
38440           schema:
38441             $ref: "#/definitions/relationship"
38442     delete:
38443       tags:
38444         - Network
38445       summary: delete an existing relationship
38446       description: delete an existing relationship
38447       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
38448       consumes:
38449         - application/json
38450         - application/xml
38451       produces:
38452         - application/json
38453         - application/xml
38454       responses:
38455         "default":
38456           description: Response codes found in [response codes](https://wiki.onap.org/).
38457       parameters:
38458         - name: vnf-id2
38459           in: path
38460           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38461           required: true
38462           type: string
38463           example: __VNF-ID2__
38464         - name: interface-name
38465           in: path
38466           description: Name given to the interface
38467           required: true
38468           type: string
38469           example: __INTERFACE-NAME__
38470         - name: l3-interface-ipv4-address
38471           in: path
38472           description: IP address
38473           required: true
38474           type: string
38475           example: __L3-INTERFACE-IPV4-ADDRESS__
38476   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
38477     get:
38478       tags:
38479         - Network
38480       summary: returns l3-interface-ipv4-address-list
38481       description: returns l3-interface-ipv4-address-list
38482       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38483       produces:
38484         - application/json
38485         - application/xml
38486       responses:
38487         "200":
38488           description: successful operation
38489           schema:
38490               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
38491         "default":
38492           description: Response codes found in [response codes](https://wiki.onap.org/).
38493       parameters:
38494         - name: vnf-id2
38495           in: path
38496           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38497           required: true
38498           type: string
38499           example: __VNF-ID2__
38500         - name: interface-name
38501           in: path
38502           description: Name given to the interface
38503           required: true
38504           type: string
38505           example: __INTERFACE-NAME__
38506         - name: l3-interface-ipv4-address
38507           in: path
38508           description: IP address
38509           required: true
38510           type: string
38511           example: __L3-INTERFACE-IPV4-ADDRESS__
38512     put:
38513       tags:
38514         - Network
38515       summary: create or update an existing l3-interface-ipv4-address-list
38516       description: |
38517         Create or update an existing l3-interface-ipv4-address-list.
38518         #
38519         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38520       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38521       consumes:
38522         - application/json
38523         - application/xml
38524       produces:
38525         - application/json
38526         - application/xml
38527       responses:
38528         "default":
38529           description: Response codes found in [response codes](https://wiki.onap.org/).
38530       parameters:
38531         - name: vnf-id2
38532           in: path
38533           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38534           required: true
38535           type: string
38536           example: __VNF-ID2__
38537         - name: interface-name
38538           in: path
38539           description: Name given to the interface
38540           required: true
38541           type: string
38542           example: __INTERFACE-NAME__
38543         - name: l3-interface-ipv4-address
38544           in: path
38545           description: IP address
38546           required: true
38547           type: string
38548           example: __L3-INTERFACE-IPV4-ADDRESS__
38549         - name: body
38550           in: body
38551           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
38552           required: true
38553           schema:
38554             $ref: "#/definitions/l3-interface-ipv4-address-list"
38555     patch:
38556       tags:
38557         - Network
38558       summary: update an existing l3-interface-ipv4-address-list
38559       description: |
38560         Update an existing l3-interface-ipv4-address-list
38561         #
38562         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38563         The PUT operation will entirely replace an existing object.
38564         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38565         #
38566         Other differences between PUT and PATCH are:
38567         #
38568         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38569         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38570         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38571       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38572       consumes:
38573         - application/json
38574         - application/xml
38575       produces:
38576         - application/json
38577         - application/xml
38578       responses:
38579         "default":
38580           description: Response codes found in [response codes](https://wiki.onap.org/).
38581       parameters:
38582         - name: vnf-id2
38583           in: path
38584           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38585           required: true
38586           type: string
38587           example: __VNF-ID2__
38588         - name: interface-name
38589           in: path
38590           description: Name given to the interface
38591           required: true
38592           type: string
38593           example: __INTERFACE-NAME__
38594         - name: l3-interface-ipv4-address
38595           in: path
38596           description: IP address
38597           required: true
38598           type: string
38599           example: __L3-INTERFACE-IPV4-ADDRESS__
38600         - name: body
38601           in: body
38602           description: l3-interface-ipv4-address-list object that needs to be updated.
38603           required: true
38604           schema:
38605             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
38606     delete:
38607       tags:
38608         - Network
38609       summary: delete an existing l3-interface-ipv4-address-list
38610       description: delete an existing l3-interface-ipv4-address-list
38611       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
38612       consumes:
38613         - application/json
38614         - application/xml
38615       produces:
38616         - application/json
38617         - application/xml
38618       responses:
38619         "default":
38620           description: Response codes found in [response codes](https://wiki.onap.org/).
38621       parameters:
38622         - name: vnf-id2
38623           in: path
38624           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38625           required: true
38626           type: string
38627           example: __VNF-ID2__
38628         - name: interface-name
38629           in: path
38630           description: Name given to the interface
38631           required: true
38632           type: string
38633           example: __INTERFACE-NAME__
38634         - name: l3-interface-ipv4-address
38635           in: path
38636           description: IP address
38637           required: true
38638           type: string
38639           example: __L3-INTERFACE-IPV4-ADDRESS__
38640         - name: resource-version
38641           in: query
38642           description: resource-version for concurrency
38643           required: true
38644           type: string
38645   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
38646     put:
38647       tags:
38648         - Network
38649       summary: see node definition for valid relationships
38650       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
38651       consumes:
38652         - application/json
38653         - application/xml
38654       produces:
38655         - application/json
38656         - application/xml
38657       responses:
38658         "default":
38659           description: Response codes found in [response codes](https://wiki.onap.org/).
38660       parameters:
38661         - name: vnf-id2
38662           in: path
38663           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38664           required: true
38665           type: string
38666           example: __VNF-ID2__
38667         - name: interface-name
38668           in: path
38669           description: Name given to the interface
38670           required: true
38671           type: string
38672           example: __INTERFACE-NAME__
38673         - name: l3-interface-ipv6-address
38674           in: path
38675           description: IP address
38676           required: true
38677           type: string
38678           example: __L3-INTERFACE-IPV6-ADDRESS__
38679         - name: body
38680           in: body
38681           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
38682           required: true
38683           schema:
38684             $ref: "#/definitions/relationship"
38685     delete:
38686       tags:
38687         - Network
38688       summary: delete an existing relationship
38689       description: delete an existing relationship
38690       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
38691       consumes:
38692         - application/json
38693         - application/xml
38694       produces:
38695         - application/json
38696         - application/xml
38697       responses:
38698         "default":
38699           description: Response codes found in [response codes](https://wiki.onap.org/).
38700       parameters:
38701         - name: vnf-id2
38702           in: path
38703           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38704           required: true
38705           type: string
38706           example: __VNF-ID2__
38707         - name: interface-name
38708           in: path
38709           description: Name given to the interface
38710           required: true
38711           type: string
38712           example: __INTERFACE-NAME__
38713         - name: l3-interface-ipv6-address
38714           in: path
38715           description: IP address
38716           required: true
38717           type: string
38718           example: __L3-INTERFACE-IPV6-ADDRESS__
38719   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
38720     get:
38721       tags:
38722         - Network
38723       summary: returns l3-interface-ipv6-address-list
38724       description: returns l3-interface-ipv6-address-list
38725       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38726       produces:
38727         - application/json
38728         - application/xml
38729       responses:
38730         "200":
38731           description: successful operation
38732           schema:
38733               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38734         "default":
38735           description: Response codes found in [response codes](https://wiki.onap.org/).
38736       parameters:
38737         - name: vnf-id2
38738           in: path
38739           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38740           required: true
38741           type: string
38742           example: __VNF-ID2__
38743         - name: interface-name
38744           in: path
38745           description: Name given to the interface
38746           required: true
38747           type: string
38748           example: __INTERFACE-NAME__
38749         - name: l3-interface-ipv6-address
38750           in: path
38751           description: IP address
38752           required: true
38753           type: string
38754           example: __L3-INTERFACE-IPV6-ADDRESS__
38755     put:
38756       tags:
38757         - Network
38758       summary: create or update an existing l3-interface-ipv6-address-list
38759       description: |
38760         Create or update an existing l3-interface-ipv6-address-list.
38761         #
38762         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38763       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38764       consumes:
38765         - application/json
38766         - application/xml
38767       produces:
38768         - application/json
38769         - application/xml
38770       responses:
38771         "default":
38772           description: Response codes found in [response codes](https://wiki.onap.org/).
38773       parameters:
38774         - name: vnf-id2
38775           in: path
38776           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38777           required: true
38778           type: string
38779           example: __VNF-ID2__
38780         - name: interface-name
38781           in: path
38782           description: Name given to the interface
38783           required: true
38784           type: string
38785           example: __INTERFACE-NAME__
38786         - name: l3-interface-ipv6-address
38787           in: path
38788           description: IP address
38789           required: true
38790           type: string
38791           example: __L3-INTERFACE-IPV6-ADDRESS__
38792         - name: body
38793           in: body
38794           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
38795           required: true
38796           schema:
38797             $ref: "#/definitions/l3-interface-ipv6-address-list"
38798     patch:
38799       tags:
38800         - Network
38801       summary: update an existing l3-interface-ipv6-address-list
38802       description: |
38803         Update an existing l3-interface-ipv6-address-list
38804         #
38805         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38806         The PUT operation will entirely replace an existing object.
38807         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38808         #
38809         Other differences between PUT and PATCH are:
38810         #
38811         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38812         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38813         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38814       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38815       consumes:
38816         - application/json
38817         - application/xml
38818       produces:
38819         - application/json
38820         - application/xml
38821       responses:
38822         "default":
38823           description: Response codes found in [response codes](https://wiki.onap.org/).
38824       parameters:
38825         - name: vnf-id2
38826           in: path
38827           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38828           required: true
38829           type: string
38830           example: __VNF-ID2__
38831         - name: interface-name
38832           in: path
38833           description: Name given to the interface
38834           required: true
38835           type: string
38836           example: __INTERFACE-NAME__
38837         - name: l3-interface-ipv6-address
38838           in: path
38839           description: IP address
38840           required: true
38841           type: string
38842           example: __L3-INTERFACE-IPV6-ADDRESS__
38843         - name: body
38844           in: body
38845           description: l3-interface-ipv6-address-list object that needs to be updated.
38846           required: true
38847           schema:
38848             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
38849     delete:
38850       tags:
38851         - Network
38852       summary: delete an existing l3-interface-ipv6-address-list
38853       description: delete an existing l3-interface-ipv6-address-list
38854       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
38855       consumes:
38856         - application/json
38857         - application/xml
38858       produces:
38859         - application/json
38860         - application/xml
38861       responses:
38862         "default":
38863           description: Response codes found in [response codes](https://wiki.onap.org/).
38864       parameters:
38865         - name: vnf-id2
38866           in: path
38867           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38868           required: true
38869           type: string
38870           example: __VNF-ID2__
38871         - name: interface-name
38872           in: path
38873           description: Name given to the interface
38874           required: true
38875           type: string
38876           example: __INTERFACE-NAME__
38877         - name: l3-interface-ipv6-address
38878           in: path
38879           description: IP address
38880           required: true
38881           type: string
38882           example: __L3-INTERFACE-IPV6-ADDRESS__
38883         - name: resource-version
38884           in: query
38885           description: resource-version for concurrency
38886           required: true
38887           type: string
38888   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
38889     get:
38890       tags:
38891         - Network
38892       summary: returns l-interface
38893       description: returns l-interface
38894       operationId: getNetworkNewvcesNewvceLInterfacesLInterface
38895       produces:
38896         - application/json
38897         - application/xml
38898       responses:
38899         "200":
38900           description: successful operation
38901           schema:
38902               $ref: "#/getDefinitions/l-interface"
38903         "default":
38904           description: Response codes found in [response codes](https://wiki.onap.org/).
38905       parameters:
38906         - name: vnf-id2
38907           in: path
38908           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38909           required: true
38910           type: string
38911           example: __VNF-ID2__
38912         - name: interface-name
38913           in: path
38914           description: Name given to the interface
38915           required: true
38916           type: string
38917           example: __INTERFACE-NAME__
38918     put:
38919       tags:
38920         - Network
38921       summary: create or update an existing l-interface
38922       description: |
38923         Create or update an existing l-interface.
38924         #
38925         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38926       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
38927       consumes:
38928         - application/json
38929         - application/xml
38930       produces:
38931         - application/json
38932         - application/xml
38933       responses:
38934         "default":
38935           description: Response codes found in [response codes](https://wiki.onap.org/).
38936       parameters:
38937         - name: vnf-id2
38938           in: path
38939           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38940           required: true
38941           type: string
38942           example: __VNF-ID2__
38943         - name: interface-name
38944           in: path
38945           description: Name given to the interface
38946           required: true
38947           type: string
38948           example: __INTERFACE-NAME__
38949         - name: body
38950           in: body
38951           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvceLInterfacesLInterface.json)
38952           required: true
38953           schema:
38954             $ref: "#/definitions/l-interface"
38955     patch:
38956       tags:
38957         - Network
38958       summary: update an existing l-interface
38959       description: |
38960         Update an existing l-interface
38961         #
38962         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38963         The PUT operation will entirely replace an existing object.
38964         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38965         #
38966         Other differences between PUT and PATCH are:
38967         #
38968         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38969         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38970         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38971       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
38972       consumes:
38973         - application/json
38974         - application/xml
38975       produces:
38976         - application/json
38977         - application/xml
38978       responses:
38979         "default":
38980           description: Response codes found in [response codes](https://wiki.onap.org/).
38981       parameters:
38982         - name: vnf-id2
38983           in: path
38984           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
38985           required: true
38986           type: string
38987           example: __VNF-ID2__
38988         - name: interface-name
38989           in: path
38990           description: Name given to the interface
38991           required: true
38992           type: string
38993           example: __INTERFACE-NAME__
38994         - name: body
38995           in: body
38996           description: l-interface object that needs to be updated.
38997           required: true
38998           schema:
38999             $ref: "#/patchDefinitions/l-interface"
39000     delete:
39001       tags:
39002         - Network
39003       summary: delete an existing l-interface
39004       description: delete an existing l-interface
39005       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
39006       consumes:
39007         - application/json
39008         - application/xml
39009       produces:
39010         - application/json
39011         - application/xml
39012       responses:
39013         "default":
39014           description: Response codes found in [response codes](https://wiki.onap.org/).
39015       parameters:
39016         - name: vnf-id2
39017           in: path
39018           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39019           required: true
39020           type: string
39021           example: __VNF-ID2__
39022         - name: interface-name
39023           in: path
39024           description: Name given to the interface
39025           required: true
39026           type: string
39027           example: __INTERFACE-NAME__
39028         - name: resource-version
39029           in: query
39030           description: resource-version for concurrency
39031           required: true
39032           type: string
39033   /network/newvces/newvce/{vnf-id2}/l-interfaces:
39034     get:
39035       tags:
39036         - Network
39037       summary: returns l-interfaces
39038       description: returns l-interfaces
39039       operationId: getNetworkNewvcesNewvceLInterfaces
39040       produces:
39041         - application/json
39042         - application/xml
39043       responses:
39044         "200":
39045           description: successful operation
39046           schema:
39047               $ref: "#/getDefinitions/l-interfaces"
39048         "default":
39049           description: Response codes found in [response codes](https://wiki.onap.org/).
39050       parameters:
39051         - name: vnf-id2
39052           in: path
39053           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39054           required: true
39055           type: string
39056           example: __VNF-ID2__
39057         - name: interface-name
39058           in: query
39059           description:
39060           required: false
39061           type: string
39062         - name: interface-id
39063           in: query
39064           description:
39065           required: false
39066           type: string
39067         - name: macaddr
39068           in: query
39069           description:
39070           required: false
39071           type: string
39072         - name: network-name
39073           in: query
39074           description:
39075           required: false
39076           type: string
39077   /network/newvces/newvce/{vnf-id2}:
39078     get:
39079       tags:
39080         - Network
39081       summary: returns newvce
39082       description: returns newvce
39083       operationId: getNetworkNewvcesNewvce
39084       produces:
39085         - application/json
39086         - application/xml
39087       responses:
39088         "200":
39089           description: successful operation
39090           schema:
39091               $ref: "#/getDefinitions/newvce"
39092         "default":
39093           description: Response codes found in [response codes](https://wiki.onap.org/).
39094       parameters:
39095         - name: vnf-id2
39096           in: path
39097           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39098           required: true
39099           type: string
39100           example: __VNF-ID2__
39101     put:
39102       tags:
39103         - Network
39104       summary: create or update an existing newvce
39105       description: |
39106         Create or update an existing newvce.
39107         #
39108         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39109       operationId: createOrUpdateNetworkNewvcesNewvce
39110       consumes:
39111         - application/json
39112         - application/xml
39113       produces:
39114         - application/json
39115         - application/xml
39116       responses:
39117         "default":
39118           description: Response codes found in [response codes](https://wiki.onap.org/).
39119       parameters:
39120         - name: vnf-id2
39121           in: path
39122           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39123           required: true
39124           type: string
39125           example: __VNF-ID2__
39126         - name: body
39127           in: body
39128           description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkNewvcesNewvce.json)
39129           required: true
39130           schema:
39131             $ref: "#/definitions/newvce"
39132     patch:
39133       tags:
39134         - Network
39135       summary: update an existing newvce
39136       description: |
39137         Update an existing newvce
39138         #
39139         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39140         The PUT operation will entirely replace an existing object.
39141         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39142         #
39143         Other differences between PUT and PATCH are:
39144         #
39145         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39146         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39147         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39148       operationId: UpdateNetworkNewvcesNewvce
39149       consumes:
39150         - application/json
39151         - application/xml
39152       produces:
39153         - application/json
39154         - application/xml
39155       responses:
39156         "default":
39157           description: Response codes found in [response codes](https://wiki.onap.org/).
39158       parameters:
39159         - name: vnf-id2
39160           in: path
39161           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39162           required: true
39163           type: string
39164           example: __VNF-ID2__
39165         - name: body
39166           in: body
39167           description: newvce object that needs to be updated.
39168           required: true
39169           schema:
39170             $ref: "#/patchDefinitions/newvce"
39171     delete:
39172       tags:
39173         - Network
39174       summary: delete an existing newvce
39175       description: delete an existing newvce
39176       operationId: deleteNetworkNewvcesNewvce
39177       consumes:
39178         - application/json
39179         - application/xml
39180       produces:
39181         - application/json
39182         - application/xml
39183       responses:
39184         "default":
39185           description: Response codes found in [response codes](https://wiki.onap.org/).
39186       parameters:
39187         - name: vnf-id2
39188           in: path
39189           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39190           required: true
39191           type: string
39192           example: __VNF-ID2__
39193         - name: resource-version
39194           in: query
39195           description: resource-version for concurrency
39196           required: true
39197           type: string
39198   /network/newvces:
39199     get:
39200       tags:
39201         - Network
39202       summary: returns newvces
39203       description: returns newvces
39204       operationId: getNetworkNewvces
39205       produces:
39206         - application/json
39207         - application/xml
39208       responses:
39209         "200":
39210           description: successful operation
39211           schema:
39212               $ref: "#/getDefinitions/newvces"
39213         "default":
39214           description: Response codes found in [response codes](https://wiki.onap.org/).
39215       parameters:
39216         - name: vnf-id2
39217           in: query
39218           description:
39219           required: false
39220           type: string
39221         - name: vnf-name
39222           in: query
39223           description:
39224           required: false
39225           type: string
39226         - name: vnf-name2
39227           in: query
39228           description:
39229           required: false
39230           type: string
39231         - name: vnf-type
39232           in: query
39233           description:
39234           required: false
39235           type: string
39236         - name: prov-status
39237           in: query
39238           description:
39239           required: false
39240           type: string
39241         - name: heat-stack-id
39242           in: query
39243           description:
39244           required: false
39245           type: string
39246   /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
39247     put:
39248       tags:
39249         - Network
39250       summary: see node definition for valid relationships
39251       operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
39252       consumes:
39253         - application/json
39254         - application/xml
39255       produces:
39256         - application/json
39257         - application/xml
39258       responses:
39259         "default":
39260           description: Response codes found in [response codes](https://wiki.onap.org/).
39261       parameters:
39262         - name: pnf-name
39263           in: path
39264           description: unique name of Physical Network Function.
39265           required: true
39266           type: string
39267           example: __PNF-NAME__
39268         - name: body
39269           in: body
39270           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnf.json)
39271           required: true
39272           schema:
39273             $ref: "#/definitions/relationship"
39274     delete:
39275       tags:
39276         - Network
39277       summary: delete an existing relationship
39278       description: delete an existing relationship
39279       operationId: deleteNetworkPnfsPnfRelationshipListRelationship
39280       consumes:
39281         - application/json
39282         - application/xml
39283       produces:
39284         - application/json
39285         - application/xml
39286       responses:
39287         "default":
39288           description: Response codes found in [response codes](https://wiki.onap.org/).
39289       parameters:
39290         - name: pnf-name
39291           in: path
39292           description: unique name of Physical Network Function.
39293           required: true
39294           type: string
39295           example: __PNF-NAME__
39296   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
39297     put:
39298       tags:
39299         - Network
39300       summary: see node definition for valid relationships
39301       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
39302       consumes:
39303         - application/json
39304         - application/xml
39305       produces:
39306         - application/json
39307         - application/xml
39308       responses:
39309         "default":
39310           description: Response codes found in [response codes](https://wiki.onap.org/).
39311       parameters:
39312         - name: pnf-name
39313           in: path
39314           description: unique name of Physical Network Function.
39315           required: true
39316           type: string
39317           example: __PNF-NAME__
39318         - name: interface-name
39319           in: path
39320           description: Name that identifies the physical interface
39321           required: true
39322           type: string
39323           example: __INTERFACE-NAME__
39324         - name: body
39325           in: body
39326           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterface.json)
39327           required: true
39328           schema:
39329             $ref: "#/definitions/relationship"
39330     delete:
39331       tags:
39332         - Network
39333       summary: delete an existing relationship
39334       description: delete an existing relationship
39335       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
39336       consumes:
39337         - application/json
39338         - application/xml
39339       produces:
39340         - application/json
39341         - application/xml
39342       responses:
39343         "default":
39344           description: Response codes found in [response codes](https://wiki.onap.org/).
39345       parameters:
39346         - name: pnf-name
39347           in: path
39348           description: unique name of Physical Network Function.
39349           required: true
39350           type: string
39351           example: __PNF-NAME__
39352         - name: interface-name
39353           in: path
39354           description: Name that identifies the physical interface
39355           required: true
39356           type: string
39357           example: __INTERFACE-NAME__
39358   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
39359     put:
39360       tags:
39361         - Network
39362       summary: see node definition for valid relationships
39363       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
39364       consumes:
39365         - application/json
39366         - application/xml
39367       produces:
39368         - application/json
39369         - application/xml
39370       responses:
39371         "default":
39372           description: Response codes found in [response codes](https://wiki.onap.org/).
39373       parameters:
39374         - name: pnf-name
39375           in: path
39376           description: unique name of Physical Network Function.
39377           required: true
39378           type: string
39379           example: __PNF-NAME__
39380         - name: interface-name
39381           in: path
39382           description: Name that identifies the physical interface
39383           required: true
39384           type: string
39385           example: __INTERFACE-NAME__
39386         - name: pf-pci-id
39387           in: path
39388           description: Identifier for the sriov-pf
39389           required: true
39390           type: string
39391           example: __PF-PCI-ID__
39392         - name: body
39393           in: body
39394           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
39395           required: true
39396           schema:
39397             $ref: "#/definitions/relationship"
39398     delete:
39399       tags:
39400         - Network
39401       summary: delete an existing relationship
39402       description: delete an existing relationship
39403       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
39404       consumes:
39405         - application/json
39406         - application/xml
39407       produces:
39408         - application/json
39409         - application/xml
39410       responses:
39411         "default":
39412           description: Response codes found in [response codes](https://wiki.onap.org/).
39413       parameters:
39414         - name: pnf-name
39415           in: path
39416           description: unique name of Physical Network Function.
39417           required: true
39418           type: string
39419           example: __PNF-NAME__
39420         - name: interface-name
39421           in: path
39422           description: Name that identifies the physical interface
39423           required: true
39424           type: string
39425           example: __INTERFACE-NAME__
39426         - name: pf-pci-id
39427           in: path
39428           description: Identifier for the sriov-pf
39429           required: true
39430           type: string
39431           example: __PF-PCI-ID__
39432   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
39433     get:
39434       tags:
39435         - Network
39436       summary: returns sriov-pf
39437       description: returns sriov-pf
39438       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39439       produces:
39440         - application/json
39441         - application/xml
39442       responses:
39443         "200":
39444           description: successful operation
39445           schema:
39446               $ref: "#/getDefinitions/sriov-pf"
39447         "default":
39448           description: Response codes found in [response codes](https://wiki.onap.org/).
39449       parameters:
39450         - name: pnf-name
39451           in: path
39452           description: unique name of Physical Network Function.
39453           required: true
39454           type: string
39455           example: __PNF-NAME__
39456         - name: interface-name
39457           in: path
39458           description: Name that identifies the physical interface
39459           required: true
39460           type: string
39461           example: __INTERFACE-NAME__
39462         - name: pf-pci-id
39463           in: path
39464           description: Identifier for the sriov-pf
39465           required: true
39466           type: string
39467           example: __PF-PCI-ID__
39468     put:
39469       tags:
39470         - Network
39471       summary: create or update an existing sriov-pf
39472       description: |
39473         Create or update an existing sriov-pf.
39474         #
39475         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39476       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39477       consumes:
39478         - application/json
39479         - application/xml
39480       produces:
39481         - application/json
39482         - application/xml
39483       responses:
39484         "default":
39485           description: Response codes found in [response codes](https://wiki.onap.org/).
39486       parameters:
39487         - name: pnf-name
39488           in: path
39489           description: unique name of Physical Network Function.
39490           required: true
39491           type: string
39492           example: __PNF-NAME__
39493         - name: interface-name
39494           in: path
39495           description: Name that identifies the physical interface
39496           required: true
39497           type: string
39498           example: __INTERFACE-NAME__
39499         - name: pf-pci-id
39500           in: path
39501           description: Identifier for the sriov-pf
39502           required: true
39503           type: string
39504           example: __PF-PCI-ID__
39505         - name: body
39506           in: body
39507           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
39508           required: true
39509           schema:
39510             $ref: "#/definitions/sriov-pf"
39511     patch:
39512       tags:
39513         - Network
39514       summary: update an existing sriov-pf
39515       description: |
39516         Update an existing sriov-pf
39517         #
39518         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39519         The PUT operation will entirely replace an existing object.
39520         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39521         #
39522         Other differences between PUT and PATCH are:
39523         #
39524         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39525         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39526         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39527       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39528       consumes:
39529         - application/json
39530         - application/xml
39531       produces:
39532         - application/json
39533         - application/xml
39534       responses:
39535         "default":
39536           description: Response codes found in [response codes](https://wiki.onap.org/).
39537       parameters:
39538         - name: pnf-name
39539           in: path
39540           description: unique name of Physical Network Function.
39541           required: true
39542           type: string
39543           example: __PNF-NAME__
39544         - name: interface-name
39545           in: path
39546           description: Name that identifies the physical interface
39547           required: true
39548           type: string
39549           example: __INTERFACE-NAME__
39550         - name: pf-pci-id
39551           in: path
39552           description: Identifier for the sriov-pf
39553           required: true
39554           type: string
39555           example: __PF-PCI-ID__
39556         - name: body
39557           in: body
39558           description: sriov-pf object that needs to be updated.
39559           required: true
39560           schema:
39561             $ref: "#/patchDefinitions/sriov-pf"
39562     delete:
39563       tags:
39564         - Network
39565       summary: delete an existing sriov-pf
39566       description: delete an existing sriov-pf
39567       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
39568       consumes:
39569         - application/json
39570         - application/xml
39571       produces:
39572         - application/json
39573         - application/xml
39574       responses:
39575         "default":
39576           description: Response codes found in [response codes](https://wiki.onap.org/).
39577       parameters:
39578         - name: pnf-name
39579           in: path
39580           description: unique name of Physical Network Function.
39581           required: true
39582           type: string
39583           example: __PNF-NAME__
39584         - name: interface-name
39585           in: path
39586           description: Name that identifies the physical interface
39587           required: true
39588           type: string
39589           example: __INTERFACE-NAME__
39590         - name: pf-pci-id
39591           in: path
39592           description: Identifier for the sriov-pf
39593           required: true
39594           type: string
39595           example: __PF-PCI-ID__
39596         - name: resource-version
39597           in: query
39598           description: resource-version for concurrency
39599           required: true
39600           type: string
39601   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
39602     get:
39603       tags:
39604         - Network
39605       summary: returns sriov-pfs
39606       description: returns sriov-pfs
39607       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
39608       produces:
39609         - application/json
39610         - application/xml
39611       responses:
39612         "200":
39613           description: successful operation
39614           schema:
39615               $ref: "#/getDefinitions/sriov-pfs"
39616         "default":
39617           description: Response codes found in [response codes](https://wiki.onap.org/).
39618       parameters:
39619         - name: pnf-name
39620           in: path
39621           description: unique name of Physical Network Function.
39622           required: true
39623           type: string
39624           example: __PNF-NAME__
39625         - name: interface-name
39626           in: path
39627           description: Name that identifies the physical interface
39628           required: true
39629           type: string
39630           example: __INTERFACE-NAME__
39631         - name: pf-pci-id
39632           in: query
39633           description:
39634           required: false
39635           type: string
39636   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
39637     put:
39638       tags:
39639         - Network
39640       summary: see node definition for valid relationships
39641       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
39642       consumes:
39643         - application/json
39644         - application/xml
39645       produces:
39646         - application/json
39647         - application/xml
39648       responses:
39649         "default":
39650           description: Response codes found in [response codes](https://wiki.onap.org/).
39651       parameters:
39652         - name: pnf-name
39653           in: path
39654           description: unique name of Physical Network Function.
39655           required: true
39656           type: string
39657           example: __PNF-NAME__
39658         - name: interface-name
39659           in: path
39660           description: Name that identifies the physical interface
39661           required: true
39662           type: string
39663           example: __INTERFACE-NAME__
39664         - name: interface-name
39665           in: path
39666           description: Name given to the interface
39667           required: true
39668           type: string
39669           example: __INTERFACE-NAME__
39670         - name: vlan-interface
39671           in: path
39672           description: String that identifies the interface
39673           required: true
39674           type: string
39675           example: __VLAN-INTERFACE__
39676         - name: body
39677           in: body
39678           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
39679           required: true
39680           schema:
39681             $ref: "#/definitions/relationship"
39682     delete:
39683       tags:
39684         - Network
39685       summary: delete an existing relationship
39686       description: delete an existing relationship
39687       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
39688       consumes:
39689         - application/json
39690         - application/xml
39691       produces:
39692         - application/json
39693         - application/xml
39694       responses:
39695         "default":
39696           description: Response codes found in [response codes](https://wiki.onap.org/).
39697       parameters:
39698         - name: pnf-name
39699           in: path
39700           description: unique name of Physical Network Function.
39701           required: true
39702           type: string
39703           example: __PNF-NAME__
39704         - name: interface-name
39705           in: path
39706           description: Name that identifies the physical interface
39707           required: true
39708           type: string
39709           example: __INTERFACE-NAME__
39710         - name: interface-name
39711           in: path
39712           description: Name given to the interface
39713           required: true
39714           type: string
39715           example: __INTERFACE-NAME__
39716         - name: vlan-interface
39717           in: path
39718           description: String that identifies the interface
39719           required: true
39720           type: string
39721           example: __VLAN-INTERFACE__
39722   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
39723     put:
39724       tags:
39725         - Network
39726       summary: see node definition for valid relationships
39727       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
39728       consumes:
39729         - application/json
39730         - application/xml
39731       produces:
39732         - application/json
39733         - application/xml
39734       responses:
39735         "default":
39736           description: Response codes found in [response codes](https://wiki.onap.org/).
39737       parameters:
39738         - name: pnf-name
39739           in: path
39740           description: unique name of Physical Network Function.
39741           required: true
39742           type: string
39743           example: __PNF-NAME__
39744         - name: interface-name
39745           in: path
39746           description: Name that identifies the physical interface
39747           required: true
39748           type: string
39749           example: __INTERFACE-NAME__
39750         - name: interface-name
39751           in: path
39752           description: Name given to the interface
39753           required: true
39754           type: string
39755           example: __INTERFACE-NAME__
39756         - name: vlan-interface
39757           in: path
39758           description: String that identifies the interface
39759           required: true
39760           type: string
39761           example: __VLAN-INTERFACE__
39762         - name: l3-interface-ipv4-address
39763           in: path
39764           description: IP address
39765           required: true
39766           type: string
39767           example: __L3-INTERFACE-IPV4-ADDRESS__
39768         - name: body
39769           in: body
39770           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
39771           required: true
39772           schema:
39773             $ref: "#/definitions/relationship"
39774     delete:
39775       tags:
39776         - Network
39777       summary: delete an existing relationship
39778       description: delete an existing relationship
39779       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
39780       consumes:
39781         - application/json
39782         - application/xml
39783       produces:
39784         - application/json
39785         - application/xml
39786       responses:
39787         "default":
39788           description: Response codes found in [response codes](https://wiki.onap.org/).
39789       parameters:
39790         - name: pnf-name
39791           in: path
39792           description: unique name of Physical Network Function.
39793           required: true
39794           type: string
39795           example: __PNF-NAME__
39796         - name: interface-name
39797           in: path
39798           description: Name that identifies the physical interface
39799           required: true
39800           type: string
39801           example: __INTERFACE-NAME__
39802         - name: interface-name
39803           in: path
39804           description: Name given to the interface
39805           required: true
39806           type: string
39807           example: __INTERFACE-NAME__
39808         - name: vlan-interface
39809           in: path
39810           description: String that identifies the interface
39811           required: true
39812           type: string
39813           example: __VLAN-INTERFACE__
39814         - name: l3-interface-ipv4-address
39815           in: path
39816           description: IP address
39817           required: true
39818           type: string
39819           example: __L3-INTERFACE-IPV4-ADDRESS__
39820   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
39821     get:
39822       tags:
39823         - Network
39824       summary: returns l3-interface-ipv4-address-list
39825       description: returns l3-interface-ipv4-address-list
39826       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39827       produces:
39828         - application/json
39829         - application/xml
39830       responses:
39831         "200":
39832           description: successful operation
39833           schema:
39834               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39835         "default":
39836           description: Response codes found in [response codes](https://wiki.onap.org/).
39837       parameters:
39838         - name: pnf-name
39839           in: path
39840           description: unique name of Physical Network Function.
39841           required: true
39842           type: string
39843           example: __PNF-NAME__
39844         - name: interface-name
39845           in: path
39846           description: Name that identifies the physical interface
39847           required: true
39848           type: string
39849           example: __INTERFACE-NAME__
39850         - name: interface-name
39851           in: path
39852           description: Name given to the interface
39853           required: true
39854           type: string
39855           example: __INTERFACE-NAME__
39856         - name: vlan-interface
39857           in: path
39858           description: String that identifies the interface
39859           required: true
39860           type: string
39861           example: __VLAN-INTERFACE__
39862         - name: l3-interface-ipv4-address
39863           in: path
39864           description: IP address
39865           required: true
39866           type: string
39867           example: __L3-INTERFACE-IPV4-ADDRESS__
39868     put:
39869       tags:
39870         - Network
39871       summary: create or update an existing l3-interface-ipv4-address-list
39872       description: |
39873         Create or update an existing l3-interface-ipv4-address-list.
39874         #
39875         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39876       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39877       consumes:
39878         - application/json
39879         - application/xml
39880       produces:
39881         - application/json
39882         - application/xml
39883       responses:
39884         "default":
39885           description: Response codes found in [response codes](https://wiki.onap.org/).
39886       parameters:
39887         - name: pnf-name
39888           in: path
39889           description: unique name of Physical Network Function.
39890           required: true
39891           type: string
39892           example: __PNF-NAME__
39893         - name: interface-name
39894           in: path
39895           description: Name that identifies the physical interface
39896           required: true
39897           type: string
39898           example: __INTERFACE-NAME__
39899         - name: interface-name
39900           in: path
39901           description: Name given to the interface
39902           required: true
39903           type: string
39904           example: __INTERFACE-NAME__
39905         - name: vlan-interface
39906           in: path
39907           description: String that identifies the interface
39908           required: true
39909           type: string
39910           example: __VLAN-INTERFACE__
39911         - name: l3-interface-ipv4-address
39912           in: path
39913           description: IP address
39914           required: true
39915           type: string
39916           example: __L3-INTERFACE-IPV4-ADDRESS__
39917         - name: body
39918           in: body
39919           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
39920           required: true
39921           schema:
39922             $ref: "#/definitions/l3-interface-ipv4-address-list"
39923     patch:
39924       tags:
39925         - Network
39926       summary: update an existing l3-interface-ipv4-address-list
39927       description: |
39928         Update an existing l3-interface-ipv4-address-list
39929         #
39930         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39931         The PUT operation will entirely replace an existing object.
39932         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39933         #
39934         Other differences between PUT and PATCH are:
39935         #
39936         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39937         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39938         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39939       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39940       consumes:
39941         - application/json
39942         - application/xml
39943       produces:
39944         - application/json
39945         - application/xml
39946       responses:
39947         "default":
39948           description: Response codes found in [response codes](https://wiki.onap.org/).
39949       parameters:
39950         - name: pnf-name
39951           in: path
39952           description: unique name of Physical Network Function.
39953           required: true
39954           type: string
39955           example: __PNF-NAME__
39956         - name: interface-name
39957           in: path
39958           description: Name that identifies the physical interface
39959           required: true
39960           type: string
39961           example: __INTERFACE-NAME__
39962         - name: interface-name
39963           in: path
39964           description: Name given to the interface
39965           required: true
39966           type: string
39967           example: __INTERFACE-NAME__
39968         - name: vlan-interface
39969           in: path
39970           description: String that identifies the interface
39971           required: true
39972           type: string
39973           example: __VLAN-INTERFACE__
39974         - name: l3-interface-ipv4-address
39975           in: path
39976           description: IP address
39977           required: true
39978           type: string
39979           example: __L3-INTERFACE-IPV4-ADDRESS__
39980         - name: body
39981           in: body
39982           description: l3-interface-ipv4-address-list object that needs to be updated.
39983           required: true
39984           schema:
39985             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39986     delete:
39987       tags:
39988         - Network
39989       summary: delete an existing l3-interface-ipv4-address-list
39990       description: delete an existing l3-interface-ipv4-address-list
39991       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39992       consumes:
39993         - application/json
39994         - application/xml
39995       produces:
39996         - application/json
39997         - application/xml
39998       responses:
39999         "default":
40000           description: Response codes found in [response codes](https://wiki.onap.org/).
40001       parameters:
40002         - name: pnf-name
40003           in: path
40004           description: unique name of Physical Network Function.
40005           required: true
40006           type: string
40007           example: __PNF-NAME__
40008         - name: interface-name
40009           in: path
40010           description: Name that identifies the physical interface
40011           required: true
40012           type: string
40013           example: __INTERFACE-NAME__
40014         - name: interface-name
40015           in: path
40016           description: Name given to the interface
40017           required: true
40018           type: string
40019           example: __INTERFACE-NAME__
40020         - name: vlan-interface
40021           in: path
40022           description: String that identifies the interface
40023           required: true
40024           type: string
40025           example: __VLAN-INTERFACE__
40026         - name: l3-interface-ipv4-address
40027           in: path
40028           description: IP address
40029           required: true
40030           type: string
40031           example: __L3-INTERFACE-IPV4-ADDRESS__
40032         - name: resource-version
40033           in: query
40034           description: resource-version for concurrency
40035           required: true
40036           type: string
40037   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
40038     put:
40039       tags:
40040         - Network
40041       summary: see node definition for valid relationships
40042       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
40043       consumes:
40044         - application/json
40045         - application/xml
40046       produces:
40047         - application/json
40048         - application/xml
40049       responses:
40050         "default":
40051           description: Response codes found in [response codes](https://wiki.onap.org/).
40052       parameters:
40053         - name: pnf-name
40054           in: path
40055           description: unique name of Physical Network Function.
40056           required: true
40057           type: string
40058           example: __PNF-NAME__
40059         - name: interface-name
40060           in: path
40061           description: Name that identifies the physical interface
40062           required: true
40063           type: string
40064           example: __INTERFACE-NAME__
40065         - name: interface-name
40066           in: path
40067           description: Name given to the interface
40068           required: true
40069           type: string
40070           example: __INTERFACE-NAME__
40071         - name: vlan-interface
40072           in: path
40073           description: String that identifies the interface
40074           required: true
40075           type: string
40076           example: __VLAN-INTERFACE__
40077         - name: l3-interface-ipv6-address
40078           in: path
40079           description: IP address
40080           required: true
40081           type: string
40082           example: __L3-INTERFACE-IPV6-ADDRESS__
40083         - name: body
40084           in: body
40085           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
40086           required: true
40087           schema:
40088             $ref: "#/definitions/relationship"
40089     delete:
40090       tags:
40091         - Network
40092       summary: delete an existing relationship
40093       description: delete an existing relationship
40094       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
40095       consumes:
40096         - application/json
40097         - application/xml
40098       produces:
40099         - application/json
40100         - application/xml
40101       responses:
40102         "default":
40103           description: Response codes found in [response codes](https://wiki.onap.org/).
40104       parameters:
40105         - name: pnf-name
40106           in: path
40107           description: unique name of Physical Network Function.
40108           required: true
40109           type: string
40110           example: __PNF-NAME__
40111         - name: interface-name
40112           in: path
40113           description: Name that identifies the physical interface
40114           required: true
40115           type: string
40116           example: __INTERFACE-NAME__
40117         - name: interface-name
40118           in: path
40119           description: Name given to the interface
40120           required: true
40121           type: string
40122           example: __INTERFACE-NAME__
40123         - name: vlan-interface
40124           in: path
40125           description: String that identifies the interface
40126           required: true
40127           type: string
40128           example: __VLAN-INTERFACE__
40129         - name: l3-interface-ipv6-address
40130           in: path
40131           description: IP address
40132           required: true
40133           type: string
40134           example: __L3-INTERFACE-IPV6-ADDRESS__
40135   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
40136     get:
40137       tags:
40138         - Network
40139       summary: returns l3-interface-ipv6-address-list
40140       description: returns l3-interface-ipv6-address-list
40141       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40142       produces:
40143         - application/json
40144         - application/xml
40145       responses:
40146         "200":
40147           description: successful operation
40148           schema:
40149               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
40150         "default":
40151           description: Response codes found in [response codes](https://wiki.onap.org/).
40152       parameters:
40153         - name: pnf-name
40154           in: path
40155           description: unique name of Physical Network Function.
40156           required: true
40157           type: string
40158           example: __PNF-NAME__
40159         - name: interface-name
40160           in: path
40161           description: Name that identifies the physical interface
40162           required: true
40163           type: string
40164           example: __INTERFACE-NAME__
40165         - name: interface-name
40166           in: path
40167           description: Name given to the interface
40168           required: true
40169           type: string
40170           example: __INTERFACE-NAME__
40171         - name: vlan-interface
40172           in: path
40173           description: String that identifies the interface
40174           required: true
40175           type: string
40176           example: __VLAN-INTERFACE__
40177         - name: l3-interface-ipv6-address
40178           in: path
40179           description: IP address
40180           required: true
40181           type: string
40182           example: __L3-INTERFACE-IPV6-ADDRESS__
40183     put:
40184       tags:
40185         - Network
40186       summary: create or update an existing l3-interface-ipv6-address-list
40187       description: |
40188         Create or update an existing l3-interface-ipv6-address-list.
40189         #
40190         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40191       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40192       consumes:
40193         - application/json
40194         - application/xml
40195       produces:
40196         - application/json
40197         - application/xml
40198       responses:
40199         "default":
40200           description: Response codes found in [response codes](https://wiki.onap.org/).
40201       parameters:
40202         - name: pnf-name
40203           in: path
40204           description: unique name of Physical Network Function.
40205           required: true
40206           type: string
40207           example: __PNF-NAME__
40208         - name: interface-name
40209           in: path
40210           description: Name that identifies the physical interface
40211           required: true
40212           type: string
40213           example: __INTERFACE-NAME__
40214         - name: interface-name
40215           in: path
40216           description: Name given to the interface
40217           required: true
40218           type: string
40219           example: __INTERFACE-NAME__
40220         - name: vlan-interface
40221           in: path
40222           description: String that identifies the interface
40223           required: true
40224           type: string
40225           example: __VLAN-INTERFACE__
40226         - name: l3-interface-ipv6-address
40227           in: path
40228           description: IP address
40229           required: true
40230           type: string
40231           example: __L3-INTERFACE-IPV6-ADDRESS__
40232         - name: body
40233           in: body
40234           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
40235           required: true
40236           schema:
40237             $ref: "#/definitions/l3-interface-ipv6-address-list"
40238     patch:
40239       tags:
40240         - Network
40241       summary: update an existing l3-interface-ipv6-address-list
40242       description: |
40243         Update an existing l3-interface-ipv6-address-list
40244         #
40245         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40246         The PUT operation will entirely replace an existing object.
40247         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40248         #
40249         Other differences between PUT and PATCH are:
40250         #
40251         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40252         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40253         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40254       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40255       consumes:
40256         - application/json
40257         - application/xml
40258       produces:
40259         - application/json
40260         - application/xml
40261       responses:
40262         "default":
40263           description: Response codes found in [response codes](https://wiki.onap.org/).
40264       parameters:
40265         - name: pnf-name
40266           in: path
40267           description: unique name of Physical Network Function.
40268           required: true
40269           type: string
40270           example: __PNF-NAME__
40271         - name: interface-name
40272           in: path
40273           description: Name that identifies the physical interface
40274           required: true
40275           type: string
40276           example: __INTERFACE-NAME__
40277         - name: interface-name
40278           in: path
40279           description: Name given to the interface
40280           required: true
40281           type: string
40282           example: __INTERFACE-NAME__
40283         - name: vlan-interface
40284           in: path
40285           description: String that identifies the interface
40286           required: true
40287           type: string
40288           example: __VLAN-INTERFACE__
40289         - name: l3-interface-ipv6-address
40290           in: path
40291           description: IP address
40292           required: true
40293           type: string
40294           example: __L3-INTERFACE-IPV6-ADDRESS__
40295         - name: body
40296           in: body
40297           description: l3-interface-ipv6-address-list object that needs to be updated.
40298           required: true
40299           schema:
40300             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
40301     delete:
40302       tags:
40303         - Network
40304       summary: delete an existing l3-interface-ipv6-address-list
40305       description: delete an existing l3-interface-ipv6-address-list
40306       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40307       consumes:
40308         - application/json
40309         - application/xml
40310       produces:
40311         - application/json
40312         - application/xml
40313       responses:
40314         "default":
40315           description: Response codes found in [response codes](https://wiki.onap.org/).
40316       parameters:
40317         - name: pnf-name
40318           in: path
40319           description: unique name of Physical Network Function.
40320           required: true
40321           type: string
40322           example: __PNF-NAME__
40323         - name: interface-name
40324           in: path
40325           description: Name that identifies the physical interface
40326           required: true
40327           type: string
40328           example: __INTERFACE-NAME__
40329         - name: interface-name
40330           in: path
40331           description: Name given to the interface
40332           required: true
40333           type: string
40334           example: __INTERFACE-NAME__
40335         - name: vlan-interface
40336           in: path
40337           description: String that identifies the interface
40338           required: true
40339           type: string
40340           example: __VLAN-INTERFACE__
40341         - name: l3-interface-ipv6-address
40342           in: path
40343           description: IP address
40344           required: true
40345           type: string
40346           example: __L3-INTERFACE-IPV6-ADDRESS__
40347         - name: resource-version
40348           in: query
40349           description: resource-version for concurrency
40350           required: true
40351           type: string
40352   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
40353     get:
40354       tags:
40355         - Network
40356       summary: returns vlan
40357       description: returns vlan
40358       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40359       produces:
40360         - application/json
40361         - application/xml
40362       responses:
40363         "200":
40364           description: successful operation
40365           schema:
40366               $ref: "#/getDefinitions/vlan"
40367         "default":
40368           description: Response codes found in [response codes](https://wiki.onap.org/).
40369       parameters:
40370         - name: pnf-name
40371           in: path
40372           description: unique name of Physical Network Function.
40373           required: true
40374           type: string
40375           example: __PNF-NAME__
40376         - name: interface-name
40377           in: path
40378           description: Name that identifies the physical interface
40379           required: true
40380           type: string
40381           example: __INTERFACE-NAME__
40382         - name: interface-name
40383           in: path
40384           description: Name given to the interface
40385           required: true
40386           type: string
40387           example: __INTERFACE-NAME__
40388         - name: vlan-interface
40389           in: path
40390           description: String that identifies the interface
40391           required: true
40392           type: string
40393           example: __VLAN-INTERFACE__
40394     put:
40395       tags:
40396         - Network
40397       summary: create or update an existing vlan
40398       description: |
40399         Create or update an existing vlan.
40400         #
40401         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40402       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40403       consumes:
40404         - application/json
40405         - application/xml
40406       produces:
40407         - application/json
40408         - application/xml
40409       responses:
40410         "default":
40411           description: Response codes found in [response codes](https://wiki.onap.org/).
40412       parameters:
40413         - name: pnf-name
40414           in: path
40415           description: unique name of Physical Network Function.
40416           required: true
40417           type: string
40418           example: __PNF-NAME__
40419         - name: interface-name
40420           in: path
40421           description: Name that identifies the physical interface
40422           required: true
40423           type: string
40424           example: __INTERFACE-NAME__
40425         - name: interface-name
40426           in: path
40427           description: Name given to the interface
40428           required: true
40429           type: string
40430           example: __INTERFACE-NAME__
40431         - name: vlan-interface
40432           in: path
40433           description: String that identifies the interface
40434           required: true
40435           type: string
40436           example: __VLAN-INTERFACE__
40437         - name: body
40438           in: body
40439           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
40440           required: true
40441           schema:
40442             $ref: "#/definitions/vlan"
40443     patch:
40444       tags:
40445         - Network
40446       summary: update an existing vlan
40447       description: |
40448         Update an existing vlan
40449         #
40450         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40451         The PUT operation will entirely replace an existing object.
40452         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40453         #
40454         Other differences between PUT and PATCH are:
40455         #
40456         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40457         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40458         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40459       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40460       consumes:
40461         - application/json
40462         - application/xml
40463       produces:
40464         - application/json
40465         - application/xml
40466       responses:
40467         "default":
40468           description: Response codes found in [response codes](https://wiki.onap.org/).
40469       parameters:
40470         - name: pnf-name
40471           in: path
40472           description: unique name of Physical Network Function.
40473           required: true
40474           type: string
40475           example: __PNF-NAME__
40476         - name: interface-name
40477           in: path
40478           description: Name that identifies the physical interface
40479           required: true
40480           type: string
40481           example: __INTERFACE-NAME__
40482         - name: interface-name
40483           in: path
40484           description: Name given to the interface
40485           required: true
40486           type: string
40487           example: __INTERFACE-NAME__
40488         - name: vlan-interface
40489           in: path
40490           description: String that identifies the interface
40491           required: true
40492           type: string
40493           example: __VLAN-INTERFACE__
40494         - name: body
40495           in: body
40496           description: vlan object that needs to be updated.
40497           required: true
40498           schema:
40499             $ref: "#/patchDefinitions/vlan"
40500     delete:
40501       tags:
40502         - Network
40503       summary: delete an existing vlan
40504       description: delete an existing vlan
40505       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
40506       consumes:
40507         - application/json
40508         - application/xml
40509       produces:
40510         - application/json
40511         - application/xml
40512       responses:
40513         "default":
40514           description: Response codes found in [response codes](https://wiki.onap.org/).
40515       parameters:
40516         - name: pnf-name
40517           in: path
40518           description: unique name of Physical Network Function.
40519           required: true
40520           type: string
40521           example: __PNF-NAME__
40522         - name: interface-name
40523           in: path
40524           description: Name that identifies the physical interface
40525           required: true
40526           type: string
40527           example: __INTERFACE-NAME__
40528         - name: interface-name
40529           in: path
40530           description: Name given to the interface
40531           required: true
40532           type: string
40533           example: __INTERFACE-NAME__
40534         - name: vlan-interface
40535           in: path
40536           description: String that identifies the interface
40537           required: true
40538           type: string
40539           example: __VLAN-INTERFACE__
40540         - name: resource-version
40541           in: query
40542           description: resource-version for concurrency
40543           required: true
40544           type: string
40545   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
40546     get:
40547       tags:
40548         - Network
40549       summary: returns vlans
40550       description: returns vlans
40551       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
40552       produces:
40553         - application/json
40554         - application/xml
40555       responses:
40556         "200":
40557           description: successful operation
40558           schema:
40559               $ref: "#/getDefinitions/vlans"
40560         "default":
40561           description: Response codes found in [response codes](https://wiki.onap.org/).
40562       parameters:
40563         - name: pnf-name
40564           in: path
40565           description: unique name of Physical Network Function.
40566           required: true
40567           type: string
40568           example: __PNF-NAME__
40569         - name: interface-name
40570           in: path
40571           description: Name that identifies the physical interface
40572           required: true
40573           type: string
40574           example: __INTERFACE-NAME__
40575         - name: interface-name
40576           in: path
40577           description: Name given to the interface
40578           required: true
40579           type: string
40580           example: __INTERFACE-NAME__
40581         - name: vlan-interface
40582           in: query
40583           description:
40584           required: false
40585           type: string
40586         - name: vlan-id-inner
40587           in: query
40588           description:
40589           required: false
40590           type: integer
40591           format: int64
40592         - name: vpn-key
40593           in: query
40594           description:
40595           required: false
40596           type: string
40597   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
40598     put:
40599       tags:
40600         - Network
40601       summary: see node definition for valid relationships
40602       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
40603       consumes:
40604         - application/json
40605         - application/xml
40606       produces:
40607         - application/json
40608         - application/xml
40609       responses:
40610         "default":
40611           description: Response codes found in [response codes](https://wiki.onap.org/).
40612       parameters:
40613         - name: pnf-name
40614           in: path
40615           description: unique name of Physical Network Function.
40616           required: true
40617           type: string
40618           example: __PNF-NAME__
40619         - name: interface-name
40620           in: path
40621           description: Name that identifies the physical interface
40622           required: true
40623           type: string
40624           example: __INTERFACE-NAME__
40625         - name: interface-name
40626           in: path
40627           description: Name given to the interface
40628           required: true
40629           type: string
40630           example: __INTERFACE-NAME__
40631         - name: pci-id
40632           in: path
40633           description: PCI ID used to identify the sriov-vf
40634           required: true
40635           type: string
40636           example: __PCI-ID__
40637         - name: body
40638           in: body
40639           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
40640           required: true
40641           schema:
40642             $ref: "#/definitions/relationship"
40643     delete:
40644       tags:
40645         - Network
40646       summary: delete an existing relationship
40647       description: delete an existing relationship
40648       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
40649       consumes:
40650         - application/json
40651         - application/xml
40652       produces:
40653         - application/json
40654         - application/xml
40655       responses:
40656         "default":
40657           description: Response codes found in [response codes](https://wiki.onap.org/).
40658       parameters:
40659         - name: pnf-name
40660           in: path
40661           description: unique name of Physical Network Function.
40662           required: true
40663           type: string
40664           example: __PNF-NAME__
40665         - name: interface-name
40666           in: path
40667           description: Name that identifies the physical interface
40668           required: true
40669           type: string
40670           example: __INTERFACE-NAME__
40671         - name: interface-name
40672           in: path
40673           description: Name given to the interface
40674           required: true
40675           type: string
40676           example: __INTERFACE-NAME__
40677         - name: pci-id
40678           in: path
40679           description: PCI ID used to identify the sriov-vf
40680           required: true
40681           type: string
40682           example: __PCI-ID__
40683   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
40684     get:
40685       tags:
40686         - Network
40687       summary: returns sriov-vf
40688       description: returns sriov-vf
40689       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40690       produces:
40691         - application/json
40692         - application/xml
40693       responses:
40694         "200":
40695           description: successful operation
40696           schema:
40697               $ref: "#/getDefinitions/sriov-vf"
40698         "default":
40699           description: Response codes found in [response codes](https://wiki.onap.org/).
40700       parameters:
40701         - name: pnf-name
40702           in: path
40703           description: unique name of Physical Network Function.
40704           required: true
40705           type: string
40706           example: __PNF-NAME__
40707         - name: interface-name
40708           in: path
40709           description: Name that identifies the physical interface
40710           required: true
40711           type: string
40712           example: __INTERFACE-NAME__
40713         - name: interface-name
40714           in: path
40715           description: Name given to the interface
40716           required: true
40717           type: string
40718           example: __INTERFACE-NAME__
40719         - name: pci-id
40720           in: path
40721           description: PCI ID used to identify the sriov-vf
40722           required: true
40723           type: string
40724           example: __PCI-ID__
40725     put:
40726       tags:
40727         - Network
40728       summary: create or update an existing sriov-vf
40729       description: |
40730         Create or update an existing sriov-vf.
40731         #
40732         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40733       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40734       consumes:
40735         - application/json
40736         - application/xml
40737       produces:
40738         - application/json
40739         - application/xml
40740       responses:
40741         "default":
40742           description: Response codes found in [response codes](https://wiki.onap.org/).
40743       parameters:
40744         - name: pnf-name
40745           in: path
40746           description: unique name of Physical Network Function.
40747           required: true
40748           type: string
40749           example: __PNF-NAME__
40750         - name: interface-name
40751           in: path
40752           description: Name that identifies the physical interface
40753           required: true
40754           type: string
40755           example: __INTERFACE-NAME__
40756         - name: interface-name
40757           in: path
40758           description: Name given to the interface
40759           required: true
40760           type: string
40761           example: __INTERFACE-NAME__
40762         - name: pci-id
40763           in: path
40764           description: PCI ID used to identify the sriov-vf
40765           required: true
40766           type: string
40767           example: __PCI-ID__
40768         - name: body
40769           in: body
40770           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
40771           required: true
40772           schema:
40773             $ref: "#/definitions/sriov-vf"
40774     patch:
40775       tags:
40776         - Network
40777       summary: update an existing sriov-vf
40778       description: |
40779         Update an existing sriov-vf
40780         #
40781         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40782         The PUT operation will entirely replace an existing object.
40783         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40784         #
40785         Other differences between PUT and PATCH are:
40786         #
40787         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40788         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40789         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40790       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40791       consumes:
40792         - application/json
40793         - application/xml
40794       produces:
40795         - application/json
40796         - application/xml
40797       responses:
40798         "default":
40799           description: Response codes found in [response codes](https://wiki.onap.org/).
40800       parameters:
40801         - name: pnf-name
40802           in: path
40803           description: unique name of Physical Network Function.
40804           required: true
40805           type: string
40806           example: __PNF-NAME__
40807         - name: interface-name
40808           in: path
40809           description: Name that identifies the physical interface
40810           required: true
40811           type: string
40812           example: __INTERFACE-NAME__
40813         - name: interface-name
40814           in: path
40815           description: Name given to the interface
40816           required: true
40817           type: string
40818           example: __INTERFACE-NAME__
40819         - name: pci-id
40820           in: path
40821           description: PCI ID used to identify the sriov-vf
40822           required: true
40823           type: string
40824           example: __PCI-ID__
40825         - name: body
40826           in: body
40827           description: sriov-vf object that needs to be updated.
40828           required: true
40829           schema:
40830             $ref: "#/patchDefinitions/sriov-vf"
40831     delete:
40832       tags:
40833         - Network
40834       summary: delete an existing sriov-vf
40835       description: delete an existing sriov-vf
40836       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
40837       consumes:
40838         - application/json
40839         - application/xml
40840       produces:
40841         - application/json
40842         - application/xml
40843       responses:
40844         "default":
40845           description: Response codes found in [response codes](https://wiki.onap.org/).
40846       parameters:
40847         - name: pnf-name
40848           in: path
40849           description: unique name of Physical Network Function.
40850           required: true
40851           type: string
40852           example: __PNF-NAME__
40853         - name: interface-name
40854           in: path
40855           description: Name that identifies the physical interface
40856           required: true
40857           type: string
40858           example: __INTERFACE-NAME__
40859         - name: interface-name
40860           in: path
40861           description: Name given to the interface
40862           required: true
40863           type: string
40864           example: __INTERFACE-NAME__
40865         - name: pci-id
40866           in: path
40867           description: PCI ID used to identify the sriov-vf
40868           required: true
40869           type: string
40870           example: __PCI-ID__
40871         - name: resource-version
40872           in: query
40873           description: resource-version for concurrency
40874           required: true
40875           type: string
40876   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
40877     get:
40878       tags:
40879         - Network
40880       summary: returns sriov-vfs
40881       description: returns sriov-vfs
40882       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
40883       produces:
40884         - application/json
40885         - application/xml
40886       responses:
40887         "200":
40888           description: successful operation
40889           schema:
40890               $ref: "#/getDefinitions/sriov-vfs"
40891         "default":
40892           description: Response codes found in [response codes](https://wiki.onap.org/).
40893       parameters:
40894         - name: pnf-name
40895           in: path
40896           description: unique name of Physical Network Function.
40897           required: true
40898           type: string
40899           example: __PNF-NAME__
40900         - name: interface-name
40901           in: path
40902           description: Name that identifies the physical interface
40903           required: true
40904           type: string
40905           example: __INTERFACE-NAME__
40906         - name: interface-name
40907           in: path
40908           description: Name given to the interface
40909           required: true
40910           type: string
40911           example: __INTERFACE-NAME__
40912         - name: pci-id
40913           in: query
40914           description:
40915           required: false
40916           type: string
40917         - name: vf-vlan-filter
40918           in: query
40919           description:
40920           required: false
40921           type: string
40922         - name: vf-mac-filter
40923           in: query
40924           description:
40925           required: false
40926           type: string
40927         - name: vf-vlan-strip
40928           in: query
40929           description:
40930           required: false
40931           type: boolean
40932         - name: neutron-network-id
40933           in: query
40934           description:
40935           required: false
40936           type: string
40937   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
40938     put:
40939       tags:
40940         - Network
40941       summary: see node definition for valid relationships
40942       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
40943       consumes:
40944         - application/json
40945         - application/xml
40946       produces:
40947         - application/json
40948         - application/xml
40949       responses:
40950         "default":
40951           description: Response codes found in [response codes](https://wiki.onap.org/).
40952       parameters:
40953         - name: pnf-name
40954           in: path
40955           description: unique name of Physical Network Function.
40956           required: true
40957           type: string
40958           example: __PNF-NAME__
40959         - name: interface-name
40960           in: path
40961           description: Name that identifies the physical interface
40962           required: true
40963           type: string
40964           example: __INTERFACE-NAME__
40965         - name: interface-name
40966           in: path
40967           description: Name given to the interface
40968           required: true
40969           type: string
40970           example: __INTERFACE-NAME__
40971         - name: body
40972           in: body
40973           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
40974           required: true
40975           schema:
40976             $ref: "#/definitions/relationship"
40977     delete:
40978       tags:
40979         - Network
40980       summary: delete an existing relationship
40981       description: delete an existing relationship
40982       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
40983       consumes:
40984         - application/json
40985         - application/xml
40986       produces:
40987         - application/json
40988         - application/xml
40989       responses:
40990         "default":
40991           description: Response codes found in [response codes](https://wiki.onap.org/).
40992       parameters:
40993         - name: pnf-name
40994           in: path
40995           description: unique name of Physical Network Function.
40996           required: true
40997           type: string
40998           example: __PNF-NAME__
40999         - name: interface-name
41000           in: path
41001           description: Name that identifies the physical interface
41002           required: true
41003           type: string
41004           example: __INTERFACE-NAME__
41005         - name: interface-name
41006           in: path
41007           description: Name given to the interface
41008           required: true
41009           type: string
41010           example: __INTERFACE-NAME__
41011   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
41012     put:
41013       tags:
41014         - Network
41015       summary: see node definition for valid relationships
41016       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
41017       consumes:
41018         - application/json
41019         - application/xml
41020       produces:
41021         - application/json
41022         - application/xml
41023       responses:
41024         "default":
41025           description: Response codes found in [response codes](https://wiki.onap.org/).
41026       parameters:
41027         - name: pnf-name
41028           in: path
41029           description: unique name of Physical Network Function.
41030           required: true
41031           type: string
41032           example: __PNF-NAME__
41033         - name: interface-name
41034           in: path
41035           description: Name that identifies the physical interface
41036           required: true
41037           type: string
41038           example: __INTERFACE-NAME__
41039         - name: interface-name
41040           in: path
41041           description: Name given to the interface
41042           required: true
41043           type: string
41044           example: __INTERFACE-NAME__
41045         - name: l3-interface-ipv4-address
41046           in: path
41047           description: IP address
41048           required: true
41049           type: string
41050           example: __L3-INTERFACE-IPV4-ADDRESS__
41051         - name: body
41052           in: body
41053           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
41054           required: true
41055           schema:
41056             $ref: "#/definitions/relationship"
41057     delete:
41058       tags:
41059         - Network
41060       summary: delete an existing relationship
41061       description: delete an existing relationship
41062       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
41063       consumes:
41064         - application/json
41065         - application/xml
41066       produces:
41067         - application/json
41068         - application/xml
41069       responses:
41070         "default":
41071           description: Response codes found in [response codes](https://wiki.onap.org/).
41072       parameters:
41073         - name: pnf-name
41074           in: path
41075           description: unique name of Physical Network Function.
41076           required: true
41077           type: string
41078           example: __PNF-NAME__
41079         - name: interface-name
41080           in: path
41081           description: Name that identifies the physical interface
41082           required: true
41083           type: string
41084           example: __INTERFACE-NAME__
41085         - name: interface-name
41086           in: path
41087           description: Name given to the interface
41088           required: true
41089           type: string
41090           example: __INTERFACE-NAME__
41091         - name: l3-interface-ipv4-address
41092           in: path
41093           description: IP address
41094           required: true
41095           type: string
41096           example: __L3-INTERFACE-IPV4-ADDRESS__
41097   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
41098     get:
41099       tags:
41100         - Network
41101       summary: returns l3-interface-ipv4-address-list
41102       description: returns l3-interface-ipv4-address-list
41103       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41104       produces:
41105         - application/json
41106         - application/xml
41107       responses:
41108         "200":
41109           description: successful operation
41110           schema:
41111               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
41112         "default":
41113           description: Response codes found in [response codes](https://wiki.onap.org/).
41114       parameters:
41115         - name: pnf-name
41116           in: path
41117           description: unique name of Physical Network Function.
41118           required: true
41119           type: string
41120           example: __PNF-NAME__
41121         - name: interface-name
41122           in: path
41123           description: Name that identifies the physical interface
41124           required: true
41125           type: string
41126           example: __INTERFACE-NAME__
41127         - name: interface-name
41128           in: path
41129           description: Name given to the interface
41130           required: true
41131           type: string
41132           example: __INTERFACE-NAME__
41133         - name: l3-interface-ipv4-address
41134           in: path
41135           description: IP address
41136           required: true
41137           type: string
41138           example: __L3-INTERFACE-IPV4-ADDRESS__
41139     put:
41140       tags:
41141         - Network
41142       summary: create or update an existing l3-interface-ipv4-address-list
41143       description: |
41144         Create or update an existing l3-interface-ipv4-address-list.
41145         #
41146         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41147       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41148       consumes:
41149         - application/json
41150         - application/xml
41151       produces:
41152         - application/json
41153         - application/xml
41154       responses:
41155         "default":
41156           description: Response codes found in [response codes](https://wiki.onap.org/).
41157       parameters:
41158         - name: pnf-name
41159           in: path
41160           description: unique name of Physical Network Function.
41161           required: true
41162           type: string
41163           example: __PNF-NAME__
41164         - name: interface-name
41165           in: path
41166           description: Name that identifies the physical interface
41167           required: true
41168           type: string
41169           example: __INTERFACE-NAME__
41170         - name: interface-name
41171           in: path
41172           description: Name given to the interface
41173           required: true
41174           type: string
41175           example: __INTERFACE-NAME__
41176         - name: l3-interface-ipv4-address
41177           in: path
41178           description: IP address
41179           required: true
41180           type: string
41181           example: __L3-INTERFACE-IPV4-ADDRESS__
41182         - name: body
41183           in: body
41184           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
41185           required: true
41186           schema:
41187             $ref: "#/definitions/l3-interface-ipv4-address-list"
41188     patch:
41189       tags:
41190         - Network
41191       summary: update an existing l3-interface-ipv4-address-list
41192       description: |
41193         Update an existing l3-interface-ipv4-address-list
41194         #
41195         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41196         The PUT operation will entirely replace an existing object.
41197         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41198         #
41199         Other differences between PUT and PATCH are:
41200         #
41201         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41202         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41203         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41204       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41205       consumes:
41206         - application/json
41207         - application/xml
41208       produces:
41209         - application/json
41210         - application/xml
41211       responses:
41212         "default":
41213           description: Response codes found in [response codes](https://wiki.onap.org/).
41214       parameters:
41215         - name: pnf-name
41216           in: path
41217           description: unique name of Physical Network Function.
41218           required: true
41219           type: string
41220           example: __PNF-NAME__
41221         - name: interface-name
41222           in: path
41223           description: Name that identifies the physical interface
41224           required: true
41225           type: string
41226           example: __INTERFACE-NAME__
41227         - name: interface-name
41228           in: path
41229           description: Name given to the interface
41230           required: true
41231           type: string
41232           example: __INTERFACE-NAME__
41233         - name: l3-interface-ipv4-address
41234           in: path
41235           description: IP address
41236           required: true
41237           type: string
41238           example: __L3-INTERFACE-IPV4-ADDRESS__
41239         - name: body
41240           in: body
41241           description: l3-interface-ipv4-address-list object that needs to be updated.
41242           required: true
41243           schema:
41244             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
41245     delete:
41246       tags:
41247         - Network
41248       summary: delete an existing l3-interface-ipv4-address-list
41249       description: delete an existing l3-interface-ipv4-address-list
41250       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41251       consumes:
41252         - application/json
41253         - application/xml
41254       produces:
41255         - application/json
41256         - application/xml
41257       responses:
41258         "default":
41259           description: Response codes found in [response codes](https://wiki.onap.org/).
41260       parameters:
41261         - name: pnf-name
41262           in: path
41263           description: unique name of Physical Network Function.
41264           required: true
41265           type: string
41266           example: __PNF-NAME__
41267         - name: interface-name
41268           in: path
41269           description: Name that identifies the physical interface
41270           required: true
41271           type: string
41272           example: __INTERFACE-NAME__
41273         - name: interface-name
41274           in: path
41275           description: Name given to the interface
41276           required: true
41277           type: string
41278           example: __INTERFACE-NAME__
41279         - name: l3-interface-ipv4-address
41280           in: path
41281           description: IP address
41282           required: true
41283           type: string
41284           example: __L3-INTERFACE-IPV4-ADDRESS__
41285         - name: resource-version
41286           in: query
41287           description: resource-version for concurrency
41288           required: true
41289           type: string
41290   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
41291     put:
41292       tags:
41293         - Network
41294       summary: see node definition for valid relationships
41295       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
41296       consumes:
41297         - application/json
41298         - application/xml
41299       produces:
41300         - application/json
41301         - application/xml
41302       responses:
41303         "default":
41304           description: Response codes found in [response codes](https://wiki.onap.org/).
41305       parameters:
41306         - name: pnf-name
41307           in: path
41308           description: unique name of Physical Network Function.
41309           required: true
41310           type: string
41311           example: __PNF-NAME__
41312         - name: interface-name
41313           in: path
41314           description: Name that identifies the physical interface
41315           required: true
41316           type: string
41317           example: __INTERFACE-NAME__
41318         - name: interface-name
41319           in: path
41320           description: Name given to the interface
41321           required: true
41322           type: string
41323           example: __INTERFACE-NAME__
41324         - name: l3-interface-ipv6-address
41325           in: path
41326           description: IP address
41327           required: true
41328           type: string
41329           example: __L3-INTERFACE-IPV6-ADDRESS__
41330         - name: body
41331           in: body
41332           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
41333           required: true
41334           schema:
41335             $ref: "#/definitions/relationship"
41336     delete:
41337       tags:
41338         - Network
41339       summary: delete an existing relationship
41340       description: delete an existing relationship
41341       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
41342       consumes:
41343         - application/json
41344         - application/xml
41345       produces:
41346         - application/json
41347         - application/xml
41348       responses:
41349         "default":
41350           description: Response codes found in [response codes](https://wiki.onap.org/).
41351       parameters:
41352         - name: pnf-name
41353           in: path
41354           description: unique name of Physical Network Function.
41355           required: true
41356           type: string
41357           example: __PNF-NAME__
41358         - name: interface-name
41359           in: path
41360           description: Name that identifies the physical interface
41361           required: true
41362           type: string
41363           example: __INTERFACE-NAME__
41364         - name: interface-name
41365           in: path
41366           description: Name given to the interface
41367           required: true
41368           type: string
41369           example: __INTERFACE-NAME__
41370         - name: l3-interface-ipv6-address
41371           in: path
41372           description: IP address
41373           required: true
41374           type: string
41375           example: __L3-INTERFACE-IPV6-ADDRESS__
41376   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
41377     get:
41378       tags:
41379         - Network
41380       summary: returns l3-interface-ipv6-address-list
41381       description: returns l3-interface-ipv6-address-list
41382       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41383       produces:
41384         - application/json
41385         - application/xml
41386       responses:
41387         "200":
41388           description: successful operation
41389           schema:
41390               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
41391         "default":
41392           description: Response codes found in [response codes](https://wiki.onap.org/).
41393       parameters:
41394         - name: pnf-name
41395           in: path
41396           description: unique name of Physical Network Function.
41397           required: true
41398           type: string
41399           example: __PNF-NAME__
41400         - name: interface-name
41401           in: path
41402           description: Name that identifies the physical interface
41403           required: true
41404           type: string
41405           example: __INTERFACE-NAME__
41406         - name: interface-name
41407           in: path
41408           description: Name given to the interface
41409           required: true
41410           type: string
41411           example: __INTERFACE-NAME__
41412         - name: l3-interface-ipv6-address
41413           in: path
41414           description: IP address
41415           required: true
41416           type: string
41417           example: __L3-INTERFACE-IPV6-ADDRESS__
41418     put:
41419       tags:
41420         - Network
41421       summary: create or update an existing l3-interface-ipv6-address-list
41422       description: |
41423         Create or update an existing l3-interface-ipv6-address-list.
41424         #
41425         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41426       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41427       consumes:
41428         - application/json
41429         - application/xml
41430       produces:
41431         - application/json
41432         - application/xml
41433       responses:
41434         "default":
41435           description: Response codes found in [response codes](https://wiki.onap.org/).
41436       parameters:
41437         - name: pnf-name
41438           in: path
41439           description: unique name of Physical Network Function.
41440           required: true
41441           type: string
41442           example: __PNF-NAME__
41443         - name: interface-name
41444           in: path
41445           description: Name that identifies the physical interface
41446           required: true
41447           type: string
41448           example: __INTERFACE-NAME__
41449         - name: interface-name
41450           in: path
41451           description: Name given to the interface
41452           required: true
41453           type: string
41454           example: __INTERFACE-NAME__
41455         - name: l3-interface-ipv6-address
41456           in: path
41457           description: IP address
41458           required: true
41459           type: string
41460           example: __L3-INTERFACE-IPV6-ADDRESS__
41461         - name: body
41462           in: body
41463           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
41464           required: true
41465           schema:
41466             $ref: "#/definitions/l3-interface-ipv6-address-list"
41467     patch:
41468       tags:
41469         - Network
41470       summary: update an existing l3-interface-ipv6-address-list
41471       description: |
41472         Update an existing l3-interface-ipv6-address-list
41473         #
41474         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41475         The PUT operation will entirely replace an existing object.
41476         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41477         #
41478         Other differences between PUT and PATCH are:
41479         #
41480         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41481         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41482         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41483       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41484       consumes:
41485         - application/json
41486         - application/xml
41487       produces:
41488         - application/json
41489         - application/xml
41490       responses:
41491         "default":
41492           description: Response codes found in [response codes](https://wiki.onap.org/).
41493       parameters:
41494         - name: pnf-name
41495           in: path
41496           description: unique name of Physical Network Function.
41497           required: true
41498           type: string
41499           example: __PNF-NAME__
41500         - name: interface-name
41501           in: path
41502           description: Name that identifies the physical interface
41503           required: true
41504           type: string
41505           example: __INTERFACE-NAME__
41506         - name: interface-name
41507           in: path
41508           description: Name given to the interface
41509           required: true
41510           type: string
41511           example: __INTERFACE-NAME__
41512         - name: l3-interface-ipv6-address
41513           in: path
41514           description: IP address
41515           required: true
41516           type: string
41517           example: __L3-INTERFACE-IPV6-ADDRESS__
41518         - name: body
41519           in: body
41520           description: l3-interface-ipv6-address-list object that needs to be updated.
41521           required: true
41522           schema:
41523             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
41524     delete:
41525       tags:
41526         - Network
41527       summary: delete an existing l3-interface-ipv6-address-list
41528       description: delete an existing l3-interface-ipv6-address-list
41529       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41530       consumes:
41531         - application/json
41532         - application/xml
41533       produces:
41534         - application/json
41535         - application/xml
41536       responses:
41537         "default":
41538           description: Response codes found in [response codes](https://wiki.onap.org/).
41539       parameters:
41540         - name: pnf-name
41541           in: path
41542           description: unique name of Physical Network Function.
41543           required: true
41544           type: string
41545           example: __PNF-NAME__
41546         - name: interface-name
41547           in: path
41548           description: Name that identifies the physical interface
41549           required: true
41550           type: string
41551           example: __INTERFACE-NAME__
41552         - name: interface-name
41553           in: path
41554           description: Name given to the interface
41555           required: true
41556           type: string
41557           example: __INTERFACE-NAME__
41558         - name: l3-interface-ipv6-address
41559           in: path
41560           description: IP address
41561           required: true
41562           type: string
41563           example: __L3-INTERFACE-IPV6-ADDRESS__
41564         - name: resource-version
41565           in: query
41566           description: resource-version for concurrency
41567           required: true
41568           type: string
41569   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
41570     get:
41571       tags:
41572         - Network
41573       summary: returns l-interface
41574       description: returns l-interface
41575       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41576       produces:
41577         - application/json
41578         - application/xml
41579       responses:
41580         "200":
41581           description: successful operation
41582           schema:
41583               $ref: "#/getDefinitions/l-interface"
41584         "default":
41585           description: Response codes found in [response codes](https://wiki.onap.org/).
41586       parameters:
41587         - name: pnf-name
41588           in: path
41589           description: unique name of Physical Network Function.
41590           required: true
41591           type: string
41592           example: __PNF-NAME__
41593         - name: interface-name
41594           in: path
41595           description: Name that identifies the physical interface
41596           required: true
41597           type: string
41598           example: __INTERFACE-NAME__
41599         - name: interface-name
41600           in: path
41601           description: Name given to the interface
41602           required: true
41603           type: string
41604           example: __INTERFACE-NAME__
41605     put:
41606       tags:
41607         - Network
41608       summary: create or update an existing l-interface
41609       description: |
41610         Create or update an existing l-interface.
41611         #
41612         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41613       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41614       consumes:
41615         - application/json
41616         - application/xml
41617       produces:
41618         - application/json
41619         - application/xml
41620       responses:
41621         "default":
41622           description: Response codes found in [response codes](https://wiki.onap.org/).
41623       parameters:
41624         - name: pnf-name
41625           in: path
41626           description: unique name of Physical Network Function.
41627           required: true
41628           type: string
41629           example: __PNF-NAME__
41630         - name: interface-name
41631           in: path
41632           description: Name that identifies the physical interface
41633           required: true
41634           type: string
41635           example: __INTERFACE-NAME__
41636         - name: interface-name
41637           in: path
41638           description: Name given to the interface
41639           required: true
41640           type: string
41641           example: __INTERFACE-NAME__
41642         - name: body
41643           in: body
41644           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
41645           required: true
41646           schema:
41647             $ref: "#/definitions/l-interface"
41648     patch:
41649       tags:
41650         - Network
41651       summary: update an existing l-interface
41652       description: |
41653         Update an existing l-interface
41654         #
41655         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41656         The PUT operation will entirely replace an existing object.
41657         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41658         #
41659         Other differences between PUT and PATCH are:
41660         #
41661         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41662         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41663         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41664       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41665       consumes:
41666         - application/json
41667         - application/xml
41668       produces:
41669         - application/json
41670         - application/xml
41671       responses:
41672         "default":
41673           description: Response codes found in [response codes](https://wiki.onap.org/).
41674       parameters:
41675         - name: pnf-name
41676           in: path
41677           description: unique name of Physical Network Function.
41678           required: true
41679           type: string
41680           example: __PNF-NAME__
41681         - name: interface-name
41682           in: path
41683           description: Name that identifies the physical interface
41684           required: true
41685           type: string
41686           example: __INTERFACE-NAME__
41687         - name: interface-name
41688           in: path
41689           description: Name given to the interface
41690           required: true
41691           type: string
41692           example: __INTERFACE-NAME__
41693         - name: body
41694           in: body
41695           description: l-interface object that needs to be updated.
41696           required: true
41697           schema:
41698             $ref: "#/patchDefinitions/l-interface"
41699     delete:
41700       tags:
41701         - Network
41702       summary: delete an existing l-interface
41703       description: delete an existing l-interface
41704       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
41705       consumes:
41706         - application/json
41707         - application/xml
41708       produces:
41709         - application/json
41710         - application/xml
41711       responses:
41712         "default":
41713           description: Response codes found in [response codes](https://wiki.onap.org/).
41714       parameters:
41715         - name: pnf-name
41716           in: path
41717           description: unique name of Physical Network Function.
41718           required: true
41719           type: string
41720           example: __PNF-NAME__
41721         - name: interface-name
41722           in: path
41723           description: Name that identifies the physical interface
41724           required: true
41725           type: string
41726           example: __INTERFACE-NAME__
41727         - name: interface-name
41728           in: path
41729           description: Name given to the interface
41730           required: true
41731           type: string
41732           example: __INTERFACE-NAME__
41733         - name: resource-version
41734           in: query
41735           description: resource-version for concurrency
41736           required: true
41737           type: string
41738   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
41739     get:
41740       tags:
41741         - Network
41742       summary: returns l-interfaces
41743       description: returns l-interfaces
41744       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
41745       produces:
41746         - application/json
41747         - application/xml
41748       responses:
41749         "200":
41750           description: successful operation
41751           schema:
41752               $ref: "#/getDefinitions/l-interfaces"
41753         "default":
41754           description: Response codes found in [response codes](https://wiki.onap.org/).
41755       parameters:
41756         - name: pnf-name
41757           in: path
41758           description: unique name of Physical Network Function.
41759           required: true
41760           type: string
41761           example: __PNF-NAME__
41762         - name: interface-name
41763           in: path
41764           description: Name that identifies the physical interface
41765           required: true
41766           type: string
41767           example: __INTERFACE-NAME__
41768         - name: interface-name
41769           in: query
41770           description:
41771           required: false
41772           type: string
41773         - name: interface-id
41774           in: query
41775           description:
41776           required: false
41777           type: string
41778         - name: macaddr
41779           in: query
41780           description:
41781           required: false
41782           type: string
41783         - name: network-name
41784           in: query
41785           description:
41786           required: false
41787           type: string
41788   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
41789     get:
41790       tags:
41791         - Network
41792       summary: returns p-interface
41793       description: returns p-interface
41794       operationId: getNetworkPnfsPnfPInterfacesPInterface
41795       produces:
41796         - application/json
41797         - application/xml
41798       responses:
41799         "200":
41800           description: successful operation
41801           schema:
41802               $ref: "#/getDefinitions/p-interface"
41803         "default":
41804           description: Response codes found in [response codes](https://wiki.onap.org/).
41805       parameters:
41806         - name: pnf-name
41807           in: path
41808           description: unique name of Physical Network Function.
41809           required: true
41810           type: string
41811           example: __PNF-NAME__
41812         - name: interface-name
41813           in: path
41814           description: Name that identifies the physical interface
41815           required: true
41816           type: string
41817           example: __INTERFACE-NAME__
41818     put:
41819       tags:
41820         - Network
41821       summary: create or update an existing p-interface
41822       description: |
41823         Create or update an existing p-interface.
41824         #
41825         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41826       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
41827       consumes:
41828         - application/json
41829         - application/xml
41830       produces:
41831         - application/json
41832         - application/xml
41833       responses:
41834         "default":
41835           description: Response codes found in [response codes](https://wiki.onap.org/).
41836       parameters:
41837         - name: pnf-name
41838           in: path
41839           description: unique name of Physical Network Function.
41840           required: true
41841           type: string
41842           example: __PNF-NAME__
41843         - name: interface-name
41844           in: path
41845           description: Name that identifies the physical interface
41846           required: true
41847           type: string
41848           example: __INTERFACE-NAME__
41849         - name: body
41850           in: body
41851           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfPInterfacesPInterface.json)
41852           required: true
41853           schema:
41854             $ref: "#/definitions/p-interface"
41855     patch:
41856       tags:
41857         - Network
41858       summary: update an existing p-interface
41859       description: |
41860         Update an existing p-interface
41861         #
41862         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41863         The PUT operation will entirely replace an existing object.
41864         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41865         #
41866         Other differences between PUT and PATCH are:
41867         #
41868         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41869         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41870         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41871       operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
41872       consumes:
41873         - application/json
41874         - application/xml
41875       produces:
41876         - application/json
41877         - application/xml
41878       responses:
41879         "default":
41880           description: Response codes found in [response codes](https://wiki.onap.org/).
41881       parameters:
41882         - name: pnf-name
41883           in: path
41884           description: unique name of Physical Network Function.
41885           required: true
41886           type: string
41887           example: __PNF-NAME__
41888         - name: interface-name
41889           in: path
41890           description: Name that identifies the physical interface
41891           required: true
41892           type: string
41893           example: __INTERFACE-NAME__
41894         - name: body
41895           in: body
41896           description: p-interface object that needs to be updated.
41897           required: true
41898           schema:
41899             $ref: "#/patchDefinitions/p-interface"
41900     delete:
41901       tags:
41902         - Network
41903       summary: delete an existing p-interface
41904       description: delete an existing p-interface
41905       operationId: deleteNetworkPnfsPnfPInterfacesPInterface
41906       consumes:
41907         - application/json
41908         - application/xml
41909       produces:
41910         - application/json
41911         - application/xml
41912       responses:
41913         "default":
41914           description: Response codes found in [response codes](https://wiki.onap.org/).
41915       parameters:
41916         - name: pnf-name
41917           in: path
41918           description: unique name of Physical Network Function.
41919           required: true
41920           type: string
41921           example: __PNF-NAME__
41922         - name: interface-name
41923           in: path
41924           description: Name that identifies the physical interface
41925           required: true
41926           type: string
41927           example: __INTERFACE-NAME__
41928         - name: resource-version
41929           in: query
41930           description: resource-version for concurrency
41931           required: true
41932           type: string
41933   /network/pnfs/pnf/{pnf-name}/p-interfaces:
41934     get:
41935       tags:
41936         - Network
41937       summary: returns p-interfaces
41938       description: returns p-interfaces
41939       operationId: getNetworkPnfsPnfPInterfaces
41940       produces:
41941         - application/json
41942         - application/xml
41943       responses:
41944         "200":
41945           description: successful operation
41946           schema:
41947               $ref: "#/getDefinitions/p-interfaces"
41948         "default":
41949           description: Response codes found in [response codes](https://wiki.onap.org/).
41950       parameters:
41951         - name: pnf-name
41952           in: path
41953           description: unique name of Physical Network Function.
41954           required: true
41955           type: string
41956           example: __PNF-NAME__
41957         - name: interface-name
41958           in: query
41959           description:
41960           required: false
41961           type: string
41962         - name: prov-status
41963           in: query
41964           description:
41965           required: false
41966           type: string
41967   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
41968     put:
41969       tags:
41970         - Network
41971       summary: see node definition for valid relationships
41972       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
41973       consumes:
41974         - application/json
41975         - application/xml
41976       produces:
41977         - application/json
41978         - application/xml
41979       responses:
41980         "default":
41981           description: Response codes found in [response codes](https://wiki.onap.org/).
41982       parameters:
41983         - name: pnf-name
41984           in: path
41985           description: unique name of Physical Network Function.
41986           required: true
41987           type: string
41988           example: __PNF-NAME__
41989         - name: interface-name
41990           in: path
41991           description: Name that identifies the link aggregate interface
41992           required: true
41993           type: string
41994           example: __INTERFACE-NAME__
41995         - name: body
41996           in: body
41997           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterface.json)
41998           required: true
41999           schema:
42000             $ref: "#/definitions/relationship"
42001     delete:
42002       tags:
42003         - Network
42004       summary: delete an existing relationship
42005       description: delete an existing relationship
42006       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
42007       consumes:
42008         - application/json
42009         - application/xml
42010       produces:
42011         - application/json
42012         - application/xml
42013       responses:
42014         "default":
42015           description: Response codes found in [response codes](https://wiki.onap.org/).
42016       parameters:
42017         - name: pnf-name
42018           in: path
42019           description: unique name of Physical Network Function.
42020           required: true
42021           type: string
42022           example: __PNF-NAME__
42023         - name: interface-name
42024           in: path
42025           description: Name that identifies the link aggregate interface
42026           required: true
42027           type: string
42028           example: __INTERFACE-NAME__
42029   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
42030     put:
42031       tags:
42032         - Network
42033       summary: see node definition for valid relationships
42034       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
42035       consumes:
42036         - application/json
42037         - application/xml
42038       produces:
42039         - application/json
42040         - application/xml
42041       responses:
42042         "default":
42043           description: Response codes found in [response codes](https://wiki.onap.org/).
42044       parameters:
42045         - name: pnf-name
42046           in: path
42047           description: unique name of Physical Network Function.
42048           required: true
42049           type: string
42050           example: __PNF-NAME__
42051         - name: interface-name
42052           in: path
42053           description: Name that identifies the link aggregate interface
42054           required: true
42055           type: string
42056           example: __INTERFACE-NAME__
42057         - name: interface-name
42058           in: path
42059           description: Name given to the interface
42060           required: true
42061           type: string
42062           example: __INTERFACE-NAME__
42063         - name: vlan-interface
42064           in: path
42065           description: String that identifies the interface
42066           required: true
42067           type: string
42068           example: __VLAN-INTERFACE__
42069         - name: body
42070           in: body
42071           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
42072           required: true
42073           schema:
42074             $ref: "#/definitions/relationship"
42075     delete:
42076       tags:
42077         - Network
42078       summary: delete an existing relationship
42079       description: delete an existing relationship
42080       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
42081       consumes:
42082         - application/json
42083         - application/xml
42084       produces:
42085         - application/json
42086         - application/xml
42087       responses:
42088         "default":
42089           description: Response codes found in [response codes](https://wiki.onap.org/).
42090       parameters:
42091         - name: pnf-name
42092           in: path
42093           description: unique name of Physical Network Function.
42094           required: true
42095           type: string
42096           example: __PNF-NAME__
42097         - name: interface-name
42098           in: path
42099           description: Name that identifies the link aggregate interface
42100           required: true
42101           type: string
42102           example: __INTERFACE-NAME__
42103         - name: interface-name
42104           in: path
42105           description: Name given to the interface
42106           required: true
42107           type: string
42108           example: __INTERFACE-NAME__
42109         - name: vlan-interface
42110           in: path
42111           description: String that identifies the interface
42112           required: true
42113           type: string
42114           example: __VLAN-INTERFACE__
42115   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
42116     put:
42117       tags:
42118         - Network
42119       summary: see node definition for valid relationships
42120       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
42121       consumes:
42122         - application/json
42123         - application/xml
42124       produces:
42125         - application/json
42126         - application/xml
42127       responses:
42128         "default":
42129           description: Response codes found in [response codes](https://wiki.onap.org/).
42130       parameters:
42131         - name: pnf-name
42132           in: path
42133           description: unique name of Physical Network Function.
42134           required: true
42135           type: string
42136           example: __PNF-NAME__
42137         - name: interface-name
42138           in: path
42139           description: Name that identifies the link aggregate interface
42140           required: true
42141           type: string
42142           example: __INTERFACE-NAME__
42143         - name: interface-name
42144           in: path
42145           description: Name given to the interface
42146           required: true
42147           type: string
42148           example: __INTERFACE-NAME__
42149         - name: vlan-interface
42150           in: path
42151           description: String that identifies the interface
42152           required: true
42153           type: string
42154           example: __VLAN-INTERFACE__
42155         - name: l3-interface-ipv4-address
42156           in: path
42157           description: IP address
42158           required: true
42159           type: string
42160           example: __L3-INTERFACE-IPV4-ADDRESS__
42161         - name: body
42162           in: body
42163           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42164           required: true
42165           schema:
42166             $ref: "#/definitions/relationship"
42167     delete:
42168       tags:
42169         - Network
42170       summary: delete an existing relationship
42171       description: delete an existing relationship
42172       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
42173       consumes:
42174         - application/json
42175         - application/xml
42176       produces:
42177         - application/json
42178         - application/xml
42179       responses:
42180         "default":
42181           description: Response codes found in [response codes](https://wiki.onap.org/).
42182       parameters:
42183         - name: pnf-name
42184           in: path
42185           description: unique name of Physical Network Function.
42186           required: true
42187           type: string
42188           example: __PNF-NAME__
42189         - name: interface-name
42190           in: path
42191           description: Name that identifies the link aggregate interface
42192           required: true
42193           type: string
42194           example: __INTERFACE-NAME__
42195         - name: interface-name
42196           in: path
42197           description: Name given to the interface
42198           required: true
42199           type: string
42200           example: __INTERFACE-NAME__
42201         - name: vlan-interface
42202           in: path
42203           description: String that identifies the interface
42204           required: true
42205           type: string
42206           example: __VLAN-INTERFACE__
42207         - name: l3-interface-ipv4-address
42208           in: path
42209           description: IP address
42210           required: true
42211           type: string
42212           example: __L3-INTERFACE-IPV4-ADDRESS__
42213   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
42214     get:
42215       tags:
42216         - Network
42217       summary: returns l3-interface-ipv4-address-list
42218       description: returns l3-interface-ipv4-address-list
42219       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42220       produces:
42221         - application/json
42222         - application/xml
42223       responses:
42224         "200":
42225           description: successful operation
42226           schema:
42227               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
42228         "default":
42229           description: Response codes found in [response codes](https://wiki.onap.org/).
42230       parameters:
42231         - name: pnf-name
42232           in: path
42233           description: unique name of Physical Network Function.
42234           required: true
42235           type: string
42236           example: __PNF-NAME__
42237         - name: interface-name
42238           in: path
42239           description: Name that identifies the link aggregate interface
42240           required: true
42241           type: string
42242           example: __INTERFACE-NAME__
42243         - name: interface-name
42244           in: path
42245           description: Name given to the interface
42246           required: true
42247           type: string
42248           example: __INTERFACE-NAME__
42249         - name: vlan-interface
42250           in: path
42251           description: String that identifies the interface
42252           required: true
42253           type: string
42254           example: __VLAN-INTERFACE__
42255         - name: l3-interface-ipv4-address
42256           in: path
42257           description: IP address
42258           required: true
42259           type: string
42260           example: __L3-INTERFACE-IPV4-ADDRESS__
42261     put:
42262       tags:
42263         - Network
42264       summary: create or update an existing l3-interface-ipv4-address-list
42265       description: |
42266         Create or update an existing l3-interface-ipv4-address-list.
42267         #
42268         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42269       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42270       consumes:
42271         - application/json
42272         - application/xml
42273       produces:
42274         - application/json
42275         - application/xml
42276       responses:
42277         "default":
42278           description: Response codes found in [response codes](https://wiki.onap.org/).
42279       parameters:
42280         - name: pnf-name
42281           in: path
42282           description: unique name of Physical Network Function.
42283           required: true
42284           type: string
42285           example: __PNF-NAME__
42286         - name: interface-name
42287           in: path
42288           description: Name that identifies the link aggregate interface
42289           required: true
42290           type: string
42291           example: __INTERFACE-NAME__
42292         - name: interface-name
42293           in: path
42294           description: Name given to the interface
42295           required: true
42296           type: string
42297           example: __INTERFACE-NAME__
42298         - name: vlan-interface
42299           in: path
42300           description: String that identifies the interface
42301           required: true
42302           type: string
42303           example: __VLAN-INTERFACE__
42304         - name: l3-interface-ipv4-address
42305           in: path
42306           description: IP address
42307           required: true
42308           type: string
42309           example: __L3-INTERFACE-IPV4-ADDRESS__
42310         - name: body
42311           in: body
42312           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42313           required: true
42314           schema:
42315             $ref: "#/definitions/l3-interface-ipv4-address-list"
42316     patch:
42317       tags:
42318         - Network
42319       summary: update an existing l3-interface-ipv4-address-list
42320       description: |
42321         Update an existing l3-interface-ipv4-address-list
42322         #
42323         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42324         The PUT operation will entirely replace an existing object.
42325         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42326         #
42327         Other differences between PUT and PATCH are:
42328         #
42329         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42330         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42331         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42332       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42333       consumes:
42334         - application/json
42335         - application/xml
42336       produces:
42337         - application/json
42338         - application/xml
42339       responses:
42340         "default":
42341           description: Response codes found in [response codes](https://wiki.onap.org/).
42342       parameters:
42343         - name: pnf-name
42344           in: path
42345           description: unique name of Physical Network Function.
42346           required: true
42347           type: string
42348           example: __PNF-NAME__
42349         - name: interface-name
42350           in: path
42351           description: Name that identifies the link aggregate interface
42352           required: true
42353           type: string
42354           example: __INTERFACE-NAME__
42355         - name: interface-name
42356           in: path
42357           description: Name given to the interface
42358           required: true
42359           type: string
42360           example: __INTERFACE-NAME__
42361         - name: vlan-interface
42362           in: path
42363           description: String that identifies the interface
42364           required: true
42365           type: string
42366           example: __VLAN-INTERFACE__
42367         - name: l3-interface-ipv4-address
42368           in: path
42369           description: IP address
42370           required: true
42371           type: string
42372           example: __L3-INTERFACE-IPV4-ADDRESS__
42373         - name: body
42374           in: body
42375           description: l3-interface-ipv4-address-list object that needs to be updated.
42376           required: true
42377           schema:
42378             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
42379     delete:
42380       tags:
42381         - Network
42382       summary: delete an existing l3-interface-ipv4-address-list
42383       description: delete an existing l3-interface-ipv4-address-list
42384       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42385       consumes:
42386         - application/json
42387         - application/xml
42388       produces:
42389         - application/json
42390         - application/xml
42391       responses:
42392         "default":
42393           description: Response codes found in [response codes](https://wiki.onap.org/).
42394       parameters:
42395         - name: pnf-name
42396           in: path
42397           description: unique name of Physical Network Function.
42398           required: true
42399           type: string
42400           example: __PNF-NAME__
42401         - name: interface-name
42402           in: path
42403           description: Name that identifies the link aggregate interface
42404           required: true
42405           type: string
42406           example: __INTERFACE-NAME__
42407         - name: interface-name
42408           in: path
42409           description: Name given to the interface
42410           required: true
42411           type: string
42412           example: __INTERFACE-NAME__
42413         - name: vlan-interface
42414           in: path
42415           description: String that identifies the interface
42416           required: true
42417           type: string
42418           example: __VLAN-INTERFACE__
42419         - name: l3-interface-ipv4-address
42420           in: path
42421           description: IP address
42422           required: true
42423           type: string
42424           example: __L3-INTERFACE-IPV4-ADDRESS__
42425         - name: resource-version
42426           in: query
42427           description: resource-version for concurrency
42428           required: true
42429           type: string
42430   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
42431     put:
42432       tags:
42433         - Network
42434       summary: see node definition for valid relationships
42435       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42436       consumes:
42437         - application/json
42438         - application/xml
42439       produces:
42440         - application/json
42441         - application/xml
42442       responses:
42443         "default":
42444           description: Response codes found in [response codes](https://wiki.onap.org/).
42445       parameters:
42446         - name: pnf-name
42447           in: path
42448           description: unique name of Physical Network Function.
42449           required: true
42450           type: string
42451           example: __PNF-NAME__
42452         - name: interface-name
42453           in: path
42454           description: Name that identifies the link aggregate interface
42455           required: true
42456           type: string
42457           example: __INTERFACE-NAME__
42458         - name: interface-name
42459           in: path
42460           description: Name given to the interface
42461           required: true
42462           type: string
42463           example: __INTERFACE-NAME__
42464         - name: vlan-interface
42465           in: path
42466           description: String that identifies the interface
42467           required: true
42468           type: string
42469           example: __VLAN-INTERFACE__
42470         - name: l3-interface-ipv6-address
42471           in: path
42472           description: IP address
42473           required: true
42474           type: string
42475           example: __L3-INTERFACE-IPV6-ADDRESS__
42476         - name: body
42477           in: body
42478           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42479           required: true
42480           schema:
42481             $ref: "#/definitions/relationship"
42482     delete:
42483       tags:
42484         - Network
42485       summary: delete an existing relationship
42486       description: delete an existing relationship
42487       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42488       consumes:
42489         - application/json
42490         - application/xml
42491       produces:
42492         - application/json
42493         - application/xml
42494       responses:
42495         "default":
42496           description: Response codes found in [response codes](https://wiki.onap.org/).
42497       parameters:
42498         - name: pnf-name
42499           in: path
42500           description: unique name of Physical Network Function.
42501           required: true
42502           type: string
42503           example: __PNF-NAME__
42504         - name: interface-name
42505           in: path
42506           description: Name that identifies the link aggregate interface
42507           required: true
42508           type: string
42509           example: __INTERFACE-NAME__
42510         - name: interface-name
42511           in: path
42512           description: Name given to the interface
42513           required: true
42514           type: string
42515           example: __INTERFACE-NAME__
42516         - name: vlan-interface
42517           in: path
42518           description: String that identifies the interface
42519           required: true
42520           type: string
42521           example: __VLAN-INTERFACE__
42522         - name: l3-interface-ipv6-address
42523           in: path
42524           description: IP address
42525           required: true
42526           type: string
42527           example: __L3-INTERFACE-IPV6-ADDRESS__
42528   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
42529     get:
42530       tags:
42531         - Network
42532       summary: returns l3-interface-ipv6-address-list
42533       description: returns l3-interface-ipv6-address-list
42534       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42535       produces:
42536         - application/json
42537         - application/xml
42538       responses:
42539         "200":
42540           description: successful operation
42541           schema:
42542               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42543         "default":
42544           description: Response codes found in [response codes](https://wiki.onap.org/).
42545       parameters:
42546         - name: pnf-name
42547           in: path
42548           description: unique name of Physical Network Function.
42549           required: true
42550           type: string
42551           example: __PNF-NAME__
42552         - name: interface-name
42553           in: path
42554           description: Name that identifies the link aggregate interface
42555           required: true
42556           type: string
42557           example: __INTERFACE-NAME__
42558         - name: interface-name
42559           in: path
42560           description: Name given to the interface
42561           required: true
42562           type: string
42563           example: __INTERFACE-NAME__
42564         - name: vlan-interface
42565           in: path
42566           description: String that identifies the interface
42567           required: true
42568           type: string
42569           example: __VLAN-INTERFACE__
42570         - name: l3-interface-ipv6-address
42571           in: path
42572           description: IP address
42573           required: true
42574           type: string
42575           example: __L3-INTERFACE-IPV6-ADDRESS__
42576     put:
42577       tags:
42578         - Network
42579       summary: create or update an existing l3-interface-ipv6-address-list
42580       description: |
42581         Create or update an existing l3-interface-ipv6-address-list.
42582         #
42583         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42584       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42585       consumes:
42586         - application/json
42587         - application/xml
42588       produces:
42589         - application/json
42590         - application/xml
42591       responses:
42592         "default":
42593           description: Response codes found in [response codes](https://wiki.onap.org/).
42594       parameters:
42595         - name: pnf-name
42596           in: path
42597           description: unique name of Physical Network Function.
42598           required: true
42599           type: string
42600           example: __PNF-NAME__
42601         - name: interface-name
42602           in: path
42603           description: Name that identifies the link aggregate interface
42604           required: true
42605           type: string
42606           example: __INTERFACE-NAME__
42607         - name: interface-name
42608           in: path
42609           description: Name given to the interface
42610           required: true
42611           type: string
42612           example: __INTERFACE-NAME__
42613         - name: vlan-interface
42614           in: path
42615           description: String that identifies the interface
42616           required: true
42617           type: string
42618           example: __VLAN-INTERFACE__
42619         - name: l3-interface-ipv6-address
42620           in: path
42621           description: IP address
42622           required: true
42623           type: string
42624           example: __L3-INTERFACE-IPV6-ADDRESS__
42625         - name: body
42626           in: body
42627           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42628           required: true
42629           schema:
42630             $ref: "#/definitions/l3-interface-ipv6-address-list"
42631     patch:
42632       tags:
42633         - Network
42634       summary: update an existing l3-interface-ipv6-address-list
42635       description: |
42636         Update an existing l3-interface-ipv6-address-list
42637         #
42638         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42639         The PUT operation will entirely replace an existing object.
42640         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42641         #
42642         Other differences between PUT and PATCH are:
42643         #
42644         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42645         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42646         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42647       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42648       consumes:
42649         - application/json
42650         - application/xml
42651       produces:
42652         - application/json
42653         - application/xml
42654       responses:
42655         "default":
42656           description: Response codes found in [response codes](https://wiki.onap.org/).
42657       parameters:
42658         - name: pnf-name
42659           in: path
42660           description: unique name of Physical Network Function.
42661           required: true
42662           type: string
42663           example: __PNF-NAME__
42664         - name: interface-name
42665           in: path
42666           description: Name that identifies the link aggregate interface
42667           required: true
42668           type: string
42669           example: __INTERFACE-NAME__
42670         - name: interface-name
42671           in: path
42672           description: Name given to the interface
42673           required: true
42674           type: string
42675           example: __INTERFACE-NAME__
42676         - name: vlan-interface
42677           in: path
42678           description: String that identifies the interface
42679           required: true
42680           type: string
42681           example: __VLAN-INTERFACE__
42682         - name: l3-interface-ipv6-address
42683           in: path
42684           description: IP address
42685           required: true
42686           type: string
42687           example: __L3-INTERFACE-IPV6-ADDRESS__
42688         - name: body
42689           in: body
42690           description: l3-interface-ipv6-address-list object that needs to be updated.
42691           required: true
42692           schema:
42693             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
42694     delete:
42695       tags:
42696         - Network
42697       summary: delete an existing l3-interface-ipv6-address-list
42698       description: delete an existing l3-interface-ipv6-address-list
42699       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42700       consumes:
42701         - application/json
42702         - application/xml
42703       produces:
42704         - application/json
42705         - application/xml
42706       responses:
42707         "default":
42708           description: Response codes found in [response codes](https://wiki.onap.org/).
42709       parameters:
42710         - name: pnf-name
42711           in: path
42712           description: unique name of Physical Network Function.
42713           required: true
42714           type: string
42715           example: __PNF-NAME__
42716         - name: interface-name
42717           in: path
42718           description: Name that identifies the link aggregate interface
42719           required: true
42720           type: string
42721           example: __INTERFACE-NAME__
42722         - name: interface-name
42723           in: path
42724           description: Name given to the interface
42725           required: true
42726           type: string
42727           example: __INTERFACE-NAME__
42728         - name: vlan-interface
42729           in: path
42730           description: String that identifies the interface
42731           required: true
42732           type: string
42733           example: __VLAN-INTERFACE__
42734         - name: l3-interface-ipv6-address
42735           in: path
42736           description: IP address
42737           required: true
42738           type: string
42739           example: __L3-INTERFACE-IPV6-ADDRESS__
42740         - name: resource-version
42741           in: query
42742           description: resource-version for concurrency
42743           required: true
42744           type: string
42745   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
42746     get:
42747       tags:
42748         - Network
42749       summary: returns vlan
42750       description: returns vlan
42751       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42752       produces:
42753         - application/json
42754         - application/xml
42755       responses:
42756         "200":
42757           description: successful operation
42758           schema:
42759               $ref: "#/getDefinitions/vlan"
42760         "default":
42761           description: Response codes found in [response codes](https://wiki.onap.org/).
42762       parameters:
42763         - name: pnf-name
42764           in: path
42765           description: unique name of Physical Network Function.
42766           required: true
42767           type: string
42768           example: __PNF-NAME__
42769         - name: interface-name
42770           in: path
42771           description: Name that identifies the link aggregate interface
42772           required: true
42773           type: string
42774           example: __INTERFACE-NAME__
42775         - name: interface-name
42776           in: path
42777           description: Name given to the interface
42778           required: true
42779           type: string
42780           example: __INTERFACE-NAME__
42781         - name: vlan-interface
42782           in: path
42783           description: String that identifies the interface
42784           required: true
42785           type: string
42786           example: __VLAN-INTERFACE__
42787     put:
42788       tags:
42789         - Network
42790       summary: create or update an existing vlan
42791       description: |
42792         Create or update an existing vlan.
42793         #
42794         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42795       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42796       consumes:
42797         - application/json
42798         - application/xml
42799       produces:
42800         - application/json
42801         - application/xml
42802       responses:
42803         "default":
42804           description: Response codes found in [response codes](https://wiki.onap.org/).
42805       parameters:
42806         - name: pnf-name
42807           in: path
42808           description: unique name of Physical Network Function.
42809           required: true
42810           type: string
42811           example: __PNF-NAME__
42812         - name: interface-name
42813           in: path
42814           description: Name that identifies the link aggregate interface
42815           required: true
42816           type: string
42817           example: __INTERFACE-NAME__
42818         - name: interface-name
42819           in: path
42820           description: Name given to the interface
42821           required: true
42822           type: string
42823           example: __INTERFACE-NAME__
42824         - name: vlan-interface
42825           in: path
42826           description: String that identifies the interface
42827           required: true
42828           type: string
42829           example: __VLAN-INTERFACE__
42830         - name: body
42831           in: body
42832           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
42833           required: true
42834           schema:
42835             $ref: "#/definitions/vlan"
42836     patch:
42837       tags:
42838         - Network
42839       summary: update an existing vlan
42840       description: |
42841         Update an existing vlan
42842         #
42843         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42844         The PUT operation will entirely replace an existing object.
42845         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42846         #
42847         Other differences between PUT and PATCH are:
42848         #
42849         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42850         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42851         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42852       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42853       consumes:
42854         - application/json
42855         - application/xml
42856       produces:
42857         - application/json
42858         - application/xml
42859       responses:
42860         "default":
42861           description: Response codes found in [response codes](https://wiki.onap.org/).
42862       parameters:
42863         - name: pnf-name
42864           in: path
42865           description: unique name of Physical Network Function.
42866           required: true
42867           type: string
42868           example: __PNF-NAME__
42869         - name: interface-name
42870           in: path
42871           description: Name that identifies the link aggregate interface
42872           required: true
42873           type: string
42874           example: __INTERFACE-NAME__
42875         - name: interface-name
42876           in: path
42877           description: Name given to the interface
42878           required: true
42879           type: string
42880           example: __INTERFACE-NAME__
42881         - name: vlan-interface
42882           in: path
42883           description: String that identifies the interface
42884           required: true
42885           type: string
42886           example: __VLAN-INTERFACE__
42887         - name: body
42888           in: body
42889           description: vlan object that needs to be updated.
42890           required: true
42891           schema:
42892             $ref: "#/patchDefinitions/vlan"
42893     delete:
42894       tags:
42895         - Network
42896       summary: delete an existing vlan
42897       description: delete an existing vlan
42898       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
42899       consumes:
42900         - application/json
42901         - application/xml
42902       produces:
42903         - application/json
42904         - application/xml
42905       responses:
42906         "default":
42907           description: Response codes found in [response codes](https://wiki.onap.org/).
42908       parameters:
42909         - name: pnf-name
42910           in: path
42911           description: unique name of Physical Network Function.
42912           required: true
42913           type: string
42914           example: __PNF-NAME__
42915         - name: interface-name
42916           in: path
42917           description: Name that identifies the link aggregate interface
42918           required: true
42919           type: string
42920           example: __INTERFACE-NAME__
42921         - name: interface-name
42922           in: path
42923           description: Name given to the interface
42924           required: true
42925           type: string
42926           example: __INTERFACE-NAME__
42927         - name: vlan-interface
42928           in: path
42929           description: String that identifies the interface
42930           required: true
42931           type: string
42932           example: __VLAN-INTERFACE__
42933         - name: resource-version
42934           in: query
42935           description: resource-version for concurrency
42936           required: true
42937           type: string
42938   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
42939     get:
42940       tags:
42941         - Network
42942       summary: returns vlans
42943       description: returns vlans
42944       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
42945       produces:
42946         - application/json
42947         - application/xml
42948       responses:
42949         "200":
42950           description: successful operation
42951           schema:
42952               $ref: "#/getDefinitions/vlans"
42953         "default":
42954           description: Response codes found in [response codes](https://wiki.onap.org/).
42955       parameters:
42956         - name: pnf-name
42957           in: path
42958           description: unique name of Physical Network Function.
42959           required: true
42960           type: string
42961           example: __PNF-NAME__
42962         - name: interface-name
42963           in: path
42964           description: Name that identifies the link aggregate interface
42965           required: true
42966           type: string
42967           example: __INTERFACE-NAME__
42968         - name: interface-name
42969           in: path
42970           description: Name given to the interface
42971           required: true
42972           type: string
42973           example: __INTERFACE-NAME__
42974         - name: vlan-interface
42975           in: query
42976           description:
42977           required: false
42978           type: string
42979         - name: vlan-id-inner
42980           in: query
42981           description:
42982           required: false
42983           type: integer
42984           format: int64
42985         - name: vpn-key
42986           in: query
42987           description:
42988           required: false
42989           type: string
42990   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
42991     put:
42992       tags:
42993         - Network
42994       summary: see node definition for valid relationships
42995       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
42996       consumes:
42997         - application/json
42998         - application/xml
42999       produces:
43000         - application/json
43001         - application/xml
43002       responses:
43003         "default":
43004           description: Response codes found in [response codes](https://wiki.onap.org/).
43005       parameters:
43006         - name: pnf-name
43007           in: path
43008           description: unique name of Physical Network Function.
43009           required: true
43010           type: string
43011           example: __PNF-NAME__
43012         - name: interface-name
43013           in: path
43014           description: Name that identifies the link aggregate interface
43015           required: true
43016           type: string
43017           example: __INTERFACE-NAME__
43018         - name: interface-name
43019           in: path
43020           description: Name given to the interface
43021           required: true
43022           type: string
43023           example: __INTERFACE-NAME__
43024         - name: pci-id
43025           in: path
43026           description: PCI ID used to identify the sriov-vf
43027           required: true
43028           type: string
43029           example: __PCI-ID__
43030         - name: body
43031           in: body
43032           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
43033           required: true
43034           schema:
43035             $ref: "#/definitions/relationship"
43036     delete:
43037       tags:
43038         - Network
43039       summary: delete an existing relationship
43040       description: delete an existing relationship
43041       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
43042       consumes:
43043         - application/json
43044         - application/xml
43045       produces:
43046         - application/json
43047         - application/xml
43048       responses:
43049         "default":
43050           description: Response codes found in [response codes](https://wiki.onap.org/).
43051       parameters:
43052         - name: pnf-name
43053           in: path
43054           description: unique name of Physical Network Function.
43055           required: true
43056           type: string
43057           example: __PNF-NAME__
43058         - name: interface-name
43059           in: path
43060           description: Name that identifies the link aggregate interface
43061           required: true
43062           type: string
43063           example: __INTERFACE-NAME__
43064         - name: interface-name
43065           in: path
43066           description: Name given to the interface
43067           required: true
43068           type: string
43069           example: __INTERFACE-NAME__
43070         - name: pci-id
43071           in: path
43072           description: PCI ID used to identify the sriov-vf
43073           required: true
43074           type: string
43075           example: __PCI-ID__
43076   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
43077     get:
43078       tags:
43079         - Network
43080       summary: returns sriov-vf
43081       description: returns sriov-vf
43082       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43083       produces:
43084         - application/json
43085         - application/xml
43086       responses:
43087         "200":
43088           description: successful operation
43089           schema:
43090               $ref: "#/getDefinitions/sriov-vf"
43091         "default":
43092           description: Response codes found in [response codes](https://wiki.onap.org/).
43093       parameters:
43094         - name: pnf-name
43095           in: path
43096           description: unique name of Physical Network Function.
43097           required: true
43098           type: string
43099           example: __PNF-NAME__
43100         - name: interface-name
43101           in: path
43102           description: Name that identifies the link aggregate interface
43103           required: true
43104           type: string
43105           example: __INTERFACE-NAME__
43106         - name: interface-name
43107           in: path
43108           description: Name given to the interface
43109           required: true
43110           type: string
43111           example: __INTERFACE-NAME__
43112         - name: pci-id
43113           in: path
43114           description: PCI ID used to identify the sriov-vf
43115           required: true
43116           type: string
43117           example: __PCI-ID__
43118     put:
43119       tags:
43120         - Network
43121       summary: create or update an existing sriov-vf
43122       description: |
43123         Create or update an existing sriov-vf.
43124         #
43125         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43126       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43127       consumes:
43128         - application/json
43129         - application/xml
43130       produces:
43131         - application/json
43132         - application/xml
43133       responses:
43134         "default":
43135           description: Response codes found in [response codes](https://wiki.onap.org/).
43136       parameters:
43137         - name: pnf-name
43138           in: path
43139           description: unique name of Physical Network Function.
43140           required: true
43141           type: string
43142           example: __PNF-NAME__
43143         - name: interface-name
43144           in: path
43145           description: Name that identifies the link aggregate interface
43146           required: true
43147           type: string
43148           example: __INTERFACE-NAME__
43149         - name: interface-name
43150           in: path
43151           description: Name given to the interface
43152           required: true
43153           type: string
43154           example: __INTERFACE-NAME__
43155         - name: pci-id
43156           in: path
43157           description: PCI ID used to identify the sriov-vf
43158           required: true
43159           type: string
43160           example: __PCI-ID__
43161         - name: body
43162           in: body
43163           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
43164           required: true
43165           schema:
43166             $ref: "#/definitions/sriov-vf"
43167     patch:
43168       tags:
43169         - Network
43170       summary: update an existing sriov-vf
43171       description: |
43172         Update an existing sriov-vf
43173         #
43174         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43175         The PUT operation will entirely replace an existing object.
43176         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43177         #
43178         Other differences between PUT and PATCH are:
43179         #
43180         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43181         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43182         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43183       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43184       consumes:
43185         - application/json
43186         - application/xml
43187       produces:
43188         - application/json
43189         - application/xml
43190       responses:
43191         "default":
43192           description: Response codes found in [response codes](https://wiki.onap.org/).
43193       parameters:
43194         - name: pnf-name
43195           in: path
43196           description: unique name of Physical Network Function.
43197           required: true
43198           type: string
43199           example: __PNF-NAME__
43200         - name: interface-name
43201           in: path
43202           description: Name that identifies the link aggregate interface
43203           required: true
43204           type: string
43205           example: __INTERFACE-NAME__
43206         - name: interface-name
43207           in: path
43208           description: Name given to the interface
43209           required: true
43210           type: string
43211           example: __INTERFACE-NAME__
43212         - name: pci-id
43213           in: path
43214           description: PCI ID used to identify the sriov-vf
43215           required: true
43216           type: string
43217           example: __PCI-ID__
43218         - name: body
43219           in: body
43220           description: sriov-vf object that needs to be updated.
43221           required: true
43222           schema:
43223             $ref: "#/patchDefinitions/sriov-vf"
43224     delete:
43225       tags:
43226         - Network
43227       summary: delete an existing sriov-vf
43228       description: delete an existing sriov-vf
43229       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43230       consumes:
43231         - application/json
43232         - application/xml
43233       produces:
43234         - application/json
43235         - application/xml
43236       responses:
43237         "default":
43238           description: Response codes found in [response codes](https://wiki.onap.org/).
43239       parameters:
43240         - name: pnf-name
43241           in: path
43242           description: unique name of Physical Network Function.
43243           required: true
43244           type: string
43245           example: __PNF-NAME__
43246         - name: interface-name
43247           in: path
43248           description: Name that identifies the link aggregate interface
43249           required: true
43250           type: string
43251           example: __INTERFACE-NAME__
43252         - name: interface-name
43253           in: path
43254           description: Name given to the interface
43255           required: true
43256           type: string
43257           example: __INTERFACE-NAME__
43258         - name: pci-id
43259           in: path
43260           description: PCI ID used to identify the sriov-vf
43261           required: true
43262           type: string
43263           example: __PCI-ID__
43264         - name: resource-version
43265           in: query
43266           description: resource-version for concurrency
43267           required: true
43268           type: string
43269   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
43270     get:
43271       tags:
43272         - Network
43273       summary: returns sriov-vfs
43274       description: returns sriov-vfs
43275       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
43276       produces:
43277         - application/json
43278         - application/xml
43279       responses:
43280         "200":
43281           description: successful operation
43282           schema:
43283               $ref: "#/getDefinitions/sriov-vfs"
43284         "default":
43285           description: Response codes found in [response codes](https://wiki.onap.org/).
43286       parameters:
43287         - name: pnf-name
43288           in: path
43289           description: unique name of Physical Network Function.
43290           required: true
43291           type: string
43292           example: __PNF-NAME__
43293         - name: interface-name
43294           in: path
43295           description: Name that identifies the link aggregate interface
43296           required: true
43297           type: string
43298           example: __INTERFACE-NAME__
43299         - name: interface-name
43300           in: path
43301           description: Name given to the interface
43302           required: true
43303           type: string
43304           example: __INTERFACE-NAME__
43305         - name: pci-id
43306           in: query
43307           description:
43308           required: false
43309           type: string
43310         - name: vf-vlan-filter
43311           in: query
43312           description:
43313           required: false
43314           type: string
43315         - name: vf-mac-filter
43316           in: query
43317           description:
43318           required: false
43319           type: string
43320         - name: vf-vlan-strip
43321           in: query
43322           description:
43323           required: false
43324           type: boolean
43325         - name: neutron-network-id
43326           in: query
43327           description:
43328           required: false
43329           type: string
43330   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
43331     put:
43332       tags:
43333         - Network
43334       summary: see node definition for valid relationships
43335       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
43336       consumes:
43337         - application/json
43338         - application/xml
43339       produces:
43340         - application/json
43341         - application/xml
43342       responses:
43343         "default":
43344           description: Response codes found in [response codes](https://wiki.onap.org/).
43345       parameters:
43346         - name: pnf-name
43347           in: path
43348           description: unique name of Physical Network Function.
43349           required: true
43350           type: string
43351           example: __PNF-NAME__
43352         - name: interface-name
43353           in: path
43354           description: Name that identifies the link aggregate interface
43355           required: true
43356           type: string
43357           example: __INTERFACE-NAME__
43358         - name: interface-name
43359           in: path
43360           description: Name given to the interface
43361           required: true
43362           type: string
43363           example: __INTERFACE-NAME__
43364         - name: body
43365           in: body
43366           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
43367           required: true
43368           schema:
43369             $ref: "#/definitions/relationship"
43370     delete:
43371       tags:
43372         - Network
43373       summary: delete an existing relationship
43374       description: delete an existing relationship
43375       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
43376       consumes:
43377         - application/json
43378         - application/xml
43379       produces:
43380         - application/json
43381         - application/xml
43382       responses:
43383         "default":
43384           description: Response codes found in [response codes](https://wiki.onap.org/).
43385       parameters:
43386         - name: pnf-name
43387           in: path
43388           description: unique name of Physical Network Function.
43389           required: true
43390           type: string
43391           example: __PNF-NAME__
43392         - name: interface-name
43393           in: path
43394           description: Name that identifies the link aggregate interface
43395           required: true
43396           type: string
43397           example: __INTERFACE-NAME__
43398         - name: interface-name
43399           in: path
43400           description: Name given to the interface
43401           required: true
43402           type: string
43403           example: __INTERFACE-NAME__
43404   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
43405     put:
43406       tags:
43407         - Network
43408       summary: see node definition for valid relationships
43409       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43410       consumes:
43411         - application/json
43412         - application/xml
43413       produces:
43414         - application/json
43415         - application/xml
43416       responses:
43417         "default":
43418           description: Response codes found in [response codes](https://wiki.onap.org/).
43419       parameters:
43420         - name: pnf-name
43421           in: path
43422           description: unique name of Physical Network Function.
43423           required: true
43424           type: string
43425           example: __PNF-NAME__
43426         - name: interface-name
43427           in: path
43428           description: Name that identifies the link aggregate interface
43429           required: true
43430           type: string
43431           example: __INTERFACE-NAME__
43432         - name: interface-name
43433           in: path
43434           description: Name given to the interface
43435           required: true
43436           type: string
43437           example: __INTERFACE-NAME__
43438         - name: l3-interface-ipv4-address
43439           in: path
43440           description: IP address
43441           required: true
43442           type: string
43443           example: __L3-INTERFACE-IPV4-ADDRESS__
43444         - name: body
43445           in: body
43446           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43447           required: true
43448           schema:
43449             $ref: "#/definitions/relationship"
43450     delete:
43451       tags:
43452         - Network
43453       summary: delete an existing relationship
43454       description: delete an existing relationship
43455       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43456       consumes:
43457         - application/json
43458         - application/xml
43459       produces:
43460         - application/json
43461         - application/xml
43462       responses:
43463         "default":
43464           description: Response codes found in [response codes](https://wiki.onap.org/).
43465       parameters:
43466         - name: pnf-name
43467           in: path
43468           description: unique name of Physical Network Function.
43469           required: true
43470           type: string
43471           example: __PNF-NAME__
43472         - name: interface-name
43473           in: path
43474           description: Name that identifies the link aggregate interface
43475           required: true
43476           type: string
43477           example: __INTERFACE-NAME__
43478         - name: interface-name
43479           in: path
43480           description: Name given to the interface
43481           required: true
43482           type: string
43483           example: __INTERFACE-NAME__
43484         - name: l3-interface-ipv4-address
43485           in: path
43486           description: IP address
43487           required: true
43488           type: string
43489           example: __L3-INTERFACE-IPV4-ADDRESS__
43490   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
43491     get:
43492       tags:
43493         - Network
43494       summary: returns l3-interface-ipv4-address-list
43495       description: returns l3-interface-ipv4-address-list
43496       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43497       produces:
43498         - application/json
43499         - application/xml
43500       responses:
43501         "200":
43502           description: successful operation
43503           schema:
43504               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
43505         "default":
43506           description: Response codes found in [response codes](https://wiki.onap.org/).
43507       parameters:
43508         - name: pnf-name
43509           in: path
43510           description: unique name of Physical Network Function.
43511           required: true
43512           type: string
43513           example: __PNF-NAME__
43514         - name: interface-name
43515           in: path
43516           description: Name that identifies the link aggregate interface
43517           required: true
43518           type: string
43519           example: __INTERFACE-NAME__
43520         - name: interface-name
43521           in: path
43522           description: Name given to the interface
43523           required: true
43524           type: string
43525           example: __INTERFACE-NAME__
43526         - name: l3-interface-ipv4-address
43527           in: path
43528           description: IP address
43529           required: true
43530           type: string
43531           example: __L3-INTERFACE-IPV4-ADDRESS__
43532     put:
43533       tags:
43534         - Network
43535       summary: create or update an existing l3-interface-ipv4-address-list
43536       description: |
43537         Create or update an existing l3-interface-ipv4-address-list.
43538         #
43539         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43540       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43541       consumes:
43542         - application/json
43543         - application/xml
43544       produces:
43545         - application/json
43546         - application/xml
43547       responses:
43548         "default":
43549           description: Response codes found in [response codes](https://wiki.onap.org/).
43550       parameters:
43551         - name: pnf-name
43552           in: path
43553           description: unique name of Physical Network Function.
43554           required: true
43555           type: string
43556           example: __PNF-NAME__
43557         - name: interface-name
43558           in: path
43559           description: Name that identifies the link aggregate interface
43560           required: true
43561           type: string
43562           example: __INTERFACE-NAME__
43563         - name: interface-name
43564           in: path
43565           description: Name given to the interface
43566           required: true
43567           type: string
43568           example: __INTERFACE-NAME__
43569         - name: l3-interface-ipv4-address
43570           in: path
43571           description: IP address
43572           required: true
43573           type: string
43574           example: __L3-INTERFACE-IPV4-ADDRESS__
43575         - name: body
43576           in: body
43577           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43578           required: true
43579           schema:
43580             $ref: "#/definitions/l3-interface-ipv4-address-list"
43581     patch:
43582       tags:
43583         - Network
43584       summary: update an existing l3-interface-ipv4-address-list
43585       description: |
43586         Update an existing l3-interface-ipv4-address-list
43587         #
43588         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43589         The PUT operation will entirely replace an existing object.
43590         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43591         #
43592         Other differences between PUT and PATCH are:
43593         #
43594         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43595         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43596         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43597       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43598       consumes:
43599         - application/json
43600         - application/xml
43601       produces:
43602         - application/json
43603         - application/xml
43604       responses:
43605         "default":
43606           description: Response codes found in [response codes](https://wiki.onap.org/).
43607       parameters:
43608         - name: pnf-name
43609           in: path
43610           description: unique name of Physical Network Function.
43611           required: true
43612           type: string
43613           example: __PNF-NAME__
43614         - name: interface-name
43615           in: path
43616           description: Name that identifies the link aggregate interface
43617           required: true
43618           type: string
43619           example: __INTERFACE-NAME__
43620         - name: interface-name
43621           in: path
43622           description: Name given to the interface
43623           required: true
43624           type: string
43625           example: __INTERFACE-NAME__
43626         - name: l3-interface-ipv4-address
43627           in: path
43628           description: IP address
43629           required: true
43630           type: string
43631           example: __L3-INTERFACE-IPV4-ADDRESS__
43632         - name: body
43633           in: body
43634           description: l3-interface-ipv4-address-list object that needs to be updated.
43635           required: true
43636           schema:
43637             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
43638     delete:
43639       tags:
43640         - Network
43641       summary: delete an existing l3-interface-ipv4-address-list
43642       description: delete an existing l3-interface-ipv4-address-list
43643       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43644       consumes:
43645         - application/json
43646         - application/xml
43647       produces:
43648         - application/json
43649         - application/xml
43650       responses:
43651         "default":
43652           description: Response codes found in [response codes](https://wiki.onap.org/).
43653       parameters:
43654         - name: pnf-name
43655           in: path
43656           description: unique name of Physical Network Function.
43657           required: true
43658           type: string
43659           example: __PNF-NAME__
43660         - name: interface-name
43661           in: path
43662           description: Name that identifies the link aggregate interface
43663           required: true
43664           type: string
43665           example: __INTERFACE-NAME__
43666         - name: interface-name
43667           in: path
43668           description: Name given to the interface
43669           required: true
43670           type: string
43671           example: __INTERFACE-NAME__
43672         - name: l3-interface-ipv4-address
43673           in: path
43674           description: IP address
43675           required: true
43676           type: string
43677           example: __L3-INTERFACE-IPV4-ADDRESS__
43678         - name: resource-version
43679           in: query
43680           description: resource-version for concurrency
43681           required: true
43682           type: string
43683   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
43684     put:
43685       tags:
43686         - Network
43687       summary: see node definition for valid relationships
43688       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
43689       consumes:
43690         - application/json
43691         - application/xml
43692       produces:
43693         - application/json
43694         - application/xml
43695       responses:
43696         "default":
43697           description: Response codes found in [response codes](https://wiki.onap.org/).
43698       parameters:
43699         - name: pnf-name
43700           in: path
43701           description: unique name of Physical Network Function.
43702           required: true
43703           type: string
43704           example: __PNF-NAME__
43705         - name: interface-name
43706           in: path
43707           description: Name that identifies the link aggregate interface
43708           required: true
43709           type: string
43710           example: __INTERFACE-NAME__
43711         - name: interface-name
43712           in: path
43713           description: Name given to the interface
43714           required: true
43715           type: string
43716           example: __INTERFACE-NAME__
43717         - name: l3-interface-ipv6-address
43718           in: path
43719           description: IP address
43720           required: true
43721           type: string
43722           example: __L3-INTERFACE-IPV6-ADDRESS__
43723         - name: body
43724           in: body
43725           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
43726           required: true
43727           schema:
43728             $ref: "#/definitions/relationship"
43729     delete:
43730       tags:
43731         - Network
43732       summary: delete an existing relationship
43733       description: delete an existing relationship
43734       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
43735       consumes:
43736         - application/json
43737         - application/xml
43738       produces:
43739         - application/json
43740         - application/xml
43741       responses:
43742         "default":
43743           description: Response codes found in [response codes](https://wiki.onap.org/).
43744       parameters:
43745         - name: pnf-name
43746           in: path
43747           description: unique name of Physical Network Function.
43748           required: true
43749           type: string
43750           example: __PNF-NAME__
43751         - name: interface-name
43752           in: path
43753           description: Name that identifies the link aggregate interface
43754           required: true
43755           type: string
43756           example: __INTERFACE-NAME__
43757         - name: interface-name
43758           in: path
43759           description: Name given to the interface
43760           required: true
43761           type: string
43762           example: __INTERFACE-NAME__
43763         - name: l3-interface-ipv6-address
43764           in: path
43765           description: IP address
43766           required: true
43767           type: string
43768           example: __L3-INTERFACE-IPV6-ADDRESS__
43769   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
43770     get:
43771       tags:
43772         - Network
43773       summary: returns l3-interface-ipv6-address-list
43774       description: returns l3-interface-ipv6-address-list
43775       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43776       produces:
43777         - application/json
43778         - application/xml
43779       responses:
43780         "200":
43781           description: successful operation
43782           schema:
43783               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
43784         "default":
43785           description: Response codes found in [response codes](https://wiki.onap.org/).
43786       parameters:
43787         - name: pnf-name
43788           in: path
43789           description: unique name of Physical Network Function.
43790           required: true
43791           type: string
43792           example: __PNF-NAME__
43793         - name: interface-name
43794           in: path
43795           description: Name that identifies the link aggregate interface
43796           required: true
43797           type: string
43798           example: __INTERFACE-NAME__
43799         - name: interface-name
43800           in: path
43801           description: Name given to the interface
43802           required: true
43803           type: string
43804           example: __INTERFACE-NAME__
43805         - name: l3-interface-ipv6-address
43806           in: path
43807           description: IP address
43808           required: true
43809           type: string
43810           example: __L3-INTERFACE-IPV6-ADDRESS__
43811     put:
43812       tags:
43813         - Network
43814       summary: create or update an existing l3-interface-ipv6-address-list
43815       description: |
43816         Create or update an existing l3-interface-ipv6-address-list.
43817         #
43818         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43819       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43820       consumes:
43821         - application/json
43822         - application/xml
43823       produces:
43824         - application/json
43825         - application/xml
43826       responses:
43827         "default":
43828           description: Response codes found in [response codes](https://wiki.onap.org/).
43829       parameters:
43830         - name: pnf-name
43831           in: path
43832           description: unique name of Physical Network Function.
43833           required: true
43834           type: string
43835           example: __PNF-NAME__
43836         - name: interface-name
43837           in: path
43838           description: Name that identifies the link aggregate interface
43839           required: true
43840           type: string
43841           example: __INTERFACE-NAME__
43842         - name: interface-name
43843           in: path
43844           description: Name given to the interface
43845           required: true
43846           type: string
43847           example: __INTERFACE-NAME__
43848         - name: l3-interface-ipv6-address
43849           in: path
43850           description: IP address
43851           required: true
43852           type: string
43853           example: __L3-INTERFACE-IPV6-ADDRESS__
43854         - name: body
43855           in: body
43856           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
43857           required: true
43858           schema:
43859             $ref: "#/definitions/l3-interface-ipv6-address-list"
43860     patch:
43861       tags:
43862         - Network
43863       summary: update an existing l3-interface-ipv6-address-list
43864       description: |
43865         Update an existing l3-interface-ipv6-address-list
43866         #
43867         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43868         The PUT operation will entirely replace an existing object.
43869         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43870         #
43871         Other differences between PUT and PATCH are:
43872         #
43873         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43874         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43875         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43876       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43877       consumes:
43878         - application/json
43879         - application/xml
43880       produces:
43881         - application/json
43882         - application/xml
43883       responses:
43884         "default":
43885           description: Response codes found in [response codes](https://wiki.onap.org/).
43886       parameters:
43887         - name: pnf-name
43888           in: path
43889           description: unique name of Physical Network Function.
43890           required: true
43891           type: string
43892           example: __PNF-NAME__
43893         - name: interface-name
43894           in: path
43895           description: Name that identifies the link aggregate interface
43896           required: true
43897           type: string
43898           example: __INTERFACE-NAME__
43899         - name: interface-name
43900           in: path
43901           description: Name given to the interface
43902           required: true
43903           type: string
43904           example: __INTERFACE-NAME__
43905         - name: l3-interface-ipv6-address
43906           in: path
43907           description: IP address
43908           required: true
43909           type: string
43910           example: __L3-INTERFACE-IPV6-ADDRESS__
43911         - name: body
43912           in: body
43913           description: l3-interface-ipv6-address-list object that needs to be updated.
43914           required: true
43915           schema:
43916             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
43917     delete:
43918       tags:
43919         - Network
43920       summary: delete an existing l3-interface-ipv6-address-list
43921       description: delete an existing l3-interface-ipv6-address-list
43922       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43923       consumes:
43924         - application/json
43925         - application/xml
43926       produces:
43927         - application/json
43928         - application/xml
43929       responses:
43930         "default":
43931           description: Response codes found in [response codes](https://wiki.onap.org/).
43932       parameters:
43933         - name: pnf-name
43934           in: path
43935           description: unique name of Physical Network Function.
43936           required: true
43937           type: string
43938           example: __PNF-NAME__
43939         - name: interface-name
43940           in: path
43941           description: Name that identifies the link aggregate interface
43942           required: true
43943           type: string
43944           example: __INTERFACE-NAME__
43945         - name: interface-name
43946           in: path
43947           description: Name given to the interface
43948           required: true
43949           type: string
43950           example: __INTERFACE-NAME__
43951         - name: l3-interface-ipv6-address
43952           in: path
43953           description: IP address
43954           required: true
43955           type: string
43956           example: __L3-INTERFACE-IPV6-ADDRESS__
43957         - name: resource-version
43958           in: query
43959           description: resource-version for concurrency
43960           required: true
43961           type: string
43962   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
43963     get:
43964       tags:
43965         - Network
43966       summary: returns l-interface
43967       description: returns l-interface
43968       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
43969       produces:
43970         - application/json
43971         - application/xml
43972       responses:
43973         "200":
43974           description: successful operation
43975           schema:
43976               $ref: "#/getDefinitions/l-interface"
43977         "default":
43978           description: Response codes found in [response codes](https://wiki.onap.org/).
43979       parameters:
43980         - name: pnf-name
43981           in: path
43982           description: unique name of Physical Network Function.
43983           required: true
43984           type: string
43985           example: __PNF-NAME__
43986         - name: interface-name
43987           in: path
43988           description: Name that identifies the link aggregate interface
43989           required: true
43990           type: string
43991           example: __INTERFACE-NAME__
43992         - name: interface-name
43993           in: path
43994           description: Name given to the interface
43995           required: true
43996           type: string
43997           example: __INTERFACE-NAME__
43998     put:
43999       tags:
44000         - Network
44001       summary: create or update an existing l-interface
44002       description: |
44003         Create or update an existing l-interface.
44004         #
44005         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44006       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
44007       consumes:
44008         - application/json
44009         - application/xml
44010       produces:
44011         - application/json
44012         - application/xml
44013       responses:
44014         "default":
44015           description: Response codes found in [response codes](https://wiki.onap.org/).
44016       parameters:
44017         - name: pnf-name
44018           in: path
44019           description: unique name of Physical Network Function.
44020           required: true
44021           type: string
44022           example: __PNF-NAME__
44023         - name: interface-name
44024           in: path
44025           description: Name that identifies the link aggregate interface
44026           required: true
44027           type: string
44028           example: __INTERFACE-NAME__
44029         - name: interface-name
44030           in: path
44031           description: Name given to the interface
44032           required: true
44033           type: string
44034           example: __INTERFACE-NAME__
44035         - name: body
44036           in: body
44037           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
44038           required: true
44039           schema:
44040             $ref: "#/definitions/l-interface"
44041     patch:
44042       tags:
44043         - Network
44044       summary: update an existing l-interface
44045       description: |
44046         Update an existing l-interface
44047         #
44048         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44049         The PUT operation will entirely replace an existing object.
44050         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44051         #
44052         Other differences between PUT and PATCH are:
44053         #
44054         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44055         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44056         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44057       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
44058       consumes:
44059         - application/json
44060         - application/xml
44061       produces:
44062         - application/json
44063         - application/xml
44064       responses:
44065         "default":
44066           description: Response codes found in [response codes](https://wiki.onap.org/).
44067       parameters:
44068         - name: pnf-name
44069           in: path
44070           description: unique name of Physical Network Function.
44071           required: true
44072           type: string
44073           example: __PNF-NAME__
44074         - name: interface-name
44075           in: path
44076           description: Name that identifies the link aggregate interface
44077           required: true
44078           type: string
44079           example: __INTERFACE-NAME__
44080         - name: interface-name
44081           in: path
44082           description: Name given to the interface
44083           required: true
44084           type: string
44085           example: __INTERFACE-NAME__
44086         - name: body
44087           in: body
44088           description: l-interface object that needs to be updated.
44089           required: true
44090           schema:
44091             $ref: "#/patchDefinitions/l-interface"
44092     delete:
44093       tags:
44094         - Network
44095       summary: delete an existing l-interface
44096       description: delete an existing l-interface
44097       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
44098       consumes:
44099         - application/json
44100         - application/xml
44101       produces:
44102         - application/json
44103         - application/xml
44104       responses:
44105         "default":
44106           description: Response codes found in [response codes](https://wiki.onap.org/).
44107       parameters:
44108         - name: pnf-name
44109           in: path
44110           description: unique name of Physical Network Function.
44111           required: true
44112           type: string
44113           example: __PNF-NAME__
44114         - name: interface-name
44115           in: path
44116           description: Name that identifies the link aggregate interface
44117           required: true
44118           type: string
44119           example: __INTERFACE-NAME__
44120         - name: interface-name
44121           in: path
44122           description: Name given to the interface
44123           required: true
44124           type: string
44125           example: __INTERFACE-NAME__
44126         - name: resource-version
44127           in: query
44128           description: resource-version for concurrency
44129           required: true
44130           type: string
44131   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
44132     get:
44133       tags:
44134         - Network
44135       summary: returns l-interfaces
44136       description: returns l-interfaces
44137       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
44138       produces:
44139         - application/json
44140         - application/xml
44141       responses:
44142         "200":
44143           description: successful operation
44144           schema:
44145               $ref: "#/getDefinitions/l-interfaces"
44146         "default":
44147           description: Response codes found in [response codes](https://wiki.onap.org/).
44148       parameters:
44149         - name: pnf-name
44150           in: path
44151           description: unique name of Physical Network Function.
44152           required: true
44153           type: string
44154           example: __PNF-NAME__
44155         - name: interface-name
44156           in: path
44157           description: Name that identifies the link aggregate interface
44158           required: true
44159           type: string
44160           example: __INTERFACE-NAME__
44161         - name: interface-name
44162           in: query
44163           description:
44164           required: false
44165           type: string
44166         - name: interface-id
44167           in: query
44168           description:
44169           required: false
44170           type: string
44171         - name: macaddr
44172           in: query
44173           description:
44174           required: false
44175           type: string
44176         - name: network-name
44177           in: query
44178           description:
44179           required: false
44180           type: string
44181   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
44182     get:
44183       tags:
44184         - Network
44185       summary: returns lag-interface
44186       description: returns lag-interface
44187       operationId: getNetworkPnfsPnfLagInterfacesLagInterface
44188       produces:
44189         - application/json
44190         - application/xml
44191       responses:
44192         "200":
44193           description: successful operation
44194           schema:
44195               $ref: "#/getDefinitions/lag-interface"
44196         "default":
44197           description: Response codes found in [response codes](https://wiki.onap.org/).
44198       parameters:
44199         - name: pnf-name
44200           in: path
44201           description: unique name of Physical Network Function.
44202           required: true
44203           type: string
44204           example: __PNF-NAME__
44205         - name: interface-name
44206           in: path
44207           description: Name that identifies the link aggregate interface
44208           required: true
44209           type: string
44210           example: __INTERFACE-NAME__
44211     put:
44212       tags:
44213         - Network
44214       summary: create or update an existing lag-interface
44215       description: |
44216         Create or update an existing lag-interface.
44217         #
44218         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44219       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
44220       consumes:
44221         - application/json
44222         - application/xml
44223       produces:
44224         - application/json
44225         - application/xml
44226       responses:
44227         "default":
44228           description: Response codes found in [response codes](https://wiki.onap.org/).
44229       parameters:
44230         - name: pnf-name
44231           in: path
44232           description: unique name of Physical Network Function.
44233           required: true
44234           type: string
44235           example: __PNF-NAME__
44236         - name: interface-name
44237           in: path
44238           description: Name that identifies the link aggregate interface
44239           required: true
44240           type: string
44241           example: __INTERFACE-NAME__
44242         - name: body
44243           in: body
44244           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnfLagInterfacesLagInterface.json)
44245           required: true
44246           schema:
44247             $ref: "#/definitions/lag-interface"
44248     patch:
44249       tags:
44250         - Network
44251       summary: update an existing lag-interface
44252       description: |
44253         Update an existing lag-interface
44254         #
44255         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44256         The PUT operation will entirely replace an existing object.
44257         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44258         #
44259         Other differences between PUT and PATCH are:
44260         #
44261         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44262         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44263         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44264       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
44265       consumes:
44266         - application/json
44267         - application/xml
44268       produces:
44269         - application/json
44270         - application/xml
44271       responses:
44272         "default":
44273           description: Response codes found in [response codes](https://wiki.onap.org/).
44274       parameters:
44275         - name: pnf-name
44276           in: path
44277           description: unique name of Physical Network Function.
44278           required: true
44279           type: string
44280           example: __PNF-NAME__
44281         - name: interface-name
44282           in: path
44283           description: Name that identifies the link aggregate interface
44284           required: true
44285           type: string
44286           example: __INTERFACE-NAME__
44287         - name: body
44288           in: body
44289           description: lag-interface object that needs to be updated.
44290           required: true
44291           schema:
44292             $ref: "#/patchDefinitions/lag-interface"
44293     delete:
44294       tags:
44295         - Network
44296       summary: delete an existing lag-interface
44297       description: delete an existing lag-interface
44298       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
44299       consumes:
44300         - application/json
44301         - application/xml
44302       produces:
44303         - application/json
44304         - application/xml
44305       responses:
44306         "default":
44307           description: Response codes found in [response codes](https://wiki.onap.org/).
44308       parameters:
44309         - name: pnf-name
44310           in: path
44311           description: unique name of Physical Network Function.
44312           required: true
44313           type: string
44314           example: __PNF-NAME__
44315         - name: interface-name
44316           in: path
44317           description: Name that identifies the link aggregate interface
44318           required: true
44319           type: string
44320           example: __INTERFACE-NAME__
44321         - name: resource-version
44322           in: query
44323           description: resource-version for concurrency
44324           required: true
44325           type: string
44326   /network/pnfs/pnf/{pnf-name}/lag-interfaces:
44327     get:
44328       tags:
44329         - Network
44330       summary: returns lag-interfaces
44331       description: returns lag-interfaces
44332       operationId: getNetworkPnfsPnfLagInterfaces
44333       produces:
44334         - application/json
44335         - application/xml
44336       responses:
44337         "200":
44338           description: successful operation
44339           schema:
44340               $ref: "#/getDefinitions/lag-interfaces"
44341         "default":
44342           description: Response codes found in [response codes](https://wiki.onap.org/).
44343       parameters:
44344         - name: pnf-name
44345           in: path
44346           description: unique name of Physical Network Function.
44347           required: true
44348           type: string
44349           example: __PNF-NAME__
44350         - name: interface-name
44351           in: query
44352           description:
44353           required: false
44354           type: string
44355         - name: interface-id
44356           in: query
44357           description:
44358           required: false
44359           type: string
44360         - name: interface-role
44361           in: query
44362           description:
44363           required: false
44364           type: string
44365   /network/pnfs/pnf/{pnf-name}:
44366     get:
44367       tags:
44368         - Network
44369       summary: returns pnf
44370       description: returns pnf
44371       operationId: getNetworkPnfsPnf
44372       produces:
44373         - application/json
44374         - application/xml
44375       responses:
44376         "200":
44377           description: successful operation
44378           schema:
44379               $ref: "#/getDefinitions/pnf"
44380         "default":
44381           description: Response codes found in [response codes](https://wiki.onap.org/).
44382       parameters:
44383         - name: pnf-name
44384           in: path
44385           description: unique name of Physical Network Function.
44386           required: true
44387           type: string
44388           example: __PNF-NAME__
44389     put:
44390       tags:
44391         - Network
44392       summary: create or update an existing pnf
44393       description: |
44394         Create or update an existing pnf.
44395         #
44396         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44397       operationId: createOrUpdateNetworkPnfsPnf
44398       consumes:
44399         - application/json
44400         - application/xml
44401       produces:
44402         - application/json
44403         - application/xml
44404       responses:
44405         "default":
44406           description: Response codes found in [response codes](https://wiki.onap.org/).
44407       parameters:
44408         - name: pnf-name
44409           in: path
44410           description: unique name of Physical Network Function.
44411           required: true
44412           type: string
44413           example: __PNF-NAME__
44414         - name: body
44415           in: body
44416           description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPnfsPnf.json)
44417           required: true
44418           schema:
44419             $ref: "#/definitions/pnf"
44420     patch:
44421       tags:
44422         - Network
44423       summary: update an existing pnf
44424       description: |
44425         Update an existing pnf
44426         #
44427         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44428         The PUT operation will entirely replace an existing object.
44429         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44430         #
44431         Other differences between PUT and PATCH are:
44432         #
44433         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44434         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44435         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44436       operationId: UpdateNetworkPnfsPnf
44437       consumes:
44438         - application/json
44439         - application/xml
44440       produces:
44441         - application/json
44442         - application/xml
44443       responses:
44444         "default":
44445           description: Response codes found in [response codes](https://wiki.onap.org/).
44446       parameters:
44447         - name: pnf-name
44448           in: path
44449           description: unique name of Physical Network Function.
44450           required: true
44451           type: string
44452           example: __PNF-NAME__
44453         - name: body
44454           in: body
44455           description: pnf object that needs to be updated.
44456           required: true
44457           schema:
44458             $ref: "#/patchDefinitions/pnf"
44459     delete:
44460       tags:
44461         - Network
44462       summary: delete an existing pnf
44463       description: delete an existing pnf
44464       operationId: deleteNetworkPnfsPnf
44465       consumes:
44466         - application/json
44467         - application/xml
44468       produces:
44469         - application/json
44470         - application/xml
44471       responses:
44472         "default":
44473           description: Response codes found in [response codes](https://wiki.onap.org/).
44474       parameters:
44475         - name: pnf-name
44476           in: path
44477           description: unique name of Physical Network Function.
44478           required: true
44479           type: string
44480           example: __PNF-NAME__
44481         - name: resource-version
44482           in: query
44483           description: resource-version for concurrency
44484           required: true
44485           type: string
44486   /network/pnfs:
44487     get:
44488       tags:
44489         - Network
44490       summary: returns pnfs
44491       description: returns pnfs
44492       operationId: getNetworkPnfs
44493       produces:
44494         - application/json
44495         - application/xml
44496       responses:
44497         "200":
44498           description: successful operation
44499           schema:
44500               $ref: "#/getDefinitions/pnfs"
44501         "default":
44502           description: Response codes found in [response codes](https://wiki.onap.org/).
44503       parameters:
44504         - name: pnf-name
44505           in: query
44506           description:
44507           required: false
44508           type: string
44509         - name: inv-status
44510           in: query
44511           description:
44512           required: false
44513           type: string
44514   /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
44515     put:
44516       tags:
44517         - Network
44518       summary: see node definition for valid relationships
44519       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
44520       consumes:
44521         - application/json
44522         - application/xml
44523       produces:
44524         - application/json
44525         - application/xml
44526       responses:
44527         "default":
44528           description: Response codes found in [response codes](https://wiki.onap.org/).
44529       parameters:
44530         - name: link-name
44531           in: path
44532           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44533           required: true
44534           type: string
44535           example: __LINK-NAME__
44536         - name: body
44537           in: body
44538           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPhysicalLinksPhysicalLink.json)
44539           required: true
44540           schema:
44541             $ref: "#/definitions/relationship"
44542     delete:
44543       tags:
44544         - Network
44545       summary: delete an existing relationship
44546       description: delete an existing relationship
44547       operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
44548       consumes:
44549         - application/json
44550         - application/xml
44551       produces:
44552         - application/json
44553         - application/xml
44554       responses:
44555         "default":
44556           description: Response codes found in [response codes](https://wiki.onap.org/).
44557       parameters:
44558         - name: link-name
44559           in: path
44560           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44561           required: true
44562           type: string
44563           example: __LINK-NAME__
44564   /network/physical-links/physical-link/{link-name}:
44565     get:
44566       tags:
44567         - Network
44568       summary: returns physical-link
44569       description: returns physical-link
44570       operationId: getNetworkPhysicalLinksPhysicalLink
44571       produces:
44572         - application/json
44573         - application/xml
44574       responses:
44575         "200":
44576           description: successful operation
44577           schema:
44578               $ref: "#/getDefinitions/physical-link"
44579         "default":
44580           description: Response codes found in [response codes](https://wiki.onap.org/).
44581       parameters:
44582         - name: link-name
44583           in: path
44584           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44585           required: true
44586           type: string
44587           example: __LINK-NAME__
44588     put:
44589       tags:
44590         - Network
44591       summary: create or update an existing physical-link
44592       description: |
44593         Create or update an existing physical-link.
44594         #
44595         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44596       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
44597       consumes:
44598         - application/json
44599         - application/xml
44600       produces:
44601         - application/json
44602         - application/xml
44603       responses:
44604         "default":
44605           description: Response codes found in [response codes](https://wiki.onap.org/).
44606       parameters:
44607         - name: link-name
44608           in: path
44609           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44610           required: true
44611           type: string
44612           example: __LINK-NAME__
44613         - name: body
44614           in: body
44615           description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkPhysicalLinksPhysicalLink.json)
44616           required: true
44617           schema:
44618             $ref: "#/definitions/physical-link"
44619     patch:
44620       tags:
44621         - Network
44622       summary: update an existing physical-link
44623       description: |
44624         Update an existing physical-link
44625         #
44626         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44627         The PUT operation will entirely replace an existing object.
44628         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44629         #
44630         Other differences between PUT and PATCH are:
44631         #
44632         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44633         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44634         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44635       operationId: UpdateNetworkPhysicalLinksPhysicalLink
44636       consumes:
44637         - application/json
44638         - application/xml
44639       produces:
44640         - application/json
44641         - application/xml
44642       responses:
44643         "default":
44644           description: Response codes found in [response codes](https://wiki.onap.org/).
44645       parameters:
44646         - name: link-name
44647           in: path
44648           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44649           required: true
44650           type: string
44651           example: __LINK-NAME__
44652         - name: body
44653           in: body
44654           description: physical-link object that needs to be updated.
44655           required: true
44656           schema:
44657             $ref: "#/patchDefinitions/physical-link"
44658     delete:
44659       tags:
44660         - Network
44661       summary: delete an existing physical-link
44662       description: delete an existing physical-link
44663       operationId: deleteNetworkPhysicalLinksPhysicalLink
44664       consumes:
44665         - application/json
44666         - application/xml
44667       produces:
44668         - application/json
44669         - application/xml
44670       responses:
44671         "default":
44672           description: Response codes found in [response codes](https://wiki.onap.org/).
44673       parameters:
44674         - name: link-name
44675           in: path
44676           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
44677           required: true
44678           type: string
44679           example: __LINK-NAME__
44680         - name: resource-version
44681           in: query
44682           description: resource-version for concurrency
44683           required: true
44684           type: string
44685   /network/physical-links:
44686     get:
44687       tags:
44688         - Network
44689       summary: returns physical-links
44690       description: returns physical-links
44691       operationId: getNetworkPhysicalLinks
44692       produces:
44693         - application/json
44694         - application/xml
44695       responses:
44696         "200":
44697           description: successful operation
44698           schema:
44699               $ref: "#/getDefinitions/physical-links"
44700         "default":
44701           description: Response codes found in [response codes](https://wiki.onap.org/).
44702       parameters:
44703         - name: link-name
44704           in: query
44705           description:
44706           required: false
44707           type: string
44708         - name: circuit-id
44709           in: query
44710           description:
44711           required: false
44712           type: string
44713   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
44714     put:
44715       tags:
44716         - Network
44717       summary: see node definition for valid relationships
44718       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
44719       consumes:
44720         - application/json
44721         - application/xml
44722       produces:
44723         - application/json
44724         - application/xml
44725       responses:
44726         "default":
44727           description: Response codes found in [response codes](https://wiki.onap.org/).
44728       parameters:
44729         - name: ipsec-configuration-id
44730           in: path
44731           description: UUID of this configuration
44732           required: true
44733           type: string
44734           example: __IPSEC-CONFIGURATION-ID__
44735         - name: body
44736           in: body
44737           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfiguration.json)
44738           required: true
44739           schema:
44740             $ref: "#/definitions/relationship"
44741     delete:
44742       tags:
44743         - Network
44744       summary: delete an existing relationship
44745       description: delete an existing relationship
44746       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
44747       consumes:
44748         - application/json
44749         - application/xml
44750       produces:
44751         - application/json
44752         - application/xml
44753       responses:
44754         "default":
44755           description: Response codes found in [response codes](https://wiki.onap.org/).
44756       parameters:
44757         - name: ipsec-configuration-id
44758           in: path
44759           description: UUID of this configuration
44760           required: true
44761           type: string
44762           example: __IPSEC-CONFIGURATION-ID__
44763   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
44764     put:
44765       tags:
44766         - Network
44767       summary: see node definition for valid relationships
44768       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
44769       consumes:
44770         - application/json
44771         - application/xml
44772       produces:
44773         - application/json
44774         - application/xml
44775       responses:
44776         "default":
44777           description: Response codes found in [response codes](https://wiki.onap.org/).
44778       parameters:
44779         - name: ipsec-configuration-id
44780           in: path
44781           description: UUID of this configuration
44782           required: true
44783           type: string
44784           example: __IPSEC-CONFIGURATION-ID__
44785         - name: vig-address-type
44786           in: path
44787           description: indicates whether the VIG is for AVPN or INTERNET
44788           required: true
44789           type: string
44790           example: __VIG-ADDRESS-TYPE__
44791         - name: body
44792           in: body
44793           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
44794           required: true
44795           schema:
44796             $ref: "#/definitions/relationship"
44797     delete:
44798       tags:
44799         - Network
44800       summary: delete an existing relationship
44801       description: delete an existing relationship
44802       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
44803       consumes:
44804         - application/json
44805         - application/xml
44806       produces:
44807         - application/json
44808         - application/xml
44809       responses:
44810         "default":
44811           description: Response codes found in [response codes](https://wiki.onap.org/).
44812       parameters:
44813         - name: ipsec-configuration-id
44814           in: path
44815           description: UUID of this configuration
44816           required: true
44817           type: string
44818           example: __IPSEC-CONFIGURATION-ID__
44819         - name: vig-address-type
44820           in: path
44821           description: indicates whether the VIG is for AVPN or INTERNET
44822           required: true
44823           type: string
44824           example: __VIG-ADDRESS-TYPE__
44825   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
44826     get:
44827       tags:
44828         - Network
44829       summary: returns vig-server
44830       description: returns vig-server
44831       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44832       produces:
44833         - application/json
44834         - application/xml
44835       responses:
44836         "200":
44837           description: successful operation
44838           schema:
44839               $ref: "#/getDefinitions/vig-server"
44840         "default":
44841           description: Response codes found in [response codes](https://wiki.onap.org/).
44842       parameters:
44843         - name: ipsec-configuration-id
44844           in: path
44845           description: UUID of this configuration
44846           required: true
44847           type: string
44848           example: __IPSEC-CONFIGURATION-ID__
44849         - name: vig-address-type
44850           in: path
44851           description: indicates whether the VIG is for AVPN or INTERNET
44852           required: true
44853           type: string
44854           example: __VIG-ADDRESS-TYPE__
44855     put:
44856       tags:
44857         - Network
44858       summary: create or update an existing vig-server
44859       description: |
44860         Create or update an existing vig-server.
44861         #
44862         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44863       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44864       consumes:
44865         - application/json
44866         - application/xml
44867       produces:
44868         - application/json
44869         - application/xml
44870       responses:
44871         "default":
44872           description: Response codes found in [response codes](https://wiki.onap.org/).
44873       parameters:
44874         - name: ipsec-configuration-id
44875           in: path
44876           description: UUID of this configuration
44877           required: true
44878           type: string
44879           example: __IPSEC-CONFIGURATION-ID__
44880         - name: vig-address-type
44881           in: path
44882           description: indicates whether the VIG is for AVPN or INTERNET
44883           required: true
44884           type: string
44885           example: __VIG-ADDRESS-TYPE__
44886         - name: body
44887           in: body
44888           description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
44889           required: true
44890           schema:
44891             $ref: "#/definitions/vig-server"
44892     patch:
44893       tags:
44894         - Network
44895       summary: update an existing vig-server
44896       description: |
44897         Update an existing vig-server
44898         #
44899         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44900         The PUT operation will entirely replace an existing object.
44901         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44902         #
44903         Other differences between PUT and PATCH are:
44904         #
44905         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44906         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44907         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44908       operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44909       consumes:
44910         - application/json
44911         - application/xml
44912       produces:
44913         - application/json
44914         - application/xml
44915       responses:
44916         "default":
44917           description: Response codes found in [response codes](https://wiki.onap.org/).
44918       parameters:
44919         - name: ipsec-configuration-id
44920           in: path
44921           description: UUID of this configuration
44922           required: true
44923           type: string
44924           example: __IPSEC-CONFIGURATION-ID__
44925         - name: vig-address-type
44926           in: path
44927           description: indicates whether the VIG is for AVPN or INTERNET
44928           required: true
44929           type: string
44930           example: __VIG-ADDRESS-TYPE__
44931         - name: body
44932           in: body
44933           description: vig-server object that needs to be updated.
44934           required: true
44935           schema:
44936             $ref: "#/patchDefinitions/vig-server"
44937     delete:
44938       tags:
44939         - Network
44940       summary: delete an existing vig-server
44941       description: delete an existing vig-server
44942       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
44943       consumes:
44944         - application/json
44945         - application/xml
44946       produces:
44947         - application/json
44948         - application/xml
44949       responses:
44950         "default":
44951           description: Response codes found in [response codes](https://wiki.onap.org/).
44952       parameters:
44953         - name: ipsec-configuration-id
44954           in: path
44955           description: UUID of this configuration
44956           required: true
44957           type: string
44958           example: __IPSEC-CONFIGURATION-ID__
44959         - name: vig-address-type
44960           in: path
44961           description: indicates whether the VIG is for AVPN or INTERNET
44962           required: true
44963           type: string
44964           example: __VIG-ADDRESS-TYPE__
44965         - name: resource-version
44966           in: query
44967           description: resource-version for concurrency
44968           required: true
44969           type: string
44970   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
44971     get:
44972       tags:
44973         - Network
44974       summary: returns vig-servers
44975       description: returns vig-servers
44976       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
44977       produces:
44978         - application/json
44979         - application/xml
44980       responses:
44981         "200":
44982           description: successful operation
44983           schema:
44984               $ref: "#/getDefinitions/vig-servers"
44985         "default":
44986           description: Response codes found in [response codes](https://wiki.onap.org/).
44987       parameters:
44988         - name: ipsec-configuration-id
44989           in: path
44990           description: UUID of this configuration
44991           required: true
44992           type: string
44993           example: __IPSEC-CONFIGURATION-ID__
44994         - name: vig-address-type
44995           in: query
44996           description:
44997           required: false
44998           type: string
44999   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
45000     get:
45001       tags:
45002         - Network
45003       summary: returns ipsec-configuration
45004       description: returns ipsec-configuration
45005       operationId: getNetworkIpsecConfigurationsIpsecConfiguration
45006       produces:
45007         - application/json
45008         - application/xml
45009       responses:
45010         "200":
45011           description: successful operation
45012           schema:
45013               $ref: "#/getDefinitions/ipsec-configuration"
45014         "default":
45015           description: Response codes found in [response codes](https://wiki.onap.org/).
45016       parameters:
45017         - name: ipsec-configuration-id
45018           in: path
45019           description: UUID of this configuration
45020           required: true
45021           type: string
45022           example: __IPSEC-CONFIGURATION-ID__
45023     put:
45024       tags:
45025         - Network
45026       summary: create or update an existing ipsec-configuration
45027       description: |
45028         Create or update an existing ipsec-configuration.
45029         #
45030         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45031       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
45032       consumes:
45033         - application/json
45034         - application/xml
45035       produces:
45036         - application/json
45037         - application/xml
45038       responses:
45039         "default":
45040           description: Response codes found in [response codes](https://wiki.onap.org/).
45041       parameters:
45042         - name: ipsec-configuration-id
45043           in: path
45044           description: UUID of this configuration
45045           required: true
45046           type: string
45047           example: __IPSEC-CONFIGURATION-ID__
45048         - name: body
45049           in: body
45050           description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkIpsecConfigurationsIpsecConfiguration.json)
45051           required: true
45052           schema:
45053             $ref: "#/definitions/ipsec-configuration"
45054     patch:
45055       tags:
45056         - Network
45057       summary: update an existing ipsec-configuration
45058       description: |
45059         Update an existing ipsec-configuration
45060         #
45061         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45062         The PUT operation will entirely replace an existing object.
45063         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45064         #
45065         Other differences between PUT and PATCH are:
45066         #
45067         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45068         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45069         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45070       operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
45071       consumes:
45072         - application/json
45073         - application/xml
45074       produces:
45075         - application/json
45076         - application/xml
45077       responses:
45078         "default":
45079           description: Response codes found in [response codes](https://wiki.onap.org/).
45080       parameters:
45081         - name: ipsec-configuration-id
45082           in: path
45083           description: UUID of this configuration
45084           required: true
45085           type: string
45086           example: __IPSEC-CONFIGURATION-ID__
45087         - name: body
45088           in: body
45089           description: ipsec-configuration object that needs to be updated.
45090           required: true
45091           schema:
45092             $ref: "#/patchDefinitions/ipsec-configuration"
45093     delete:
45094       tags:
45095         - Network
45096       summary: delete an existing ipsec-configuration
45097       description: delete an existing ipsec-configuration
45098       operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
45099       consumes:
45100         - application/json
45101         - application/xml
45102       produces:
45103         - application/json
45104         - application/xml
45105       responses:
45106         "default":
45107           description: Response codes found in [response codes](https://wiki.onap.org/).
45108       parameters:
45109         - name: ipsec-configuration-id
45110           in: path
45111           description: UUID of this configuration
45112           required: true
45113           type: string
45114           example: __IPSEC-CONFIGURATION-ID__
45115         - name: resource-version
45116           in: query
45117           description: resource-version for concurrency
45118           required: true
45119           type: string
45120   /network/ipsec-configurations:
45121     get:
45122       tags:
45123         - Network
45124       summary: returns ipsec-configurations
45125       description: returns ipsec-configurations
45126       operationId: getNetworkIpsecConfigurations
45127       produces:
45128         - application/json
45129         - application/xml
45130       responses:
45131         "200":
45132           description: successful operation
45133           schema:
45134               $ref: "#/getDefinitions/ipsec-configurations"
45135         "default":
45136           description: Response codes found in [response codes](https://wiki.onap.org/).
45137       parameters:
45138         - name: ipsec-configuration-id
45139           in: query
45140           description:
45141           required: false
45142           type: string
45143   /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
45144     put:
45145       tags:
45146         - Network
45147       summary: see node definition for valid relationships
45148       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
45149       consumes:
45150         - application/json
45151         - application/xml
45152       produces:
45153         - application/json
45154         - application/xml
45155       responses:
45156         "default":
45157           description: Response codes found in [response codes](https://wiki.onap.org/).
45158       parameters:
45159         - name: route-table-reference-id
45160           in: path
45161           description: Route Table Reference id, UUID assigned to this instance.
45162           required: true
45163           type: string
45164           example: __ROUTE-TABLE-REFERENCE-ID__
45165         - name: body
45166           in: body
45167           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkRouteTableReferencesRouteTableReference.json)
45168           required: true
45169           schema:
45170             $ref: "#/definitions/relationship"
45171     delete:
45172       tags:
45173         - Network
45174       summary: delete an existing relationship
45175       description: delete an existing relationship
45176       operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
45177       consumes:
45178         - application/json
45179         - application/xml
45180       produces:
45181         - application/json
45182         - application/xml
45183       responses:
45184         "default":
45185           description: Response codes found in [response codes](https://wiki.onap.org/).
45186       parameters:
45187         - name: route-table-reference-id
45188           in: path
45189           description: Route Table Reference id, UUID assigned to this instance.
45190           required: true
45191           type: string
45192           example: __ROUTE-TABLE-REFERENCE-ID__
45193   /network/route-table-references/route-table-reference/{route-table-reference-id}:
45194     get:
45195       tags:
45196         - Network
45197       summary: returns route-table-reference
45198       description: returns route-table-reference
45199       operationId: getNetworkRouteTableReferencesRouteTableReference
45200       produces:
45201         - application/json
45202         - application/xml
45203       responses:
45204         "200":
45205           description: successful operation
45206           schema:
45207               $ref: "#/getDefinitions/route-table-reference"
45208         "default":
45209           description: Response codes found in [response codes](https://wiki.onap.org/).
45210       parameters:
45211         - name: route-table-reference-id
45212           in: path
45213           description: Route Table Reference id, UUID assigned to this instance.
45214           required: true
45215           type: string
45216           example: __ROUTE-TABLE-REFERENCE-ID__
45217     put:
45218       tags:
45219         - Network
45220       summary: create or update an existing route-table-reference
45221       description: |
45222         Create or update an existing route-table-reference.
45223         #
45224         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45225       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
45226       consumes:
45227         - application/json
45228         - application/xml
45229       produces:
45230         - application/json
45231         - application/xml
45232       responses:
45233         "default":
45234           description: Response codes found in [response codes](https://wiki.onap.org/).
45235       parameters:
45236         - name: route-table-reference-id
45237           in: path
45238           description: Route Table Reference id, UUID assigned to this instance.
45239           required: true
45240           type: string
45241           example: __ROUTE-TABLE-REFERENCE-ID__
45242         - name: body
45243           in: body
45244           description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkRouteTableReferencesRouteTableReference.json)
45245           required: true
45246           schema:
45247             $ref: "#/definitions/route-table-reference"
45248     patch:
45249       tags:
45250         - Network
45251       summary: update an existing route-table-reference
45252       description: |
45253         Update an existing route-table-reference
45254         #
45255         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45256         The PUT operation will entirely replace an existing object.
45257         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45258         #
45259         Other differences between PUT and PATCH are:
45260         #
45261         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45262         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45263         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45264       operationId: UpdateNetworkRouteTableReferencesRouteTableReference
45265       consumes:
45266         - application/json
45267         - application/xml
45268       produces:
45269         - application/json
45270         - application/xml
45271       responses:
45272         "default":
45273           description: Response codes found in [response codes](https://wiki.onap.org/).
45274       parameters:
45275         - name: route-table-reference-id
45276           in: path
45277           description: Route Table Reference id, UUID assigned to this instance.
45278           required: true
45279           type: string
45280           example: __ROUTE-TABLE-REFERENCE-ID__
45281         - name: body
45282           in: body
45283           description: route-table-reference object that needs to be updated.
45284           required: true
45285           schema:
45286             $ref: "#/patchDefinitions/route-table-reference"
45287     delete:
45288       tags:
45289         - Network
45290       summary: delete an existing route-table-reference
45291       description: delete an existing route-table-reference
45292       operationId: deleteNetworkRouteTableReferencesRouteTableReference
45293       consumes:
45294         - application/json
45295         - application/xml
45296       produces:
45297         - application/json
45298         - application/xml
45299       responses:
45300         "default":
45301           description: Response codes found in [response codes](https://wiki.onap.org/).
45302       parameters:
45303         - name: route-table-reference-id
45304           in: path
45305           description: Route Table Reference id, UUID assigned to this instance.
45306           required: true
45307           type: string
45308           example: __ROUTE-TABLE-REFERENCE-ID__
45309         - name: resource-version
45310           in: query
45311           description: resource-version for concurrency
45312           required: true
45313           type: string
45314   /network/route-table-references:
45315     get:
45316       tags:
45317         - Network
45318       summary: returns route-table-references
45319       description: returns route-table-references
45320       operationId: getNetworkRouteTableReferences
45321       produces:
45322         - application/json
45323         - application/xml
45324       responses:
45325         "200":
45326           description: successful operation
45327           schema:
45328               $ref: "#/getDefinitions/route-table-references"
45329         "default":
45330           description: Response codes found in [response codes](https://wiki.onap.org/).
45331       parameters:
45332         - name: route-table-reference-id
45333           in: query
45334           description:
45335           required: false
45336           type: string
45337         - name: route-table-reference-fqdn
45338           in: query
45339           description:
45340           required: false
45341           type: string
45342   /network/instance-groups/instance-group/{id}/relationship-list/relationship:
45343     put:
45344       tags:
45345         - Network
45346       summary: see node definition for valid relationships
45347       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
45348       consumes:
45349         - application/json
45350         - application/xml
45351       produces:
45352         - application/json
45353         - application/xml
45354       responses:
45355         "default":
45356           description: Response codes found in [response codes](https://wiki.onap.org/).
45357       parameters:
45358         - name: id
45359           in: path
45360           description: Instance Group ID, UUID assigned to this instance.
45361           required: true
45362           type: string
45363           example: __ID__
45364         - name: body
45365           in: body
45366           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkInstanceGroupsInstanceGroup.json)
45367           required: true
45368           schema:
45369             $ref: "#/definitions/relationship"
45370     delete:
45371       tags:
45372         - Network
45373       summary: delete an existing relationship
45374       description: delete an existing relationship
45375       operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
45376       consumes:
45377         - application/json
45378         - application/xml
45379       produces:
45380         - application/json
45381         - application/xml
45382       responses:
45383         "default":
45384           description: Response codes found in [response codes](https://wiki.onap.org/).
45385       parameters:
45386         - name: id
45387           in: path
45388           description: Instance Group ID, UUID assigned to this instance.
45389           required: true
45390           type: string
45391           example: __ID__
45392   /network/instance-groups/instance-group/{id}:
45393     get:
45394       tags:
45395         - Network
45396       summary: returns instance-group
45397       description: returns instance-group
45398       operationId: getNetworkInstanceGroupsInstanceGroup
45399       produces:
45400         - application/json
45401         - application/xml
45402       responses:
45403         "200":
45404           description: successful operation
45405           schema:
45406               $ref: "#/getDefinitions/instance-group"
45407         "default":
45408           description: Response codes found in [response codes](https://wiki.onap.org/).
45409       parameters:
45410         - name: id
45411           in: path
45412           description: Instance Group ID, UUID assigned to this instance.
45413           required: true
45414           type: string
45415           example: __ID__
45416     put:
45417       tags:
45418         - Network
45419       summary: create or update an existing instance-group
45420       description: |
45421         Create or update an existing instance-group.
45422         #
45423         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45424       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
45425       consumes:
45426         - application/json
45427         - application/xml
45428       produces:
45429         - application/json
45430         - application/xml
45431       responses:
45432         "default":
45433           description: Response codes found in [response codes](https://wiki.onap.org/).
45434       parameters:
45435         - name: id
45436           in: path
45437           description: Instance Group ID, UUID assigned to this instance.
45438           required: true
45439           type: string
45440           example: __ID__
45441         - name: body
45442           in: body
45443           description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkInstanceGroupsInstanceGroup.json)
45444           required: true
45445           schema:
45446             $ref: "#/definitions/instance-group"
45447     patch:
45448       tags:
45449         - Network
45450       summary: update an existing instance-group
45451       description: |
45452         Update an existing instance-group
45453         #
45454         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45455         The PUT operation will entirely replace an existing object.
45456         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45457         #
45458         Other differences between PUT and PATCH are:
45459         #
45460         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45461         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45462         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45463       operationId: UpdateNetworkInstanceGroupsInstanceGroup
45464       consumes:
45465         - application/json
45466         - application/xml
45467       produces:
45468         - application/json
45469         - application/xml
45470       responses:
45471         "default":
45472           description: Response codes found in [response codes](https://wiki.onap.org/).
45473       parameters:
45474         - name: id
45475           in: path
45476           description: Instance Group ID, UUID assigned to this instance.
45477           required: true
45478           type: string
45479           example: __ID__
45480         - name: body
45481           in: body
45482           description: instance-group object that needs to be updated.
45483           required: true
45484           schema:
45485             $ref: "#/patchDefinitions/instance-group"
45486     delete:
45487       tags:
45488         - Network
45489       summary: delete an existing instance-group
45490       description: delete an existing instance-group
45491       operationId: deleteNetworkInstanceGroupsInstanceGroup
45492       consumes:
45493         - application/json
45494         - application/xml
45495       produces:
45496         - application/json
45497         - application/xml
45498       responses:
45499         "default":
45500           description: Response codes found in [response codes](https://wiki.onap.org/).
45501       parameters:
45502         - name: id
45503           in: path
45504           description: Instance Group ID, UUID assigned to this instance.
45505           required: true
45506           type: string
45507           example: __ID__
45508         - name: resource-version
45509           in: query
45510           description: resource-version for concurrency
45511           required: true
45512           type: string
45513   /network/instance-groups:
45514     get:
45515       tags:
45516         - Network
45517       summary: returns instance-groups
45518       description: returns instance-groups
45519       operationId: getNetworkInstanceGroups
45520       produces:
45521         - application/json
45522         - application/xml
45523       responses:
45524         "200":
45525           description: successful operation
45526           schema:
45527               $ref: "#/getDefinitions/instance-groups"
45528         "default":
45529           description: Response codes found in [response codes](https://wiki.onap.org/).
45530       parameters:
45531         - name: id
45532           in: query
45533           description:
45534           required: false
45535           type: string
45536         - name: description
45537           in: query
45538           description:
45539           required: false
45540           type: string
45541         - name: type
45542           in: query
45543           description:
45544           required: false
45545           type: string
45546         - name: sub-type
45547           in: query
45548           description:
45549           required: false
45550           type: string
45551   /network/zones/zone/{zone-id}/relationship-list/relationship:
45552     put:
45553       tags:
45554         - Network
45555       summary: see node definition for valid relationships
45556       operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
45557       consumes:
45558         - application/json
45559         - application/xml
45560       produces:
45561         - application/json
45562         - application/xml
45563       responses:
45564         "default":
45565           description: Response codes found in [response codes](https://wiki.onap.org/).
45566       parameters:
45567         - name: zone-id
45568           in: path
45569           description: Code assigned by AIC to the zone
45570           required: true
45571           type: string
45572           example: __ZONE-ID__
45573         - name: body
45574           in: body
45575           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkZonesZone.json)
45576           required: true
45577           schema:
45578             $ref: "#/definitions/relationship"
45579     delete:
45580       tags:
45581         - Network
45582       summary: delete an existing relationship
45583       description: delete an existing relationship
45584       operationId: deleteNetworkZonesZoneRelationshipListRelationship
45585       consumes:
45586         - application/json
45587         - application/xml
45588       produces:
45589         - application/json
45590         - application/xml
45591       responses:
45592         "default":
45593           description: Response codes found in [response codes](https://wiki.onap.org/).
45594       parameters:
45595         - name: zone-id
45596           in: path
45597           description: Code assigned by AIC to the zone
45598           required: true
45599           type: string
45600           example: __ZONE-ID__
45601   /network/zones/zone/{zone-id}:
45602     get:
45603       tags:
45604         - Network
45605       summary: returns zone
45606       description: returns zone
45607       operationId: getNetworkZonesZone
45608       produces:
45609         - application/json
45610         - application/xml
45611       responses:
45612         "200":
45613           description: successful operation
45614           schema:
45615               $ref: "#/getDefinitions/zone"
45616         "default":
45617           description: Response codes found in [response codes](https://wiki.onap.org/).
45618       parameters:
45619         - name: zone-id
45620           in: path
45621           description: Code assigned by AIC to the zone
45622           required: true
45623           type: string
45624           example: __ZONE-ID__
45625     put:
45626       tags:
45627         - Network
45628       summary: create or update an existing zone
45629       description: |
45630         Create or update an existing zone.
45631         #
45632         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45633       operationId: createOrUpdateNetworkZonesZone
45634       consumes:
45635         - application/json
45636         - application/xml
45637       produces:
45638         - application/json
45639         - application/xml
45640       responses:
45641         "default":
45642           description: Response codes found in [response codes](https://wiki.onap.org/).
45643       parameters:
45644         - name: zone-id
45645           in: path
45646           description: Code assigned by AIC to the zone
45647           required: true
45648           type: string
45649           example: __ZONE-ID__
45650         - name: body
45651           in: body
45652           description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkZonesZone.json)
45653           required: true
45654           schema:
45655             $ref: "#/definitions/zone"
45656     patch:
45657       tags:
45658         - Network
45659       summary: update an existing zone
45660       description: |
45661         Update an existing zone
45662         #
45663         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45664         The PUT operation will entirely replace an existing object.
45665         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45666         #
45667         Other differences between PUT and PATCH are:
45668         #
45669         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45670         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45671         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45672       operationId: UpdateNetworkZonesZone
45673       consumes:
45674         - application/json
45675         - application/xml
45676       produces:
45677         - application/json
45678         - application/xml
45679       responses:
45680         "default":
45681           description: Response codes found in [response codes](https://wiki.onap.org/).
45682       parameters:
45683         - name: zone-id
45684           in: path
45685           description: Code assigned by AIC to the zone
45686           required: true
45687           type: string
45688           example: __ZONE-ID__
45689         - name: body
45690           in: body
45691           description: zone object that needs to be updated.
45692           required: true
45693           schema:
45694             $ref: "#/patchDefinitions/zone"
45695     delete:
45696       tags:
45697         - Network
45698       summary: delete an existing zone
45699       description: delete an existing zone
45700       operationId: deleteNetworkZonesZone
45701       consumes:
45702         - application/json
45703         - application/xml
45704       produces:
45705         - application/json
45706         - application/xml
45707       responses:
45708         "default":
45709           description: Response codes found in [response codes](https://wiki.onap.org/).
45710       parameters:
45711         - name: zone-id
45712           in: path
45713           description: Code assigned by AIC to the zone
45714           required: true
45715           type: string
45716           example: __ZONE-ID__
45717         - name: resource-version
45718           in: query
45719           description: resource-version for concurrency
45720           required: true
45721           type: string
45722   /network/zones:
45723     get:
45724       tags:
45725         - Network
45726       summary: returns zones
45727       description: returns zones
45728       operationId: getNetworkZones
45729       produces:
45730         - application/json
45731         - application/xml
45732       responses:
45733         "200":
45734           description: successful operation
45735           schema:
45736               $ref: "#/getDefinitions/zones"
45737         "default":
45738           description: Response codes found in [response codes](https://wiki.onap.org/).
45739       parameters:
45740         - name: zone-id
45741           in: query
45742           description:
45743           required: false
45744           type: string
45745         - name: design-type
45746           in: query
45747           description:
45748           required: false
45749           type: string
45750         - name: zone-context
45751           in: query
45752           description:
45753           required: false
45754           type: string
45755   /network/configurations/configuration/{configuration-id}/relationship-list/relationship:
45756     put:
45757       tags:
45758         - Network
45759       summary: see node definition for valid relationships
45760       operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship
45761       consumes:
45762         - application/json
45763         - application/xml
45764       produces:
45765         - application/json
45766         - application/xml
45767       responses:
45768         "default":
45769           description: Response codes found in [response codes](https://wiki.onap.org/).
45770       parameters:
45771         - name: configuration-id
45772           in: path
45773           description: UUID assigned to configuration.
45774           required: true
45775           type: string
45776           example: __CONFIGURATION-ID__
45777         - name: body
45778           in: body
45779           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfiguration.json)
45780           required: true
45781           schema:
45782             $ref: "#/definitions/relationship"
45783     delete:
45784       tags:
45785         - Network
45786       summary: delete an existing relationship
45787       description: delete an existing relationship
45788       operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship
45789       consumes:
45790         - application/json
45791         - application/xml
45792       produces:
45793         - application/json
45794         - application/xml
45795       responses:
45796         "default":
45797           description: Response codes found in [response codes](https://wiki.onap.org/).
45798       parameters:
45799         - name: configuration-id
45800           in: path
45801           description: UUID assigned to configuration.
45802           required: true
45803           type: string
45804           example: __CONFIGURATION-ID__
45805   /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}:
45806     get:
45807       tags:
45808         - Network
45809       summary: returns metadatum
45810       description: returns metadatum
45811       operationId: getNetworkConfigurationsConfigurationMetadataMetadatum
45812       produces:
45813         - application/json
45814         - application/xml
45815       responses:
45816         "200":
45817           description: successful operation
45818           schema:
45819               $ref: "#/getDefinitions/metadatum"
45820         "default":
45821           description: Response codes found in [response codes](https://wiki.onap.org/).
45822       parameters:
45823         - name: configuration-id
45824           in: path
45825           description: UUID assigned to configuration.
45826           required: true
45827           type: string
45828           example: __CONFIGURATION-ID__
45829         - name: metaname
45830           in: path
45831           required: true
45832           type: string
45833           example: __METANAME__
45834     put:
45835       tags:
45836         - Network
45837       summary: create or update an existing metadatum
45838       description: |
45839         Create or update an existing metadatum.
45840         #
45841         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45842       operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum
45843       consumes:
45844         - application/json
45845         - application/xml
45846       produces:
45847         - application/json
45848         - application/xml
45849       responses:
45850         "default":
45851           description: Response codes found in [response codes](https://wiki.onap.org/).
45852       parameters:
45853         - name: configuration-id
45854           in: path
45855           description: UUID assigned to configuration.
45856           required: true
45857           type: string
45858           example: __CONFIGURATION-ID__
45859         - name: metaname
45860           in: path
45861           required: true
45862           type: string
45863           example: __METANAME__
45864         - name: body
45865           in: body
45866           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationMetadataMetadatum.json)
45867           required: true
45868           schema:
45869             $ref: "#/definitions/metadatum"
45870     patch:
45871       tags:
45872         - Network
45873       summary: update an existing metadatum
45874       description: |
45875         Update an existing metadatum
45876         #
45877         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45878         The PUT operation will entirely replace an existing object.
45879         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45880         #
45881         Other differences between PUT and PATCH are:
45882         #
45883         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45884         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45885         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45886       operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum
45887       consumes:
45888         - application/json
45889         - application/xml
45890       produces:
45891         - application/json
45892         - application/xml
45893       responses:
45894         "default":
45895           description: Response codes found in [response codes](https://wiki.onap.org/).
45896       parameters:
45897         - name: configuration-id
45898           in: path
45899           description: UUID assigned to configuration.
45900           required: true
45901           type: string
45902           example: __CONFIGURATION-ID__
45903         - name: metaname
45904           in: path
45905           required: true
45906           type: string
45907           example: __METANAME__
45908         - name: body
45909           in: body
45910           description: metadatum object that needs to be updated.
45911           required: true
45912           schema:
45913             $ref: "#/patchDefinitions/metadatum"
45914     delete:
45915       tags:
45916         - Network
45917       summary: delete an existing metadatum
45918       description: delete an existing metadatum
45919       operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum
45920       consumes:
45921         - application/json
45922         - application/xml
45923       produces:
45924         - application/json
45925         - application/xml
45926       responses:
45927         "default":
45928           description: Response codes found in [response codes](https://wiki.onap.org/).
45929       parameters:
45930         - name: configuration-id
45931           in: path
45932           description: UUID assigned to configuration.
45933           required: true
45934           type: string
45935           example: __CONFIGURATION-ID__
45936         - name: metaname
45937           in: path
45938           required: true
45939           type: string
45940           example: __METANAME__
45941         - name: resource-version
45942           in: query
45943           description: resource-version for concurrency
45944           required: true
45945           type: string
45946   /network/configurations/configuration/{configuration-id}/metadata:
45947     get:
45948       tags:
45949         - Network
45950       summary: returns metadata
45951       description: returns metadata
45952       operationId: getNetworkConfigurationsConfigurationMetadata
45953       produces:
45954         - application/json
45955         - application/xml
45956       responses:
45957         "200":
45958           description: successful operation
45959           schema:
45960               $ref: "#/getDefinitions/metadata"
45961         "default":
45962           description: Response codes found in [response codes](https://wiki.onap.org/).
45963       parameters:
45964         - name: configuration-id
45965           in: path
45966           description: UUID assigned to configuration.
45967           required: true
45968           type: string
45969           example: __CONFIGURATION-ID__
45970         - name: metaname
45971           in: query
45972           description:
45973           required: false
45974           type: string
45975   /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}/relationship-list/relationship:
45976     put:
45977       tags:
45978         - Network
45979       summary: see node definition for valid relationships
45980       operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
45981       consumes:
45982         - application/json
45983         - application/xml
45984       produces:
45985         - application/json
45986         - application/xml
45987       responses:
45988         "default":
45989           description: Response codes found in [response codes](https://wiki.onap.org/).
45990       parameters:
45991         - name: configuration-id
45992           in: path
45993           description: UUID assigned to configuration.
45994           required: true
45995           type: string
45996           example: __CONFIGURATION-ID__
45997         - name: forwarder-evc-id
45998           in: path
45999           description: Key for forwarder-evc object
46000           required: true
46001           type: string
46002           example: __FORWARDER-EVC-ID__
46003         - name: body
46004           in: body
46005           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
46006           required: true
46007           schema:
46008             $ref: "#/definitions/relationship"
46009     delete:
46010       tags:
46011         - Network
46012       summary: delete an existing relationship
46013       description: delete an existing relationship
46014       operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvcRelationshipListRelationship
46015       consumes:
46016         - application/json
46017         - application/xml
46018       produces:
46019         - application/json
46020         - application/xml
46021       responses:
46022         "default":
46023           description: Response codes found in [response codes](https://wiki.onap.org/).
46024       parameters:
46025         - name: configuration-id
46026           in: path
46027           description: UUID assigned to configuration.
46028           required: true
46029           type: string
46030           example: __CONFIGURATION-ID__
46031         - name: forwarder-evc-id
46032           in: path
46033           description: Key for forwarder-evc object
46034           required: true
46035           type: string
46036           example: __FORWARDER-EVC-ID__
46037   /network/configurations/configuration/{configuration-id}/forwarder-evcs/forwarder-evc/{forwarder-evc-id}:
46038     get:
46039       tags:
46040         - Network
46041       summary: returns forwarder-evc
46042       description: returns forwarder-evc
46043       operationId: getNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
46044       produces:
46045         - application/json
46046         - application/xml
46047       responses:
46048         "200":
46049           description: successful operation
46050           schema:
46051               $ref: "#/getDefinitions/forwarder-evc"
46052         "default":
46053           description: Response codes found in [response codes](https://wiki.onap.org/).
46054       parameters:
46055         - name: configuration-id
46056           in: path
46057           description: UUID assigned to configuration.
46058           required: true
46059           type: string
46060           example: __CONFIGURATION-ID__
46061         - name: forwarder-evc-id
46062           in: path
46063           description: Key for forwarder-evc object
46064           required: true
46065           type: string
46066           example: __FORWARDER-EVC-ID__
46067     put:
46068       tags:
46069         - Network
46070       summary: create or update an existing forwarder-evc
46071       description: |
46072         Create or update an existing forwarder-evc.
46073         #
46074         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46075       operationId: createOrUpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
46076       consumes:
46077         - application/json
46078         - application/xml
46079       produces:
46080         - application/json
46081         - application/xml
46082       responses:
46083         "default":
46084           description: Response codes found in [response codes](https://wiki.onap.org/).
46085       parameters:
46086         - name: configuration-id
46087           in: path
46088           description: UUID assigned to configuration.
46089           required: true
46090           type: string
46091           example: __CONFIGURATION-ID__
46092         - name: forwarder-evc-id
46093           in: path
46094           description: Key for forwarder-evc object
46095           required: true
46096           type: string
46097           example: __FORWARDER-EVC-ID__
46098         - name: body
46099           in: body
46100           description: forwarder-evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationForwarderEvcsForwarderEvc.json)
46101           required: true
46102           schema:
46103             $ref: "#/definitions/forwarder-evc"
46104     patch:
46105       tags:
46106         - Network
46107       summary: update an existing forwarder-evc
46108       description: |
46109         Update an existing forwarder-evc
46110         #
46111         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46112         The PUT operation will entirely replace an existing object.
46113         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46114         #
46115         Other differences between PUT and PATCH are:
46116         #
46117         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46118         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46119         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46120       operationId: UpdateNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
46121       consumes:
46122         - application/json
46123         - application/xml
46124       produces:
46125         - application/json
46126         - application/xml
46127       responses:
46128         "default":
46129           description: Response codes found in [response codes](https://wiki.onap.org/).
46130       parameters:
46131         - name: configuration-id
46132           in: path
46133           description: UUID assigned to configuration.
46134           required: true
46135           type: string
46136           example: __CONFIGURATION-ID__
46137         - name: forwarder-evc-id
46138           in: path
46139           description: Key for forwarder-evc object
46140           required: true
46141           type: string
46142           example: __FORWARDER-EVC-ID__
46143         - name: body
46144           in: body
46145           description: forwarder-evc object that needs to be updated.
46146           required: true
46147           schema:
46148             $ref: "#/patchDefinitions/forwarder-evc"
46149     delete:
46150       tags:
46151         - Network
46152       summary: delete an existing forwarder-evc
46153       description: delete an existing forwarder-evc
46154       operationId: deleteNetworkConfigurationsConfigurationForwarderEvcsForwarderEvc
46155       consumes:
46156         - application/json
46157         - application/xml
46158       produces:
46159         - application/json
46160         - application/xml
46161       responses:
46162         "default":
46163           description: Response codes found in [response codes](https://wiki.onap.org/).
46164       parameters:
46165         - name: configuration-id
46166           in: path
46167           description: UUID assigned to configuration.
46168           required: true
46169           type: string
46170           example: __CONFIGURATION-ID__
46171         - name: forwarder-evc-id
46172           in: path
46173           description: Key for forwarder-evc object
46174           required: true
46175           type: string
46176           example: __FORWARDER-EVC-ID__
46177         - name: resource-version
46178           in: query
46179           description: resource-version for concurrency
46180           required: true
46181           type: string
46182   /network/configurations/configuration/{configuration-id}/forwarder-evcs:
46183     get:
46184       tags:
46185         - Network
46186       summary: returns forwarder-evcs
46187       description: returns forwarder-evcs
46188       operationId: getNetworkConfigurationsConfigurationForwarderEvcs
46189       produces:
46190         - application/json
46191         - application/xml
46192       responses:
46193         "200":
46194           description: successful operation
46195           schema:
46196               $ref: "#/getDefinitions/forwarder-evcs"
46197         "default":
46198           description: Response codes found in [response codes](https://wiki.onap.org/).
46199       parameters:
46200         - name: configuration-id
46201           in: path
46202           description: UUID assigned to configuration.
46203           required: true
46204           type: string
46205           example: __CONFIGURATION-ID__
46206   /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}/relationship-list/relationship:
46207     put:
46208       tags:
46209         - Network
46210       summary: see node definition for valid relationships
46211       operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
46212       consumes:
46213         - application/json
46214         - application/xml
46215       produces:
46216         - application/json
46217         - application/xml
46218       responses:
46219         "default":
46220           description: Response codes found in [response codes](https://wiki.onap.org/).
46221       parameters:
46222         - name: configuration-id
46223           in: path
46224           description: UUID assigned to configuration.
46225           required: true
46226           type: string
46227           example: __CONFIGURATION-ID__
46228         - name: evc-id
46229           in: path
46230           description: Unique/key field for the evc object
46231           required: true
46232           type: string
46233           example: __EVC-ID__
46234         - name: body
46235           in: body
46236           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationEvcsEvc.json)
46237           required: true
46238           schema:
46239             $ref: "#/definitions/relationship"
46240     delete:
46241       tags:
46242         - Network
46243       summary: delete an existing relationship
46244       description: delete an existing relationship
46245       operationId: deleteNetworkConfigurationsConfigurationEvcsEvcRelationshipListRelationship
46246       consumes:
46247         - application/json
46248         - application/xml
46249       produces:
46250         - application/json
46251         - application/xml
46252       responses:
46253         "default":
46254           description: Response codes found in [response codes](https://wiki.onap.org/).
46255       parameters:
46256         - name: configuration-id
46257           in: path
46258           description: UUID assigned to configuration.
46259           required: true
46260           type: string
46261           example: __CONFIGURATION-ID__
46262         - name: evc-id
46263           in: path
46264           description: Unique/key field for the evc object
46265           required: true
46266           type: string
46267           example: __EVC-ID__
46268   /network/configurations/configuration/{configuration-id}/evcs/evc/{evc-id}:
46269     get:
46270       tags:
46271         - Network
46272       summary: returns evc
46273       description: returns evc
46274       operationId: getNetworkConfigurationsConfigurationEvcsEvc
46275       produces:
46276         - application/json
46277         - application/xml
46278       responses:
46279         "200":
46280           description: successful operation
46281           schema:
46282               $ref: "#/getDefinitions/evc"
46283         "default":
46284           description: Response codes found in [response codes](https://wiki.onap.org/).
46285       parameters:
46286         - name: configuration-id
46287           in: path
46288           description: UUID assigned to configuration.
46289           required: true
46290           type: string
46291           example: __CONFIGURATION-ID__
46292         - name: evc-id
46293           in: path
46294           description: Unique/key field for the evc object
46295           required: true
46296           type: string
46297           example: __EVC-ID__
46298     put:
46299       tags:
46300         - Network
46301       summary: create or update an existing evc
46302       description: |
46303         Create or update an existing evc.
46304         #
46305         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46306       operationId: createOrUpdateNetworkConfigurationsConfigurationEvcsEvc
46307       consumes:
46308         - application/json
46309         - application/xml
46310       produces:
46311         - application/json
46312         - application/xml
46313       responses:
46314         "default":
46315           description: Response codes found in [response codes](https://wiki.onap.org/).
46316       parameters:
46317         - name: configuration-id
46318           in: path
46319           description: UUID assigned to configuration.
46320           required: true
46321           type: string
46322           example: __CONFIGURATION-ID__
46323         - name: evc-id
46324           in: path
46325           description: Unique/key field for the evc object
46326           required: true
46327           type: string
46328           example: __EVC-ID__
46329         - name: body
46330           in: body
46331           description: evc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfigurationEvcsEvc.json)
46332           required: true
46333           schema:
46334             $ref: "#/definitions/evc"
46335     patch:
46336       tags:
46337         - Network
46338       summary: update an existing evc
46339       description: |
46340         Update an existing evc
46341         #
46342         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46343         The PUT operation will entirely replace an existing object.
46344         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46345         #
46346         Other differences between PUT and PATCH are:
46347         #
46348         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46349         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46350         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46351       operationId: UpdateNetworkConfigurationsConfigurationEvcsEvc
46352       consumes:
46353         - application/json
46354         - application/xml
46355       produces:
46356         - application/json
46357         - application/xml
46358       responses:
46359         "default":
46360           description: Response codes found in [response codes](https://wiki.onap.org/).
46361       parameters:
46362         - name: configuration-id
46363           in: path
46364           description: UUID assigned to configuration.
46365           required: true
46366           type: string
46367           example: __CONFIGURATION-ID__
46368         - name: evc-id
46369           in: path
46370           description: Unique/key field for the evc object
46371           required: true
46372           type: string
46373           example: __EVC-ID__
46374         - name: body
46375           in: body
46376           description: evc object that needs to be updated.
46377           required: true
46378           schema:
46379             $ref: "#/patchDefinitions/evc"
46380     delete:
46381       tags:
46382         - Network
46383       summary: delete an existing evc
46384       description: delete an existing evc
46385       operationId: deleteNetworkConfigurationsConfigurationEvcsEvc
46386       consumes:
46387         - application/json
46388         - application/xml
46389       produces:
46390         - application/json
46391         - application/xml
46392       responses:
46393         "default":
46394           description: Response codes found in [response codes](https://wiki.onap.org/).
46395       parameters:
46396         - name: configuration-id
46397           in: path
46398           description: UUID assigned to configuration.
46399           required: true
46400           type: string
46401           example: __CONFIGURATION-ID__
46402         - name: evc-id
46403           in: path
46404           description: Unique/key field for the evc object
46405           required: true
46406           type: string
46407           example: __EVC-ID__
46408         - name: resource-version
46409           in: query
46410           description: resource-version for concurrency
46411           required: true
46412           type: string
46413   /network/configurations/configuration/{configuration-id}/evcs:
46414     get:
46415       tags:
46416         - Network
46417       summary: returns evcs
46418       description: returns evcs
46419       operationId: getNetworkConfigurationsConfigurationEvcs
46420       produces:
46421         - application/json
46422         - application/xml
46423       responses:
46424         "200":
46425           description: successful operation
46426           schema:
46427               $ref: "#/getDefinitions/evcs"
46428         "default":
46429           description: Response codes found in [response codes](https://wiki.onap.org/).
46430       parameters:
46431         - name: configuration-id
46432           in: path
46433           description: UUID assigned to configuration.
46434           required: true
46435           type: string
46436           example: __CONFIGURATION-ID__
46437   /network/configurations/configuration/{configuration-id}:
46438     get:
46439       tags:
46440         - Network
46441       summary: returns configuration
46442       description: returns configuration
46443       operationId: getNetworkConfigurationsConfiguration
46444       produces:
46445         - application/json
46446         - application/xml
46447       responses:
46448         "200":
46449           description: successful operation
46450           schema:
46451               $ref: "#/getDefinitions/configuration"
46452         "default":
46453           description: Response codes found in [response codes](https://wiki.onap.org/).
46454       parameters:
46455         - name: configuration-id
46456           in: path
46457           description: UUID assigned to configuration.
46458           required: true
46459           type: string
46460           example: __CONFIGURATION-ID__
46461     put:
46462       tags:
46463         - Network
46464       summary: create or update an existing configuration
46465       description: |
46466         Create or update an existing configuration.
46467         #
46468         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46469       operationId: createOrUpdateNetworkConfigurationsConfiguration
46470       consumes:
46471         - application/json
46472         - application/xml
46473       produces:
46474         - application/json
46475         - application/xml
46476       responses:
46477         "default":
46478           description: Response codes found in [response codes](https://wiki.onap.org/).
46479       parameters:
46480         - name: configuration-id
46481           in: path
46482           description: UUID assigned to configuration.
46483           required: true
46484           type: string
46485           example: __CONFIGURATION-ID__
46486         - name: body
46487           in: body
46488           description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkConfigurationsConfiguration.json)
46489           required: true
46490           schema:
46491             $ref: "#/definitions/configuration"
46492     patch:
46493       tags:
46494         - Network
46495       summary: update an existing configuration
46496       description: |
46497         Update an existing configuration
46498         #
46499         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46500         The PUT operation will entirely replace an existing object.
46501         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46502         #
46503         Other differences between PUT and PATCH are:
46504         #
46505         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46506         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46507         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46508       operationId: UpdateNetworkConfigurationsConfiguration
46509       consumes:
46510         - application/json
46511         - application/xml
46512       produces:
46513         - application/json
46514         - application/xml
46515       responses:
46516         "default":
46517           description: Response codes found in [response codes](https://wiki.onap.org/).
46518       parameters:
46519         - name: configuration-id
46520           in: path
46521           description: UUID assigned to configuration.
46522           required: true
46523           type: string
46524           example: __CONFIGURATION-ID__
46525         - name: body
46526           in: body
46527           description: configuration object that needs to be updated.
46528           required: true
46529           schema:
46530             $ref: "#/patchDefinitions/configuration"
46531     delete:
46532       tags:
46533         - Network
46534       summary: delete an existing configuration
46535       description: delete an existing configuration
46536       operationId: deleteNetworkConfigurationsConfiguration
46537       consumes:
46538         - application/json
46539         - application/xml
46540       produces:
46541         - application/json
46542         - application/xml
46543       responses:
46544         "default":
46545           description: Response codes found in [response codes](https://wiki.onap.org/).
46546       parameters:
46547         - name: configuration-id
46548           in: path
46549           description: UUID assigned to configuration.
46550           required: true
46551           type: string
46552           example: __CONFIGURATION-ID__
46553         - name: resource-version
46554           in: query
46555           description: resource-version for concurrency
46556           required: true
46557           type: string
46558   /network/configurations:
46559     get:
46560       tags:
46561         - Network
46562       summary: returns configurations
46563       description: returns configurations
46564       operationId: getNetworkConfigurations
46565       produces:
46566         - application/json
46567         - application/xml
46568       responses:
46569         "200":
46570           description: successful operation
46571           schema:
46572               $ref: "#/getDefinitions/configurations"
46573         "default":
46574           description: Response codes found in [response codes](https://wiki.onap.org/).
46575       parameters:
46576         - name: configuration-id
46577           in: query
46578           description:
46579           required: false
46580           type: string
46581         - name: model-invariant-id
46582           in: query
46583           description:
46584           required: false
46585           type: string
46586         - name: model-version-id
46587           in: query
46588           description:
46589           required: false
46590           type: string
46591   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/relationship-list/relationship:
46592     put:
46593       tags:
46594         - Network
46595       summary: see node definition for valid relationships
46596       operationId: createOrUpdateNetworkForwardingPathsForwardingPathRelationshipListRelationship
46597       consumes:
46598         - application/json
46599         - application/xml
46600       produces:
46601         - application/json
46602         - application/xml
46603       responses:
46604         "default":
46605           description: Response codes found in [response codes](https://wiki.onap.org/).
46606       parameters:
46607         - name: forwarding-path-id
46608           in: path
46609           description: Unique ID of this FP
46610           required: true
46611           type: string
46612           example: __FORWARDING-PATH-ID__
46613         - name: body
46614           in: body
46615           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPath.json)
46616           required: true
46617           schema:
46618             $ref: "#/definitions/relationship"
46619     delete:
46620       tags:
46621         - Network
46622       summary: delete an existing relationship
46623       description: delete an existing relationship
46624       operationId: deleteNetworkForwardingPathsForwardingPathRelationshipListRelationship
46625       consumes:
46626         - application/json
46627         - application/xml
46628       produces:
46629         - application/json
46630         - application/xml
46631       responses:
46632         "default":
46633           description: Response codes found in [response codes](https://wiki.onap.org/).
46634       parameters:
46635         - name: forwarding-path-id
46636           in: path
46637           description: Unique ID of this FP
46638           required: true
46639           type: string
46640           example: __FORWARDING-PATH-ID__
46641   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}/relationship-list/relationship:
46642     put:
46643       tags:
46644         - Network
46645       summary: see node definition for valid relationships
46646       operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
46647       consumes:
46648         - application/json
46649         - application/xml
46650       produces:
46651         - application/json
46652         - application/xml
46653       responses:
46654         "default":
46655           description: Response codes found in [response codes](https://wiki.onap.org/).
46656       parameters:
46657         - name: forwarding-path-id
46658           in: path
46659           description: Unique ID of this FP
46660           required: true
46661           type: string
46662           example: __FORWARDING-PATH-ID__
46663         - name: sequence
46664           in: path
46665           description: Unique ID of this segmentation
46666           required: true
46667           type: integer
46668           format: int32
46669           example: __SEQUENCE__
46670         - name: body
46671           in: body
46672           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
46673           required: true
46674           schema:
46675             $ref: "#/definitions/relationship"
46676     delete:
46677       tags:
46678         - Network
46679       summary: delete an existing relationship
46680       description: delete an existing relationship
46681       operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarderRelationshipListRelationship
46682       consumes:
46683         - application/json
46684         - application/xml
46685       produces:
46686         - application/json
46687         - application/xml
46688       responses:
46689         "default":
46690           description: Response codes found in [response codes](https://wiki.onap.org/).
46691       parameters:
46692         - name: forwarding-path-id
46693           in: path
46694           description: Unique ID of this FP
46695           required: true
46696           type: string
46697           example: __FORWARDING-PATH-ID__
46698         - name: sequence
46699           in: path
46700           description: Unique ID of this segmentation
46701           required: true
46702           type: integer
46703           format: int32
46704           example: __SEQUENCE__
46705   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders/forwarder/{sequence}:
46706     get:
46707       tags:
46708         - Network
46709       summary: returns forwarder
46710       description: returns forwarder
46711       operationId: getNetworkForwardingPathsForwardingPathForwardersForwarder
46712       produces:
46713         - application/json
46714         - application/xml
46715       responses:
46716         "200":
46717           description: successful operation
46718           schema:
46719               $ref: "#/getDefinitions/forwarder"
46720         "default":
46721           description: Response codes found in [response codes](https://wiki.onap.org/).
46722       parameters:
46723         - name: forwarding-path-id
46724           in: path
46725           description: Unique ID of this FP
46726           required: true
46727           type: string
46728           example: __FORWARDING-PATH-ID__
46729         - name: sequence
46730           in: path
46731           description: Unique ID of this segmentation
46732           required: true
46733           type: integer
46734           format: int32
46735           example: __SEQUENCE__
46736     put:
46737       tags:
46738         - Network
46739       summary: create or update an existing forwarder
46740       description: |
46741         Create or update an existing forwarder.
46742         #
46743         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46744       operationId: createOrUpdateNetworkForwardingPathsForwardingPathForwardersForwarder
46745       consumes:
46746         - application/json
46747         - application/xml
46748       produces:
46749         - application/json
46750         - application/xml
46751       responses:
46752         "default":
46753           description: Response codes found in [response codes](https://wiki.onap.org/).
46754       parameters:
46755         - name: forwarding-path-id
46756           in: path
46757           description: Unique ID of this FP
46758           required: true
46759           type: string
46760           example: __FORWARDING-PATH-ID__
46761         - name: sequence
46762           in: path
46763           description: Unique ID of this segmentation
46764           required: true
46765           type: integer
46766           format: int32
46767           example: __SEQUENCE__
46768         - name: body
46769           in: body
46770           description: forwarder object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPathForwardersForwarder.json)
46771           required: true
46772           schema:
46773             $ref: "#/definitions/forwarder"
46774     patch:
46775       tags:
46776         - Network
46777       summary: update an existing forwarder
46778       description: |
46779         Update an existing forwarder
46780         #
46781         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46782         The PUT operation will entirely replace an existing object.
46783         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46784         #
46785         Other differences between PUT and PATCH are:
46786         #
46787         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46788         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46789         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46790       operationId: UpdateNetworkForwardingPathsForwardingPathForwardersForwarder
46791       consumes:
46792         - application/json
46793         - application/xml
46794       produces:
46795         - application/json
46796         - application/xml
46797       responses:
46798         "default":
46799           description: Response codes found in [response codes](https://wiki.onap.org/).
46800       parameters:
46801         - name: forwarding-path-id
46802           in: path
46803           description: Unique ID of this FP
46804           required: true
46805           type: string
46806           example: __FORWARDING-PATH-ID__
46807         - name: sequence
46808           in: path
46809           description: Unique ID of this segmentation
46810           required: true
46811           type: integer
46812           format: int32
46813           example: __SEQUENCE__
46814         - name: body
46815           in: body
46816           description: forwarder object that needs to be updated.
46817           required: true
46818           schema:
46819             $ref: "#/patchDefinitions/forwarder"
46820     delete:
46821       tags:
46822         - Network
46823       summary: delete an existing forwarder
46824       description: delete an existing forwarder
46825       operationId: deleteNetworkForwardingPathsForwardingPathForwardersForwarder
46826       consumes:
46827         - application/json
46828         - application/xml
46829       produces:
46830         - application/json
46831         - application/xml
46832       responses:
46833         "default":
46834           description: Response codes found in [response codes](https://wiki.onap.org/).
46835       parameters:
46836         - name: forwarding-path-id
46837           in: path
46838           description: Unique ID of this FP
46839           required: true
46840           type: string
46841           example: __FORWARDING-PATH-ID__
46842         - name: sequence
46843           in: path
46844           description: Unique ID of this segmentation
46845           required: true
46846           type: integer
46847           format: int32
46848           example: __SEQUENCE__
46849         - name: resource-version
46850           in: query
46851           description: resource-version for concurrency
46852           required: true
46853           type: string
46854   /network/forwarding-paths/forwarding-path/{forwarding-path-id}/forwarders:
46855     get:
46856       tags:
46857         - Network
46858       summary: returns forwarders
46859       description: returns forwarders
46860       operationId: getNetworkForwardingPathsForwardingPathForwarders
46861       produces:
46862         - application/json
46863         - application/xml
46864       responses:
46865         "200":
46866           description: successful operation
46867           schema:
46868               $ref: "#/getDefinitions/forwarders"
46869         "default":
46870           description: Response codes found in [response codes](https://wiki.onap.org/).
46871       parameters:
46872         - name: forwarding-path-id
46873           in: path
46874           description: Unique ID of this FP
46875           required: true
46876           type: string
46877           example: __FORWARDING-PATH-ID__
46878         - name: sequence
46879           in: query
46880           description:
46881           required: false
46882           type: integer
46883           format: int32
46884   /network/forwarding-paths/forwarding-path/{forwarding-path-id}:
46885     get:
46886       tags:
46887         - Network
46888       summary: returns forwarding-path
46889       description: returns forwarding-path
46890       operationId: getNetworkForwardingPathsForwardingPath
46891       produces:
46892         - application/json
46893         - application/xml
46894       responses:
46895         "200":
46896           description: successful operation
46897           schema:
46898               $ref: "#/getDefinitions/forwarding-path"
46899         "default":
46900           description: Response codes found in [response codes](https://wiki.onap.org/).
46901       parameters:
46902         - name: forwarding-path-id
46903           in: path
46904           description: Unique ID of this FP
46905           required: true
46906           type: string
46907           example: __FORWARDING-PATH-ID__
46908     put:
46909       tags:
46910         - Network
46911       summary: create or update an existing forwarding-path
46912       description: |
46913         Create or update an existing forwarding-path.
46914         #
46915         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46916       operationId: createOrUpdateNetworkForwardingPathsForwardingPath
46917       consumes:
46918         - application/json
46919         - application/xml
46920       produces:
46921         - application/json
46922         - application/xml
46923       responses:
46924         "default":
46925           description: Response codes found in [response codes](https://wiki.onap.org/).
46926       parameters:
46927         - name: forwarding-path-id
46928           in: path
46929           description: Unique ID of this FP
46930           required: true
46931           type: string
46932           example: __FORWARDING-PATH-ID__
46933         - name: body
46934           in: body
46935           description: forwarding-path object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkForwardingPathsForwardingPath.json)
46936           required: true
46937           schema:
46938             $ref: "#/definitions/forwarding-path"
46939     patch:
46940       tags:
46941         - Network
46942       summary: update an existing forwarding-path
46943       description: |
46944         Update an existing forwarding-path
46945         #
46946         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46947         The PUT operation will entirely replace an existing object.
46948         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46949         #
46950         Other differences between PUT and PATCH are:
46951         #
46952         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46953         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46954         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46955       operationId: UpdateNetworkForwardingPathsForwardingPath
46956       consumes:
46957         - application/json
46958         - application/xml
46959       produces:
46960         - application/json
46961         - application/xml
46962       responses:
46963         "default":
46964           description: Response codes found in [response codes](https://wiki.onap.org/).
46965       parameters:
46966         - name: forwarding-path-id
46967           in: path
46968           description: Unique ID of this FP
46969           required: true
46970           type: string
46971           example: __FORWARDING-PATH-ID__
46972         - name: body
46973           in: body
46974           description: forwarding-path object that needs to be updated.
46975           required: true
46976           schema:
46977             $ref: "#/patchDefinitions/forwarding-path"
46978     delete:
46979       tags:
46980         - Network
46981       summary: delete an existing forwarding-path
46982       description: delete an existing forwarding-path
46983       operationId: deleteNetworkForwardingPathsForwardingPath
46984       consumes:
46985         - application/json
46986         - application/xml
46987       produces:
46988         - application/json
46989         - application/xml
46990       responses:
46991         "default":
46992           description: Response codes found in [response codes](https://wiki.onap.org/).
46993       parameters:
46994         - name: forwarding-path-id
46995           in: path
46996           description: Unique ID of this FP
46997           required: true
46998           type: string
46999           example: __FORWARDING-PATH-ID__
47000         - name: resource-version
47001           in: query
47002           description: resource-version for concurrency
47003           required: true
47004           type: string
47005   /network/forwarding-paths:
47006     get:
47007       tags:
47008         - Network
47009       summary: returns forwarding-paths
47010       description: returns forwarding-paths
47011       operationId: getNetworkForwardingPaths
47012       produces:
47013         - application/json
47014         - application/xml
47015       responses:
47016         "200":
47017           description: successful operation
47018           schema:
47019               $ref: "#/getDefinitions/forwarding-paths"
47020         "default":
47021           description: Response codes found in [response codes](https://wiki.onap.org/).
47022       parameters:
47023         - name: forwarding-path-id
47024           in: query
47025           description:
47026           required: false
47027           type: string
47028         - name: forwarding-path-name
47029           in: query
47030           description:
47031           required: false
47032           type: string
47033 definitions:
47034   action:
47035     properties:
47036       action-type:
47037         type: string
47038       action-data:
47039         type: array
47040         items:
47041           $ref: "#/definitions/action-data"
47042   action-data:
47043     properties:
47044       property-name:
47045         type: string
47046       property-value:
47047         type: string
47048   actions:
47049     description: |
47050       APIs that are more action related than REST (e.g., notify, update).
47051     properties:
47052       update:
47053         type: object
47054         $ref: "#/definitions/update"
47055       notify:
47056         type: object
47057         $ref: "#/definitions/notify"
47058   allotted-resource:
47059     description: |
47060       Represents a slice or partial piece of a resource that gets separately allotted
47061       ###### Related Nodes
47062       - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
47063       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
47064       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
47065       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
47066       - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
47067       - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
47068       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
47069       - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
47070       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
47071       - TO model-ver( allotted-resource IsA model-ver, Many2One)
47072       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
47073       - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
47074       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
47075       - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
47076
47077       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
47078       -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
47079       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
47080     required:
47081     - id
47082     properties:
47083       id:
47084         type: string
47085         description: Allotted Resource id UUID assigned to this instance.
47086       description:
47087         type: string
47088         description: The descriptive information assigned to this allotted resource instance
47089       selflink:
47090         type: string
47091         description: Link back to more information in the controller
47092       model-invariant-id:
47093         type: string
47094         description: the ASDC model id for this resource or service model.
47095       model-version-id:
47096         type: string
47097         description: the ASDC model version for this resource or service model.
47098       persona-model-version:
47099         type: string
47100         description: the ASDC model version for this resource or service model.
47101       resource-version:
47102         type: string
47103         description: Concurrency value
47104       orchestration-status:
47105         type: string
47106         description: Orchestration status
47107       operational-status:
47108         type: string
47109         description: Indicator for whether the resource is considered operational
47110       type:
47111         type: string
47112         description: Generic description of the type of allotted resource.
47113       role:
47114         type: string
47115         description: role in the network that this resource will be providing.
47116       tunnel-xconnects:
47117         type: array
47118         items:
47119           $ref: "#/definitions/tunnel-xconnect"
47120       relationship-list:
47121         type: array
47122         items:
47123           $ref: "#/definitions/relationship"
47124   allotted-resources:
47125     description: |
47126       This object is used to store slices of services being offered
47127     properties:
47128       allotted-resource:
47129         type: array
47130         items:
47131           $ref: "#/definitions/allotted-resource"
47132   availability-zone:
47133     description: |
47134       Availability zone, a collection of compute hosts/pservers
47135       ###### Related Nodes
47136       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
47137       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
47138       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
47139       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
47140       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
47141       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
47142       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
47143       - FROM vce( vce Uses availability-zone, MANY2MANY)
47144
47145       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
47146       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
47147
47148     required:
47149     - availability-zone-name
47150     - hypervisor-type
47151     properties:
47152       availability-zone-name:
47153         type: string
47154         description: Name of the availability zone.  Unique across a cloud region
47155       hypervisor-type:
47156         type: string
47157         description: Type of hypervisor.  Source of truth should define valid values.
47158       operational-status:
47159         type: string
47160         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
47161       resource-version:
47162         type: string
47163         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47164       relationship-list:
47165         type: array
47166         items:
47167           $ref: "#/definitions/relationship"
47168   availability-zones:
47169     description: |
47170       Collection of availability zones
47171     properties:
47172       availability-zone:
47173         type: array
47174         items:
47175           $ref: "#/definitions/availability-zone"
47176   az-and-dvs-switches:
47177     properties:
47178       dvs-switches:
47179         type: object
47180         $ref: "#/definitions/dvs-switches"
47181       availability-zone:
47182         type: object
47183         $ref: "#/definitions/availability-zone"
47184   business:
47185     description: |
47186       Namespace for business related constructs
47187     properties:
47188       connectors:
47189         type: array
47190         items:
47191           $ref: "#/definitions/connector"
47192       customers:
47193         type: array
47194         items:
47195           $ref: "#/definitions/customer"
47196       lines-of-business:
47197         type: array
47198         items:
47199           $ref: "#/definitions/line-of-business"
47200       owning-entities:
47201         type: array
47202         items:
47203           $ref: "#/definitions/owning-entity"
47204       platforms:
47205         type: array
47206         items:
47207           $ref: "#/definitions/platform"
47208       projects:
47209         type: array
47210         items:
47211           $ref: "#/definitions/project"
47212   class-of-service:
47213     description: |
47214       ###### Related Nodes
47215       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
47216
47217       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
47218     required:
47219     - cos
47220     properties:
47221       cos:
47222         type: string
47223         description: unique identifier of probe
47224       probe-id:
47225         type: string
47226         description: identifier of probe
47227       probe-type:
47228         type: string
47229         description: type of probe
47230       resource-version:
47231         type: string
47232         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47233       relationship-list:
47234         type: array
47235         items:
47236           $ref: "#/definitions/relationship"
47237   classes-of-service:
47238     description: |
47239       class-of-service of probe
47240     properties:
47241       class-of-service:
47242         type: array
47243         items:
47244           $ref: "#/definitions/class-of-service"
47245   cloud-infrastructure:
47246     description: |
47247       Namespace for cloud infrastructure.
47248     properties:
47249       complexes:
47250         type: array
47251         items:
47252           $ref: "#/definitions/complex"
47253       cloud-regions:
47254         type: array
47255         items:
47256           $ref: "#/definitions/cloud-region"
47257       network-profiles:
47258         type: array
47259         items:
47260           $ref: "#/definitions/network-profile"
47261       pservers:
47262         type: array
47263         items:
47264           $ref: "#/definitions/pserver"
47265       virtual-data-centers:
47266         type: array
47267         items:
47268           $ref: "#/definitions/virtual-data-center"
47269       operational-environments:
47270         type: array
47271         items:
47272           $ref: "#/definitions/operational-environment"
47273   cloud-region:
47274     description: |
47275       cloud-region designates an installation of a cloud cluster or region or instantiation.
47276       ###### Related Nodes
47277       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
47278       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
47279       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
47280       - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
47281       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
47282       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
47283       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
47284       - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
47285       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
47286       - FROM image( image BelongsTo cloud-region, MANY2ONE)
47287       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
47288       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
47289       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
47290       - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
47291       - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
47292       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
47293       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
47294       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
47295
47296       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
47297       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
47298
47299     required:
47300     - cloud-owner
47301     - cloud-region-id
47302     - sriov-automation
47303     properties:
47304       cloud-owner:
47305         type: string
47306         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
47307       cloud-region-id:
47308         type: string
47309         description: Identifier used by the vendor for the region. Second part of composite key
47310       cloud-type:
47311         type: string
47312         description: Type of the cloud (e.g., openstack)
47313       owner-defined-type:
47314         type: string
47315         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
47316       cloud-region-version:
47317         type: string
47318         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
47319       identity-url:
47320         type: string
47321         description: URL of the keystone identity service
47322       cloud-zone:
47323         type: string
47324         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
47325       complex-name:
47326         type: string
47327         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
47328       sriov-automation:
47329         type: boolean
47330         description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
47331       cloud-extra-info:
47332         type: string
47333         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
47334       cloud-epa-caps:
47335         type: string
47336         description: MultiVIM will discover and expose EPA capabilities.
47337       resource-version:
47338         type: string
47339         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47340       volume-groups:
47341         type: array
47342         items:
47343           $ref: "#/definitions/volume-group"
47344       tenants:
47345         type: array
47346         items:
47347           $ref: "#/definitions/tenant"
47348       flavors:
47349         type: array
47350         items:
47351           $ref: "#/definitions/flavor"
47352       group-assignments:
47353         type: array
47354         items:
47355           $ref: "#/definitions/group-assignment"
47356       snapshots:
47357         type: array
47358         items:
47359           $ref: "#/definitions/snapshot"
47360       images:
47361         type: array
47362         items:
47363           $ref: "#/definitions/image"
47364       dvs-switches:
47365         type: array
47366         items:
47367           $ref: "#/definitions/dvs-switch"
47368       oam-networks:
47369         type: array
47370         items:
47371           $ref: "#/definitions/oam-network"
47372       availability-zones:
47373         type: array
47374         items:
47375           $ref: "#/definitions/availability-zone"
47376       relationship-list:
47377         type: array
47378         items:
47379           $ref: "#/definitions/relationship"
47380       vip-ipv4-address-list:
47381         type: array
47382         items:
47383           $ref: "#/definitions/vip-ipv4-address-list"
47384       vip-ipv6-address-list:
47385         type: array
47386         items:
47387           $ref: "#/definitions/vip-ipv6-address-list"
47388       hpa-capabilities:
47389         type: array
47390         items:
47391           $ref: "#/definitions/hpa-capability"
47392         description: List of cloud-region specific HPA Capabilities
47393       esr-system-info-list:
47394         type: array
47395         items:
47396           $ref: "#/definitions/esr-system-info"
47397   cloud-regions:
47398     properties:
47399       cloud-region:
47400         type: array
47401         items:
47402           $ref: "#/definitions/cloud-region"
47403   complex:
47404     description: |
47405       Collection of physical locations that can house cloud-regions.
47406       ###### Related Nodes
47407       - TO l3-network( complex Uses l3-network, MANY2MANY)
47408       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
47409       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
47410       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
47411       - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
47412       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
47413       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
47414       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
47415       - FROM vce( vce LocatedIn complex, MANY2MANY)
47416       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
47417       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
47418       - FROM zone( zone LocatedIn complex, MANY2ONE)
47419
47420       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
47421       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
47422
47423     required:
47424     - physical-location-id
47425     - physical-location-type
47426     - street1
47427     - city
47428     - postal-code
47429     - country
47430     - region
47431     properties:
47432       physical-location-id:
47433         type: string
47434         description: Unique identifier for physical location, e.g., CLLI
47435       data-center-code:
47436         type: string
47437         description: Data center code which can be an alternate way to identify a complex
47438       complex-name:
47439         type: string
47440         description: Gamma complex name for LCP instance.
47441       identity-url:
47442         type: string
47443         description: URL of the keystone identity service
47444       resource-version:
47445         type: string
47446         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47447       physical-location-type:
47448         type: string
47449         description: Type, e.g., central office, data center.
47450       street1:
47451         type: string
47452       street2:
47453         type: string
47454       city:
47455         type: string
47456       state:
47457         type: string
47458       postal-code:
47459         type: string
47460       country:
47461         type: string
47462       region:
47463         type: string
47464       latitude:
47465         type: string
47466       longitude:
47467         type: string
47468       elevation:
47469         type: string
47470       lata:
47471         type: string
47472       ctag-pools:
47473         type: array
47474         items:
47475           $ref: "#/definitions/ctag-pool"
47476       relationship-list:
47477         type: array
47478         items:
47479           $ref: "#/definitions/relationship"
47480   complexes:
47481     description: |
47482       Collection of physical locations that can house cloud-regions.
47483     properties:
47484       complex:
47485         type: array
47486         items:
47487           $ref: "#/definitions/complex"
47488   configuration:
47489     description: |
47490       Port Mirror Configuration.
47491       ###### Related Nodes
47492       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
47493       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
47494       - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
47495       - TO pnf( configuration AppliesTo pnf, ONE2MANY)
47496       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
47497       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
47498       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
47499       - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
47500       - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
47501       - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
47502       - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
47503
47504       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
47505       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
47506       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
47507     required:
47508     - configuration-id
47509     - configuration-type
47510     - configuration-sub-type
47511     - orchestration-status
47512     - operational-status
47513     - configuration-selflink
47514     - model-customization-id
47515     properties:
47516       configuration-id:
47517         type: string
47518         description: UUID assigned to configuration.
47519       management-option:
47520         type: string
47521         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
47522       configuration-name:
47523         type: string
47524         description: Name of the configuration.
47525       configuration-type:
47526         type: string
47527         description: port-mirroring-configuration.
47528       configuration-sub-type:
47529         type: string
47530         description: vprobe, pprobe.
47531       model-invariant-id:
47532         type: string
47533         description: the ASDC model id for this resource or service model.
47534       model-version-id:
47535         type: string
47536         description: the ASDC model version for this resource or service model.
47537       orchestration-status:
47538         type: string
47539         description: Orchestration status of the configuration.
47540       operational-status:
47541         type: string
47542         description: Indicator for whether the resource is considered operational.
47543       configuration-selflink:
47544         type: string
47545         description: URL to endpoint where AAI can get more details from SDN-GC.
47546       model-customization-id:
47547         type: string
47548         description: id of  the configuration used to customize the resource
47549       tunnel-bandwidth:
47550         type: string
47551         description: DHV Site Effective Bandwidth
47552       vendor-allowed-max-bandwidth:
47553         type: string
47554         description: Velocloud Nominal Throughput - VNT
47555       resource-version:
47556         type: string
47557         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47558       relationship-list:
47559         type: array
47560         items:
47561           $ref: "#/definitions/relationship"
47562       metadata:
47563         type: array
47564         items:
47565           $ref: "#/definitions/metadatum"
47566       forwarder-evcs:
47567         type: array
47568         items:
47569           $ref: "#/definitions/forwarder-evc"
47570       evcs:
47571         type: array
47572         items:
47573           $ref: "#/definitions/evc"
47574   configurations:
47575     description: |
47576       Collection of configurations
47577     properties:
47578       configuration:
47579         type: array
47580         items:
47581           $ref: "#/definitions/configuration"
47582   connector:
47583     description: |
47584       Collection of resource instances used to connect a variety of disparate inventory widgets
47585       ###### Related Nodes
47586       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
47587       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
47588       - FROM service-instance( service-instance Uses connector, MANY2MANY)
47589
47590       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
47591     required:
47592     - resource-instance-id
47593     properties:
47594       resource-instance-id:
47595         type: string
47596         description: Unique id of resource instance.
47597       resource-version:
47598         type: string
47599         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47600       model-invariant-id:
47601         type: string
47602         description: the ASDC model id for this resource or service model.
47603       model-version-id:
47604         type: string
47605         description: the ASDC model version for this resource or service model.
47606       persona-model-version:
47607         type: string
47608         description: the ASDC model version for this resource or service model.
47609       widget-model-id:
47610         type: string
47611         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
47612       widget-model-version:
47613         type: string
47614         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
47615       relationship-list:
47616         type: array
47617         items:
47618           $ref: "#/definitions/relationship"
47619       metadata:
47620         type: array
47621         items:
47622           $ref: "#/definitions/metadatum"
47623   connectors:
47624     description: |
47625       Collection of resource instances used to connect a variety of disparate inventory widgets
47626     properties:
47627       connector:
47628         type: array
47629         items:
47630           $ref: "#/definitions/connector"
47631   constrained-element-set:
47632     description: |
47633       This is how we would capture constraints defining allowed sets of elements.
47634       ###### Related Nodes
47635       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
47636       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
47637       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
47638
47639       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
47640       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
47641     required:
47642     - constrained-element-set-uuid
47643     - constraint-type
47644     - check-type
47645     properties:
47646       constrained-element-set-uuid:
47647         type: string
47648       constraint-type:
47649         type: string
47650       check-type:
47651         type: string
47652       resource-version:
47653         type: string
47654       element-choice-sets:
47655         type: array
47656         items:
47657           $ref: "#/definitions/element-choice-set"
47658       relationship-list:
47659         type: array
47660         items:
47661           $ref: "#/definitions/relationship"
47662   constrained-element-sets:
47663     properties:
47664       constrained-element-set:
47665         type: array
47666         items:
47667           $ref: "#/definitions/constrained-element-set"
47668   ctag-assignment:
47669     description: |
47670       ###### Related Nodes
47671       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
47672       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
47673
47674       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
47675     required:
47676     - vlan-id-inner
47677     properties:
47678       vlan-id-inner:
47679         type: integer
47680         format: int64
47681         description: id.
47682       resource-version:
47683         type: string
47684         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47685       relationship-list:
47686         type: array
47687         items:
47688           $ref: "#/definitions/relationship"
47689   ctag-assignments:
47690     properties:
47691       ctag-assignment:
47692         type: array
47693         items:
47694           $ref: "#/definitions/ctag-assignment"
47695   ctag-pool:
47696     description: |
47697       A collection of C tags (vlan tags) grouped for a specific purpose.
47698       ###### Related Nodes
47699       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
47700       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
47701       - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
47702       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
47703
47704       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
47705     required:
47706     - target-pe
47707     - availability-zone-name
47708     - ctag-pool-purpose
47709     properties:
47710       target-pe:
47711         type: string
47712         description: The Target provider edge router
47713       availability-zone-name:
47714         type: string
47715         description: Name of the availability zone
47716       ctag-pool-purpose:
47717         type: string
47718         description: Describes what the intended purpose of this pool is.
47719       ctag-values:
47720         type: string
47721         description: Comma separated list of ctags
47722       resource-version:
47723         type: string
47724         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47725       relationship-list:
47726         type: array
47727         items:
47728           $ref: "#/definitions/relationship"
47729   ctag-pools:
47730     properties:
47731       ctag-pool:
47732         type: array
47733         items:
47734           $ref: "#/definitions/ctag-pool"
47735   customer:
47736     description: |
47737       customer identifiers to provide linkage back to BSS information.
47738       ###### Related Nodes
47739       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
47740
47741       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
47742     required:
47743     - global-customer-id
47744     - subscriber-name
47745     - subscriber-type
47746     properties:
47747       global-customer-id:
47748         type: string
47749         description: Global customer id used across ECOMP to uniquely identify customer.
47750       subscriber-name:
47751         type: string
47752         description: Subscriber name, an alternate way to retrieve a customer.
47753       subscriber-type:
47754         type: string
47755         description: Subscriber type, a way to provide VID with only the INFRA customers.
47756       resource-version:
47757         type: string
47758         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47759       service-subscriptions:
47760         type: array
47761         items:
47762           $ref: "#/definitions/service-subscription"
47763       relationship-list:
47764         type: array
47765         items:
47766           $ref: "#/definitions/relationship"
47767   customers:
47768     description: |
47769       Collection of customer identifiers to provide linkage back to BSS information.
47770     properties:
47771       customer:
47772         type: array
47773         items:
47774           $ref: "#/definitions/customer"
47775   cvlan-tag-entry:
47776     required:
47777     - cvlan-tag
47778     properties:
47779       cvlan-tag:
47780         type: integer
47781         format: int64
47782         description: See mis-na-virtualization-platform.yang
47783       resource-version:
47784         type: string
47785         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47786       relationship-list:
47787         type: array
47788         items:
47789           $ref: "#/definitions/relationship"
47790   cvlan-tags:
47791     properties:
47792       cvlan-tag-entry:
47793         type: array
47794         items:
47795           $ref: "#/definitions/cvlan-tag-entry"
47796   dvs-switch:
47797     description: |
47798       Digital virtual switch metadata, used by SDN-C to configure VCEs.  A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
47799       ###### Related Nodes
47800       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
47801       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
47802
47803     required:
47804     - switch-name
47805     - vcenter-url
47806     properties:
47807       switch-name:
47808         type: string
47809         description: DVS switch name
47810       vcenter-url:
47811         type: string
47812         description: URL used to reach the vcenter
47813       resource-version:
47814         type: string
47815         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47816       relationship-list:
47817         type: array
47818         items:
47819           $ref: "#/definitions/relationship"
47820   dvs-switches:
47821     description: |
47822       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
47823     properties:
47824       dvs-switch:
47825         type: array
47826         items:
47827           $ref: "#/definitions/dvs-switch"
47828   edge-prop-names:
47829     description: |
47830       Internal map to define the properties of an edge and interpret the map EdgeRules
47831     properties:
47832       edgeLabel:
47833         type: string
47834       direction:
47835         type: string
47836       multiplicityRule:
47837         type: string
47838       contains-other-v:
47839         type: string
47840       delete-other-v:
47841         type: string
47842       SVC-INFRA:
47843         type: string
47844       prevent-delete:
47845         type: string
47846       aai-uuid:
47847         type: string
47848   edge-tag-query-request:
47849     properties:
47850       edge-tag:
47851         type: string
47852       result-detail:
47853         type: string
47854       start-node-type:
47855         type: string
47856       start-node-filter:
47857         type: array
47858         items:
47859           $ref: "#/definitions/start-node-filter"
47860       include-node-filter:
47861         type: array
47862         items:
47863           $ref: "#/definitions/include-node-filter"
47864       secondary-filter:
47865         type: array
47866         items:
47867           $ref: "#/definitions/secondary-filter"
47868   edge-tag-query-result:
47869     properties:
47870       tagged-inventory-item-list:
47871         type: array
47872         items:
47873           $ref: "#/definitions/tagged-inventory-item-list"
47874   element-choice-set:
47875     description: |
47876       This is how we would capture constraints defining allowed sets of elements.
47877       ###### Related Nodes
47878       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
47879       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
47880
47881       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
47882       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
47883     required:
47884     - element-choice-set-uuid
47885     - element-choice-set-name
47886     properties:
47887       element-choice-set-uuid:
47888         type: string
47889       element-choice-set-name:
47890         type: string
47891       cardinality:
47892         type: string
47893       resource-version:
47894         type: string
47895       model-elements:
47896         type: array
47897         items:
47898           $ref: "#/definitions/model-element"
47899       relationship-list:
47900         type: array
47901         items:
47902           $ref: "#/definitions/relationship"
47903   element-choice-sets:
47904     properties:
47905       element-choice-set:
47906         type: array
47907         items:
47908           $ref: "#/definitions/element-choice-set"
47909   entitlement:
47910     description: |
47911       Metadata for entitlement group.
47912       ###### Related Nodes
47913       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
47914       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
47915
47916       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
47917     required:
47918     - group-uuid
47919     - resource-uuid
47920     properties:
47921       group-uuid:
47922         type: string
47923         description: Unique ID for the entitlement group the resource comes from, should be uuid.
47924       resource-uuid:
47925         type: string
47926         description: Unique ID of an entitlement resource.
47927       resource-version:
47928         type: string
47929         description: Concurrency value
47930       relationship-list:
47931         type: array
47932         items:
47933           $ref: "#/definitions/relationship"
47934   entitlements:
47935     description: |
47936       Entitlements, keyed by group-uuid and resource-uuid, related to license management
47937     properties:
47938       entitlement:
47939         type: array
47940         items:
47941           $ref: "#/definitions/entitlement"
47942   esr-ems:
47943     description: |
47944       Persist EMS address information used by EMS driver.
47945       ###### Related Nodes
47946       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
47947
47948       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
47949     required:
47950     - ems-id
47951     properties:
47952       ems-id:
47953         type: string
47954         description: Unique ID of EMS.
47955       resource-version:
47956         type: string
47957         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47958       esr-system-info-list:
47959         type: object
47960         $ref: "#/definitions/esr-system-info-list"
47961       relationship-list:
47962         type: object
47963         $ref: "#/definitions/relationship-list"
47964   esr-ems-list:
47965     properties:
47966       esr-ems:
47967         type: array
47968         items:
47969           $ref: "#/definitions/esr-ems"
47970   esr-system-info:
47971     description: |
47972       Persist common address information of external systems.
47973       ###### Related Nodes
47974       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
47975       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
47976       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
47977       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
47978
47979       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
47980     required:
47981     - esr-system-info-id
47982     - user-name
47983     - password
47984     - system-type
47985     properties:
47986       esr-system-info-id:
47987         type: string
47988         description: Unique ID of esr system info.
47989       system-name:
47990         type: string
47991         description: name of external system.
47992       type:
47993         type: string
47994         description: type of external systems.
47995       vendor:
47996         type: string
47997         description: vendor of external systems.
47998       version:
47999         type: string
48000         description: version of external systems.
48001       service-url:
48002         type: string
48003         description: url used to access external systems.
48004       user-name:
48005         type: string
48006         description: username used to access external systems.
48007       password:
48008         type: string
48009         description: password used to access external systems.
48010       system-type:
48011         type: string
48012         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
48013       protocol:
48014         type: string
48015         description: protocol of third party SDNC, for example netconf/snmp.
48016       ssl-cacert:
48017         type: string
48018         description: ca file content if enabled ssl on auth-url.
48019       ssl-insecure:
48020         type: boolean
48021         description: Whether to verify VIM's certificate.
48022       ip-address:
48023         type: string
48024         description: service IP of ftp server.
48025       port:
48026         type: string
48027         description: service port of ftp server.
48028       cloud-domain:
48029         type: string
48030         description: domain info for authentication.
48031       default-tenant:
48032         type: string
48033         description: default tenant of VIM.
48034       passive:
48035         type: boolean
48036         description: ftp passive mode or not.
48037       remote-path:
48038         type: string
48039         description: resource or performance data file path.
48040       system-status:
48041         type: string
48042         description: the status of external system.
48043       resource-version:
48044         type: string
48045         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48046       relationship-list:
48047         type: array
48048         items:
48049           $ref: "#/definitions/relationship"
48050   esr-system-info-list:
48051     description: |
48052       Collection of persistent block-level external system auth info.
48053     properties:
48054       esr-system-info:
48055         type: array
48056         items:
48057           $ref: "#/definitions/esr-system-info"
48058   esr-thirdparty-sdnc:
48059     description: |
48060       Persist SDNC address information used by ONAP SDNC.
48061       ###### Related Nodes
48062       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
48063       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
48064
48065       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
48066     required:
48067     - thirdparty-sdnc-id
48068     properties:
48069       thirdparty-sdnc-id:
48070         type: string
48071         description: Unique ID of SDNC.
48072       location:
48073         type: string
48074         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
48075       product-name:
48076         type: string
48077         description: password used to access SDNC server.
48078       resource-version:
48079         type: string
48080         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48081       esr-system-info-list:
48082         type: object
48083         $ref: "#/definitions/esr-system-info-list"
48084       relationship-list:
48085         type: object
48086         $ref: "#/definitions/relationship-list"
48087   esr-thirdparty-sdnc-list:
48088     properties:
48089       esr-thirdparty-sdnc:
48090         type: array
48091         items:
48092           $ref: "#/definitions/esr-thirdparty-sdnc"
48093   esr-vnfm:
48094     description: |
48095       Persist VNFM address information used by VF-C.
48096       ###### Related Nodes
48097       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
48098
48099       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
48100     required:
48101     - vnfm-id
48102     properties:
48103       vnfm-id:
48104         type: string
48105         description: Unique ID of VNFM.
48106       vim-id:
48107         type: string
48108         description: indecate the VIM to deploy VNF.
48109       certificate-url:
48110         type: string
48111         description: certificate url of VNFM.
48112       resource-version:
48113         type: string
48114         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48115       esr-system-info-list:
48116         type: object
48117         $ref: "#/definitions/esr-system-info-list"
48118       relationship-list:
48119         type: object
48120         $ref: "#/definitions/relationship-list"
48121   esr-vnfm-list:
48122     properties:
48123       esr-vnfm:
48124         type: array
48125         items:
48126           $ref: "#/definitions/esr-vnfm"
48127   evc:
48128     description: |
48129       evc object is an optional child object of the Configuration object.
48130       ###### Related Nodes
48131       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
48132
48133       -(4) IF this TO node is deleted, this EVC is DELETED also
48134     required:
48135     - evc-id
48136     properties:
48137       evc-id:
48138         type: string
48139         description: Unique/key field for the evc object
48140       forwarding-path-topology:
48141         type: string
48142         description: Point-to-Point, Multi-Point
48143       cir-value:
48144         type: string
48145         description: Commited Information Rate
48146       cir-units:
48147         type: string
48148         description: CIR units
48149       connection-diversity-group-id:
48150         type: string
48151         description: Diversity Group ID
48152       service-hours:
48153         type: string
48154         description: formerly Performance Group
48155       esp-evc-circuit-id:
48156         type: string
48157         description: EVC Circuit ID of ESP EVC
48158       esp-evc-cir-value:
48159         type: string
48160         description: Committed Information Rate (For ESP)
48161       esp-evc-cir-units:
48162         type: string
48163         description: CIR units (For ESP)
48164       esp-itu-code:
48165         type: string
48166         description: Identifies ESP
48167       collector-pop-clli:
48168         type: string
48169         description: Collector POP CLLI (from the hostname of the access pnf)
48170       inter-connect-type-ingress:
48171         type: string
48172         description: Interconnect type on ingress side of EVC.
48173       tagmode-access-ingress:
48174         type: string
48175         description: tagode for collector side of EVC
48176       tagmode-access-egress:
48177         type: string
48178         description: tagMode for network side of EVC
48179       relationship-list:
48180         type: array
48181         items:
48182           $ref: "#/definitions/relationship"
48183       resource-version:
48184         type: string
48185         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48186   evcs:
48187     properties:
48188       evc:
48189         type: array
48190         items:
48191           $ref: "#/definitions/evc"
48192   external-system:
48193     description: |
48194       Namespace for external system.
48195     properties:
48196       esr-ems-list:
48197         type: object
48198         $ref: "#/definitions/esr-ems-list"
48199       esr-vnfm-list:
48200         type: object
48201         $ref: "#/definitions/esr-vnfm-list"
48202       esr-thirdparty-sdnc-list:
48203         type: object
48204         $ref: "#/definitions/esr-thirdparty-sdnc-list"
48205   extra-properties:
48206     description: |
48207       Extra properties for inventory item for response list
48208     properties:
48209       extra-property:
48210         type: array
48211         items:
48212           $ref: "#/definitions/extra-property"
48213   extra-property:
48214     properties:
48215       property-name:
48216         type: string
48217       property-value:
48218         type: string
48219   flavor:
48220     description: |
48221       Openstack flavor.
48222       ###### Related Nodes
48223       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
48224       - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
48225       - FROM vserver( vserver Uses flavor, MANY2ONE)
48226
48227       -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
48228
48229     required:
48230     - flavor-id
48231     - flavor-name
48232     - flavor-selflink
48233     properties:
48234       flavor-id:
48235         type: string
48236         description: Flavor id, expected to be unique across cloud-region.
48237       flavor-name:
48238         type: string
48239         description: Cloud region Flavor name
48240       flavor-vcpus:
48241         type: integer
48242         format: int32
48243         description: Number of CPUs
48244       flavor-ram:
48245         type: integer
48246         format: int32
48247         description: Amount of memory
48248       flavor-disk:
48249         type: integer
48250         format: int32
48251         description: Disk space
48252       flavor-ephemeral:
48253         type: integer
48254         format: int32
48255         description: Amount of ephemeral disk space
48256       flavor-swap:
48257         type: string
48258         description: amount of swap space allocation
48259       flavor-is-public:
48260         type: boolean
48261         description: whether flavor is available to all users or private to the tenant it was created in.
48262       flavor-selflink:
48263         type: string
48264         description: URL to endpoint where AAI can get more details
48265       flavor-disabled:
48266         type: boolean
48267         description: Boolean as to whether this flavor is no longer enabled
48268       hpa-capabilities:
48269         type: array
48270         items:
48271           $ref: "#/definitions/hpa-capability"
48272         description: List of flavor specific HPA Capabilities
48273       resource-version:
48274         type: string
48275         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48276       relationship-list:
48277         type: array
48278         items:
48279           $ref: "#/definitions/relationship"
48280   flavors:
48281     description: |
48282       Collection of openstack flavors.
48283     properties:
48284       flavor:
48285         type: array
48286         items:
48287           $ref: "#/definitions/flavor"
48288   forwarder:
48289     description: |
48290       Entity describing a sequenced segment of forwarding path
48291       ###### Related Nodes
48292       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
48293       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
48294       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
48295       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
48296       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
48297
48298       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
48299       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
48300     required:
48301     - sequence
48302     properties:
48303       sequence:
48304         type: integer
48305         format: int32
48306         description: Unique ID of this segmentation
48307       forwarder-role:
48308         type: string
48309         description: ingress, intermediate, egress
48310       relationship-list:
48311         type: array
48312         items:
48313           $ref: "#/definitions/relationship"
48314       resource-version:
48315         type: string
48316         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48317   forwarder-evc:
48318     description: |
48319       forwarder object is an optional child object of the Configuration object.
48320       ###### Related Nodes
48321       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
48322
48323       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
48324     required:
48325     - forwarder-evc-id
48326     properties:
48327       forwarder-evc-id:
48328         type: string
48329         description: Key for forwarder-evc object
48330       circuit-id:
48331         type: string
48332         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
48333       ivlan:
48334         type: string
48335         description: Internal VLAN.
48336       svlan:
48337         type: string
48338         description: SVLAN value for ingress of egress forwarder.
48339       cvlan:
48340         type: string
48341         description: CVLAN value for ingress of egress forwarder.
48342       relationship-list:
48343         type: array
48344         items:
48345           $ref: "#/definitions/relationship"
48346       resource-version:
48347         type: string
48348         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48349   forwarder-evcs:
48350     properties:
48351       forwarder-evc:
48352         type: array
48353         items:
48354           $ref: "#/definitions/forwarder-evc"
48355   forwarders:
48356     properties:
48357       forwarder:
48358         type: array
48359         items:
48360           $ref: "#/definitions/forwarder"
48361   forwarding-path:
48362     description: |
48363       Entity that describes the sequenced forwarding path between interfaces of services or resources
48364       ###### Related Nodes
48365       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
48366       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
48367       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
48368
48369       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
48370       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
48371       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
48372     required:
48373     - forwarding-path-id
48374     - forwarding-path-name
48375     properties:
48376       forwarding-path-id:
48377         type: string
48378         description: Unique ID of this FP
48379       forwarding-path-name:
48380         type: string
48381         description: Name of the FP
48382       relationship-list:
48383         type: array
48384         items:
48385           $ref: "#/definitions/relationship"
48386       resource-version:
48387         type: string
48388         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
48389       selflink:
48390         type: string
48391         description: the self link for this FP
48392       forwarders:
48393         type: array
48394         items:
48395           $ref: "#/definitions/forwarder"
48396   forwarding-paths:
48397     properties:
48398       forwarding-path:
48399         type: array
48400         items:
48401           $ref: "#/definitions/forwarding-path"
48402   generic-vnf:
48403     description: |
48404       General purpose VNF
48405       ###### Related Nodes
48406       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
48407       - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
48408       - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
48409       - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
48410       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
48411       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
48412       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
48413       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
48414       - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
48415       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
48416       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
48417       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
48418       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
48419       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
48420       - TO model-ver( generic-vnf IsA model-ver, Many2One)
48421       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
48422       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
48423       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
48424       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
48425       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
48426       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
48427       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
48428       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
48429       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
48430       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
48431       - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
48432       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
48433       - FROM platform( platform Uses generic-vnf, MANY2MANY)
48434
48435       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
48436       -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
48437     required:
48438     - vnf-id
48439     - vnf-name
48440     - vnf-type
48441     - in-maint
48442     - is-closed-loop-disabled
48443     properties:
48444       vnf-id:
48445         type: string
48446         description: Unique id of VNF.  This is unique across the graph.
48447       vnf-instance-id:
48448         type: string
48449         description: vnf instance id.
48450       vnf-name:
48451         type: string
48452         description: Name of VNF.
48453       vnf-name2:
48454         type: string
48455         description: Alternate name of VNF.
48456       vnf-type:
48457         type: string
48458         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
48459       service-id:
48460         type: string
48461         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
48462       regional-resource-zone:
48463         type: string
48464         description: Regional way of organizing pservers, source of truth should define values
48465       prov-status:
48466         type: string
48467         description: Trigger for operational monitoring of this resource by Service Assurance systems.
48468       operational-status:
48469         type: string
48470         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
48471       license-key:
48472         type: string
48473         description: OBSOLETE -  do not use
48474       equipment-role:
48475         type: string
48476         description: Client should send valid enumerated value
48477       orchestration-status:
48478         type: string
48479         description: Orchestration status of this VNF, used by MSO.
48480       vnf-package-name:
48481         type: string
48482       vnf-discriptor-name:
48483         type: string
48484         description: vnf discriptor name
48485       job-id:
48486         type: string
48487         description: job id corresponding to vnf
48488       heat-stack-id:
48489         type: string
48490         description: Heat stack id corresponding to this instance, managed by MSO
48491       mso-catalog-key:
48492         type: string
48493         description: Corresponds to the SDN-C catalog id used to configure this VCE
48494       management-option:
48495         type: string
48496         description: identifier of managed by ATT or customer
48497       ipv4-oam-address:
48498         type: string
48499         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
48500       ipv4-loopback0-address:
48501         type: string
48502         description: v4 Loopback0 address
48503       nm-lan-v6-address:
48504         type: string
48505         description: v6 Loopback address
48506       management-v6-address:
48507         type: string
48508         description: v6 management address
48509       vcpu:
48510         type: integer
48511         format: int64
48512         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
48513       vcpu-units:
48514         type: string
48515         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
48516       vmemory:
48517         type: integer
48518         format: int64
48519         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
48520       vmemory-units:
48521         type: string
48522         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
48523       vdisk:
48524         type: integer
48525         format: int64
48526         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
48527       vdisk-units:
48528         type: string
48529         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
48530       nshd:
48531         type: integer
48532         format: int64
48533         description: number of associated SHD in vnf.
48534       nvm:
48535         type: integer
48536         format: int64
48537         description: number of vms in vnf.
48538       nnet:
48539         type: integer
48540         format: int64
48541         description: number of network in vnf.
48542       in-maint:
48543         type: boolean
48544         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
48545       is-closed-loop-disabled:
48546         type: boolean
48547         description: used to indicate whether closed loop function is enabled on this node
48548       resource-version:
48549         type: string
48550         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48551       summary-status:
48552         type: string
48553         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
48554       encrypted-access-flag:
48555         type: boolean
48556         description: indicates whether generic-vnf access uses SSH
48557       entitlement-assignment-group-uuid:
48558         type: string
48559         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
48560       entitlement-resource-uuid:
48561         type: string
48562         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
48563       license-assignment-group-uuid:
48564         type: string
48565         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
48566       license-key-uuid:
48567         type: string
48568         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
48569       model-invariant-id:
48570         type: string
48571         description: the ASDC model id for this resource or service model.
48572       model-version-id:
48573         type: string
48574         description: the ASDC model version for this resource or service model.
48575       persona-model-version:
48576         type: string
48577         description: the ASDC model version for this resource or service model.
48578       model-customization-id:
48579         type: string
48580         description: captures the id of all the configuration used to customize the resource for the service.
48581       widget-model-id:
48582         type: string
48583         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48584       widget-model-version:
48585         type: string
48586         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48587       as-number:
48588         type: string
48589         description: as-number of the VNF
48590       regional-resource-subzone:
48591         type: string
48592         description: represents sub zone of the rr plane
48593       nf-type:
48594         type: string
48595         description: Generic description of the type of NF
48596       nf-function:
48597         type: string
48598         description: English description of Network function that the specific VNF deployment is providing
48599       nf-role:
48600         type: string
48601         description: role in the network that this model will be providing
48602       nf-naming-code:
48603         type: string
48604         description: string assigned to this model used for naming purposes
48605       selflink:
48606         type: string
48607         description: Path to the controller object.
48608       ipv4-oam-gateway-address:
48609         type: string
48610         description: Gateway address
48611       ipv4-oam-gateway-address-prefix-length:
48612         type: integer
48613         format: int32
48614         description: Prefix length for oam-address
48615       vlan-id-outer:
48616         type: integer
48617         format: int64
48618         description: Temporary location for S-TAG to get to VCE
48619       nm-profile-name:
48620         type: string
48621         description: Network Management profile of this VNF
48622       relationship-list:
48623         type: array
48624         items:
48625           $ref: "#/definitions/relationship"
48626       l-interfaces:
48627         type: array
48628         items:
48629           $ref: "#/definitions/l-interface"
48630       lag-interfaces:
48631         type: array
48632         items:
48633           $ref: "#/definitions/lag-interface"
48634       vf-modules:
48635         type: array
48636         items:
48637           $ref: "#/definitions/vf-module"
48638       licenses:
48639         type: array
48640         items:
48641           $ref: "#/definitions/license"
48642       entitlements:
48643         type: array
48644         items:
48645           $ref: "#/definitions/entitlement"
48646   generic-vnfs:
48647     description: |
48648       Collection of VNFs
48649     properties:
48650       generic-vnf:
48651         type: array
48652         items:
48653           $ref: "#/definitions/generic-vnf"
48654   group-assignment:
48655     description: |
48656       Openstack group-assignment used to store exclusivity groups (EG).
48657       ###### Related Nodes
48658       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
48659       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
48660       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
48661
48662     required:
48663     - group-id
48664     - group-type
48665     - group-name
48666     properties:
48667       group-id:
48668         type: string
48669         description: Group id, expected to be unique across cloud-region.
48670       group-type:
48671         type: string
48672         description: Group type - the type of group this instance refers to
48673       group-name:
48674         type: string
48675         description: Group name - name assigned to the group
48676       group-description:
48677         type: string
48678         description: Group description - description of the group
48679       resource-version:
48680         type: string
48681         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48682       relationship-list:
48683         type: array
48684         items:
48685           $ref: "#/definitions/relationship"
48686   group-assignments:
48687     description: |
48688       Collection of openstack group assignments
48689     properties:
48690       group-assignment:
48691         type: array
48692         items:
48693           $ref: "#/definitions/group-assignment"
48694   host-route:
48695     description: |
48696       ###### Related Nodes
48697       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
48698
48699       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
48700     required:
48701     - host-route-id
48702     - route-prefix
48703     - next-hop
48704     properties:
48705       host-route-id:
48706         type: string
48707         description: host-route id
48708       route-prefix:
48709         type: string
48710         description: subnet prefix
48711       next-hop:
48712         type: string
48713         description: Could be ip-address, hostname, or service-instance
48714       next-hop-type:
48715         type: string
48716         description: Should be ip-address, hostname, or service-instance to match next-hop
48717       resource-version:
48718         type: string
48719         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48720       relationship-list:
48721         type: array
48722         items:
48723           $ref: "#/definitions/relationship"
48724   host-routes:
48725     properties:
48726       host-route:
48727         type: array
48728         items:
48729           $ref: "#/definitions/host-route"
48730   hpa-capabilities:
48731     description: |
48732       Collection of HPA Capabilities
48733     properties:
48734       hpa-capability:
48735         type: array
48736         items:
48737           $ref: "#/definitions/hpa-capability"
48738   hpa-capability:
48739     description: |
48740       Represents a HPA capability
48741       ###### Related Nodes
48742       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
48743       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
48744       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
48745
48746       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
48747     required:
48748     - hpa-capability-id
48749     - hpa-feature
48750     properties:
48751       hpa-capability-id:
48752         type: string
48753         description: UUID to uniquely identify a HPA capability
48754       hpa-feature:
48755         type: string
48756         description: Name of the HPACapability
48757       hpa-version:
48758         type: string
48759         description: HPA schema version
48760       architecture:
48761         type: string
48762         description: Hardware architecture
48763       resource-version:
48764         type: string
48765         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48766       relationship-list:
48767         type: array
48768         items:
48769           $ref: "#/definitions/relationship"
48770       hpa-feature-attributes:
48771         type: array
48772         items:
48773           $ref: "#/definitions/hpa-feature-attributes"
48774   hpa-feature-attributes:
48775     description: |
48776       HPA Capability Feature attributes
48777       ###### Related Nodes
48778       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
48779
48780       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
48781     required:
48782     - hpa-attribute-key
48783     properties:
48784       hpa-attribute-key:
48785         type: string
48786         description: name of the specific HPA attribute
48787       hpa-attribute-value:
48788         type: string
48789         description: JSON string specifying the value, unit and type of the specific HPA attribute
48790       resource-version:
48791         type: string
48792         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48793       relationship-list:
48794         type: array
48795         items:
48796           $ref: "#/definitions/relationship"
48797   image:
48798     description: |
48799       Openstack image.
48800       ###### Related Nodes
48801       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
48802       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
48803       - FROM vserver( vserver Uses image, MANY2ONE)
48804
48805       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
48806       -IMAGE cannot be deleted if related to VSERVER
48807
48808     required:
48809     - image-id
48810     - image-name
48811     - image-os-distro
48812     - image-os-version
48813     - image-selflink
48814     properties:
48815       image-id:
48816         type: string
48817         description: Image id, expected to be unique across cloud region
48818       image-name:
48819         type: string
48820         description: Image name
48821       image-architecture:
48822         type: string
48823         description: Operating system architecture.
48824       image-os-distro:
48825         type: string
48826         description: The common name of the operating system distribution in lowercase
48827       image-os-version:
48828         type: string
48829         description: The operating system version as specified by the distributor.
48830       application:
48831         type: string
48832         description: The application that the image instantiates.
48833       application-vendor:
48834         type: string
48835         description: The vendor of the application.
48836       application-version:
48837         type: string
48838         description: The version of the application.
48839       image-selflink:
48840         type: string
48841         description: URL to endpoint where AAI can get more details
48842       resource-version:
48843         type: string
48844         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48845       relationship-list:
48846         type: array
48847         items:
48848           $ref: "#/definitions/relationship"
48849       metadata:
48850         type: array
48851         items:
48852           $ref: "#/definitions/metadatum"
48853   images:
48854     description: |
48855       Collectio of Openstack images.
48856     properties:
48857       image:
48858         type: array
48859         items:
48860           $ref: "#/definitions/image"
48861   include-node-filter:
48862     properties:
48863       include-node-type:
48864         type: string
48865   instance-filter:
48866     description: |
48867       InstanceFilter for performing a named-query or model query
48868   instance-filters:
48869     description: |
48870       InstanceFilters for performing a named-query or model query
48871     properties:
48872       instance-filter:
48873         type: array
48874         items:
48875           $ref: "#/definitions/instance-filter"
48876   instance-group:
48877     description: |
48878       General mechanism for grouping instances
48879       ###### Related Nodes
48880       - TO model( instance-group Targets model, MANY2MANY)
48881       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
48882       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
48883       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
48884       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
48885       - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
48886       - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
48887       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
48888       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
48889       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
48890       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
48891       - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
48892
48893     required:
48894     - id
48895     - description
48896     - type
48897     properties:
48898       instance-group-role:
48899         type: string
48900         description: role of the instance group.
48901       model-invariant-id:
48902         type: string
48903         description: ASDC model id for this resource or service model.
48904       model-version-id:
48905         type: string
48906         description: ASDC model version uid for this resource model.
48907       id:
48908         type: string
48909         description: Instance Group ID, UUID assigned to this instance.
48910       description:
48911         type: string
48912         description: Descriptive text to help identify the usage of this instance-group
48913       type:
48914         type: string
48915         description: Only valid value today is lower case ha for high availability
48916       sub-type:
48917         type: string
48918         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
48919       resource-version:
48920         type: string
48921         description: Concurrency value
48922       relationship-list:
48923         type: array
48924         items:
48925           $ref: "#/definitions/relationship"
48926   instance-groups:
48927     description: |
48928       Collection of openstack route table references
48929     properties:
48930       instance-group:
48931         type: array
48932         items:
48933           $ref: "#/definitions/instance-group"
48934   inventory:
48935     properties:
48936       search:
48937         type: object
48938         $ref: "#/definitions/search"
48939       actions:
48940         type: object
48941         $ref: "#/definitions/actions"
48942       cloud-infrastructure:
48943         type: object
48944         $ref: "#/definitions/cloud-infrastructure"
48945       external-system:
48946         type: object
48947         $ref: "#/definitions/external-system"
48948       business:
48949         type: object
48950         $ref: "#/definitions/business"
48951       service-design-and-creation:
48952         type: object
48953         $ref: "#/definitions/service-design-and-creation"
48954       network:
48955         type: object
48956         $ref: "#/definitions/network"
48957       nodes:
48958         type: object
48959         $ref: "#/definitions/nodes"
48960   inventory-item:
48961     properties:
48962       inventory-item-type:
48963         type: string
48964       inventory-item-link:
48965         type: string
48966       inventory-item-data:
48967         type: array
48968         items:
48969           $ref: "#/definitions/inventory-item-data"
48970       tagged-inventory-item-list:
48971         type: array
48972         items:
48973           $ref: "#/definitions/tagged-inventory-item-list"
48974   inventory-item-data:
48975     properties:
48976       property-name:
48977         type: string
48978       property-value:
48979         type: string
48980   inventory-response-item:
48981     description: |
48982       Inventory item for response list
48983     properties:
48984       model-name:
48985         type: string
48986       extra-properties:
48987         type: object
48988         $ref: "#/definitions/extra-properties"
48989       inventory-response-items:
48990         type: object
48991         $ref: "#/definitions/inventory-response-items"
48992   inventory-response-items:
48993     description: |
48994       Container for inventory items in response list
48995     properties:
48996       inventory-response-item:
48997         type: array
48998         items:
48999           $ref: "#/definitions/inventory-response-item"
49000   ipsec-configuration:
49001     description: |
49002       IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
49003       ###### Related Nodes
49004       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
49005       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
49006
49007       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
49008     required:
49009     - ipsec-configuration-id
49010     properties:
49011       ipsec-configuration-id:
49012         type: string
49013         description: UUID of this configuration
49014       requested-vig-address-type:
49015         type: string
49016         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
49017       requested-encryption-strength:
49018         type: string
49019         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
49020       requested-dmz-type:
49021         type: string
49022         description: ATT can offer a shared DMZ or a DMZ specific to a customer
49023       shared-dmz-network-address:
49024         type: string
49025         description: Network address of shared DMZ
49026       requested-customer-name:
49027         type: string
49028         description: If the DMZ is a custom DMZ, this field will indicate the customer information
49029       ike-version:
49030         type: string
49031         description: can be 1 or 2
49032       ikev1-authentication:
49033         type: string
49034         description: Contains values like md5, sha1, sha256, sha384
49035       ikev1-encryption:
49036         type: string
49037         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
49038       ikev1-dh-group:
49039         type: string
49040         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
49041       ikev1-am-group-id:
49042         type: string
49043         description: Group name defined in VIG for clients using aggressive mode
49044       ikev1-am-password:
49045         type: string
49046         description: pre-shared key for the above group name
49047       ikev1-sa-lifetime:
49048         type: string
49049         description: Lifetime for IKEv1 SA
49050       ipsec-authentication:
49051         type: string
49052         description: md5, sha1, sha256, sha384
49053       ipsec-encryption:
49054         type: string
49055         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
49056       ipsec-sa-lifetime:
49057         type: string
49058         description: Life time for IPSec SA
49059       ipsec-pfs:
49060         type: string
49061         description: enable PFS or not
49062       xauth-userid:
49063         type: string
49064         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
49065       xauth-user-password:
49066         type: string
49067         description: Encrypted using the Juniper $9$ algorithm
49068       dpd-interval:
49069         type: string
49070         description: The time between DPD probe
49071       dpd-frequency:
49072         type: string
49073         description: Maximum number of DPD before claiming the tunnel is down
49074       resource-version:
49075         type: string
49076         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49077       relationship-list:
49078         type: array
49079         items:
49080           $ref: "#/definitions/relationship"
49081       vig-servers:
49082         type: array
49083         items:
49084           $ref: "#/definitions/vig-server"
49085   ipsec-configurations:
49086     properties:
49087       ipsec-configuration:
49088         type: array
49089         items:
49090           $ref: "#/definitions/ipsec-configuration"
49091   key-data:
49092     properties:
49093       key-name:
49094         type: string
49095       key-value:
49096         type: string
49097   l-interface:
49098     description: |
49099       Logical interfaces, e.g., a vnic.
49100       ###### Related Nodes
49101       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
49102       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
49103       - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
49104       - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
49105       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
49106       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
49107       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
49108       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
49109       - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
49110       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
49111       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
49112       - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
49113       - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
49114       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
49115       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
49116       - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
49117       - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
49118       - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
49119
49120       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
49121       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
49122       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
49123     required:
49124     - interface-name
49125     - is-port-mirrored
49126     - in-maint
49127     - is-ip-unnumbered
49128     properties:
49129       interface-name:
49130         type: string
49131         description: Name given to the interface
49132       interface-role:
49133         type: string
49134         description: E.g., CUSTOMER, UPLINK, etc.
49135       v6-wan-link-ip:
49136         type: string
49137         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
49138       selflink:
49139         type: string
49140         description: URL to endpoint where AAI can get more details
49141       interface-id:
49142         type: string
49143         description: ID of interface
49144       macaddr:
49145         type: string
49146         description: MAC address for the interface
49147       network-name:
49148         type: string
49149         description: Name of the network
49150       management-option:
49151         type: string
49152         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
49153       interface-description:
49154         type: string
49155         description: Human friendly text regarding this interface.
49156       is-port-mirrored:
49157         type: boolean
49158         description: boolean indicatating whether or not port is a mirrored.
49159       resource-version:
49160         type: string
49161         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49162       in-maint:
49163         type: boolean
49164         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
49165       prov-status:
49166         type: string
49167         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
49168       is-ip-unnumbered:
49169         type: boolean
49170         description: Flag indicating the interface uses the IP Unnumbered configuration.
49171       allowed-address-pairs:
49172         type: string
49173         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
49174       vlans:
49175         type: array
49176         items:
49177           $ref: "#/definitions/vlan"
49178       sriov-vfs:
49179         type: array
49180         items:
49181           $ref: "#/definitions/sriov-vf"
49182       l-interfaces:
49183         type: array
49184         items:
49185           $ref: "#/definitions/l-interface"
49186       relationship-list:
49187         type: array
49188         items:
49189           $ref: "#/definitions/relationship"
49190       l3-interface-ipv4-address-list:
49191         type: array
49192         items:
49193           $ref: "#/definitions/l3-interface-ipv4-address-list"
49194       l3-interface-ipv6-address-list:
49195         type: array
49196         items:
49197           $ref: "#/definitions/l3-interface-ipv6-address-list"
49198   l-interfaces:
49199     description: |
49200       Collection of logical interfaces.
49201     properties:
49202       l-interface:
49203         type: array
49204         items:
49205           $ref: "#/definitions/l-interface"
49206   l3-interface-ipv4-address-list:
49207     description: |
49208       IPv4 Address Range
49209       ###### Related Nodes
49210       - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
49211       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
49212       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
49213       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
49214       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
49215       - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
49216
49217       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
49218     required:
49219     - l3-interface-ipv4-address
49220     properties:
49221       l3-interface-ipv4-address:
49222         type: string
49223         description: IP address
49224       l3-interface-ipv4-prefix-length:
49225         type: integer
49226         format: int64
49227         description: Prefix length, 32 for single address
49228       vlan-id-inner:
49229         type: integer
49230         format: int64
49231         description: Inner VLAN tag
49232       vlan-id-outer:
49233         type: integer
49234         format: int64
49235         description: Outer VLAN tag
49236       is-floating:
49237         type: boolean
49238         description: Indicator of fixed or floating address
49239       resource-version:
49240         type: string
49241         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49242       neutron-network-id:
49243         type: string
49244         description: Neutron network id of the interface that address belongs to
49245       neutron-subnet-id:
49246         type: string
49247         description: Neutron id of subnet that address belongs to
49248       relationship-list:
49249         type: array
49250         items:
49251           $ref: "#/definitions/relationship"
49252   l3-interface-ipv6-address-list:
49253     description: |
49254       IPv6 Address Range
49255       ###### Related Nodes
49256       - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
49257       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
49258       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
49259       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
49260       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
49261       - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
49262
49263       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
49264     required:
49265     - l3-interface-ipv6-address
49266     properties:
49267       l3-interface-ipv6-address:
49268         type: string
49269         description: IP address
49270       l3-interface-ipv6-prefix-length:
49271         type: integer
49272         format: int64
49273         description: Prefix length, 128 for single address
49274       vlan-id-inner:
49275         type: integer
49276         format: int64
49277         description: Inner VLAN tag
49278       vlan-id-outer:
49279         type: integer
49280         format: int64
49281         description: Outer VLAN tag
49282       is-floating:
49283         type: boolean
49284         description: Indicator of fixed or floating address
49285       resource-version:
49286         type: string
49287         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49288       neutron-network-id:
49289         type: string
49290         description: Neutron network id of the interface that address belongs to
49291       neutron-subnet-id:
49292         type: string
49293         description: Neutron id of subnet that address belongs to
49294       relationship-list:
49295         type: array
49296         items:
49297           $ref: "#/definitions/relationship"
49298   l3-network:
49299     description: |
49300       Generic network definition
49301       ###### Related Nodes
49302       - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
49303       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
49304       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
49305       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
49306       - TO model-ver( l3-network IsA model-ver, Many2One)
49307       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
49308       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
49309       - FROM complex( complex Uses l3-network, MANY2MANY)
49310       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
49311       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
49312       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
49313       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
49314       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
49315       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
49316       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
49317       - FROM tenant( tenant Uses l3-network, MANY2MANY)
49318       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
49319
49320       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
49321     required:
49322     - network-id
49323     - network-name
49324     - is-bound-to-vpn
49325     - is-provider-network
49326     - is-shared-network
49327     - is-external-network
49328     properties:
49329       network-id:
49330         type: string
49331         description: Network ID, should be uuid. Unique across A&AI.
49332       network-name:
49333         type: string
49334         description: Name of the network, governed by some naming convention..
49335       network-type:
49336         type: string
49337         description: Type of the network - who defines these values?
49338       network-role:
49339         type: string
49340         description: Role the network plans - who defines these values?
49341       network-technology:
49342         type: string
49343         description: Network technology - who defines these values?
49344       neutron-network-id:
49345         type: string
49346         description: Neutron network id of this Interface
49347       is-bound-to-vpn:
49348         type: boolean
49349         description: Set to true if bound to VPN
49350       service-id:
49351         type: string
49352         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
49353       network-role-instance:
49354         type: integer
49355         format: int64
49356         description: network role instance
49357       resource-version:
49358         type: string
49359         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49360       orchestration-status:
49361         type: string
49362         description: Orchestration status of this VNF, mastered by MSO
49363       heat-stack-id:
49364         type: string
49365         description: Heat stack id corresponding to this instance, managed by MSO
49366       mso-catalog-key:
49367         type: string
49368         description: Corresponds to the SDN-C catalog id used to configure this VCE
49369       contrail-network-fqdn:
49370         type: string
49371         description: Contrail FQDN for the network
49372       model-invariant-id:
49373         type: string
49374         description: the ASDC model id for this resource or service model.
49375       model-version-id:
49376         type: string
49377         description: the ASDC model version for this resource or service model.
49378       persona-model-version:
49379         type: string
49380         description: the ASDC model version for this resource or service model.
49381       model-customization-id:
49382         type: string
49383         description: captures the id of all the configuration used to customize the resource for the service.
49384       widget-model-id:
49385         type: string
49386         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49387       widget-model-version:
49388         type: string
49389         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49390       physical-network-name:
49391         type: string
49392         description: Name associated with the physical network.
49393       is-provider-network:
49394         type: boolean
49395         description: boolean indicatating whether or not network is a provider network.
49396       is-shared-network:
49397         type: boolean
49398         description: boolean indicatating whether or not network is a shared network.
49399       is-external-network:
49400         type: boolean
49401         description: boolean indicatating whether or not network is an external network.
49402       selflink:
49403         type: string
49404         description: Path to the controller object.
49405       operational-status:
49406         type: string
49407         description: Indicator for whether the resource is considered operational.
49408       subnets:
49409         type: array
49410         items:
49411           $ref: "#/definitions/subnet"
49412       ctag-assignments:
49413         type: array
49414         items:
49415           $ref: "#/definitions/ctag-assignment"
49416       segmentation-assignments:
49417         type: array
49418         items:
49419           $ref: "#/definitions/segmentation-assignment"
49420       relationship-list:
49421         type: array
49422         items:
49423           $ref: "#/definitions/relationship"
49424         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
49425   l3-networks:
49426     properties:
49427       l3-network:
49428         type: array
49429         items:
49430           $ref: "#/definitions/l3-network"
49431   lag-interface:
49432     description: |
49433       Link aggregate interface
49434       ###### Related Nodes
49435       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
49436       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
49437       - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
49438       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
49439       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
49440       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
49441       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
49442       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
49443       - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
49444
49445       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
49446       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
49447       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
49448     required:
49449     - interface-name
49450     - in-maint
49451     properties:
49452       interface-name:
49453         type: string
49454         description: Name that identifies the link aggregate interface
49455       interface-description:
49456         type: string
49457         description: Human friendly text regarding this interface.
49458       resource-version:
49459         type: string
49460         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49461       speed-value:
49462         type: string
49463         description: Captures the numeric part of the speed
49464       speed-units:
49465         type: string
49466         description: Captures the units corresponding to the speed
49467       interface-id:
49468         type: string
49469         description: ID of interface
49470       interface-role:
49471         type: string
49472         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49473       prov-status:
49474         type: string
49475         description: Trigger for operational monitoring of this resource by Service Assurance systems.
49476       in-maint:
49477         type: boolean
49478         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
49479       relationship-list:
49480         type: array
49481         items:
49482           $ref: "#/definitions/relationship"
49483       l-interfaces:
49484         type: array
49485         items:
49486           $ref: "#/definitions/l-interface"
49487   lag-interfaces:
49488     description: |
49489       Collection of link aggregate interfaces.
49490     properties:
49491       lag-interface:
49492         type: array
49493         items:
49494           $ref: "#/definitions/lag-interface"
49495   lag-link:
49496     description: |
49497       LAG links can connect lag-interfaces
49498       ###### Related Nodes
49499       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
49500       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
49501
49502       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
49503     required:
49504     - link-name
49505     properties:
49506       link-name:
49507         type: string
49508         description: Alphabetical concatenation of lag-interface names
49509       resource-version:
49510         type: string
49511         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49512       relationship-list:
49513         type: array
49514         items:
49515           $ref: "#/definitions/relationship"
49516   lag-links:
49517     description: |
49518       Collection of link aggregation connections
49519     properties:
49520       lag-link:
49521         type: array
49522         items:
49523           $ref: "#/definitions/lag-link"
49524   license:
49525     description: |
49526       Metadata for license group.
49527       ###### Related Nodes
49528       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
49529       - TO vce( license BelongsTo vce, MANY2ONE)(4)
49530
49531       -(4) IF this TO node is deleted, this LICENSE is DELETED also
49532     required:
49533     - group-uuid
49534     - resource-uuid
49535     properties:
49536       group-uuid:
49537         type: string
49538         description: Unique ID for the license group the resource belongs to, should be uuid.
49539       resource-uuid:
49540         type: string
49541         description: Unique ID of a license resource.
49542       resource-version:
49543         type: string
49544         description: Concurrency value
49545       relationship-list:
49546         type: array
49547         items:
49548           $ref: "#/definitions/relationship"
49549   licenses:
49550     description: |
49551       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
49552     properties:
49553       license:
49554         type: array
49555         items:
49556           $ref: "#/definitions/license"
49557   line-of-business:
49558     description: |
49559       describes a line-of-business
49560       ###### Related Nodes
49561       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
49562
49563     required:
49564     - line-of-business-name
49565     properties:
49566       line-of-business-name:
49567         type: string
49568         description: Name of the line-of-business (product)
49569       resource-version:
49570         type: string
49571         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49572       relationship-list:
49573         type: array
49574         items:
49575           $ref: "#/definitions/relationship"
49576   lines-of-business:
49577     description: |
49578       Collection of lines-of-business
49579     properties:
49580       line-of-business:
49581         type: array
49582         items:
49583           $ref: "#/definitions/line-of-business"
49584   logical-link:
49585     description: |
49586       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
49587       ###### Related Nodes
49588       - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
49589       - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
49590       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
49591       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
49592       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
49593       - TO logical-link( logical-link Uses logical-link, MANY2MANY)
49594       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
49595       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
49596       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
49597       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
49598       - TO model-ver( logical-link IsA model-ver, Many2One)
49599       - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
49600       - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
49601       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
49602       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
49603       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
49604       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
49605       - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
49606
49607       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
49608       -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
49609     required:
49610     - link-name
49611     - in-maint
49612     - link-type
49613     properties:
49614       link-name:
49615         type: string
49616         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
49617       in-maint:
49618         type: boolean
49619         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
49620       link-type:
49621         type: string
49622         description: Type of logical link, e.g., evc
49623       speed-value:
49624         type: string
49625         description: Captures the numeric part of the speed
49626       speed-units:
49627         type: string
49628         description: Captures the units corresponding to the speed
49629       ip-version:
49630         type: string
49631         description: v4, v6, or ds for dual stack
49632       routing-protocol:
49633         type: string
49634         description: For example, static or BGP
49635       resource-version:
49636         type: string
49637         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49638       model-invariant-id:
49639         type: string
49640         description: the ASDC model id for this resource or service model.
49641       model-version-id:
49642         type: string
49643         description: the ASDC model version for this resource or service model.
49644       persona-model-version:
49645         type: string
49646         description: the ASDC model version for this resource or service model.
49647       widget-model-id:
49648         type: string
49649         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49650       widget-model-version:
49651         type: string
49652         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49653       operational-status:
49654         type: string
49655         description: Indication of operational status of the logical link.
49656       prov-status:
49657         type: string
49658         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
49659       link-role:
49660         type: string
49661         description: Indication of the network use of the logical link.
49662       link-name2:
49663         type: string
49664         description: Alias or alternate name (CLCI or D1 name).
49665       link-id:
49666         type: string
49667         description: UUID of the logical-link, SDNC generates this.
49668       circuit-id:
49669         type: string
49670         description: Circuit id
49671       purpose:
49672         type: string
49673         description: Reason for this entity, role it is playing
49674       relationship-list:
49675         type: array
49676         items:
49677           $ref: "#/definitions/relationship"
49678   logical-links:
49679     description: |
49680       Collection of logical connections
49681     properties:
49682       logical-link:
49683         type: array
49684         items:
49685           $ref: "#/definitions/logical-link"
49686   metadata:
49687     description: |
49688       Collection of metadatum (key/value pairs)
49689     properties:
49690       metadatum:
49691         type: array
49692         items:
49693           $ref: "#/definitions/metadatum"
49694   metadatum:
49695     description: |
49696       Key/value pairs
49697       ###### Related Nodes
49698       - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
49699       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
49700       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
49701       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
49702       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
49703
49704       -(4) IF this TO node is deleted, this METADATUM is DELETED also
49705     required:
49706     - metaname
49707     - metaval
49708     properties:
49709       metaname:
49710         type: string
49711       metaval:
49712         type: string
49713       resource-version:
49714         type: string
49715         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49716   model:
49717     description: |
49718       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
49719       ###### Related Nodes
49720       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
49721       - FROM instance-group( instance-group Targets model, MANY2MANY)
49722       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
49723       - FROM named-query( named-query AppliesTo model, ONE2MANY)
49724       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
49725
49726       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
49727       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
49728
49729     required:
49730     - model-invariant-id
49731     - model-type
49732     properties:
49733       model-invariant-id:
49734         type: string
49735         description: Unique identifier corresponding to the main definition of a model in ASDC
49736       model-type:
49737         type: string
49738         description: Type of the model, e.g., service, resource, widget, etc.
49739       resource-version:
49740         type: string
49741         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49742       model-vers:
49743         type: array
49744         items:
49745           $ref: "#/definitions/model-ver"
49746       relationship-list:
49747         type: array
49748         items:
49749           $ref: "#/definitions/relationship"
49750   model-and-named-query-search:
49751     description: |
49752       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
49753     properties:
49754       query-parameters:
49755         type: object
49756         $ref: "#/definitions/query-parameters"
49757       instance-filters:
49758         type: object
49759         $ref: "#/definitions/instance-filters"
49760       secondary-filts:
49761         type: object
49762         $ref: "#/definitions/secondary-filts"
49763       top-node-type:
49764         type: string
49765       secondary-filter-cut-point:
49766         type: string
49767   model-constraint:
49768     description: |
49769       This is how we would capture constraints defining allowed sets of elements.
49770       ###### Related Nodes
49771       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
49772       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
49773
49774       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
49775       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
49776     required:
49777     - model-constraint-uuid
49778     - constrained-element-set-uuid-to-replace
49779     properties:
49780       model-constraint-uuid:
49781         type: string
49782       constrained-element-set-uuid-to-replace:
49783         type: string
49784       constrained-element-sets:
49785         type: array
49786         items:
49787           $ref: "#/definitions/constrained-element-set"
49788       resource-version:
49789         type: string
49790         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49791   model-constraints:
49792     properties:
49793       model-constraint:
49794         type: array
49795         items:
49796           $ref: "#/definitions/model-constraint"
49797   model-element:
49798     description: |
49799       Defines how other models combine to make up a higher-level model.
49800       ###### Related Nodes
49801       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
49802       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
49803       - TO model-ver( model-element IsA model-ver, MANY2ONE)
49804       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
49805       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
49806       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
49807       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
49808
49809       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
49810       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
49811     required:
49812     - model-element-uuid
49813     - new-data-del-flag
49814     - cardinality
49815     properties:
49816       model-element-uuid:
49817         type: string
49818       new-data-del-flag:
49819         type: string
49820         description: Indicates whether this element was created as part of instantiation from this model
49821       cardinality:
49822         type: string
49823         description: How many of this type of element are required/allowed
49824       linkage-points:
49825         type: string
49826       resource-version:
49827         type: string
49828         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49829       model-elements:
49830         type: array
49831         items:
49832           $ref: "#/definitions/model-element"
49833         description: Defines how other models combine to make up a higher-level model
49834       model-constraints:
49835         type: array
49836         items:
49837           $ref: "#/definitions/model-constraint"
49838         description: Describes new constraints on this model element that are not part of that model's definition
49839       relationship-list:
49840         type: array
49841         items:
49842           $ref: "#/definitions/relationship"
49843   model-elements:
49844     properties:
49845       model-element:
49846         type: array
49847         items:
49848           $ref: "#/definitions/model-element"
49849   model-ver:
49850     description: |
49851       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
49852       ###### Related Nodes
49853       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
49854       - FROM model-element( model-element IsA model-ver, MANY2ONE)
49855       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
49856       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
49857       - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
49858       - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
49859       - FROM l3-network( l3-network IsA model-ver, Many2One)
49860       - FROM logical-link( logical-link IsA model-ver, Many2One)
49861       - FROM service-instance( service-instance IsA model-ver, Many2One)
49862       - FROM vf-module( vf-module IsA model-ver, Many2One)
49863
49864       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
49865       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
49866       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
49867
49868     required:
49869     - model-version-id
49870     - model-name
49871     - model-version
49872     properties:
49873       model-version-id:
49874         type: string
49875         description: Unique identifier corresponding to one version of a model in ASDC
49876       model-name:
49877         type: string
49878         description: Name of the model, which can change from version to version.
49879       model-version:
49880         type: string
49881         description: Version
49882       distribution-status:
49883         type: string
49884         description: Distribution Status
49885       model-description:
49886         type: string
49887         description: Description
49888       resource-version:
49889         type: string
49890         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49891       model-elements:
49892         type: array
49893         items:
49894           $ref: "#/definitions/model-element"
49895       metadata:
49896         type: array
49897         items:
49898           $ref: "#/definitions/metadatum"
49899       relationship-list:
49900         type: array
49901         items:
49902           $ref: "#/definitions/relationship"
49903   model-vers:
49904     properties:
49905       model-ver:
49906         type: array
49907         items:
49908           $ref: "#/definitions/model-ver"
49909   models:
49910     description: |
49911       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
49912     properties:
49913       model:
49914         type: array
49915         items:
49916           $ref: "#/definitions/model"
49917   multicast-configuration:
49918     description: |
49919       ###### Related Nodes
49920       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
49921
49922     required:
49923     - multicast-configuration-id
49924     - multicast-protocol
49925     - rp-type
49926     properties:
49927       multicast-configuration-id:
49928         type: string
49929         description: Unique id of multicast configuration.
49930       multicast-protocol:
49931         type: string
49932         description: protocol of multicast configuration
49933       rp-type:
49934         type: string
49935         description: rp type of multicast configuration
49936       resource-version:
49937         type: string
49938         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49939       relationship-list:
49940         type: array
49941         items:
49942           $ref: "#/definitions/relationship"
49943   multicast-configurations:
49944     description: |
49945       multicast configuration of generic-vnf ip-address
49946     properties:
49947       multicast-configuration:
49948         type: array
49949         items:
49950           $ref: "#/definitions/multicast-configuration"
49951   named-queries:
49952     properties:
49953       named-query:
49954         type: array
49955         items:
49956           $ref: "#/definitions/named-query"
49957   named-query:
49958     description: |
49959       TBD
49960       ###### Related Nodes
49961       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
49962       - TO model( named-query AppliesTo model, ONE2MANY)
49963       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
49964
49965       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
49966     required:
49967     - named-query-uuid
49968     - named-query-name
49969     - named-query-version
49970     properties:
49971       named-query-uuid:
49972         type: string
49973       named-query-name:
49974         type: string
49975       named-query-version:
49976         type: string
49977       required-input-param:
49978         type: string
49979       description:
49980         type: string
49981       resource-version:
49982         type: string
49983       named-query-elements:
49984         type: array
49985         items:
49986           $ref: "#/definitions/named-query-element"
49987       relationship-list:
49988         type: array
49989         items:
49990           $ref: "#/definitions/relationship"
49991   named-query-element:
49992     description: |
49993       TBD
49994       ###### Related Nodes
49995       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
49996       - TO model( named-query-element IsA model, MANY2ONE)
49997       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
49998       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
49999       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
50000       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
50001
50002       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
50003       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
50004     required:
50005     - named-query-element-uuid
50006     properties:
50007       named-query-element-uuid:
50008         type: string
50009       property-collect-list:
50010         type: string
50011       resource-version:
50012         type: string
50013       property-limit-desc:
50014         type: string
50015       do-not-output:
50016         type: string
50017       named-query-elements:
50018         type: array
50019         items:
50020           $ref: "#/definitions/named-query-element"
50021       related-lookups:
50022         type: array
50023         items:
50024           $ref: "#/definitions/related-lookup"
50025       property-constraints:
50026         type: array
50027         items:
50028           $ref: "#/definitions/property-constraint"
50029       relationship-list:
50030         type: array
50031         items:
50032           $ref: "#/definitions/relationship"
50033   named-query-elements:
50034     properties:
50035       named-query-element:
50036         type: array
50037         items:
50038           $ref: "#/definitions/named-query-element"
50039   network:
50040     description: |
50041       Namespace for network inventory resources.
50042     properties:
50043       logical-links:
50044         type: array
50045         items:
50046           $ref: "#/definitions/logical-link"
50047       site-pair-sets:
50048         type: array
50049         items:
50050           $ref: "#/definitions/site-pair-set"
50051       vpn-bindings:
50052         type: array
50053         items:
50054           $ref: "#/definitions/vpn-binding"
50055       vpls-pes:
50056         type: array
50057         items:
50058           $ref: "#/definitions/vpls-pe"
50059       multicast-configurations:
50060         type: array
50061         items:
50062           $ref: "#/definitions/multicast-configuration"
50063       vces:
50064         type: array
50065         items:
50066           $ref: "#/definitions/vce"
50067       vnfcs:
50068         type: array
50069         items:
50070           $ref: "#/definitions/vnfc"
50071       l3-networks:
50072         type: array
50073         items:
50074           $ref: "#/definitions/l3-network"
50075       network-policies:
50076         type: array
50077         items:
50078           $ref: "#/definitions/network-policy"
50079       generic-vnfs:
50080         type: array
50081         items:
50082           $ref: "#/definitions/generic-vnf"
50083       lag-links:
50084         type: array
50085         items:
50086           $ref: "#/definitions/lag-link"
50087       newvces:
50088         type: array
50089         items:
50090           $ref: "#/definitions/newvce"
50091       pnfs:
50092         type: array
50093         items:
50094           $ref: "#/definitions/pnf"
50095       physical-links:
50096         type: array
50097         items:
50098           $ref: "#/definitions/physical-link"
50099       ipsec-configurations:
50100         type: array
50101         items:
50102           $ref: "#/definitions/ipsec-configuration"
50103       route-table-references:
50104         type: array
50105         items:
50106           $ref: "#/definitions/route-table-reference"
50107       instance-groups:
50108         type: array
50109         items:
50110           $ref: "#/definitions/instance-group"
50111       zones:
50112         type: array
50113         items:
50114           $ref: "#/definitions/zone"
50115       configurations:
50116         type: array
50117         items:
50118           $ref: "#/definitions/configuration"
50119       forwarding-paths:
50120         type: array
50121         items:
50122           $ref: "#/definitions/forwarding-path"
50123   network-policies:
50124     properties:
50125       network-policy:
50126         type: array
50127         items:
50128           $ref: "#/definitions/network-policy"
50129   network-policy:
50130     description: |
50131       ###### Related Nodes
50132       - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
50133       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
50134
50135     required:
50136     - network-policy-id
50137     properties:
50138       network-policy-id:
50139         type: string
50140         description: UUID representing unique key to this instance
50141       network-policy-fqdn:
50142         type: string
50143         description: Contrail FQDN for the policy
50144       heat-stack-id:
50145         type: string
50146         description: ID for the openStack Heat instance
50147       resource-version:
50148         type: string
50149         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50150       relationship-list:
50151         type: array
50152         items:
50153           $ref: "#/definitions/relationship"
50154   network-profile:
50155     description: |
50156       Network profile populated by SDN-GP for SNMP
50157       ###### Related Nodes
50158       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
50159
50160     required:
50161     - nm-profile-name
50162     properties:
50163       nm-profile-name:
50164         type: string
50165         description: Unique name of network profile.
50166       community-string:
50167         type: string
50168         description: Encrypted SNMP community string
50169       resource-version:
50170         type: string
50171         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50172       relationship-list:
50173         type: array
50174         items:
50175           $ref: "#/definitions/relationship"
50176   network-profiles:
50177     description: |
50178       Collection of network profiles
50179     properties:
50180       network-profile:
50181         type: array
50182         items:
50183           $ref: "#/definitions/network-profile"
50184   newvce:
50185     description: |
50186       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
50187       ###### Related Nodes
50188       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
50189
50190       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
50191     required:
50192     - vnf-id2
50193     - vnf-name
50194     - vnf-type
50195     properties:
50196       vnf-id2:
50197         type: string
50198         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
50199       vnf-name:
50200         type: string
50201         description: Name of VNF.
50202       vnf-name2:
50203         type: string
50204         description: Alternate name of VNF.
50205       vnf-type:
50206         type: string
50207         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
50208       prov-status:
50209         type: string
50210         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50211       operational-status:
50212         type: string
50213         description: Indicator for whether the resource is considered operational
50214       license-key:
50215         type: string
50216         description: OBSOLETE -  do not use
50217       ipv4-oam-address:
50218         type: string
50219         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
50220       equipment-role:
50221         type: string
50222         description: Client should send valid enumerated value.
50223       resource-version:
50224         type: string
50225         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50226       ipv4-loopback0-address:
50227         type: string
50228         description: v4 Loopback0 address
50229       orchestration-status:
50230         type: string
50231         description: Orchestration status of this VNF, mastered by MSO.
50232       heat-stack-id:
50233         type: string
50234         description: Heat stack id corresponding to this instance, managed by MSO
50235       mso-catalog-key:
50236         type: string
50237         description: Corresponds to the SDN-C catalog id used to configure this VCE
50238       relationship-list:
50239         type: array
50240         items:
50241           $ref: "#/definitions/relationship"
50242       l-interfaces:
50243         type: array
50244         items:
50245           $ref: "#/definitions/l-interface"
50246   newvces:
50247     description: |
50248       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
50249     properties:
50250       newvce:
50251         type: array
50252         items:
50253           $ref: "#/definitions/newvce"
50254   nodes:
50255     properties:
50256       inventory-item-data:
50257         type: array
50258         items:
50259           $ref: "#/definitions/inventory-item-data"
50260   notification-event:
50261     properties:
50262       cambria.partition:
50263         type: string
50264       notification-event-header:
50265         type: object
50266         $ref: "#/definitions/notification-event-header"
50267   notification-event-header:
50268     properties:
50269       id:
50270         type: string
50271       timestamp:
50272         type: string
50273       source-name:
50274         type: string
50275       domain:
50276         type: string
50277       sequence-number:
50278         type: string
50279       severity:
50280         type: string
50281       event-type:
50282         type: string
50283       version:
50284         type: string
50285       action:
50286         type: string
50287       entity-type:
50288         type: string
50289       top-entity-type:
50290         type: string
50291       entity-link:
50292         type: string
50293       status:
50294         type: string
50295   notify:
50296     required:
50297     - event-id
50298     properties:
50299       event-id:
50300         type: string
50301       node-type:
50302         type: string
50303       event-trigger:
50304         type: string
50305       key-data:
50306         type: array
50307         items:
50308           $ref: "#/definitions/key-data"
50309       selflink:
50310         type: string
50311   oam-network:
50312     description: |
50313       OAM network, to be deprecated shortly.  Do not use for new purposes.
50314       ###### Related Nodes
50315       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
50316       - TO complex( oam-network AppliesTo complex, MANY2MANY)
50317       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
50318
50319     required:
50320     - network-uuid
50321     - network-name
50322     - cvlan-tag
50323     properties:
50324       network-uuid:
50325         type: string
50326         description: UUID of the network. Unique across a cloud-region
50327       network-name:
50328         type: string
50329         description: Name of the network.
50330       cvlan-tag:
50331         type: integer
50332         format: int64
50333         description: cvlan-id
50334       ipv4-oam-gateway-address:
50335         type: string
50336         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50337       ipv4-oam-gateway-address-prefix-length:
50338         type: integer
50339         format: int32
50340         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50341       resource-version:
50342         type: string
50343         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50344       relationship-list:
50345         type: array
50346         items:
50347           $ref: "#/definitions/relationship"
50348   oam-networks:
50349     description: |
50350       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
50351     properties:
50352       oam-network:
50353         type: array
50354         items:
50355           $ref: "#/definitions/oam-network"
50356   operational-environment:
50357     description: |
50358       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
50359       ###### Related Nodes
50360       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
50361       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
50362
50363     required:
50364     - operational-environment-id
50365     - operational-environment-name
50366     - operational-environment-type
50367     - operational-environment-status
50368     - tenant-context
50369     - workload-context
50370     properties:
50371       operational-environment-id:
50372         type: string
50373         description: UUID of an operational environment
50374       operational-environment-name:
50375         type: string
50376         description: Operational Environment name
50377       operational-environment-type:
50378         type: string
50379         description: Operational Environment Type.
50380       operational-environment-status:
50381         type: string
50382         description: Status
50383       tenant-context:
50384         type: string
50385         description: Tenant Context.
50386       workload-context:
50387         type: string
50388         description: Workload Context.
50389       resource-version:
50390         type: string
50391         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50392       relationship-list:
50393         type: array
50394         items:
50395           $ref: "#/definitions/relationship"
50396   operational-environments:
50397     description: |
50398       a logical partition of the cloud which allows to have multiple environments in the production AIC.
50399     properties:
50400       operational-environment:
50401         type: array
50402         items:
50403           $ref: "#/definitions/operational-environment"
50404   overloaded-model:
50405     description: |
50406       Allows for legacy POST of old-style and new-style models
50407     required:
50408     - model-invariant-id
50409     - model-name-version-id
50410     - model-type
50411     - model-name
50412     - model-id
50413     - model-version
50414     properties:
50415       model-invariant-id:
50416         type: string
50417         description: Unique identifier corresponding to the main definition of a model in ASDC
50418       model-name-version-id:
50419         type: string
50420         description: Unique identifier corresponding to one version of a model in ASDC
50421       model-type:
50422         type: string
50423         description: Type of the model, e.g., service, resource, widget, etc.
50424       model-name:
50425         type: string
50426         description: Name of the model, which can change from version to version.
50427       model-id:
50428         type: string
50429         description: Invariant unique ID which does not change from version to version
50430       model-version:
50431         type: string
50432         description: Version
50433       model-description:
50434         type: string
50435         description: Description
50436       resource-version:
50437         type: string
50438         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50439       model-vers:
50440         type: object
50441         $ref: "#/definitions/model-vers"
50442       relationship-list:
50443         type: object
50444         $ref: "#/definitions/relationship-list"
50445   owning-entities:
50446     description: |
50447       Collection of owning-entities
50448     properties:
50449       owning-entity:
50450         type: array
50451         items:
50452           $ref: "#/definitions/owning-entity"
50453   owning-entity:
50454     description: |
50455       describes an owning-entity
50456       ###### Related Nodes
50457       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
50458
50459     required:
50460     - owning-entity-id
50461     - owning-entity-name
50462     properties:
50463       owning-entity-id:
50464         type: string
50465         description: UUID of an owning entity
50466       owning-entity-name:
50467         type: string
50468         description: Owning entity name
50469       resource-version:
50470         type: string
50471         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50472       relationship-list:
50473         type: array
50474         items:
50475           $ref: "#/definitions/relationship"
50476   p-interface:
50477     description: |
50478       Physical interface (e.g., nic)
50479       ###### Related Nodes
50480       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
50481       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
50482       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
50483       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
50484       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
50485       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
50486       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
50487       - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
50488       - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
50489
50490       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
50491       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
50492       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
50493     required:
50494     - interface-name
50495     - in-maint
50496     properties:
50497       interface-name:
50498         type: string
50499         description: Name that identifies the physical interface
50500       selflink:
50501         type: string
50502         description: URL to endpoint where AAI can get more details.
50503       speed-value:
50504         type: string
50505         description: Captures the numeric part of the speed
50506       speed-units:
50507         type: string
50508         description: Captures the units corresponding to the speed
50509       port-description:
50510         type: string
50511         description: Nature of the services and connectivity on this port.
50512       equipment-identifier:
50513         type: string
50514         description: CLEI or other specification for p-interface hardware.
50515       interface-role:
50516         type: string
50517         description: Role specification for p-interface hardware.
50518       interface-type:
50519         type: string
50520         description: Indicates the physical properties of the interface.
50521       prov-status:
50522         type: string
50523         description: Trigger for operational monitoring of this resource by Service Assurance systems.
50524       mac-addresss:
50525         type: string
50526         description: MAC Address of the p-interface.
50527       resource-version:
50528         type: string
50529         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50530       in-maint:
50531         type: boolean
50532         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
50533       inv-status:
50534         type: string
50535         description: inventory status
50536       relationship-list:
50537         type: array
50538         items:
50539           $ref: "#/definitions/relationship"
50540       sriov-pfs:
50541         type: array
50542         items:
50543           $ref: "#/definitions/sriov-pf"
50544       l-interfaces:
50545         type: array
50546         items:
50547           $ref: "#/definitions/l-interface"
50548   p-interfaces:
50549     description: |
50550       Collection of physical interfaces.
50551     properties:
50552       p-interface:
50553         type: array
50554         items:
50555           $ref: "#/definitions/p-interface"
50556   physical-link:
50557     description: |
50558       Collection of physical connections, typically between p-interfaces
50559       ###### Related Nodes
50560       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
50561
50562       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
50563     required:
50564     - link-name
50565     properties:
50566       link-name:
50567         type: string
50568         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50569       speed-value:
50570         type: string
50571         description: Captures the numeric part of the speed
50572       speed-units:
50573         type: string
50574         description: Captures the units corresponding to the speed
50575       circuit-id:
50576         type: string
50577         description: Circuit it
50578       dual-mode:
50579         type: string
50580         description: Dual access mode (e.g., primary, secondary
50581       management-option:
50582         type: string
50583         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
50584       service-provider-name:
50585         type: string
50586         description: Name of the service Provider on this link.
50587       service-provider-bandwidth-up-value:
50588         type: integer
50589         format: int32
50590         description: Upstream Bandwidth value agreed with the service provider
50591       service-provider-bandwidth-up-units:
50592         type: string
50593         description: Units for the upstream BW value
50594       service-provider-bandwidth-down-value:
50595         type: integer
50596         format: int32
50597         description: Downstream Bandwidth value agreed with the service provider
50598       service-provider-bandwidth-down-units:
50599         type: string
50600         description: Units for downstream BW value
50601       resource-version:
50602         type: string
50603         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50604       relationship-list:
50605         type: array
50606         items:
50607           $ref: "#/definitions/relationship"
50608   physical-links:
50609     description: |
50610       Collection of physical connections, typically between p-interfaces
50611     properties:
50612       physical-link:
50613         type: array
50614         items:
50615           $ref: "#/definitions/physical-link"
50616   platform:
50617     description: |
50618       describes a platform
50619       ###### Related Nodes
50620       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
50621
50622     required:
50623     - platform-name
50624     properties:
50625       platform-name:
50626         type: string
50627         description: Name of the platform
50628       resource-version:
50629         type: string
50630         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50631       relationship-list:
50632         type: array
50633         items:
50634           $ref: "#/definitions/relationship"
50635   platforms:
50636     description: |
50637       Collection of platforms
50638     properties:
50639       platform:
50640         type: array
50641         items:
50642           $ref: "#/definitions/platform"
50643   pnf:
50644     description: |
50645       PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
50646       ###### Related Nodes
50647       - TO complex( pnf LocatedIn complex, MANY2ONE)
50648       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
50649       - TO zone( pnf LocatedIn zone, MANY2ONE)
50650       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
50651       - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
50652       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
50653       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
50654       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
50655       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
50656       - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
50657
50658       -(1) IF this PNF node is deleted, this FROM node is DELETED also
50659     required:
50660     - pnf-name
50661     - in-maint
50662     properties:
50663       pnf-name:
50664         type: string
50665         description: unique name of Physical Network Function.
50666       pnf-name2:
50667         type: string
50668         description: name of Physical Network Function.
50669       selflink:
50670         type: string
50671         description: URL to endpoint where AAI can get more details.
50672       pnf-name2-source:
50673         type: string
50674         description: source of name2
50675       pnf-id:
50676         type: string
50677         description: id of pnf
50678       equip-type:
50679         type: string
50680         description: Equipment type.  Source of truth should define valid values.
50681       equip-vendor:
50682         type: string
50683         description: Equipment vendor.  Source of truth should define valid values.
50684       equip-model:
50685         type: string
50686         description: Equipment model.  Source of truth should define valid values.
50687       management-option:
50688         type: string
50689         description: identifier of managed by ATT or customer
50690       ipaddress-v4-oam:
50691         type: string
50692         description: ipv4-oam-address with new naming convention for IP addresses
50693       sw-version:
50694         type: string
50695         description: sw-version is the version of SW for the hosted application on the PNF.
50696       in-maint:
50697         type: boolean
50698         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
50699       frame-id:
50700         type: string
50701         description: ID of the physical frame (relay rack) where pnf is installed.
50702       serial-number:
50703         type: string
50704         description: Serial number of the device
50705       ipaddress-v4-loopback-0:
50706         type: string
50707         description: IPV4 Loopback 0 address
50708       ipaddress-v6-loopback-0:
50709         type: string
50710         description: IPV6 Loopback 0 address
50711       ipaddress-v4-aim:
50712         type: string
50713         description: IPV4 AIM address
50714       ipaddress-v6-aim:
50715         type: string
50716         description: IPV6 AIM address
50717       ipaddress-v6-oam:
50718         type: string
50719         description: IPV6 OAM address
50720       inv-status:
50721         type: string
50722         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50723       resource-version:
50724         type: string
50725         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50726       prov-status:
50727         type: string
50728         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
50729       nf-role:
50730         type: string
50731         description: Nf Role is the role performed by this instance in the network.
50732       relationship-list:
50733         type: array
50734         items:
50735           $ref: "#/definitions/relationship"
50736       p-interfaces:
50737         type: array
50738         items:
50739           $ref: "#/definitions/p-interface"
50740       lag-interfaces:
50741         type: array
50742         items:
50743           $ref: "#/definitions/lag-interface"
50744   pnfs:
50745     description: |
50746       Collection of Physical Network Functions.
50747     properties:
50748       pnf:
50749         type: array
50750         items:
50751           $ref: "#/definitions/pnf"
50752   port-group:
50753     description: |
50754       Used to capture the network interfaces of this VCE
50755       ###### Related Nodes
50756       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
50757       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
50758
50759       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
50760       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
50761     required:
50762     - interface-id
50763     - orchestration-status
50764     properties:
50765       interface-id:
50766         type: string
50767         description: Unique ID of the interface
50768       neutron-network-id:
50769         type: string
50770         description: Neutron network id of this Interface
50771       neutron-network-name:
50772         type: string
50773         description: Neutron network name of this Interface
50774       interface-role:
50775         type: string
50776         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50777       resource-version:
50778         type: string
50779         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50780       port-group-id:
50781         type: string
50782         description: Unique ID for port group in vmware
50783       port-group-name:
50784         type: string
50785         description: Likely to duplicate value of neutron network name
50786       switch-name:
50787         type: string
50788         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
50789       orchestration-status:
50790         type: string
50791         description: Orchestration status of this VNF, mastered by MSO
50792       heat-stack-id:
50793         type: string
50794         description: Heat stack id corresponding to this instance, managed by MSO
50795       mso-catalog-key:
50796         type: string
50797         description: Corresponds to the SDN-C catalog id used to configure this VCE
50798       cvlan-tags:
50799         type: array
50800         items:
50801           $ref: "#/definitions/cvlan-tag-entry"
50802       relationship-list:
50803         type: array
50804         items:
50805           $ref: "#/definitions/relationship"
50806   port-groups:
50807     properties:
50808       port-group:
50809         type: array
50810         items:
50811           $ref: "#/definitions/port-group"
50812   project:
50813     description: |
50814       describes the project
50815       ###### Related Nodes
50816       - TO service-instance( project Uses service-instance, ONE2MANY)
50817
50818     required:
50819     - project-name
50820     properties:
50821       project-name:
50822         type: string
50823         description: Name of the project deploying a service
50824       resource-version:
50825         type: string
50826         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50827       relationship-list:
50828         type: array
50829         items:
50830           $ref: "#/definitions/relationship"
50831   projects:
50832     description: |
50833       Collection of projects
50834     properties:
50835       project:
50836         type: array
50837         items:
50838           $ref: "#/definitions/project"
50839   properties:
50840     description: |
50841       Property holder for query properties or instance properties
50842     properties:
50843       property-name:
50844         type: string
50845       property-value:
50846         type: string
50847   property-constraint:
50848     description: |
50849       TBD
50850       ###### Related Nodes
50851       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
50852
50853       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
50854     required:
50855     - property-constraint-uuid
50856     - constraint-type
50857     - property-name
50858     - property-value
50859     properties:
50860       property-constraint-uuid:
50861         type: string
50862       constraint-type:
50863         type: string
50864       property-name:
50865         type: string
50866       property-value:
50867         type: string
50868       resource-version:
50869         type: string
50870   property-constraints:
50871     properties:
50872       property-constraint:
50873         type: array
50874         items:
50875           $ref: "#/definitions/property-constraint"
50876   pserver:
50877     description: |
50878       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
50879       ###### Related Nodes
50880       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
50881       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
50882       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
50883       - TO complex( pserver LocatedIn complex, MANY2ONE)
50884       - TO zone( pserver LocatedIn zone, MANY2ONE)
50885       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
50886       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
50887       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
50888       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
50889       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
50890
50891       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
50892       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
50893
50894     required:
50895     - hostname
50896     - in-maint
50897     properties:
50898       hostname:
50899         type: string
50900         description: Value from executing hostname on the compute node.
50901       ptnii-equip-name:
50902         type: string
50903         description: PTNII name
50904       number-of-cpus:
50905         type: integer
50906         format: int32
50907         description: Number of cpus
50908       disk-in-gigabytes:
50909         type: integer
50910         format: int32
50911         description: Disk size, in GBs
50912       ram-in-megabytes:
50913         type: integer
50914         format: int32
50915         description: RAM size, in MBs
50916       equip-type:
50917         type: string
50918         description: Equipment type.  Source of truth should define valid values.
50919       equip-vendor:
50920         type: string
50921         description: Equipment vendor.  Source of truth should define valid values.
50922       equip-model:
50923         type: string
50924         description: Equipment model.  Source of truth should define valid values.
50925       fqdn:
50926         type: string
50927         description: Fully-qualified domain name
50928       pserver-selflink:
50929         type: string
50930         description: URL to endpoint where AAI can get more details
50931       ipv4-oam-address:
50932         type: string
50933         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
50934       serial-number:
50935         type: string
50936         description: Serial number, may be queried
50937       ipaddress-v4-loopback-0:
50938         type: string
50939         description: IPV4 Loopback 0 address
50940       ipaddress-v6-loopback-0:
50941         type: string
50942         description: IPV6 Loopback 0 address
50943       ipaddress-v4-aim:
50944         type: string
50945         description: IPV4 AIM address
50946       ipaddress-v6-aim:
50947         type: string
50948         description: IPV6 AIM address
50949       ipaddress-v6-oam:
50950         type: string
50951         description: IPV6 OAM address
50952       inv-status:
50953         type: string
50954         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50955       pserver-id:
50956         type: string
50957         description: ID of Pserver
50958       internet-topology:
50959         type: string
50960         description: internet topology of Pserver
50961       in-maint:
50962         type: boolean
50963         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
50964       resource-version:
50965         type: string
50966         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50967       pserver-name2:
50968         type: string
50969         description: alternative pserver name
50970       purpose:
50971         type: string
50972         description: purpose of pserver
50973       prov-status:
50974         type: string
50975         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
50976       management-option:
50977         type: string
50978         description: Indicates who owns and or manages the device.
50979       host-profile:
50980         type: string
50981         description: The host profile that defines the configuration of the pserver.
50982       relationship-list:
50983         type: array
50984         items:
50985           $ref: "#/definitions/relationship"
50986       p-interfaces:
50987         type: array
50988         items:
50989           $ref: "#/definitions/p-interface"
50990       lag-interfaces:
50991         type: array
50992         items:
50993           $ref: "#/definitions/lag-interface"
50994   pservers:
50995     description: |
50996       Collection of compute hosts.
50997     properties:
50998       pserver:
50999         type: array
51000         items:
51001           $ref: "#/definitions/pserver"
51002   query-parameters:
51003     description: |
51004       QueryParameters for performing a named-query or model query
51005     properties:
51006       named-query:
51007         type: object
51008         $ref: "#/definitions/named-query"
51009       overloaded-model:
51010         type: object
51011         $ref: "#/definitions/overloaded-model"
51012   related-lookup:
51013     description: |
51014       TBD
51015       ###### Related Nodes
51016       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
51017
51018       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
51019     required:
51020     - related-lookup-uuid
51021     - source-node-type
51022     - source-node-property
51023     - target-node-type
51024     - target-node-property
51025     properties:
51026       related-lookup-uuid:
51027         type: string
51028       source-node-type:
51029         type: string
51030       source-node-property:
51031         type: string
51032       target-node-type:
51033         type: string
51034       target-node-property:
51035         type: string
51036       property-collect-list:
51037         type: string
51038       resource-version:
51039         type: string
51040       relationship-list:
51041         type: array
51042         items:
51043           $ref: "#/definitions/relationship"
51044   related-lookups:
51045     properties:
51046       related-lookup:
51047         type: array
51048         items:
51049           $ref: "#/definitions/related-lookup"
51050   related-to-property:
51051     properties:
51052       property-key:
51053         type: string
51054         description: Key part of a key/value pair
51055       property-value:
51056         type: string
51057         description: Value part of a key/value pair
51058   relationship:
51059     properties:
51060       related-to:
51061         type: string
51062         description: A keyword provided by A&AI to indicate type of node.
51063       relationship-label:
51064         type: string
51065         description: The edge label for this relationship.
51066       related-link:
51067         type: string
51068         description: URL to the object in A&AI.
51069       relationship-data:
51070         type: array
51071         items:
51072           $ref: "#/definitions/relationship-data"
51073   relationship-data:
51074     required:
51075     - relationship-key
51076     - relationship-value
51077     properties:
51078       relationship-key:
51079         type: string
51080         description: A keyword provided by A&AI to indicate an attribute.
51081       relationship-value:
51082         type: string
51083         description: Value of the attribute.
51084   relationship-list:
51085     properties:
51086       relationship:
51087         type: array
51088         items:
51089           $ref: "#/definitions/relationship"
51090   reserved-prop-names:
51091     description: |
51092       Internal map to define some reserved properties of a vertex
51093     properties:
51094       last-mod-source-of-truth:
51095         type: string
51096       aai-node-type:
51097         type: string
51098       aai-created-ts:
51099         type: integer
51100         format: int64
51101       aai-unique-key:
51102         type: string
51103       aai-last-mod-ts:
51104         type: integer
51105         format: int64
51106       source-of-truth:
51107         type: string
51108       aai-uri:
51109         type: string
51110   response-list:
51111     description: |
51112       Response container for the results of a named-query or model query
51113     properties:
51114       inventory-response-items:
51115         type: object
51116         $ref: "#/definitions/inventory-response-items"
51117   result-data:
51118     properties:
51119       resource-type:
51120         type: string
51121         description: The specific type of node in the A&AI graph
51122       resource-link:
51123         type: string
51124         description: The URL to the specific resource
51125   route-table-reference:
51126     description: |
51127       Openstack route table reference.
51128       ###### Related Nodes
51129       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
51130
51131     required:
51132     - route-table-reference-id
51133     - route-table-reference-fqdn
51134     properties:
51135       route-table-reference-id:
51136         type: string
51137         description: Route Table Reference id, UUID assigned to this instance.
51138       route-table-reference-fqdn:
51139         type: string
51140         description: FQDN entry in the route table.
51141       resource-version:
51142         type: string
51143         description: Concurrency value
51144       relationship-list:
51145         type: array
51146         items:
51147           $ref: "#/definitions/relationship"
51148   route-table-references:
51149     description: |
51150       Collection of openstack route table references
51151     properties:
51152       route-table-reference:
51153         type: array
51154         items:
51155           $ref: "#/definitions/route-table-reference"
51156   route-target:
51157     description: |
51158       Route target information
51159       ###### Related Nodes
51160       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
51161
51162       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
51163     required:
51164     - global-route-target
51165     - route-target-role
51166     properties:
51167       global-route-target:
51168         type: string
51169         description: Number used to identify an RT, globally unique in the network
51170       route-target-role:
51171         type: string
51172         description: Role assigned to this route target
51173       resource-version:
51174         type: string
51175         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51176       relationship-list:
51177         type: array
51178         items:
51179           $ref: "#/definitions/relationship"
51180   route-targets:
51181     description: |
51182       Collection of route target information
51183     properties:
51184       route-target:
51185         type: array
51186         items:
51187           $ref: "#/definitions/route-target"
51188   routing-instance:
51189     description: |
51190       ###### Related Nodes
51191       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
51192       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
51193
51194       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
51195       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
51196     required:
51197     - routing-instance-id
51198     properties:
51199       routing-instance-id:
51200         type: string
51201         description: Unique id of routing instance
51202       rpm-owner:
51203         type: string
51204         description: rpm owner
51205       resource-version:
51206         type: string
51207         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51208       site-pairs:
51209         type: array
51210         items:
51211           $ref: "#/definitions/site-pair"
51212       relationship-list:
51213         type: array
51214         items:
51215           $ref: "#/definitions/relationship"
51216   routing-instances:
51217     description: |
51218       set of probes related to generic-vnf routing instance
51219     properties:
51220       routing-instance:
51221         type: array
51222         items:
51223           $ref: "#/definitions/routing-instance"
51224   sdn-zone-response:
51225     properties:
51226       oam-networks:
51227         type: object
51228         $ref: "#/definitions/oam-networks"
51229       az-and-dvs-switches:
51230         type: array
51231         items:
51232           $ref: "#/definitions/az-and-dvs-switches"
51233   search:
51234     properties:
51235       edge-tag-query-result:
51236         type: object
51237         $ref: "#/definitions/edge-tag-query-result"
51238       edge-tag-query-request:
51239         type: object
51240         $ref: "#/definitions/edge-tag-query-request"
51241       search-results:
51242         type: object
51243         $ref: "#/definitions/search-results"
51244       sdn-zone-response:
51245         type: object
51246         $ref: "#/definitions/sdn-zone-response"
51247   search-results:
51248     properties:
51249       result-data:
51250         type: array
51251         items:
51252           $ref: "#/definitions/result-data"
51253   secondary-filt:
51254     description: |
51255       SecondaryFilt for performing a named-query or model query
51256   secondary-filter:
51257     properties:
51258       property-name:
51259         type: string
51260       filter-type:
51261         type: string
51262       property-value:
51263         type: string
51264   secondary-filts:
51265     description: |
51266       SecondaryFilts for performing a named-query or model query
51267     properties:
51268       secondary-filt:
51269         type: array
51270         items:
51271           $ref: "#/definitions/secondary-filt"
51272   segmentation-assignment:
51273     description: |
51274       Openstack segmentation assignment.
51275       ###### Related Nodes
51276       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
51277
51278       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
51279     required:
51280     - segmentation-id
51281     properties:
51282       segmentation-id:
51283         type: string
51284         description: Route Table Reference id, UUID assigned to this instance.
51285       resource-version:
51286         type: string
51287         description: Concurrency value
51288       relationship-list:
51289         type: array
51290         items:
51291           $ref: "#/definitions/relationship"
51292   segmentation-assignments:
51293     description: |
51294       Collection of openstack segmentation assignments
51295     properties:
51296       segmentation-assignment:
51297         type: array
51298         items:
51299           $ref: "#/definitions/segmentation-assignment"
51300   service:
51301     description: |
51302       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
51303     required:
51304     - service-id
51305     - service-description
51306     properties:
51307       service-id:
51308         type: string
51309         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51310       service-description:
51311         type: string
51312         description: Description of the service
51313       service-selflink:
51314         type: string
51315         description: URL to endpoint where AAI can get more details
51316       resource-version:
51317         type: string
51318         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51319       service-version:
51320         type: string
51321         description: service version
51322       relationship-list:
51323         type: array
51324         items:
51325           $ref: "#/definitions/relationship"
51326   service-capabilities:
51327     description: |
51328       Collection of service capabilities.
51329     properties:
51330       service-capability:
51331         type: array
51332         items:
51333           $ref: "#/definitions/service-capability"
51334   service-capability:
51335     description: |
51336       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
51337       ###### Related Nodes
51338       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
51339       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
51340
51341       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
51342
51343     required:
51344     - service-type
51345     - vnf-type
51346     properties:
51347       service-type:
51348         type: string
51349         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51350       vnf-type:
51351         type: string
51352         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
51353       resource-version:
51354         type: string
51355         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51356       relationship-list:
51357         type: array
51358         items:
51359           $ref: "#/definitions/relationship"
51360   service-design-and-creation:
51361     description: |
51362       Namespace for objects managed by ASDC
51363     properties:
51364       vnf-images:
51365         type: array
51366         items:
51367           $ref: "#/definitions/vnf-image"
51368       services:
51369         type: array
51370         items:
51371           $ref: "#/definitions/service"
51372       service-capabilities:
51373         type: array
51374         items:
51375           $ref: "#/definitions/service-capability"
51376       models:
51377         type: array
51378         items:
51379           $ref: "#/definitions/model"
51380       named-queries:
51381         type: array
51382         items:
51383           $ref: "#/definitions/named-query"
51384   service-instance:
51385     description: |
51386       Instance of a service
51387       ###### Related Nodes
51388       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
51389       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
51390       - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
51391       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
51392       - TO configuration( service-instance Uses configuration, ONE2MANY)
51393       - TO connector( service-instance Uses connector, MANY2MANY)
51394       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
51395       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
51396       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
51397       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
51398       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
51399       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
51400       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
51401       - TO zone( service-instance LocatedIn zone, MANY2ONE)
51402       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
51403       - TO vce( service-instance ComposedOf vce, ONE2MANY)
51404       - TO model-ver( service-instance IsA model-ver, Many2One)
51405       - FROM project( project Uses service-instance, ONE2MANY)
51406       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
51407       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
51408       - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
51409       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
51410
51411       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
51412       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
51413       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
51414     required:
51415     - service-instance-id
51416     properties:
51417       service-instance-id:
51418         type: string
51419         description: Uniquely identifies this instance of a service
51420       service-instance-name:
51421         type: string
51422         description: This field will store a name assigned to the service-instance.
51423       service-type:
51424         type: string
51425         description: String capturing type of service.
51426       service-role:
51427         type: string
51428         description: String capturing the service role.
51429       environment-context:
51430         type: string
51431         description: This field will store the environment context assigned to the service-instance.
51432       workload-context:
51433         type: string
51434         description: This field will store the workload context assigned to the service-instance.
51435       created-at:
51436         type: string
51437         description: create time of Network Service.
51438       updated-at:
51439         type: string
51440         description: last update of Network Service.
51441       description:
51442         type: string
51443         description: short description for service-instance.
51444       model-invariant-id:
51445         type: string
51446         description: the ASDC model id for this resource or service model.
51447       model-version-id:
51448         type: string
51449         description: the ASDC model version for this resource or service model.
51450       persona-model-version:
51451         type: string
51452         description: the ASDC model version for this resource or service model.
51453       widget-model-id:
51454         type: string
51455         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51456       widget-model-version:
51457         type: string
51458         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51459       bandwidth-total:
51460         type: string
51461         description: Indicates the total bandwidth to be used for this service.
51462       bandwidth-up-wan1:
51463         type: string
51464         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
51465       bandwidth-down-wan1:
51466         type: string
51467         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
51468       bandwidth-up-wan2:
51469         type: string
51470         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
51471       bandwidth-down-wan2:
51472         type: string
51473         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
51474       vhn-portal-url:
51475         type: string
51476         description: URL customers will use to access the vHN Portal.
51477       service-instance-location-id:
51478         type: string
51479         description: An identifier that customers assign to the location where this service is being used.
51480       resource-version:
51481         type: string
51482         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51483       selflink:
51484         type: string
51485         description: Path to the controller object.
51486       orchestration-status:
51487         type: string
51488         description: Orchestration status of this service.
51489       relationship-list:
51490         type: array
51491         items:
51492           $ref: "#/definitions/relationship"
51493       metadata:
51494         type: array
51495         items:
51496           $ref: "#/definitions/metadatum"
51497       allotted-resources:
51498         type: array
51499         items:
51500           $ref: "#/definitions/allotted-resource"
51501   service-instances:
51502     description: |
51503       Collection of service instances
51504     properties:
51505       service-instance:
51506         type: array
51507         items:
51508           $ref: "#/definitions/service-instance"
51509   service-subscription:
51510     description: |
51511       Object that group service instances.
51512       ###### Related Nodes
51513       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
51514       - TO tenant( service-subscription Uses tenant, MANY2MANY)
51515       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
51516
51517       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
51518       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
51519     required:
51520     - service-type
51521     properties:
51522       service-type:
51523         type: string
51524         description: Value defined by orchestration to identify this service across ECOMP.
51525       temp-ub-sub-account-id:
51526         type: string
51527         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
51528       resource-version:
51529         type: string
51530         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51531       service-instances:
51532         type: array
51533         items:
51534           $ref: "#/definitions/service-instance"
51535       relationship-list:
51536         type: array
51537         items:
51538           $ref: "#/definitions/relationship"
51539   service-subscriptions:
51540     description: |
51541       Collection of objects that group service instances.
51542     properties:
51543       service-subscription:
51544         type: array
51545         items:
51546           $ref: "#/definitions/service-subscription"
51547   services:
51548     description: |
51549       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
51550     properties:
51551       service:
51552         type: array
51553         items:
51554           $ref: "#/definitions/service"
51555   site-pair:
51556     description: |
51557       ###### Related Nodes
51558       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
51559       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
51560
51561       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
51562       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
51563     required:
51564     - site-pair-id
51565     properties:
51566       site-pair-id:
51567         type: string
51568         description: unique identifier of probe
51569       source-ip:
51570         type: string
51571         description: Prefix address
51572       destination-ip:
51573         type: string
51574         description: Prefix address
51575       ip-version:
51576         type: string
51577         description: ip version, v4, v6
51578       destination-hostname:
51579         type: string
51580         description: Hostname of the destination equipment to which SLAs are measured against.
51581       destination-equip-type:
51582         type: string
51583         description: The type of destinatination equipment. Could be Router, UCPE, etc.
51584       resource-version:
51585         type: string
51586         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51587       classes-of-service:
51588         type: array
51589         items:
51590           $ref: "#/definitions/class-of-service"
51591       relationship-list:
51592         type: array
51593         items:
51594           $ref: "#/definitions/relationship"
51595   site-pair-set:
51596     description: |
51597       Set of instances for probes used to measure service level agreements
51598       ###### Related Nodes
51599       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
51600       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
51601
51602       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
51603     required:
51604     - site-pair-set-id
51605     properties:
51606       site-pair-set-id:
51607         type: string
51608         description: Unique id of site pair set.
51609       resource-version:
51610         type: string
51611         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51612       routing-instances:
51613         type: array
51614         items:
51615           $ref: "#/definitions/routing-instance"
51616       relationship-list:
51617         type: array
51618         items:
51619           $ref: "#/definitions/relationship"
51620   site-pair-sets:
51621     description: |
51622       Collection of sets of instances for probes related to generic-vnf
51623     properties:
51624       site-pair-set:
51625         type: array
51626         items:
51627           $ref: "#/definitions/site-pair-set"
51628   site-pairs:
51629     description: |
51630       probe within a set
51631     properties:
51632       site-pair:
51633         type: array
51634         items:
51635           $ref: "#/definitions/site-pair"
51636   snapshot:
51637     description: |
51638       Openstack snapshot
51639       ###### Related Nodes
51640       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
51641       - FROM vserver( vserver Uses snapshot, ONE2ONE)
51642
51643     required:
51644     - snapshot-id
51645     properties:
51646       snapshot-id:
51647         type: string
51648         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
51649       snapshot-name:
51650         type: string
51651         description: Snapshot name
51652       snapshot-architecture:
51653         type: string
51654         description: Operating system architecture
51655       snapshot-os-distro:
51656         type: string
51657         description: The common name of the operating system distribution in lowercase
51658       snapshot-os-version:
51659         type: string
51660         description: The operating system version as specified by the distributor.
51661       application:
51662         type: string
51663         description: The application that the image instantiates.
51664       application-vendor:
51665         type: string
51666         description: The vendor of the application.
51667       application-version:
51668         type: string
51669         description: The version of the application.
51670       snapshot-selflink:
51671         type: string
51672         description: URL to endpoint where AAI can get more details
51673       prev-snapshot-id:
51674         type: string
51675         description: This field contains the UUID of the previous snapshot (if any).
51676       resource-version:
51677         type: string
51678         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51679       relationship-list:
51680         type: array
51681         items:
51682           $ref: "#/definitions/relationship"
51683   snapshots:
51684     description: |
51685       Collection of openstack snapshots
51686     properties:
51687       snapshot:
51688         type: array
51689         items:
51690           $ref: "#/definitions/snapshot"
51691   sriov-pf:
51692     description: |
51693       SR-IOV Physical Function
51694       ###### Related Nodes
51695       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
51696       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
51697
51698       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
51699     required:
51700     - pf-pci-id
51701     properties:
51702       pf-pci-id:
51703         type: string
51704         description: Identifier for the sriov-pf
51705       resource-version:
51706         type: string
51707         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51708       relationship-list:
51709         type: array
51710         items:
51711           $ref: "#/definitions/relationship"
51712   sriov-pfs:
51713     description: |
51714       Collection of SR-IOV Physical Functions.
51715     properties:
51716       sriov-pf:
51717         type: array
51718         items:
51719           $ref: "#/definitions/sriov-pf"
51720   sriov-vf:
51721     description: |
51722       SR-IOV Virtual Function (not to be confused with virtual network function)
51723       ###### Related Nodes
51724       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
51725       - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
51726
51727       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
51728     required:
51729     - pci-id
51730     properties:
51731       pci-id:
51732         type: string
51733         description: PCI ID used to identify the sriov-vf
51734       vf-vlan-filter:
51735         type: string
51736         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
51737       vf-mac-filter:
51738         type: string
51739         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
51740       vf-vlan-strip:
51741         type: boolean
51742         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
51743       vf-vlan-anti-spoof-check:
51744         type: boolean
51745         description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
51746       vf-mac-anti-spoof-check:
51747         type: boolean
51748         description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
51749       vf-mirrors:
51750         type: string
51751         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
51752       vf-broadcast-allow:
51753         type: boolean
51754         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
51755       vf-unknown-multicast-allow:
51756         type: boolean
51757         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
51758       vf-unknown-unicast-allow:
51759         type: boolean
51760         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
51761       vf-insert-stag:
51762         type: boolean
51763         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
51764       vf-link-status:
51765         type: string
51766         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
51767       resource-version:
51768         type: string
51769         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51770       neutron-network-id:
51771         type: string
51772         description: Neutron network id of the interface
51773       relationship-list:
51774         type: array
51775         items:
51776           $ref: "#/definitions/relationship"
51777   sriov-vfs:
51778     description: |
51779       Collection of SR-IOV Virtual Functions.
51780     properties:
51781       sriov-vf:
51782         type: array
51783         items:
51784           $ref: "#/definitions/sriov-vf"
51785   start-node-filter:
51786     properties:
51787       property-name:
51788         type: string
51789       property-value:
51790         type: string
51791   subnet:
51792     description: |
51793       ###### Related Nodes
51794       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
51795       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
51796       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
51797       - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
51798       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
51799       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
51800
51801       -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
51802       -(4) IF this TO node is deleted, this SUBNET is DELETED also
51803       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
51804
51805     required:
51806     - subnet-id
51807     - dhcp-enabled
51808     properties:
51809       subnet-id:
51810         type: string
51811         description: Subnet ID, should be UUID.
51812       subnet-name:
51813         type: string
51814         description: Name associated with the subnet.
51815       neutron-subnet-id:
51816         type: string
51817         description: Neutron id of this subnet
51818       gateway-address:
51819         type: string
51820         description: gateway ip address
51821       network-start-address:
51822         type: string
51823         description: network start address
51824       cidr-mask:
51825         type: string
51826         description: cidr mask
51827       ip-version:
51828         type: string
51829         description: ip version
51830       orchestration-status:
51831         type: string
51832         description: Orchestration status of this VNF, mastered by MSO
51833       dhcp-enabled:
51834         type: boolean
51835         description: dhcp enabled
51836       dhcp-start:
51837         type: string
51838         description: the start address reserved for use by dhcp
51839       dhcp-end:
51840         type: string
51841         description: the last address reserved for use by dhcp
51842       subnet-role:
51843         type: string
51844         description: role of the subnet, referenced when assigning IPs
51845       ip-assignment-direction:
51846         type: string
51847         description: ip address assignment direction of the subnet
51848       resource-version:
51849         type: string
51850         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51851       subnet-sequence:
51852         type: integer
51853         format: int32
51854         description: sequence of the subnet
51855       host-routes:
51856         type: array
51857         items:
51858           $ref: "#/definitions/host-route"
51859       relationship-list:
51860         type: array
51861         items:
51862           $ref: "#/definitions/relationship"
51863   subnets:
51864     properties:
51865       subnet:
51866         type: array
51867         items:
51868           $ref: "#/definitions/subnet"
51869   tagged-inventory-item-list:
51870     properties:
51871       inventory-item:
51872         type: array
51873         items:
51874           $ref: "#/definitions/inventory-item"
51875   tenant:
51876     description: |
51877       Openstack tenant
51878       ###### Related Nodes
51879       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
51880       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
51881       - TO l3-network( tenant Uses l3-network, MANY2MANY)
51882       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
51883       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
51884       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
51885
51886       -TENANT cannot be deleted if related to VSERVER
51887
51888     required:
51889     - tenant-id
51890     - tenant-name
51891     properties:
51892       tenant-id:
51893         type: string
51894         description: Unique id relative to the cloud-region.
51895       tenant-name:
51896         type: string
51897         description: Readable name of tenant
51898       tenant-context:
51899         type: string
51900         description: This field will store the tenant context.
51901       resource-version:
51902         type: string
51903         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51904       vservers:
51905         type: array
51906         items:
51907           $ref: "#/definitions/vserver"
51908       relationship-list:
51909         type: array
51910         items:
51911           $ref: "#/definitions/relationship"
51912   tenants:
51913     description: |
51914       Collection of openstack tenants.
51915     properties:
51916       tenant:
51917         type: array
51918         items:
51919           $ref: "#/definitions/tenant"
51920   tunnel-xconnect:
51921     description: |
51922       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
51923       ###### Related Nodes
51924       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
51925
51926       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
51927     required:
51928     - id
51929     properties:
51930       id:
51931         type: string
51932         description: Allotted Resource id UUID assigned to this instance.
51933       bandwidth-up-wan1:
51934         type: string
51935         description: The WAN uplink bandwidth for WAN1
51936       bandwidth-down-wan1:
51937         type: string
51938         description: The WAN downlink bandwidth for WAN1
51939       bandwidth-up-wan2:
51940         type: string
51941         description: The WAN uplink bandwidth for WAN2
51942       bandwidth-down-wan2:
51943         type: string
51944         description: The WAN downlink bandwidth for WAN2
51945       resource-version:
51946         type: string
51947         description: Concurrency value
51948       relationship-list:
51949         type: array
51950         items:
51951           $ref: "#/definitions/relationship"
51952   tunnel-xconnects:
51953     description: |
51954       This object is used to store the specific tunnel cross connect aspects of an allotted resource
51955     properties:
51956       tunnel-xconnect:
51957         type: array
51958         items:
51959           $ref: "#/definitions/tunnel-xconnect"
51960   update:
51961     description: |
51962       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
51963     required:
51964     - update-node-type
51965     properties:
51966       update-node-type:
51967         type: string
51968       update-node-key:
51969         type: array
51970         items:
51971           $ref: "#/definitions/update-node-key"
51972       update-node-uri:
51973         type: string
51974       action:
51975         type: array
51976         items:
51977           $ref: "#/definitions/action"
51978   update-node-key:
51979     properties:
51980       key-name:
51981         type: string
51982       key-value:
51983         type: string
51984   vce:
51985     description: |
51986       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
51987       ###### Related Nodes
51988       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
51989       - TO complex( vce LocatedIn complex, MANY2MANY)
51990       - TO vserver( vce HostedOn vserver, ONE2MANY)
51991       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
51992       - FROM license( license BelongsTo vce, MANY2ONE)(1)
51993       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
51994       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
51995
51996       -(1) IF this VCE node is deleted, this FROM node is DELETED also
51997     required:
51998     - vnf-id
51999     - vnf-name
52000     - vnf-type
52001     properties:
52002       vnf-id:
52003         type: string
52004         description: Unique id of VNF.  This is unique across the graph.
52005       vnf-name:
52006         type: string
52007         description: Name of VNF.
52008       vnf-name2:
52009         type: string
52010         description: Alternate name of VNF.
52011       vnf-type:
52012         type: string
52013         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
52014       service-id:
52015         type: string
52016         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
52017       regional-resource-zone:
52018         type: string
52019         description: Regional way of organizing pservers, source of truth should define values
52020       prov-status:
52021         type: string
52022         description: Trigger for operational monitoring of this resource by Service Assurance systems.
52023       operational-status:
52024         type: string
52025         description: Indicator for whether the resource is considered operational
52026       license-key:
52027         type: string
52028         description: OBSOLETE -  do not use
52029       equipment-role:
52030         type: string
52031         description: Network role being played by this VNF
52032       orchestration-status:
52033         type: string
52034         description: Orchestration status of this VNF, mastered by MSO
52035       heat-stack-id:
52036         type: string
52037         description: Heat stack id corresponding to this instance, managed by MSO
52038       mso-catalog-key:
52039         type: string
52040         description: Corresponds to the SDN-C catalog id used to configure this VCE
52041       vpe-id:
52042         type: string
52043         description: Unique ID of VPE connected to this VCE.
52044       v6-vce-wan-address:
52045         type: string
52046         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
52047       ipv4-oam-address:
52048         type: string
52049         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
52050       resource-version:
52051         type: string
52052         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52053       ipv4-loopback0-address:
52054         type: string
52055         description: Loopback0 address
52056       entitlement-resource-uuid:
52057         type: string
52058         description: OBSOLETE -  see child relationships
52059       port-groups:
52060         type: array
52061         items:
52062           $ref: "#/definitions/port-group"
52063       licenses:
52064         type: array
52065         items:
52066           $ref: "#/definitions/license"
52067       entitlements:
52068         type: array
52069         items:
52070           $ref: "#/definitions/entitlement"
52071       relationship-list:
52072         type: array
52073         items:
52074           $ref: "#/definitions/relationship"
52075   vces:
52076     description: |
52077       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
52078     properties:
52079       vce:
52080         type: array
52081         items:
52082           $ref: "#/definitions/vce"
52083   vf-module:
52084     description: |
52085       a deployment unit of VNFCs
52086       ###### Related Nodes
52087       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
52088       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
52089       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
52090       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
52091       - TO vserver( vf-module Uses vserver, ONE2MANY)
52092       - TO model-ver( vf-module IsA model-ver, Many2One)
52093
52094       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
52095       -VF-MODULE cannot be deleted if related to VNFC
52096
52097     required:
52098     - vf-module-id
52099     - is-base-vf-module
52100     properties:
52101       vf-module-id:
52102         type: string
52103         description: Unique ID of vf-module.
52104       vf-module-name:
52105         type: string
52106         description: Name of vf-module
52107       heat-stack-id:
52108         type: string
52109         description: Heat stack id corresponding to this instance.
52110       orchestration-status:
52111         type: string
52112         description: orchestration status of this vf-module, mastered by MSO
52113       is-base-vf-module:
52114         type: boolean
52115         description: used to indicate whether or not this object is base vf module
52116       resource-version:
52117         type: string
52118         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52119       model-invariant-id:
52120         type: string
52121         description: the ASDC model id for this resource or service model.
52122       model-version-id:
52123         type: string
52124         description: the ASDC model version for this resource or service model.
52125       persona-model-version:
52126         type: string
52127         description: the ASDC model version for this resource or service model.
52128       model-customization-id:
52129         type: string
52130         description: captures the id of all the configuration used to customize the resource for the service.
52131       widget-model-id:
52132         type: string
52133         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52134       widget-model-version:
52135         type: string
52136         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52137       contrail-service-instance-fqdn:
52138         type: string
52139         description: the Contrail unique ID for a service-instance
52140       module-index:
52141         type: integer
52142         format: int32
52143         description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
52144       selflink:
52145         type: string
52146         description: Path to the controller object.
52147       relationship-list:
52148         type: array
52149         items:
52150           $ref: "#/definitions/relationship"
52151   vf-modules:
52152     description: |
52153       Collection of vf-modules, a deployment unit of VNFCs
52154     properties:
52155       vf-module:
52156         type: array
52157         items:
52158           $ref: "#/definitions/vf-module"
52159   vig-server:
52160     description: |
52161       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
52162       ###### Related Nodes
52163       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
52164
52165       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
52166     required:
52167     - vig-address-type
52168     properties:
52169       vig-address-type:
52170         type: string
52171         description: indicates whether the VIG is for AVPN or INTERNET
52172       ipaddress-v4-vig:
52173         type: string
52174         description: v4 IP of the vig server
52175       ipaddress-v6-vig:
52176         type: string
52177         description: v6 IP of the vig server
52178       resource-version:
52179         type: string
52180         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52181       relationship-list:
52182         type: array
52183         items:
52184           $ref: "#/definitions/relationship"
52185   vig-servers:
52186     properties:
52187       vig-server:
52188         type: array
52189         items:
52190           $ref: "#/definitions/vig-server"
52191   vip-ipv4-address-list:
52192     description: |
52193       IPv4 Address Range
52194       ###### Related Nodes
52195       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
52196       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
52197       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
52198       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
52199
52200     required:
52201     - vip-ipv4-address
52202     properties:
52203       vip-ipv4-address:
52204         type: string
52205         description: IP address
52206       vip-ipv4-prefix-length:
52207         type: integer
52208         format: int64
52209         description: Prefix length, 32 for single address
52210       vlan-id-inner:
52211         type: integer
52212         format: int64
52213         description: Inner VLAN tag
52214       vlan-id-outer:
52215         type: integer
52216         format: int64
52217         description: Outer VLAN tag
52218       is-floating:
52219         type: boolean
52220         description: Indicator of fixed or floating address
52221       resource-version:
52222         type: string
52223         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52224       neutron-network-id:
52225         type: string
52226         description: Neutron network id of the interface that address belongs to
52227       neutron-subnet-id:
52228         type: string
52229         description: Neutron id of subnet that address belongs to
52230       relationship-list:
52231         type: array
52232         items:
52233           $ref: "#/definitions/relationship"
52234   vip-ipv6-address-list:
52235     description: |
52236       IPv6 Address Range
52237       ###### Related Nodes
52238       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
52239       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
52240       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
52241       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
52242
52243     required:
52244     - vip-ipv6-address
52245     properties:
52246       vip-ipv6-address:
52247         type: string
52248         description: IP address
52249       vip-ipv6-prefix-length:
52250         type: integer
52251         format: int64
52252         description: Prefix length, 128 for single address
52253       vlan-id-inner:
52254         type: integer
52255         format: int64
52256         description: Inner VLAN tag
52257       vlan-id-outer:
52258         type: integer
52259         format: int64
52260         description: Outer VLAN tag
52261       is-floating:
52262         type: boolean
52263         description: Indicator of fixed or floating address
52264       resource-version:
52265         type: string
52266         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52267       neutron-network-id:
52268         type: string
52269         description: Neutron network id of the interface that address belongs to
52270       neutron-subnet-id:
52271         type: string
52272         description: Neutron id of subnet that address belongs to
52273       relationship-list:
52274         type: array
52275         items:
52276           $ref: "#/definitions/relationship"
52277   virtual-data-center:
52278     description: |
52279       Virtual organization of cloud infrastructure elements in a data center context
52280       ###### Related Nodes
52281       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
52282       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
52283       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
52284
52285     required:
52286     - vdc-id
52287     - vdc-name
52288     properties:
52289       vdc-id:
52290         type: string
52291         description: Unique ID of the vdc
52292       vdc-name:
52293         type: string
52294         description: Name of the virtual data center
52295       resource-version:
52296         type: string
52297         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52298       relationship-list:
52299         type: array
52300         items:
52301           $ref: "#/definitions/relationship"
52302   virtual-data-centers:
52303     description: |
52304       Virtual organization of cloud infrastructure elements in a data center context
52305     properties:
52306       virtual-data-center:
52307         type: array
52308         items:
52309           $ref: "#/definitions/virtual-data-center"
52310   vlan:
52311     description: |
52312       Definition of vlan
52313       ###### Related Nodes
52314       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
52315       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
52316       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
52317       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
52318       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
52319       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
52320       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
52321
52322       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
52323       -(2) IF this VLAN node is deleted, this TO node is DELETED also
52324       -(4) IF this TO node is deleted, this VLAN is DELETED also
52325     required:
52326     - vlan-interface
52327     - in-maint
52328     - is-ip-unnumbered
52329     properties:
52330       vlan-interface:
52331         type: string
52332         description: String that identifies the interface
52333       vlan-id-inner:
52334         type: integer
52335         format: int64
52336         description: Inner VLAN tag
52337       vlan-id-outer:
52338         type: integer
52339         format: int64
52340         description: Outer VLAN tag
52341       resource-version:
52342         type: string
52343         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52344       speed-value:
52345         type: string
52346         description: Captures the numeric part of the speed
52347       speed-units:
52348         type: string
52349         description: Captures the units corresponding to the speed
52350       vlan-description:
52351         type: string
52352         description: Used to describe (the service associated with) the vlan
52353       backdoor-connection:
52354         type: string
52355         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
52356       vpn-key:
52357         type: string
52358         description: This indicates the customers VPN ID associated with this vlan
52359       orchestration-status:
52360         type: string
52361         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
52362       in-maint:
52363         type: boolean
52364         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
52365       prov-status:
52366         type: string
52367         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
52368       is-ip-unnumbered:
52369         type: boolean
52370         description: Flag indicating the interface uses the IP Unnumbered configuration.
52371       relationship-list:
52372         type: array
52373         items:
52374           $ref: "#/definitions/relationship"
52375       l3-interface-ipv4-address-list:
52376         type: array
52377         items:
52378           $ref: "#/definitions/l3-interface-ipv4-address-list"
52379       l3-interface-ipv6-address-list:
52380         type: array
52381         items:
52382           $ref: "#/definitions/l3-interface-ipv6-address-list"
52383   vlans:
52384     properties:
52385       vlan:
52386         type: array
52387         items:
52388           $ref: "#/definitions/vlan"
52389   vnf:
52390     description: |
52391       Abstract vnf class
52392     required:
52393     - vnf-id
52394     properties:
52395       vnf-id:
52396         type: string
52397         description: Unique id of VNF.  This is unique across the graph.
52398   vnf-image:
52399     description: |
52400       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
52401       ###### Related Nodes
52402       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
52403
52404       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
52405
52406     required:
52407     - vnf-image-uuid
52408     - application
52409     - application-vendor
52410     properties:
52411       vnf-image-uuid:
52412         type: string
52413         description: Unique ID of this asset
52414       application:
52415         type: string
52416         description: The application that the image instantiates.
52417       application-vendor:
52418         type: string
52419         description: The vendor of the application.
52420       application-version:
52421         type: string
52422         description: The version of the application.
52423       selflink:
52424         type: string
52425         description: URL to endpoint where AAI can get more details
52426       resource-version:
52427         type: string
52428         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52429       relationship-list:
52430         type: array
52431         items:
52432           $ref: "#/definitions/relationship"
52433   vnf-images:
52434     description: |
52435       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
52436     properties:
52437       vnf-image:
52438         type: array
52439         items:
52440           $ref: "#/definitions/vnf-image"
52441   vnfc:
52442     description: |
52443       ###### Related Nodes
52444       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
52445       - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
52446       - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
52447       - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
52448       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
52449       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
52450       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
52451       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
52452
52453       -(1) IF this VNFC node is deleted, this FROM node is DELETED also
52454       -(4) IF this TO node is deleted, this VNFC is DELETED also
52455     required:
52456     - vnfc-name
52457     - nfc-naming-code
52458     - nfc-function
52459     - in-maint
52460     - is-closed-loop-disabled
52461     properties:
52462       vnfc-name:
52463         type: string
52464         description: Unique ID of vnfc.
52465       nfc-naming-code:
52466         type: string
52467         description: Short code that is used in naming instances of the item being modeled
52468       nfc-function:
52469         type: string
52470         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
52471       prov-status:
52472         type: string
52473         description: prov status of this vnfc
52474       orchestration-status:
52475         type: string
52476         description: Orchestration status of this VNF, mastered by APP-C
52477       ipaddress-v4-oam-vip:
52478         type: string
52479         description: Oam V4 vip address of this vnfc
52480       in-maint:
52481         type: boolean
52482         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
52483       is-closed-loop-disabled:
52484         type: boolean
52485         description: used to indicate whether closed loop function is enabled on this node
52486       group-notation:
52487         type: string
52488         description: Group notation of VNFC
52489       model-invariant-id:
52490         type: string
52491         description: the ASDC model id for this resource or service model.
52492       model-version-id:
52493         type: string
52494         description: the ASDC model version for this resource or service model.
52495       resource-version:
52496         type: string
52497         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52498       relationship-list:
52499         type: array
52500         items:
52501           $ref: "#/definitions/relationship"
52502       l3-interface-ipv4-address-list:
52503         type: array
52504         items:
52505           $ref: "#/definitions/l3-interface-ipv4-address-list"
52506       l3-interface-ipv6-address-list:
52507         type: array
52508         items:
52509           $ref: "#/definitions/l3-interface-ipv6-address-list"
52510   vnfcs:
52511     description: |
52512       virtual network components associated with a vserver from application controller.
52513     properties:
52514       vnfc:
52515         type: array
52516         items:
52517           $ref: "#/definitions/vnfc"
52518   volume:
52519     description: |
52520       Ephemeral Block storage volume.
52521       ###### Related Nodes
52522       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
52523
52524       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
52525     required:
52526     - volume-id
52527     - volume-selflink
52528     properties:
52529       volume-id:
52530         type: string
52531         description: Unique ID of block storage volume relative to the vserver.
52532       volume-selflink:
52533         type: string
52534         description: URL to endpoint where AAI can get more details
52535       resource-version:
52536         type: string
52537         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52538       relationship-list:
52539         type: array
52540         items:
52541           $ref: "#/definitions/relationship"
52542   volume-group:
52543     description: |
52544       Persistent block-level storage.
52545       ###### Related Nodes
52546       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
52547       - TO complex( volume-group LocatedIn complex, MANY2ONE)
52548       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
52549       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
52550       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
52551
52552     required:
52553     - volume-group-id
52554     - volume-group-name
52555     - vnf-type
52556     properties:
52557       volume-group-id:
52558         type: string
52559         description: Unique ID of volume-group.
52560       volume-group-name:
52561         type: string
52562         description: Name of the volume group.
52563       heat-stack-id:
52564         type: string
52565         description: Heat stack id corresponding to this volume-group
52566       vnf-type:
52567         type: string
52568         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
52569       orchestration-status:
52570         type: string
52571         description: Orchestration status of this volume-group
52572       model-customization-id:
52573         type: string
52574         description: captures the id of all the configuration used to customize the resource for the service.
52575       vf-module-model-customization-id:
52576         type: string
52577         description: helps relate the volume group to the vf-module whose components will require the volume group
52578       resource-version:
52579         type: string
52580         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52581       relationship-list:
52582         type: array
52583         items:
52584           $ref: "#/definitions/relationship"
52585   volume-groups:
52586     description: |
52587       Collection of persistent block-level storage.
52588     properties:
52589       volume-group:
52590         type: array
52591         items:
52592           $ref: "#/definitions/volume-group"
52593   volumes:
52594     description: |
52595       Collection of ephemeral Block storage volumes.
52596     properties:
52597       volume:
52598         type: array
52599         items:
52600           $ref: "#/definitions/volume"
52601   vpls-pe:
52602     description: |
52603       VPLS Provider Edge routers.
52604       ###### Related Nodes
52605       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
52606       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
52607       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
52608       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
52609
52610       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
52611     required:
52612     - equipment-name
52613     properties:
52614       equipment-name:
52615         type: string
52616       prov-status:
52617         type: string
52618         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52619       ipv4-oam-address:
52620         type: string
52621         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
52622       equipment-role:
52623         type: string
52624         description: Client should send valid enumerated value, e.g., VPLS-PE.
52625       vlan-id-outer:
52626         type: integer
52627         format: int64
52628         description: Temporary location for stag to get to VCE
52629       resource-version:
52630         type: string
52631         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52632       relationship-list:
52633         type: array
52634         items:
52635           $ref: "#/definitions/relationship"
52636       p-interfaces:
52637         type: array
52638         items:
52639           $ref: "#/definitions/p-interface"
52640       lag-interfaces:
52641         type: array
52642         items:
52643           $ref: "#/definitions/lag-interface"
52644   vpls-pes:
52645     description: |
52646       Collection of VPLS Provider Edge routers
52647     properties:
52648       vpls-pe:
52649         type: array
52650         items:
52651           $ref: "#/definitions/vpls-pe"
52652   vpn-binding:
52653     description: |
52654       VPN binding
52655       ###### Related Nodes
52656       - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
52657       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
52658       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
52659       - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
52660
52661       -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
52662       -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
52663
52664     required:
52665     - vpn-id
52666     - vpn-name
52667     properties:
52668       vpn-id:
52669         type: string
52670         description: VPN ID, globally unique within A&AI
52671       vpn-name:
52672         type: string
52673         description: VPN Name
52674       vpn-platform:
52675         type: string
52676         description: the platform associated with the VPN example AVPN, Mobility
52677       vpn-type:
52678         type: string
52679         description: Type of the vpn, should be taken from enumerated/valid values
52680       vpn-region:
52681         type: string
52682         description: region of customer vpn
52683       customer-vpn-id:
52684         type: string
52685         description: id for this customer vpn
52686       route-distinguisher:
52687         type: string
52688         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
52689       resource-version:
52690         type: string
52691         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52692       route-targets:
52693         type: array
52694         items:
52695           $ref: "#/definitions/route-target"
52696       relationship-list:
52697         type: array
52698         items:
52699           $ref: "#/definitions/relationship"
52700         description: l3-networks relate to vpn-bindings
52701   vpn-bindings:
52702     properties:
52703       vpn-binding:
52704         type: array
52705         items:
52706           $ref: "#/definitions/vpn-binding"
52707   vserver:
52708     description: |
52709       Virtual Servers, aka virtual machine or VM.
52710       ###### Related Nodes
52711       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
52712       - TO flavor( vserver Uses flavor, MANY2ONE)
52713       - TO image( vserver Uses image, MANY2ONE)
52714       - TO pserver( vserver HostedOn pserver, MANY2ONE)
52715       - TO snapshot( vserver Uses snapshot, ONE2ONE)
52716       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
52717       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
52718       - FROM vce( vce HostedOn vserver, ONE2MANY)
52719       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
52720       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
52721       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
52722
52723       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
52724       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
52725     required:
52726     - vserver-id
52727     - vserver-name
52728     - vserver-selflink
52729     - in-maint
52730     - is-closed-loop-disabled
52731     properties:
52732       vserver-id:
52733         type: string
52734         description: Unique identifier for this vserver relative to its tenant
52735       vserver-name:
52736         type: string
52737         description: Name of vserver
52738       vserver-name2:
52739         type: string
52740         description: Alternative name of vserver
52741       prov-status:
52742         type: string
52743         description: Trigger for operational monitoring of this resource by Service Assurance systems.
52744       vserver-selflink:
52745         type: string
52746         description: URL to endpoint where AAI can get more details
52747       in-maint:
52748         type: boolean
52749         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
52750       is-closed-loop-disabled:
52751         type: boolean
52752         description: Used to indicate whether closed loop function is enabled on this node
52753       resource-version:
52754         type: string
52755         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52756       volumes:
52757         type: array
52758         items:
52759           $ref: "#/definitions/volume"
52760       relationship-list:
52761         type: array
52762         items:
52763           $ref: "#/definitions/relationship"
52764       l-interfaces:
52765         type: array
52766         items:
52767           $ref: "#/definitions/l-interface"
52768   vservers:
52769     description: |
52770       Collection of virtual Servers, aka virtual machines or VMs.
52771     properties:
52772       vserver:
52773         type: array
52774         items:
52775           $ref: "#/definitions/vserver"
52776   zone:
52777     description: |
52778       A zone is a grouping of assets in a location homing to the same connections into the CBB
52779       ###### Related Nodes
52780       - TO complex( zone LocatedIn complex, MANY2ONE)
52781       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
52782       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
52783       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
52784       - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
52785
52786     required:
52787     - zone-id
52788     - zone-name
52789     - design-type
52790     - zone-context
52791     properties:
52792       zone-id:
52793         type: string
52794         description: Code assigned by AIC to the zone
52795       zone-name:
52796         type: string
52797         description: English name associated with the zone
52798       design-type:
52799         type: string
52800         description: Design of zone [Medium/Large…]
52801       zone-context:
52802         type: string
52803         description: Context of zone [production/test]
52804       status:
52805         type: string
52806         description: Status of a zone.
52807       resource-version:
52808         type: string
52809         description: Concurrency value
52810       relationship-list:
52811         type: array
52812         items:
52813           $ref: "#/definitions/relationship"
52814   zones:
52815     description: |
52816       Collection of zones
52817     properties:
52818       zone:
52819         type: array
52820         items:
52821           $ref: "#/definitions/zone"
52822 patchDefinitions:
52823   action:
52824     properties:
52825       action-type:
52826         type: string
52827       action-data:
52828         type: array
52829         items:
52830           $ref: "#/patchDefinitions/action-data"
52831   action-data:
52832     properties:
52833       property-name:
52834         type: string
52835       property-value:
52836         type: string
52837   actions:
52838     description: |
52839       APIs that are more action related than REST (e.g., notify, update).
52840     properties:
52841       update:
52842         type: object
52843         $ref: "#/patchDefinitions/update"
52844       notify:
52845         type: object
52846         $ref: "#/patchDefinitions/notify"
52847   allotted-resource:
52848     description: |
52849       Represents a slice or partial piece of a resource that gets separately allotted
52850       ###### Related Nodes
52851       - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
52852       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
52853       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
52854       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
52855       - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
52856       - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
52857       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
52858       - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
52859       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
52860       - TO model-ver( allotted-resource IsA model-ver, Many2One)
52861       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
52862       - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
52863       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
52864       - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
52865
52866       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
52867       -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
52868       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
52869     required:
52870     - id
52871     properties:
52872       id:
52873         type: string
52874         description: Allotted Resource id UUID assigned to this instance.
52875       description:
52876         type: string
52877         description: The descriptive information assigned to this allotted resource instance
52878       selflink:
52879         type: string
52880         description: Link back to more information in the controller
52881       model-invariant-id:
52882         type: string
52883         description: the ASDC model id for this resource or service model.
52884       model-version-id:
52885         type: string
52886         description: the ASDC model version for this resource or service model.
52887       persona-model-version:
52888         type: string
52889         description: the ASDC model version for this resource or service model.
52890   allotted-resources:
52891     description: |
52892       This object is used to store slices of services being offered
52893     properties:
52894       allotted-resource:
52895         type: array
52896         items:
52897           $ref: "#/patchDefinitions/allotted-resource"
52898   availability-zone:
52899     description: |
52900       Availability zone, a collection of compute hosts/pservers
52901       ###### Related Nodes
52902       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
52903       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
52904       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
52905       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
52906       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
52907       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
52908       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
52909       - FROM vce( vce Uses availability-zone, MANY2MANY)
52910
52911       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
52912       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
52913
52914     required:
52915     - availability-zone-name
52916     - hypervisor-type
52917     properties:
52918       availability-zone-name:
52919         type: string
52920         description: Name of the availability zone.  Unique across a cloud region
52921       hypervisor-type:
52922         type: string
52923         description: Type of hypervisor.  Source of truth should define valid values.
52924       operational-status:
52925         type: string
52926         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
52927   availability-zones:
52928     description: |
52929       Collection of availability zones
52930     properties:
52931       availability-zone:
52932         type: array
52933         items:
52934           $ref: "#/patchDefinitions/availability-zone"
52935   az-and-dvs-switches:
52936     properties:
52937       dvs-switches:
52938         type: object
52939         $ref: "#/patchDefinitions/dvs-switches"
52940       availability-zone:
52941         type: object
52942         $ref: "#/patchDefinitions/availability-zone"
52943   business:
52944     description: |
52945       Namespace for business related constructs
52946     properties:
52947       connectors:
52948         type: array
52949         items:
52950           $ref: "#/patchDefinitions/connector"
52951       customers:
52952         type: array
52953         items:
52954           $ref: "#/patchDefinitions/customer"
52955       lines-of-business:
52956         type: array
52957         items:
52958           $ref: "#/patchDefinitions/line-of-business"
52959       owning-entities:
52960         type: array
52961         items:
52962           $ref: "#/patchDefinitions/owning-entity"
52963       platforms:
52964         type: array
52965         items:
52966           $ref: "#/patchDefinitions/platform"
52967       projects:
52968         type: array
52969         items:
52970           $ref: "#/patchDefinitions/project"
52971   class-of-service:
52972     description: |
52973       ###### Related Nodes
52974       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
52975
52976       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
52977     required:
52978     - cos
52979     properties:
52980       cos:
52981         type: string
52982         description: unique identifier of probe
52983       probe-id:
52984         type: string
52985         description: identifier of probe
52986       probe-type:
52987         type: string
52988         description: type of probe
52989   classes-of-service:
52990     description: |
52991       class-of-service of probe
52992     properties:
52993       class-of-service:
52994         type: array
52995         items:
52996           $ref: "#/patchDefinitions/class-of-service"
52997   cloud-infrastructure:
52998     description: |
52999       Namespace for cloud infrastructure.
53000     properties:
53001       complexes:
53002         type: array
53003         items:
53004           $ref: "#/patchDefinitions/complex"
53005       cloud-regions:
53006         type: array
53007         items:
53008           $ref: "#/patchDefinitions/cloud-region"
53009       network-profiles:
53010         type: array
53011         items:
53012           $ref: "#/patchDefinitions/network-profile"
53013       pservers:
53014         type: array
53015         items:
53016           $ref: "#/patchDefinitions/pserver"
53017       virtual-data-centers:
53018         type: array
53019         items:
53020           $ref: "#/patchDefinitions/virtual-data-center"
53021       operational-environments:
53022         type: array
53023         items:
53024           $ref: "#/patchDefinitions/operational-environment"
53025   cloud-region:
53026     description: |
53027       cloud-region designates an installation of a cloud cluster or region or instantiation.
53028       ###### Related Nodes
53029       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
53030       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
53031       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
53032       - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
53033       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
53034       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
53035       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
53036       - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
53037       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
53038       - FROM image( image BelongsTo cloud-region, MANY2ONE)
53039       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
53040       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
53041       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
53042       - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
53043       - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
53044       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
53045       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
53046       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
53047
53048       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
53049       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
53050
53051     required:
53052     - cloud-owner
53053     - cloud-region-id
53054     - sriov-automation
53055     properties:
53056       cloud-owner:
53057         type: string
53058         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
53059       cloud-region-id:
53060         type: string
53061         description: Identifier used by the vendor for the region. Second part of composite key
53062       cloud-type:
53063         type: string
53064         description: Type of the cloud (e.g., openstack)
53065       owner-defined-type:
53066         type: string
53067         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
53068       cloud-region-version:
53069         type: string
53070         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
53071       identity-url:
53072         type: string
53073         description: URL of the keystone identity service
53074       cloud-zone:
53075         type: string
53076         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
53077       complex-name:
53078         type: string
53079         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
53080       sriov-automation:
53081         type: boolean
53082         description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
53083       cloud-extra-info:
53084         type: string
53085         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
53086       cloud-epa-caps:
53087         type: string
53088         description: MultiVIM will discover and expose EPA capabilities.
53089   cloud-regions:
53090     properties:
53091       cloud-region:
53092         type: array
53093         items:
53094           $ref: "#/patchDefinitions/cloud-region"
53095   complex:
53096     description: |
53097       Collection of physical locations that can house cloud-regions.
53098       ###### Related Nodes
53099       - TO l3-network( complex Uses l3-network, MANY2MANY)
53100       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
53101       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
53102       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
53103       - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
53104       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
53105       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
53106       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
53107       - FROM vce( vce LocatedIn complex, MANY2MANY)
53108       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
53109       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
53110       - FROM zone( zone LocatedIn complex, MANY2ONE)
53111
53112       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
53113       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
53114
53115     required:
53116     - physical-location-id
53117     - physical-location-type
53118     - street1
53119     - city
53120     - postal-code
53121     - country
53122     - region
53123     properties:
53124       physical-location-id:
53125         type: string
53126         description: Unique identifier for physical location, e.g., CLLI
53127       data-center-code:
53128         type: string
53129         description: Data center code which can be an alternate way to identify a complex
53130       complex-name:
53131         type: string
53132         description: Gamma complex name for LCP instance.
53133       identity-url:
53134         type: string
53135         description: URL of the keystone identity service
53136   complexes:
53137     description: |
53138       Collection of physical locations that can house cloud-regions.
53139     properties:
53140       complex:
53141         type: array
53142         items:
53143           $ref: "#/patchDefinitions/complex"
53144   configuration:
53145     description: |
53146       Port Mirror Configuration.
53147       ###### Related Nodes
53148       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
53149       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
53150       - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
53151       - TO pnf( configuration AppliesTo pnf, ONE2MANY)
53152       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
53153       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
53154       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
53155       - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
53156       - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
53157       - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
53158       - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
53159
53160       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
53161       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
53162       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
53163     required:
53164     - configuration-id
53165     - configuration-type
53166     - configuration-sub-type
53167     - orchestration-status
53168     - operational-status
53169     - configuration-selflink
53170     - model-customization-id
53171     properties:
53172       configuration-id:
53173         type: string
53174         description: UUID assigned to configuration.
53175       management-option:
53176         type: string
53177         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
53178       configuration-name:
53179         type: string
53180         description: Name of the configuration.
53181       configuration-type:
53182         type: string
53183         description: port-mirroring-configuration.
53184       configuration-sub-type:
53185         type: string
53186         description: vprobe, pprobe.
53187       model-invariant-id:
53188         type: string
53189         description: the ASDC model id for this resource or service model.
53190       model-version-id:
53191         type: string
53192         description: the ASDC model version for this resource or service model.
53193       orchestration-status:
53194         type: string
53195         description: Orchestration status of the configuration.
53196       operational-status:
53197         type: string
53198         description: Indicator for whether the resource is considered operational.
53199       configuration-selflink:
53200         type: string
53201         description: URL to endpoint where AAI can get more details from SDN-GC.
53202       model-customization-id:
53203         type: string
53204         description: id of  the configuration used to customize the resource
53205       tunnel-bandwidth:
53206         type: string
53207         description: DHV Site Effective Bandwidth
53208       vendor-allowed-max-bandwidth:
53209         type: string
53210         description: Velocloud Nominal Throughput - VNT
53211   configurations:
53212     description: |
53213       Collection of configurations
53214     properties:
53215       configuration:
53216         type: array
53217         items:
53218           $ref: "#/patchDefinitions/configuration"
53219   connector:
53220     description: |
53221       Collection of resource instances used to connect a variety of disparate inventory widgets
53222       ###### Related Nodes
53223       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
53224       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
53225       - FROM service-instance( service-instance Uses connector, MANY2MANY)
53226
53227       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
53228     required:
53229     - resource-instance-id
53230     properties:
53231       resource-instance-id:
53232         type: string
53233         description: Unique id of resource instance.
53234   connectors:
53235     description: |
53236       Collection of resource instances used to connect a variety of disparate inventory widgets
53237     properties:
53238       connector:
53239         type: array
53240         items:
53241           $ref: "#/patchDefinitions/connector"
53242   constrained-element-set:
53243     description: |
53244       This is how we would capture constraints defining allowed sets of elements.
53245       ###### Related Nodes
53246       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
53247       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
53248       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
53249
53250       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
53251       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
53252     required:
53253     - constrained-element-set-uuid
53254     - constraint-type
53255     - check-type
53256     properties:
53257       constrained-element-set-uuid:
53258         type: string
53259       constraint-type:
53260         type: string
53261       check-type:
53262         type: string
53263   constrained-element-sets:
53264     properties:
53265       constrained-element-set:
53266         type: array
53267         items:
53268           $ref: "#/patchDefinitions/constrained-element-set"
53269   ctag-assignment:
53270     description: |
53271       ###### Related Nodes
53272       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
53273       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
53274
53275       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
53276     required:
53277     - vlan-id-inner
53278     properties:
53279       vlan-id-inner:
53280         type: integer
53281         format: int64
53282         description: id.
53283   ctag-assignments:
53284     properties:
53285       ctag-assignment:
53286         type: array
53287         items:
53288           $ref: "#/patchDefinitions/ctag-assignment"
53289   ctag-pool:
53290     description: |
53291       A collection of C tags (vlan tags) grouped for a specific purpose.
53292       ###### Related Nodes
53293       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
53294       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
53295       - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
53296       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
53297
53298       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
53299     required:
53300     - target-pe
53301     - availability-zone-name
53302     - ctag-pool-purpose
53303     properties:
53304       target-pe:
53305         type: string
53306         description: The Target provider edge router
53307       availability-zone-name:
53308         type: string
53309         description: Name of the availability zone
53310       ctag-pool-purpose:
53311         type: string
53312         description: Describes what the intended purpose of this pool is.
53313       ctag-values:
53314         type: string
53315         description: Comma separated list of ctags
53316   ctag-pools:
53317     properties:
53318       ctag-pool:
53319         type: array
53320         items:
53321           $ref: "#/patchDefinitions/ctag-pool"
53322   customer:
53323     description: |
53324       customer identifiers to provide linkage back to BSS information.
53325       ###### Related Nodes
53326       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
53327
53328       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
53329     required:
53330     - global-customer-id
53331     - subscriber-name
53332     - subscriber-type
53333     properties:
53334       global-customer-id:
53335         type: string
53336         description: Global customer id used across ECOMP to uniquely identify customer.
53337       subscriber-name:
53338         type: string
53339         description: Subscriber name, an alternate way to retrieve a customer.
53340       subscriber-type:
53341         type: string
53342         description: Subscriber type, a way to provide VID with only the INFRA customers.
53343   customers:
53344     description: |
53345       Collection of customer identifiers to provide linkage back to BSS information.
53346     properties:
53347       customer:
53348         type: array
53349         items:
53350           $ref: "#/patchDefinitions/customer"
53351   cvlan-tag-entry:
53352     required:
53353     - cvlan-tag
53354     properties:
53355       cvlan-tag:
53356         type: integer
53357         format: int64
53358         description: See mis-na-virtualization-platform.yang
53359   cvlan-tags:
53360     properties:
53361       cvlan-tag-entry:
53362         type: array
53363         items:
53364           $ref: "#/patchDefinitions/cvlan-tag-entry"
53365   dvs-switch:
53366     description: |
53367       Digital virtual switch metadata, used by SDN-C to configure VCEs.  A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
53368       ###### Related Nodes
53369       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
53370       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
53371
53372     required:
53373     - switch-name
53374     - vcenter-url
53375     properties:
53376       switch-name:
53377         type: string
53378         description: DVS switch name
53379       vcenter-url:
53380         type: string
53381         description: URL used to reach the vcenter
53382   dvs-switches:
53383     description: |
53384       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
53385     properties:
53386       dvs-switch:
53387         type: array
53388         items:
53389           $ref: "#/patchDefinitions/dvs-switch"
53390   edge-prop-names:
53391     description: |
53392       Internal map to define the properties of an edge and interpret the map EdgeRules
53393     properties:
53394       edgeLabel:
53395         type: string
53396       direction:
53397         type: string
53398       multiplicityRule:
53399         type: string
53400       contains-other-v:
53401         type: string
53402       delete-other-v:
53403         type: string
53404       SVC-INFRA:
53405         type: string
53406       prevent-delete:
53407         type: string
53408       aai-uuid:
53409         type: string
53410   edge-tag-query-request:
53411     properties:
53412       edge-tag:
53413         type: string
53414       result-detail:
53415         type: string
53416       start-node-type:
53417         type: string
53418       start-node-filter:
53419         type: array
53420         items:
53421           $ref: "#/patchDefinitions/start-node-filter"
53422       include-node-filter:
53423         type: array
53424         items:
53425           $ref: "#/patchDefinitions/include-node-filter"
53426       secondary-filter:
53427         type: array
53428         items:
53429           $ref: "#/patchDefinitions/secondary-filter"
53430   edge-tag-query-result:
53431     properties:
53432       tagged-inventory-item-list:
53433         type: array
53434         items:
53435           $ref: "#/patchDefinitions/tagged-inventory-item-list"
53436   element-choice-set:
53437     description: |
53438       This is how we would capture constraints defining allowed sets of elements.
53439       ###### Related Nodes
53440       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
53441       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
53442
53443       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
53444       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
53445     required:
53446     - element-choice-set-uuid
53447     - element-choice-set-name
53448     properties:
53449       element-choice-set-uuid:
53450         type: string
53451       element-choice-set-name:
53452         type: string
53453       cardinality:
53454         type: string
53455   element-choice-sets:
53456     properties:
53457       element-choice-set:
53458         type: array
53459         items:
53460           $ref: "#/patchDefinitions/element-choice-set"
53461   entitlement:
53462     description: |
53463       Metadata for entitlement group.
53464       ###### Related Nodes
53465       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
53466       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
53467
53468       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
53469     required:
53470     - group-uuid
53471     - resource-uuid
53472     properties:
53473       group-uuid:
53474         type: string
53475         description: Unique ID for the entitlement group the resource comes from, should be uuid.
53476       resource-uuid:
53477         type: string
53478         description: Unique ID of an entitlement resource.
53479   entitlements:
53480     description: |
53481       Entitlements, keyed by group-uuid and resource-uuid, related to license management
53482     properties:
53483       entitlement:
53484         type: array
53485         items:
53486           $ref: "#/patchDefinitions/entitlement"
53487   esr-ems:
53488     description: |
53489       Persist EMS address information used by EMS driver.
53490       ###### Related Nodes
53491       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
53492
53493       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
53494     required:
53495     - ems-id
53496     properties:
53497       ems-id:
53498         type: string
53499         description: Unique ID of EMS.
53500   esr-ems-list:
53501     properties:
53502       esr-ems:
53503         type: array
53504         items:
53505           $ref: "#/patchDefinitions/esr-ems"
53506   esr-system-info:
53507     description: |
53508       Persist common address information of external systems.
53509       ###### Related Nodes
53510       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
53511       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
53512       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
53513       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
53514
53515       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
53516     required:
53517     - esr-system-info-id
53518     - user-name
53519     - password
53520     - system-type
53521     properties:
53522       esr-system-info-id:
53523         type: string
53524         description: Unique ID of esr system info.
53525       system-name:
53526         type: string
53527         description: name of external system.
53528       type:
53529         type: string
53530         description: type of external systems.
53531       vendor:
53532         type: string
53533         description: vendor of external systems.
53534       version:
53535         type: string
53536         description: version of external systems.
53537       service-url:
53538         type: string
53539         description: url used to access external systems.
53540       user-name:
53541         type: string
53542         description: username used to access external systems.
53543       password:
53544         type: string
53545         description: password used to access external systems.
53546       system-type:
53547         type: string
53548         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
53549       protocol:
53550         type: string
53551         description: protocol of third party SDNC, for example netconf/snmp.
53552       ssl-cacert:
53553         type: string
53554         description: ca file content if enabled ssl on auth-url.
53555       ssl-insecure:
53556         type: boolean
53557         description: Whether to verify VIM's certificate.
53558       ip-address:
53559         type: string
53560         description: service IP of ftp server.
53561       port:
53562         type: string
53563         description: service port of ftp server.
53564       cloud-domain:
53565         type: string
53566         description: domain info for authentication.
53567       default-tenant:
53568         type: string
53569         description: default tenant of VIM.
53570       passive:
53571         type: boolean
53572         description: ftp passive mode or not.
53573       remote-path:
53574         type: string
53575         description: resource or performance data file path.
53576       system-status:
53577         type: string
53578         description: the status of external system.
53579   esr-system-info-list:
53580     description: |
53581       Collection of persistent block-level external system auth info.
53582     properties:
53583       esr-system-info:
53584         type: array
53585         items:
53586           $ref: "#/patchDefinitions/esr-system-info"
53587   esr-thirdparty-sdnc:
53588     description: |
53589       Persist SDNC address information used by ONAP SDNC.
53590       ###### Related Nodes
53591       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
53592       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
53593
53594       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
53595     required:
53596     - thirdparty-sdnc-id
53597     properties:
53598       thirdparty-sdnc-id:
53599         type: string
53600         description: Unique ID of SDNC.
53601       location:
53602         type: string
53603         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
53604       product-name:
53605         type: string
53606         description: password used to access SDNC server.
53607   esr-thirdparty-sdnc-list:
53608     properties:
53609       esr-thirdparty-sdnc:
53610         type: array
53611         items:
53612           $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
53613   esr-vnfm:
53614     description: |
53615       Persist VNFM address information used by VF-C.
53616       ###### Related Nodes
53617       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
53618
53619       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
53620     required:
53621     - vnfm-id
53622     properties:
53623       vnfm-id:
53624         type: string
53625         description: Unique ID of VNFM.
53626       vim-id:
53627         type: string
53628         description: indecate the VIM to deploy VNF.
53629       certificate-url:
53630         type: string
53631         description: certificate url of VNFM.
53632   esr-vnfm-list:
53633     properties:
53634       esr-vnfm:
53635         type: array
53636         items:
53637           $ref: "#/patchDefinitions/esr-vnfm"
53638   evc:
53639     description: |
53640       evc object is an optional child object of the Configuration object.
53641       ###### Related Nodes
53642       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
53643
53644       -(4) IF this TO node is deleted, this EVC is DELETED also
53645     required:
53646     - evc-id
53647     properties:
53648       evc-id:
53649         type: string
53650         description: Unique/key field for the evc object
53651       forwarding-path-topology:
53652         type: string
53653         description: Point-to-Point, Multi-Point
53654       cir-value:
53655         type: string
53656         description: Commited Information Rate
53657       cir-units:
53658         type: string
53659         description: CIR units
53660       connection-diversity-group-id:
53661         type: string
53662         description: Diversity Group ID
53663       service-hours:
53664         type: string
53665         description: formerly Performance Group
53666       esp-evc-circuit-id:
53667         type: string
53668         description: EVC Circuit ID of ESP EVC
53669       esp-evc-cir-value:
53670         type: string
53671         description: Committed Information Rate (For ESP)
53672       esp-evc-cir-units:
53673         type: string
53674         description: CIR units (For ESP)
53675       esp-itu-code:
53676         type: string
53677         description: Identifies ESP
53678       collector-pop-clli:
53679         type: string
53680         description: Collector POP CLLI (from the hostname of the access pnf)
53681       inter-connect-type-ingress:
53682         type: string
53683         description: Interconnect type on ingress side of EVC.
53684       tagmode-access-ingress:
53685         type: string
53686         description: tagode for collector side of EVC
53687       tagmode-access-egress:
53688         type: string
53689         description: tagMode for network side of EVC
53690   evcs:
53691     properties:
53692       evc:
53693         type: array
53694         items:
53695           $ref: "#/patchDefinitions/evc"
53696   external-system:
53697     description: |
53698       Namespace for external system.
53699     properties:
53700       esr-ems-list:
53701         type: object
53702         $ref: "#/patchDefinitions/esr-ems-list"
53703       esr-vnfm-list:
53704         type: object
53705         $ref: "#/patchDefinitions/esr-vnfm-list"
53706       esr-thirdparty-sdnc-list:
53707         type: object
53708         $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
53709   extra-properties:
53710     description: |
53711       Extra properties for inventory item for response list
53712     properties:
53713       extra-property:
53714         type: array
53715         items:
53716           $ref: "#/patchDefinitions/extra-property"
53717   extra-property:
53718     properties:
53719       property-name:
53720         type: string
53721       property-value:
53722         type: string
53723   flavor:
53724     description: |
53725       Openstack flavor.
53726       ###### Related Nodes
53727       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
53728       - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
53729       - FROM vserver( vserver Uses flavor, MANY2ONE)
53730
53731       -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
53732
53733     required:
53734     - flavor-id
53735     - flavor-name
53736     - flavor-selflink
53737     properties:
53738       flavor-id:
53739         type: string
53740         description: Flavor id, expected to be unique across cloud-region.
53741       flavor-name:
53742         type: string
53743         description: Cloud region Flavor name
53744       flavor-vcpus:
53745         type: integer
53746         format: int32
53747         description: Number of CPUs
53748       flavor-ram:
53749         type: integer
53750         format: int32
53751         description: Amount of memory
53752       flavor-disk:
53753         type: integer
53754         format: int32
53755         description: Disk space
53756       flavor-ephemeral:
53757         type: integer
53758         format: int32
53759         description: Amount of ephemeral disk space
53760       flavor-swap:
53761         type: string
53762         description: amount of swap space allocation
53763       flavor-is-public:
53764         type: boolean
53765         description: whether flavor is available to all users or private to the tenant it was created in.
53766       flavor-selflink:
53767         type: string
53768         description: URL to endpoint where AAI can get more details
53769       flavor-disabled:
53770         type: boolean
53771         description: Boolean as to whether this flavor is no longer enabled
53772       hpa-capabilities:
53773         type: array
53774         items:
53775           $ref: "#/patchDefinitions/hpa-capability"
53776         description: List of flavor specific HPA Capabilities
53777   flavors:
53778     description: |
53779       Collection of openstack flavors.
53780     properties:
53781       flavor:
53782         type: array
53783         items:
53784           $ref: "#/patchDefinitions/flavor"
53785   forwarder:
53786     description: |
53787       Entity describing a sequenced segment of forwarding path
53788       ###### Related Nodes
53789       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
53790       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
53791       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
53792       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
53793       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
53794
53795       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
53796       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
53797     required:
53798     - sequence
53799     properties:
53800       sequence:
53801         type: integer
53802         format: int32
53803         description: Unique ID of this segmentation
53804       forwarder-role:
53805         type: string
53806         description: ingress, intermediate, egress
53807   forwarder-evc:
53808     description: |
53809       forwarder object is an optional child object of the Configuration object.
53810       ###### Related Nodes
53811       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
53812
53813       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
53814     required:
53815     - forwarder-evc-id
53816     properties:
53817       forwarder-evc-id:
53818         type: string
53819         description: Key for forwarder-evc object
53820       circuit-id:
53821         type: string
53822         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
53823       ivlan:
53824         type: string
53825         description: Internal VLAN.
53826       svlan:
53827         type: string
53828         description: SVLAN value for ingress of egress forwarder.
53829       cvlan:
53830         type: string
53831         description: CVLAN value for ingress of egress forwarder.
53832   forwarder-evcs:
53833     properties:
53834       forwarder-evc:
53835         type: array
53836         items:
53837           $ref: "#/patchDefinitions/forwarder-evc"
53838   forwarders:
53839     properties:
53840       forwarder:
53841         type: array
53842         items:
53843           $ref: "#/patchDefinitions/forwarder"
53844   forwarding-path:
53845     description: |
53846       Entity that describes the sequenced forwarding path between interfaces of services or resources
53847       ###### Related Nodes
53848       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
53849       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
53850       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
53851
53852       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
53853       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
53854       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
53855     required:
53856     - forwarding-path-id
53857     - forwarding-path-name
53858     properties:
53859       forwarding-path-id:
53860         type: string
53861         description: Unique ID of this FP
53862       forwarding-path-name:
53863         type: string
53864         description: Name of the FP
53865   forwarding-paths:
53866     properties:
53867       forwarding-path:
53868         type: array
53869         items:
53870           $ref: "#/patchDefinitions/forwarding-path"
53871   generic-vnf:
53872     description: |
53873       General purpose VNF
53874       ###### Related Nodes
53875       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
53876       - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
53877       - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
53878       - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
53879       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
53880       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
53881       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
53882       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
53883       - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
53884       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
53885       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
53886       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
53887       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
53888       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
53889       - TO model-ver( generic-vnf IsA model-ver, Many2One)
53890       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
53891       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
53892       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
53893       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
53894       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
53895       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
53896       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
53897       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
53898       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
53899       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
53900       - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
53901       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
53902       - FROM platform( platform Uses generic-vnf, MANY2MANY)
53903
53904       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
53905       -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
53906     required:
53907     - vnf-id
53908     - vnf-name
53909     - vnf-type
53910     - in-maint
53911     - is-closed-loop-disabled
53912     properties:
53913       vnf-id:
53914         type: string
53915         description: Unique id of VNF.  This is unique across the graph.
53916       vnf-instance-id:
53917         type: string
53918         description: vnf instance id.
53919       vnf-name:
53920         type: string
53921         description: Name of VNF.
53922       vnf-name2:
53923         type: string
53924         description: Alternate name of VNF.
53925       vnf-type:
53926         type: string
53927         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
53928       service-id:
53929         type: string
53930         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
53931       regional-resource-zone:
53932         type: string
53933         description: Regional way of organizing pservers, source of truth should define values
53934       prov-status:
53935         type: string
53936         description: Trigger for operational monitoring of this resource by Service Assurance systems.
53937       operational-status:
53938         type: string
53939         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
53940       license-key:
53941         type: string
53942         description: OBSOLETE -  do not use
53943       equipment-role:
53944         type: string
53945         description: Client should send valid enumerated value
53946       orchestration-status:
53947         type: string
53948         description: Orchestration status of this VNF, used by MSO.
53949       vnf-package-name:
53950         type: string
53951       vnf-discriptor-name:
53952         type: string
53953         description: vnf discriptor name
53954       job-id:
53955         type: string
53956         description: job id corresponding to vnf
53957       heat-stack-id:
53958         type: string
53959         description: Heat stack id corresponding to this instance, managed by MSO
53960       mso-catalog-key:
53961         type: string
53962         description: Corresponds to the SDN-C catalog id used to configure this VCE
53963       management-option:
53964         type: string
53965         description: identifier of managed by ATT or customer
53966       ipv4-oam-address:
53967         type: string
53968         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
53969       ipv4-loopback0-address:
53970         type: string
53971         description: v4 Loopback0 address
53972       nm-lan-v6-address:
53973         type: string
53974         description: v6 Loopback address
53975       management-v6-address:
53976         type: string
53977         description: v6 management address
53978       vcpu:
53979         type: integer
53980         format: int64
53981         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
53982       vcpu-units:
53983         type: string
53984         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
53985       vmemory:
53986         type: integer
53987         format: int64
53988         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
53989       vmemory-units:
53990         type: string
53991         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
53992       vdisk:
53993         type: integer
53994         format: int64
53995         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
53996       vdisk-units:
53997         type: string
53998         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
53999       nshd:
54000         type: integer
54001         format: int64
54002         description: number of associated SHD in vnf.
54003       nvm:
54004         type: integer
54005         format: int64
54006         description: number of vms in vnf.
54007       nnet:
54008         type: integer
54009         format: int64
54010         description: number of network in vnf.
54011       in-maint:
54012         type: boolean
54013         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
54014       is-closed-loop-disabled:
54015         type: boolean
54016         description: used to indicate whether closed loop function is enabled on this node
54017   generic-vnfs:
54018     description: |
54019       Collection of VNFs
54020     properties:
54021       generic-vnf:
54022         type: array
54023         items:
54024           $ref: "#/patchDefinitions/generic-vnf"
54025   group-assignment:
54026     description: |
54027       Openstack group-assignment used to store exclusivity groups (EG).
54028       ###### Related Nodes
54029       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
54030       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
54031       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
54032
54033     required:
54034     - group-id
54035     - group-type
54036     - group-name
54037     properties:
54038       group-id:
54039         type: string
54040         description: Group id, expected to be unique across cloud-region.
54041       group-type:
54042         type: string
54043         description: Group type - the type of group this instance refers to
54044       group-name:
54045         type: string
54046         description: Group name - name assigned to the group
54047       group-description:
54048         type: string
54049         description: Group description - description of the group
54050   group-assignments:
54051     description: |
54052       Collection of openstack group assignments
54053     properties:
54054       group-assignment:
54055         type: array
54056         items:
54057           $ref: "#/patchDefinitions/group-assignment"
54058   host-route:
54059     description: |
54060       ###### Related Nodes
54061       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
54062
54063       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
54064     required:
54065     - host-route-id
54066     - route-prefix
54067     - next-hop
54068     properties:
54069       host-route-id:
54070         type: string
54071         description: host-route id
54072       route-prefix:
54073         type: string
54074         description: subnet prefix
54075       next-hop:
54076         type: string
54077         description: Could be ip-address, hostname, or service-instance
54078       next-hop-type:
54079         type: string
54080         description: Should be ip-address, hostname, or service-instance to match next-hop
54081   host-routes:
54082     properties:
54083       host-route:
54084         type: array
54085         items:
54086           $ref: "#/patchDefinitions/host-route"
54087   hpa-capabilities:
54088     description: |
54089       Collection of HPA Capabilities
54090     properties:
54091       hpa-capability:
54092         type: array
54093         items:
54094           $ref: "#/patchDefinitions/hpa-capability"
54095   hpa-capability:
54096     description: |
54097       Represents a HPA capability
54098       ###### Related Nodes
54099       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
54100       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
54101       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
54102
54103       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
54104     required:
54105     - hpa-capability-id
54106     - hpa-feature
54107     properties:
54108       hpa-capability-id:
54109         type: string
54110         description: UUID to uniquely identify a HPA capability
54111       hpa-feature:
54112         type: string
54113         description: Name of the HPACapability
54114       hpa-version:
54115         type: string
54116         description: HPA schema version
54117       architecture:
54118         type: string
54119         description: Hardware architecture
54120   hpa-feature-attributes:
54121     description: |
54122       HPA Capability Feature attributes
54123       ###### Related Nodes
54124       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
54125
54126       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
54127     required:
54128     - hpa-attribute-key
54129     properties:
54130       hpa-attribute-key:
54131         type: string
54132         description: name of the specific HPA attribute
54133       hpa-attribute-value:
54134         type: string
54135         description: JSON string specifying the value, unit and type of the specific HPA attribute
54136   image:
54137     description: |
54138       Openstack image.
54139       ###### Related Nodes
54140       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
54141       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
54142       - FROM vserver( vserver Uses image, MANY2ONE)
54143
54144       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
54145       -IMAGE cannot be deleted if related to VSERVER
54146
54147     required:
54148     - image-id
54149     - image-name
54150     - image-os-distro
54151     - image-os-version
54152     - image-selflink
54153     properties:
54154       image-id:
54155         type: string
54156         description: Image id, expected to be unique across cloud region
54157       image-name:
54158         type: string
54159         description: Image name
54160       image-architecture:
54161         type: string
54162         description: Operating system architecture.
54163       image-os-distro:
54164         type: string
54165         description: The common name of the operating system distribution in lowercase
54166       image-os-version:
54167         type: string
54168         description: The operating system version as specified by the distributor.
54169       application:
54170         type: string
54171         description: The application that the image instantiates.
54172       application-vendor:
54173         type: string
54174         description: The vendor of the application.
54175       application-version:
54176         type: string
54177         description: The version of the application.
54178       image-selflink:
54179         type: string
54180         description: URL to endpoint where AAI can get more details
54181   images:
54182     description: |
54183       Collectio of Openstack images.
54184     properties:
54185       image:
54186         type: array
54187         items:
54188           $ref: "#/patchDefinitions/image"
54189   include-node-filter:
54190     properties:
54191       include-node-type:
54192         type: string
54193   instance-filter:
54194     description: |
54195       InstanceFilter for performing a named-query or model query
54196   instance-filters:
54197     description: |
54198       InstanceFilters for performing a named-query or model query
54199     properties:
54200       instance-filter:
54201         type: array
54202         items:
54203           $ref: "#/patchDefinitions/instance-filter"
54204   instance-group:
54205     description: |
54206       General mechanism for grouping instances
54207       ###### Related Nodes
54208       - TO model( instance-group Targets model, MANY2MANY)
54209       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
54210       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
54211       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
54212       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
54213       - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
54214       - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
54215       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
54216       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
54217       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
54218       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
54219       - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
54220
54221     required:
54222     - id
54223     - description
54224     - type
54225     properties:
54226       instance-group-role:
54227         type: string
54228         description: role of the instance group.
54229       model-invariant-id:
54230         type: string
54231         description: ASDC model id for this resource or service model.
54232       model-version-id:
54233         type: string
54234         description: ASDC model version uid for this resource model.
54235       id:
54236         type: string
54237         description: Instance Group ID, UUID assigned to this instance.
54238       description:
54239         type: string
54240         description: Descriptive text to help identify the usage of this instance-group
54241       type:
54242         type: string
54243         description: Only valid value today is lower case ha for high availability
54244       sub-type:
54245         type: string
54246         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
54247   instance-groups:
54248     description: |
54249       Collection of openstack route table references
54250     properties:
54251       instance-group:
54252         type: array
54253         items:
54254           $ref: "#/patchDefinitions/instance-group"
54255   inventory:
54256     properties:
54257       search:
54258         type: object
54259         $ref: "#/patchDefinitions/search"
54260       actions:
54261         type: object
54262         $ref: "#/patchDefinitions/actions"
54263       cloud-infrastructure:
54264         type: object
54265         $ref: "#/patchDefinitions/cloud-infrastructure"
54266       external-system:
54267         type: object
54268         $ref: "#/patchDefinitions/external-system"
54269       business:
54270         type: object
54271         $ref: "#/patchDefinitions/business"
54272       service-design-and-creation:
54273         type: object
54274         $ref: "#/patchDefinitions/service-design-and-creation"
54275       network:
54276         type: object
54277         $ref: "#/patchDefinitions/network"
54278       nodes:
54279         type: object
54280         $ref: "#/patchDefinitions/nodes"
54281   inventory-item:
54282     properties:
54283       inventory-item-type:
54284         type: string
54285       inventory-item-link:
54286         type: string
54287       inventory-item-data:
54288         type: array
54289         items:
54290           $ref: "#/patchDefinitions/inventory-item-data"
54291       tagged-inventory-item-list:
54292         type: array
54293         items:
54294           $ref: "#/patchDefinitions/tagged-inventory-item-list"
54295   inventory-item-data:
54296     properties:
54297       property-name:
54298         type: string
54299       property-value:
54300         type: string
54301   inventory-response-item:
54302     description: |
54303       Inventory item for response list
54304     properties:
54305       model-name:
54306         type: string
54307       extra-properties:
54308         type: object
54309         $ref: "#/patchDefinitions/extra-properties"
54310       inventory-response-items:
54311         type: object
54312         $ref: "#/patchDefinitions/inventory-response-items"
54313   inventory-response-items:
54314     description: |
54315       Container for inventory items in response list
54316     properties:
54317       inventory-response-item:
54318         type: array
54319         items:
54320           $ref: "#/patchDefinitions/inventory-response-item"
54321   ipsec-configuration:
54322     description: |
54323       IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
54324       ###### Related Nodes
54325       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
54326       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
54327
54328       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
54329     required:
54330     - ipsec-configuration-id
54331     properties:
54332       ipsec-configuration-id:
54333         type: string
54334         description: UUID of this configuration
54335       requested-vig-address-type:
54336         type: string
54337         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
54338       requested-encryption-strength:
54339         type: string
54340         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
54341       requested-dmz-type:
54342         type: string
54343         description: ATT can offer a shared DMZ or a DMZ specific to a customer
54344       shared-dmz-network-address:
54345         type: string
54346         description: Network address of shared DMZ
54347       requested-customer-name:
54348         type: string
54349         description: If the DMZ is a custom DMZ, this field will indicate the customer information
54350       ike-version:
54351         type: string
54352         description: can be 1 or 2
54353       ikev1-authentication:
54354         type: string
54355         description: Contains values like md5, sha1, sha256, sha384
54356       ikev1-encryption:
54357         type: string
54358         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
54359       ikev1-dh-group:
54360         type: string
54361         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
54362       ikev1-am-group-id:
54363         type: string
54364         description: Group name defined in VIG for clients using aggressive mode
54365       ikev1-am-password:
54366         type: string
54367         description: pre-shared key for the above group name
54368       ikev1-sa-lifetime:
54369         type: string
54370         description: Lifetime for IKEv1 SA
54371       ipsec-authentication:
54372         type: string
54373         description: md5, sha1, sha256, sha384
54374       ipsec-encryption:
54375         type: string
54376         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
54377       ipsec-sa-lifetime:
54378         type: string
54379         description: Life time for IPSec SA
54380       ipsec-pfs:
54381         type: string
54382         description: enable PFS or not
54383       xauth-userid:
54384         type: string
54385         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
54386       xauth-user-password:
54387         type: string
54388         description: Encrypted using the Juniper $9$ algorithm
54389       dpd-interval:
54390         type: string
54391         description: The time between DPD probe
54392       dpd-frequency:
54393         type: string
54394         description: Maximum number of DPD before claiming the tunnel is down
54395   ipsec-configurations:
54396     properties:
54397       ipsec-configuration:
54398         type: array
54399         items:
54400           $ref: "#/patchDefinitions/ipsec-configuration"
54401   key-data:
54402     properties:
54403       key-name:
54404         type: string
54405       key-value:
54406         type: string
54407   l-interface:
54408     description: |
54409       Logical interfaces, e.g., a vnic.
54410       ###### Related Nodes
54411       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
54412       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
54413       - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
54414       - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
54415       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
54416       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
54417       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
54418       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
54419       - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
54420       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
54421       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
54422       - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
54423       - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
54424       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
54425       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
54426       - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
54427       - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
54428       - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
54429
54430       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
54431       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
54432       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
54433     required:
54434     - interface-name
54435     - is-port-mirrored
54436     - in-maint
54437     - is-ip-unnumbered
54438     properties:
54439       interface-name:
54440         type: string
54441         description: Name given to the interface
54442       interface-role:
54443         type: string
54444         description: E.g., CUSTOMER, UPLINK, etc.
54445       v6-wan-link-ip:
54446         type: string
54447         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
54448       selflink:
54449         type: string
54450         description: URL to endpoint where AAI can get more details
54451       interface-id:
54452         type: string
54453         description: ID of interface
54454       macaddr:
54455         type: string
54456         description: MAC address for the interface
54457       network-name:
54458         type: string
54459         description: Name of the network
54460       management-option:
54461         type: string
54462         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
54463       interface-description:
54464         type: string
54465         description: Human friendly text regarding this interface.
54466       is-port-mirrored:
54467         type: boolean
54468         description: boolean indicatating whether or not port is a mirrored.
54469   l-interfaces:
54470     description: |
54471       Collection of logical interfaces.
54472     properties:
54473       l-interface:
54474         type: array
54475         items:
54476           $ref: "#/patchDefinitions/l-interface"
54477   l3-interface-ipv4-address-list:
54478     description: |
54479       IPv4 Address Range
54480       ###### Related Nodes
54481       - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
54482       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
54483       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
54484       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
54485       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
54486       - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
54487
54488       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
54489     required:
54490     - l3-interface-ipv4-address
54491     properties:
54492       l3-interface-ipv4-address:
54493         type: string
54494         description: IP address
54495       l3-interface-ipv4-prefix-length:
54496         type: integer
54497         format: int64
54498         description: Prefix length, 32 for single address
54499       vlan-id-inner:
54500         type: integer
54501         format: int64
54502         description: Inner VLAN tag
54503       vlan-id-outer:
54504         type: integer
54505         format: int64
54506         description: Outer VLAN tag
54507       is-floating:
54508         type: boolean
54509         description: Indicator of fixed or floating address
54510   l3-interface-ipv6-address-list:
54511     description: |
54512       IPv6 Address Range
54513       ###### Related Nodes
54514       - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
54515       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
54516       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
54517       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
54518       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
54519       - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
54520
54521       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
54522     required:
54523     - l3-interface-ipv6-address
54524     properties:
54525       l3-interface-ipv6-address:
54526         type: string
54527         description: IP address
54528       l3-interface-ipv6-prefix-length:
54529         type: integer
54530         format: int64
54531         description: Prefix length, 128 for single address
54532       vlan-id-inner:
54533         type: integer
54534         format: int64
54535         description: Inner VLAN tag
54536       vlan-id-outer:
54537         type: integer
54538         format: int64
54539         description: Outer VLAN tag
54540       is-floating:
54541         type: boolean
54542         description: Indicator of fixed or floating address
54543   l3-network:
54544     description: |
54545       Generic network definition
54546       ###### Related Nodes
54547       - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
54548       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
54549       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
54550       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
54551       - TO model-ver( l3-network IsA model-ver, Many2One)
54552       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
54553       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
54554       - FROM complex( complex Uses l3-network, MANY2MANY)
54555       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
54556       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
54557       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
54558       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
54559       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
54560       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
54561       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
54562       - FROM tenant( tenant Uses l3-network, MANY2MANY)
54563       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
54564
54565       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
54566     required:
54567     - network-id
54568     - network-name
54569     - is-bound-to-vpn
54570     - is-provider-network
54571     - is-shared-network
54572     - is-external-network
54573     properties:
54574       network-id:
54575         type: string
54576         description: Network ID, should be uuid. Unique across A&AI.
54577       network-name:
54578         type: string
54579         description: Name of the network, governed by some naming convention..
54580       network-type:
54581         type: string
54582         description: Type of the network - who defines these values?
54583       network-role:
54584         type: string
54585         description: Role the network plans - who defines these values?
54586       network-technology:
54587         type: string
54588         description: Network technology - who defines these values?
54589       neutron-network-id:
54590         type: string
54591         description: Neutron network id of this Interface
54592       is-bound-to-vpn:
54593         type: boolean
54594         description: Set to true if bound to VPN
54595       service-id:
54596         type: string
54597         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
54598       network-role-instance:
54599         type: integer
54600         format: int64
54601         description: network role instance
54602   l3-networks:
54603     properties:
54604       l3-network:
54605         type: array
54606         items:
54607           $ref: "#/patchDefinitions/l3-network"
54608   lag-interface:
54609     description: |
54610       Link aggregate interface
54611       ###### Related Nodes
54612       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
54613       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
54614       - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
54615       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
54616       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
54617       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
54618       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
54619       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
54620       - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
54621
54622       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
54623       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
54624       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
54625     required:
54626     - interface-name
54627     - in-maint
54628     properties:
54629       interface-name:
54630         type: string
54631         description: Name that identifies the link aggregate interface
54632       interface-description:
54633         type: string
54634         description: Human friendly text regarding this interface.
54635   lag-interfaces:
54636     description: |
54637       Collection of link aggregate interfaces.
54638     properties:
54639       lag-interface:
54640         type: array
54641         items:
54642           $ref: "#/patchDefinitions/lag-interface"
54643   lag-link:
54644     description: |
54645       LAG links can connect lag-interfaces
54646       ###### Related Nodes
54647       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
54648       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
54649
54650       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
54651     required:
54652     - link-name
54653     properties:
54654       link-name:
54655         type: string
54656         description: Alphabetical concatenation of lag-interface names
54657   lag-links:
54658     description: |
54659       Collection of link aggregation connections
54660     properties:
54661       lag-link:
54662         type: array
54663         items:
54664           $ref: "#/patchDefinitions/lag-link"
54665   license:
54666     description: |
54667       Metadata for license group.
54668       ###### Related Nodes
54669       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
54670       - TO vce( license BelongsTo vce, MANY2ONE)(4)
54671
54672       -(4) IF this TO node is deleted, this LICENSE is DELETED also
54673     required:
54674     - group-uuid
54675     - resource-uuid
54676     properties:
54677       group-uuid:
54678         type: string
54679         description: Unique ID for the license group the resource belongs to, should be uuid.
54680       resource-uuid:
54681         type: string
54682         description: Unique ID of a license resource.
54683   licenses:
54684     description: |
54685       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
54686     properties:
54687       license:
54688         type: array
54689         items:
54690           $ref: "#/patchDefinitions/license"
54691   line-of-business:
54692     description: |
54693       describes a line-of-business
54694       ###### Related Nodes
54695       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
54696
54697     required:
54698     - line-of-business-name
54699     properties:
54700       line-of-business-name:
54701         type: string
54702         description: Name of the line-of-business (product)
54703   lines-of-business:
54704     description: |
54705       Collection of lines-of-business
54706     properties:
54707       line-of-business:
54708         type: array
54709         items:
54710           $ref: "#/patchDefinitions/line-of-business"
54711   logical-link:
54712     description: |
54713       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
54714       ###### Related Nodes
54715       - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
54716       - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
54717       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
54718       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
54719       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
54720       - TO logical-link( logical-link Uses logical-link, MANY2MANY)
54721       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
54722       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
54723       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
54724       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
54725       - TO model-ver( logical-link IsA model-ver, Many2One)
54726       - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
54727       - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
54728       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
54729       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
54730       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
54731       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
54732       - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
54733
54734       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
54735       -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
54736     required:
54737     - link-name
54738     - in-maint
54739     - link-type
54740     properties:
54741       link-name:
54742         type: string
54743         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
54744       in-maint:
54745         type: boolean
54746         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
54747       link-type:
54748         type: string
54749         description: Type of logical link, e.g., evc
54750       speed-value:
54751         type: string
54752         description: Captures the numeric part of the speed
54753       speed-units:
54754         type: string
54755         description: Captures the units corresponding to the speed
54756       ip-version:
54757         type: string
54758         description: v4, v6, or ds for dual stack
54759       routing-protocol:
54760         type: string
54761         description: For example, static or BGP
54762   logical-links:
54763     description: |
54764       Collection of logical connections
54765     properties:
54766       logical-link:
54767         type: array
54768         items:
54769           $ref: "#/patchDefinitions/logical-link"
54770   metadata:
54771     description: |
54772       Collection of metadatum (key/value pairs)
54773     properties:
54774       metadatum:
54775         type: array
54776         items:
54777           $ref: "#/patchDefinitions/metadatum"
54778   metadatum:
54779     description: |
54780       Key/value pairs
54781       ###### Related Nodes
54782       - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
54783       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
54784       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
54785       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
54786       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
54787
54788       -(4) IF this TO node is deleted, this METADATUM is DELETED also
54789     required:
54790     - metaname
54791     - metaval
54792     properties:
54793       metaname:
54794         type: string
54795       metaval:
54796         type: string
54797   model:
54798     description: |
54799       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
54800       ###### Related Nodes
54801       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
54802       - FROM instance-group( instance-group Targets model, MANY2MANY)
54803       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
54804       - FROM named-query( named-query AppliesTo model, ONE2MANY)
54805       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
54806
54807       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
54808       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
54809
54810     required:
54811     - model-invariant-id
54812     - model-type
54813     properties:
54814       model-invariant-id:
54815         type: string
54816         description: Unique identifier corresponding to the main definition of a model in ASDC
54817       model-type:
54818         type: string
54819         description: Type of the model, e.g., service, resource, widget, etc.
54820   model-and-named-query-search:
54821     description: |
54822       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
54823     properties:
54824       query-parameters:
54825         type: object
54826         $ref: "#/patchDefinitions/query-parameters"
54827       instance-filters:
54828         type: object
54829         $ref: "#/patchDefinitions/instance-filters"
54830       secondary-filts:
54831         type: object
54832         $ref: "#/patchDefinitions/secondary-filts"
54833       top-node-type:
54834         type: string
54835       secondary-filter-cut-point:
54836         type: string
54837   model-constraint:
54838     description: |
54839       This is how we would capture constraints defining allowed sets of elements.
54840       ###### Related Nodes
54841       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
54842       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
54843
54844       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
54845       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
54846     required:
54847     - model-constraint-uuid
54848     - constrained-element-set-uuid-to-replace
54849     properties:
54850       model-constraint-uuid:
54851         type: string
54852       constrained-element-set-uuid-to-replace:
54853         type: string
54854       constrained-element-sets:
54855         type: array
54856         items:
54857           $ref: "#/patchDefinitions/constrained-element-set"
54858   model-constraints:
54859     properties:
54860       model-constraint:
54861         type: array
54862         items:
54863           $ref: "#/patchDefinitions/model-constraint"
54864   model-element:
54865     description: |
54866       Defines how other models combine to make up a higher-level model.
54867       ###### Related Nodes
54868       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
54869       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
54870       - TO model-ver( model-element IsA model-ver, MANY2ONE)
54871       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
54872       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
54873       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
54874       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
54875
54876       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
54877       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
54878     required:
54879     - model-element-uuid
54880     - new-data-del-flag
54881     - cardinality
54882     properties:
54883       model-element-uuid:
54884         type: string
54885       new-data-del-flag:
54886         type: string
54887         description: Indicates whether this element was created as part of instantiation from this model
54888       cardinality:
54889         type: string
54890         description: How many of this type of element are required/allowed
54891       linkage-points:
54892         type: string
54893   model-elements:
54894     properties:
54895       model-element:
54896         type: array
54897         items:
54898           $ref: "#/patchDefinitions/model-element"
54899   model-ver:
54900     description: |
54901       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
54902       ###### Related Nodes
54903       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
54904       - FROM model-element( model-element IsA model-ver, MANY2ONE)
54905       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
54906       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
54907       - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
54908       - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
54909       - FROM l3-network( l3-network IsA model-ver, Many2One)
54910       - FROM logical-link( logical-link IsA model-ver, Many2One)
54911       - FROM service-instance( service-instance IsA model-ver, Many2One)
54912       - FROM vf-module( vf-module IsA model-ver, Many2One)
54913
54914       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
54915       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
54916       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
54917
54918     required:
54919     - model-version-id
54920     - model-name
54921     - model-version
54922     properties:
54923       model-version-id:
54924         type: string
54925         description: Unique identifier corresponding to one version of a model in ASDC
54926       model-name:
54927         type: string
54928         description: Name of the model, which can change from version to version.
54929       model-version:
54930         type: string
54931         description: Version
54932       distribution-status:
54933         type: string
54934         description: Distribution Status
54935       model-description:
54936         type: string
54937         description: Description
54938   model-vers:
54939     properties:
54940       model-ver:
54941         type: array
54942         items:
54943           $ref: "#/patchDefinitions/model-ver"
54944   models:
54945     description: |
54946       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
54947     properties:
54948       model:
54949         type: array
54950         items:
54951           $ref: "#/patchDefinitions/model"
54952   multicast-configuration:
54953     description: |
54954       ###### Related Nodes
54955       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
54956
54957     required:
54958     - multicast-configuration-id
54959     - multicast-protocol
54960     - rp-type
54961     properties:
54962       multicast-configuration-id:
54963         type: string
54964         description: Unique id of multicast configuration.
54965       multicast-protocol:
54966         type: string
54967         description: protocol of multicast configuration
54968       rp-type:
54969         type: string
54970         description: rp type of multicast configuration
54971   multicast-configurations:
54972     description: |
54973       multicast configuration of generic-vnf ip-address
54974     properties:
54975       multicast-configuration:
54976         type: array
54977         items:
54978           $ref: "#/patchDefinitions/multicast-configuration"
54979   named-queries:
54980     properties:
54981       named-query:
54982         type: array
54983         items:
54984           $ref: "#/patchDefinitions/named-query"
54985   named-query:
54986     description: |
54987       TBD
54988       ###### Related Nodes
54989       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
54990       - TO model( named-query AppliesTo model, ONE2MANY)
54991       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
54992
54993       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
54994     required:
54995     - named-query-uuid
54996     - named-query-name
54997     - named-query-version
54998     properties:
54999       named-query-uuid:
55000         type: string
55001       named-query-name:
55002         type: string
55003       named-query-version:
55004         type: string
55005       required-input-param:
55006         type: string
55007       description:
55008         type: string
55009   named-query-element:
55010     description: |
55011       TBD
55012       ###### Related Nodes
55013       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
55014       - TO model( named-query-element IsA model, MANY2ONE)
55015       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
55016       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
55017       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
55018       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
55019
55020       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
55021       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
55022     required:
55023     - named-query-element-uuid
55024     properties:
55025       named-query-element-uuid:
55026         type: string
55027       property-collect-list:
55028         type: string
55029   named-query-elements:
55030     properties:
55031       named-query-element:
55032         type: array
55033         items:
55034           $ref: "#/patchDefinitions/named-query-element"
55035   network:
55036     description: |
55037       Namespace for network inventory resources.
55038     properties:
55039       logical-links:
55040         type: array
55041         items:
55042           $ref: "#/patchDefinitions/logical-link"
55043       site-pair-sets:
55044         type: array
55045         items:
55046           $ref: "#/patchDefinitions/site-pair-set"
55047       vpn-bindings:
55048         type: array
55049         items:
55050           $ref: "#/patchDefinitions/vpn-binding"
55051       vpls-pes:
55052         type: array
55053         items:
55054           $ref: "#/patchDefinitions/vpls-pe"
55055       multicast-configurations:
55056         type: array
55057         items:
55058           $ref: "#/patchDefinitions/multicast-configuration"
55059       vces:
55060         type: array
55061         items:
55062           $ref: "#/patchDefinitions/vce"
55063       vnfcs:
55064         type: array
55065         items:
55066           $ref: "#/patchDefinitions/vnfc"
55067       l3-networks:
55068         type: array
55069         items:
55070           $ref: "#/patchDefinitions/l3-network"
55071       network-policies:
55072         type: array
55073         items:
55074           $ref: "#/patchDefinitions/network-policy"
55075       generic-vnfs:
55076         type: array
55077         items:
55078           $ref: "#/patchDefinitions/generic-vnf"
55079       lag-links:
55080         type: array
55081         items:
55082           $ref: "#/patchDefinitions/lag-link"
55083       newvces:
55084         type: array
55085         items:
55086           $ref: "#/patchDefinitions/newvce"
55087       pnfs:
55088         type: array
55089         items:
55090           $ref: "#/patchDefinitions/pnf"
55091       physical-links:
55092         type: array
55093         items:
55094           $ref: "#/patchDefinitions/physical-link"
55095       ipsec-configurations:
55096         type: array
55097         items:
55098           $ref: "#/patchDefinitions/ipsec-configuration"
55099       route-table-references:
55100         type: array
55101         items:
55102           $ref: "#/patchDefinitions/route-table-reference"
55103       instance-groups:
55104         type: array
55105         items:
55106           $ref: "#/patchDefinitions/instance-group"
55107       zones:
55108         type: array
55109         items:
55110           $ref: "#/patchDefinitions/zone"
55111       configurations:
55112         type: array
55113         items:
55114           $ref: "#/patchDefinitions/configuration"
55115       forwarding-paths:
55116         type: array
55117         items:
55118           $ref: "#/patchDefinitions/forwarding-path"
55119   network-policies:
55120     properties:
55121       network-policy:
55122         type: array
55123         items:
55124           $ref: "#/patchDefinitions/network-policy"
55125   network-policy:
55126     description: |
55127       ###### Related Nodes
55128       - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
55129       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
55130
55131     required:
55132     - network-policy-id
55133     properties:
55134       network-policy-id:
55135         type: string
55136         description: UUID representing unique key to this instance
55137       network-policy-fqdn:
55138         type: string
55139         description: Contrail FQDN for the policy
55140       heat-stack-id:
55141         type: string
55142         description: ID for the openStack Heat instance
55143   network-profile:
55144     description: |
55145       Network profile populated by SDN-GP for SNMP
55146       ###### Related Nodes
55147       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
55148
55149     required:
55150     - nm-profile-name
55151     properties:
55152       nm-profile-name:
55153         type: string
55154         description: Unique name of network profile.
55155       community-string:
55156         type: string
55157         description: Encrypted SNMP community string
55158   network-profiles:
55159     description: |
55160       Collection of network profiles
55161     properties:
55162       network-profile:
55163         type: array
55164         items:
55165           $ref: "#/patchDefinitions/network-profile"
55166   newvce:
55167     description: |
55168       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
55169       ###### Related Nodes
55170       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
55171
55172       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
55173     required:
55174     - vnf-id2
55175     - vnf-name
55176     - vnf-type
55177     properties:
55178       vnf-id2:
55179         type: string
55180         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
55181       vnf-name:
55182         type: string
55183         description: Name of VNF.
55184       vnf-name2:
55185         type: string
55186         description: Alternate name of VNF.
55187       vnf-type:
55188         type: string
55189         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
55190       prov-status:
55191         type: string
55192         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
55193       operational-status:
55194         type: string
55195         description: Indicator for whether the resource is considered operational
55196       license-key:
55197         type: string
55198         description: OBSOLETE -  do not use
55199       ipv4-oam-address:
55200         type: string
55201         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
55202       equipment-role:
55203         type: string
55204         description: Client should send valid enumerated value.
55205   newvces:
55206     description: |
55207       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
55208     properties:
55209       newvce:
55210         type: array
55211         items:
55212           $ref: "#/patchDefinitions/newvce"
55213   nodes:
55214     properties:
55215       inventory-item-data:
55216         type: array
55217         items:
55218           $ref: "#/patchDefinitions/inventory-item-data"
55219   notification-event:
55220     properties:
55221       cambria.partition:
55222         type: string
55223       notification-event-header:
55224         type: object
55225         $ref: "#/patchDefinitions/notification-event-header"
55226   notification-event-header:
55227     properties:
55228       id:
55229         type: string
55230       timestamp:
55231         type: string
55232       source-name:
55233         type: string
55234       domain:
55235         type: string
55236       sequence-number:
55237         type: string
55238       severity:
55239         type: string
55240       event-type:
55241         type: string
55242       version:
55243         type: string
55244       action:
55245         type: string
55246       entity-type:
55247         type: string
55248       top-entity-type:
55249         type: string
55250       entity-link:
55251         type: string
55252       status:
55253         type: string
55254   notify:
55255     required:
55256     - event-id
55257     properties:
55258       event-id:
55259         type: string
55260       node-type:
55261         type: string
55262       event-trigger:
55263         type: string
55264       key-data:
55265         type: array
55266         items:
55267           $ref: "#/patchDefinitions/key-data"
55268       selflink:
55269         type: string
55270   oam-network:
55271     description: |
55272       OAM network, to be deprecated shortly.  Do not use for new purposes.
55273       ###### Related Nodes
55274       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
55275       - TO complex( oam-network AppliesTo complex, MANY2MANY)
55276       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
55277
55278     required:
55279     - network-uuid
55280     - network-name
55281     - cvlan-tag
55282     properties:
55283       network-uuid:
55284         type: string
55285         description: UUID of the network. Unique across a cloud-region
55286       network-name:
55287         type: string
55288         description: Name of the network.
55289       cvlan-tag:
55290         type: integer
55291         format: int64
55292         description: cvlan-id
55293       ipv4-oam-gateway-address:
55294         type: string
55295         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55296       ipv4-oam-gateway-address-prefix-length:
55297         type: integer
55298         format: int32
55299         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55300   oam-networks:
55301     description: |
55302       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
55303     properties:
55304       oam-network:
55305         type: array
55306         items:
55307           $ref: "#/patchDefinitions/oam-network"
55308   operational-environment:
55309     description: |
55310       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
55311       ###### Related Nodes
55312       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
55313       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
55314
55315     required:
55316     - operational-environment-id
55317     - operational-environment-name
55318     - operational-environment-type
55319     - operational-environment-status
55320     - tenant-context
55321     - workload-context
55322     properties:
55323       operational-environment-id:
55324         type: string
55325         description: UUID of an operational environment
55326       operational-environment-name:
55327         type: string
55328         description: Operational Environment name
55329       operational-environment-type:
55330         type: string
55331         description: Operational Environment Type.
55332       operational-environment-status:
55333         type: string
55334         description: Status
55335       tenant-context:
55336         type: string
55337         description: Tenant Context.
55338       workload-context:
55339         type: string
55340         description: Workload Context.
55341   operational-environments:
55342     description: |
55343       a logical partition of the cloud which allows to have multiple environments in the production AIC.
55344     properties:
55345       operational-environment:
55346         type: array
55347         items:
55348           $ref: "#/patchDefinitions/operational-environment"
55349   overloaded-model:
55350     description: |
55351       Allows for legacy POST of old-style and new-style models
55352     required:
55353     - model-invariant-id
55354     - model-name-version-id
55355     - model-type
55356     - model-name
55357     - model-id
55358     - model-version
55359     properties:
55360       model-invariant-id:
55361         type: string
55362         description: Unique identifier corresponding to the main definition of a model in ASDC
55363       model-name-version-id:
55364         type: string
55365         description: Unique identifier corresponding to one version of a model in ASDC
55366       model-type:
55367         type: string
55368         description: Type of the model, e.g., service, resource, widget, etc.
55369       model-name:
55370         type: string
55371         description: Name of the model, which can change from version to version.
55372       model-id:
55373         type: string
55374         description: Invariant unique ID which does not change from version to version
55375       model-version:
55376         type: string
55377         description: Version
55378       model-description:
55379         type: string
55380         description: Description
55381   owning-entities:
55382     description: |
55383       Collection of owning-entities
55384     properties:
55385       owning-entity:
55386         type: array
55387         items:
55388           $ref: "#/patchDefinitions/owning-entity"
55389   owning-entity:
55390     description: |
55391       describes an owning-entity
55392       ###### Related Nodes
55393       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
55394
55395     required:
55396     - owning-entity-id
55397     - owning-entity-name
55398     properties:
55399       owning-entity-id:
55400         type: string
55401         description: UUID of an owning entity
55402       owning-entity-name:
55403         type: string
55404         description: Owning entity name
55405   p-interface:
55406     description: |
55407       Physical interface (e.g., nic)
55408       ###### Related Nodes
55409       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
55410       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
55411       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
55412       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
55413       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
55414       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
55415       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
55416       - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
55417       - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
55418
55419       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
55420       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
55421       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
55422     required:
55423     - interface-name
55424     - in-maint
55425     properties:
55426       interface-name:
55427         type: string
55428         description: Name that identifies the physical interface
55429       selflink:
55430         type: string
55431         description: URL to endpoint where AAI can get more details.
55432       speed-value:
55433         type: string
55434         description: Captures the numeric part of the speed
55435       speed-units:
55436         type: string
55437         description: Captures the units corresponding to the speed
55438       port-description:
55439         type: string
55440         description: Nature of the services and connectivity on this port.
55441       equipment-identifier:
55442         type: string
55443         description: CLEI or other specification for p-interface hardware.
55444       interface-role:
55445         type: string
55446         description: Role specification for p-interface hardware.
55447       interface-type:
55448         type: string
55449         description: Indicates the physical properties of the interface.
55450       prov-status:
55451         type: string
55452         description: Trigger for operational monitoring of this resource by Service Assurance systems.
55453       mac-addresss:
55454         type: string
55455         description: MAC Address of the p-interface.
55456   p-interfaces:
55457     description: |
55458       Collection of physical interfaces.
55459     properties:
55460       p-interface:
55461         type: array
55462         items:
55463           $ref: "#/patchDefinitions/p-interface"
55464   physical-link:
55465     description: |
55466       Collection of physical connections, typically between p-interfaces
55467       ###### Related Nodes
55468       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
55469
55470       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
55471     required:
55472     - link-name
55473     properties:
55474       link-name:
55475         type: string
55476         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
55477       speed-value:
55478         type: string
55479         description: Captures the numeric part of the speed
55480       speed-units:
55481         type: string
55482         description: Captures the units corresponding to the speed
55483       circuit-id:
55484         type: string
55485         description: Circuit it
55486       dual-mode:
55487         type: string
55488         description: Dual access mode (e.g., primary, secondary
55489       management-option:
55490         type: string
55491         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
55492       service-provider-name:
55493         type: string
55494         description: Name of the service Provider on this link.
55495       service-provider-bandwidth-up-value:
55496         type: integer
55497         format: int32
55498         description: Upstream Bandwidth value agreed with the service provider
55499       service-provider-bandwidth-up-units:
55500         type: string
55501         description: Units for the upstream BW value
55502       service-provider-bandwidth-down-value:
55503         type: integer
55504         format: int32
55505         description: Downstream Bandwidth value agreed with the service provider
55506       service-provider-bandwidth-down-units:
55507         type: string
55508         description: Units for downstream BW value
55509   physical-links:
55510     description: |
55511       Collection of physical connections, typically between p-interfaces
55512     properties:
55513       physical-link:
55514         type: array
55515         items:
55516           $ref: "#/patchDefinitions/physical-link"
55517   platform:
55518     description: |
55519       describes a platform
55520       ###### Related Nodes
55521       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
55522
55523     required:
55524     - platform-name
55525     properties:
55526       platform-name:
55527         type: string
55528         description: Name of the platform
55529   platforms:
55530     description: |
55531       Collection of platforms
55532     properties:
55533       platform:
55534         type: array
55535         items:
55536           $ref: "#/patchDefinitions/platform"
55537   pnf:
55538     description: |
55539       PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
55540       ###### Related Nodes
55541       - TO complex( pnf LocatedIn complex, MANY2ONE)
55542       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
55543       - TO zone( pnf LocatedIn zone, MANY2ONE)
55544       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
55545       - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
55546       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
55547       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
55548       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
55549       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
55550       - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
55551
55552       -(1) IF this PNF node is deleted, this FROM node is DELETED also
55553     required:
55554     - pnf-name
55555     - in-maint
55556     properties:
55557       pnf-name:
55558         type: string
55559         description: unique name of Physical Network Function.
55560       pnf-name2:
55561         type: string
55562         description: name of Physical Network Function.
55563       selflink:
55564         type: string
55565         description: URL to endpoint where AAI can get more details.
55566       pnf-name2-source:
55567         type: string
55568         description: source of name2
55569       pnf-id:
55570         type: string
55571         description: id of pnf
55572       equip-type:
55573         type: string
55574         description: Equipment type.  Source of truth should define valid values.
55575       equip-vendor:
55576         type: string
55577         description: Equipment vendor.  Source of truth should define valid values.
55578       equip-model:
55579         type: string
55580         description: Equipment model.  Source of truth should define valid values.
55581       management-option:
55582         type: string
55583         description: identifier of managed by ATT or customer
55584       ipaddress-v4-oam:
55585         type: string
55586         description: ipv4-oam-address with new naming convention for IP addresses
55587       sw-version:
55588         type: string
55589         description: sw-version is the version of SW for the hosted application on the PNF.
55590       in-maint:
55591         type: boolean
55592         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
55593       frame-id:
55594         type: string
55595         description: ID of the physical frame (relay rack) where pnf is installed.
55596       serial-number:
55597         type: string
55598         description: Serial number of the device
55599       ipaddress-v4-loopback-0:
55600         type: string
55601         description: IPV4 Loopback 0 address
55602       ipaddress-v6-loopback-0:
55603         type: string
55604         description: IPV6 Loopback 0 address
55605       ipaddress-v4-aim:
55606         type: string
55607         description: IPV4 AIM address
55608       ipaddress-v6-aim:
55609         type: string
55610         description: IPV6 AIM address
55611       ipaddress-v6-oam:
55612         type: string
55613         description: IPV6 OAM address
55614       inv-status:
55615         type: string
55616         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
55617   pnfs:
55618     description: |
55619       Collection of Physical Network Functions.
55620     properties:
55621       pnf:
55622         type: array
55623         items:
55624           $ref: "#/patchDefinitions/pnf"
55625   port-group:
55626     description: |
55627       Used to capture the network interfaces of this VCE
55628       ###### Related Nodes
55629       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
55630       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
55631
55632       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
55633       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
55634     required:
55635     - interface-id
55636     - orchestration-status
55637     properties:
55638       interface-id:
55639         type: string
55640         description: Unique ID of the interface
55641       neutron-network-id:
55642         type: string
55643         description: Neutron network id of this Interface
55644       neutron-network-name:
55645         type: string
55646         description: Neutron network name of this Interface
55647       interface-role:
55648         type: string
55649         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
55650   port-groups:
55651     properties:
55652       port-group:
55653         type: array
55654         items:
55655           $ref: "#/patchDefinitions/port-group"
55656   project:
55657     description: |
55658       describes the project
55659       ###### Related Nodes
55660       - TO service-instance( project Uses service-instance, ONE2MANY)
55661
55662     required:
55663     - project-name
55664     properties:
55665       project-name:
55666         type: string
55667         description: Name of the project deploying a service
55668   projects:
55669     description: |
55670       Collection of projects
55671     properties:
55672       project:
55673         type: array
55674         items:
55675           $ref: "#/patchDefinitions/project"
55676   properties:
55677     description: |
55678       Property holder for query properties or instance properties
55679     properties:
55680       property-name:
55681         type: string
55682       property-value:
55683         type: string
55684   property-constraint:
55685     description: |
55686       TBD
55687       ###### Related Nodes
55688       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
55689
55690       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
55691     required:
55692     - property-constraint-uuid
55693     - constraint-type
55694     - property-name
55695     - property-value
55696     properties:
55697       property-constraint-uuid:
55698         type: string
55699       constraint-type:
55700         type: string
55701       property-name:
55702         type: string
55703       property-value:
55704         type: string
55705   property-constraints:
55706     properties:
55707       property-constraint:
55708         type: array
55709         items:
55710           $ref: "#/patchDefinitions/property-constraint"
55711   pserver:
55712     description: |
55713       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
55714       ###### Related Nodes
55715       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
55716       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
55717       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
55718       - TO complex( pserver LocatedIn complex, MANY2ONE)
55719       - TO zone( pserver LocatedIn zone, MANY2ONE)
55720       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
55721       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
55722       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
55723       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
55724       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
55725
55726       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
55727       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
55728
55729     required:
55730     - hostname
55731     - in-maint
55732     properties:
55733       hostname:
55734         type: string
55735         description: Value from executing hostname on the compute node.
55736       ptnii-equip-name:
55737         type: string
55738         description: PTNII name
55739       number-of-cpus:
55740         type: integer
55741         format: int32
55742         description: Number of cpus
55743       disk-in-gigabytes:
55744         type: integer
55745         format: int32
55746         description: Disk size, in GBs
55747       ram-in-megabytes:
55748         type: integer
55749         format: int32
55750         description: RAM size, in MBs
55751       equip-type:
55752         type: string
55753         description: Equipment type.  Source of truth should define valid values.
55754       equip-vendor:
55755         type: string
55756         description: Equipment vendor.  Source of truth should define valid values.
55757       equip-model:
55758         type: string
55759         description: Equipment model.  Source of truth should define valid values.
55760       fqdn:
55761         type: string
55762         description: Fully-qualified domain name
55763       pserver-selflink:
55764         type: string
55765         description: URL to endpoint where AAI can get more details
55766       ipv4-oam-address:
55767         type: string
55768         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
55769       serial-number:
55770         type: string
55771         description: Serial number, may be queried
55772       ipaddress-v4-loopback-0:
55773         type: string
55774         description: IPV4 Loopback 0 address
55775       ipaddress-v6-loopback-0:
55776         type: string
55777         description: IPV6 Loopback 0 address
55778       ipaddress-v4-aim:
55779         type: string
55780         description: IPV4 AIM address
55781       ipaddress-v6-aim:
55782         type: string
55783         description: IPV6 AIM address
55784       ipaddress-v6-oam:
55785         type: string
55786         description: IPV6 OAM address
55787       inv-status:
55788         type: string
55789         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
55790       pserver-id:
55791         type: string
55792         description: ID of Pserver
55793       internet-topology:
55794         type: string
55795         description: internet topology of Pserver
55796       in-maint:
55797         type: boolean
55798         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
55799   pservers:
55800     description: |
55801       Collection of compute hosts.
55802     properties:
55803       pserver:
55804         type: array
55805         items:
55806           $ref: "#/patchDefinitions/pserver"
55807   query-parameters:
55808     description: |
55809       QueryParameters for performing a named-query or model query
55810     properties:
55811       named-query:
55812         type: object
55813         $ref: "#/patchDefinitions/named-query"
55814       overloaded-model:
55815         type: object
55816         $ref: "#/patchDefinitions/overloaded-model"
55817   related-lookup:
55818     description: |
55819       TBD
55820       ###### Related Nodes
55821       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
55822
55823       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
55824     required:
55825     - related-lookup-uuid
55826     - source-node-type
55827     - source-node-property
55828     - target-node-type
55829     - target-node-property
55830     properties:
55831       related-lookup-uuid:
55832         type: string
55833       source-node-type:
55834         type: string
55835       source-node-property:
55836         type: string
55837       target-node-type:
55838         type: string
55839       target-node-property:
55840         type: string
55841       property-collect-list:
55842         type: string
55843   related-lookups:
55844     properties:
55845       related-lookup:
55846         type: array
55847         items:
55848           $ref: "#/patchDefinitions/related-lookup"
55849   related-to-property:
55850     properties:
55851       property-key:
55852         type: string
55853         description: Key part of a key/value pair
55854       property-value:
55855         type: string
55856         description: Value part of a key/value pair
55857   relationship:
55858     properties:
55859       related-to:
55860         type: string
55861         description: A keyword provided by A&AI to indicate type of node.
55862       relationship-label:
55863         type: string
55864         description: The edge label for this relationship.
55865       related-link:
55866         type: string
55867         description: URL to the object in A&AI.
55868       relationship-data:
55869         type: array
55870         items:
55871           $ref: "#/patchDefinitions/relationship-data"
55872       related-to-property:
55873         type: array
55874         items:
55875           $ref: "#/patchDefinitions/related-to-property"
55876   relationship-data:
55877     required:
55878     - relationship-key
55879     - relationship-value
55880     properties:
55881       relationship-key:
55882         type: string
55883         description: A keyword provided by A&AI to indicate an attribute.
55884       relationship-value:
55885         type: string
55886         description: Value of the attribute.
55887   reserved-prop-names:
55888     description: |
55889       Internal map to define some reserved properties of a vertex
55890     properties:
55891       last-mod-source-of-truth:
55892         type: string
55893       aai-node-type:
55894         type: string
55895       aai-created-ts:
55896         type: integer
55897         format: int64
55898       aai-unique-key:
55899         type: string
55900       aai-last-mod-ts:
55901         type: integer
55902         format: int64
55903       source-of-truth:
55904         type: string
55905       aai-uri:
55906         type: string
55907   response-list:
55908     description: |
55909       Response container for the results of a named-query or model query
55910     properties:
55911       inventory-response-items:
55912         type: object
55913         $ref: "#/patchDefinitions/inventory-response-items"
55914   result-data:
55915     properties:
55916       resource-type:
55917         type: string
55918         description: The specific type of node in the A&AI graph
55919       resource-link:
55920         type: string
55921         description: The URL to the specific resource
55922   route-table-reference:
55923     description: |
55924       Openstack route table reference.
55925       ###### Related Nodes
55926       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
55927
55928     required:
55929     - route-table-reference-id
55930     - route-table-reference-fqdn
55931     properties:
55932       route-table-reference-id:
55933         type: string
55934         description: Route Table Reference id, UUID assigned to this instance.
55935       route-table-reference-fqdn:
55936         type: string
55937         description: FQDN entry in the route table.
55938   route-table-references:
55939     description: |
55940       Collection of openstack route table references
55941     properties:
55942       route-table-reference:
55943         type: array
55944         items:
55945           $ref: "#/patchDefinitions/route-table-reference"
55946   route-target:
55947     description: |
55948       Route target information
55949       ###### Related Nodes
55950       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
55951
55952       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
55953     required:
55954     - global-route-target
55955     - route-target-role
55956     properties:
55957       global-route-target:
55958         type: string
55959         description: Number used to identify an RT, globally unique in the network
55960       route-target-role:
55961         type: string
55962         description: Role assigned to this route target
55963   route-targets:
55964     description: |
55965       Collection of route target information
55966     properties:
55967       route-target:
55968         type: array
55969         items:
55970           $ref: "#/patchDefinitions/route-target"
55971   routing-instance:
55972     description: |
55973       ###### Related Nodes
55974       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
55975       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
55976
55977       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
55978       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
55979     required:
55980     - routing-instance-id
55981     properties:
55982       routing-instance-id:
55983         type: string
55984         description: Unique id of routing instance
55985       rpm-owner:
55986         type: string
55987         description: rpm owner
55988   routing-instances:
55989     description: |
55990       set of probes related to generic-vnf routing instance
55991     properties:
55992       routing-instance:
55993         type: array
55994         items:
55995           $ref: "#/patchDefinitions/routing-instance"
55996   sdn-zone-response:
55997     properties:
55998       oam-networks:
55999         type: object
56000         $ref: "#/patchDefinitions/oam-networks"
56001       az-and-dvs-switches:
56002         type: array
56003         items:
56004           $ref: "#/patchDefinitions/az-and-dvs-switches"
56005   search:
56006     properties:
56007       edge-tag-query-result:
56008         type: object
56009         $ref: "#/patchDefinitions/edge-tag-query-result"
56010       edge-tag-query-request:
56011         type: object
56012         $ref: "#/patchDefinitions/edge-tag-query-request"
56013       search-results:
56014         type: object
56015         $ref: "#/patchDefinitions/search-results"
56016       sdn-zone-response:
56017         type: object
56018         $ref: "#/patchDefinitions/sdn-zone-response"
56019   search-results:
56020     properties:
56021       result-data:
56022         type: array
56023         items:
56024           $ref: "#/patchDefinitions/result-data"
56025   secondary-filt:
56026     description: |
56027       SecondaryFilt for performing a named-query or model query
56028   secondary-filter:
56029     properties:
56030       property-name:
56031         type: string
56032       filter-type:
56033         type: string
56034       property-value:
56035         type: string
56036   secondary-filts:
56037     description: |
56038       SecondaryFilts for performing a named-query or model query
56039     properties:
56040       secondary-filt:
56041         type: array
56042         items:
56043           $ref: "#/patchDefinitions/secondary-filt"
56044   segmentation-assignment:
56045     description: |
56046       Openstack segmentation assignment.
56047       ###### Related Nodes
56048       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
56049
56050       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
56051     required:
56052     - segmentation-id
56053     properties:
56054       segmentation-id:
56055         type: string
56056         description: Route Table Reference id, UUID assigned to this instance.
56057   segmentation-assignments:
56058     description: |
56059       Collection of openstack segmentation assignments
56060     properties:
56061       segmentation-assignment:
56062         type: array
56063         items:
56064           $ref: "#/patchDefinitions/segmentation-assignment"
56065   service:
56066     description: |
56067       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
56068     required:
56069     - service-id
56070     - service-description
56071     properties:
56072       service-id:
56073         type: string
56074         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56075       service-description:
56076         type: string
56077         description: Description of the service
56078       service-selflink:
56079         type: string
56080         description: URL to endpoint where AAI can get more details
56081   service-capabilities:
56082     description: |
56083       Collection of service capabilities.
56084     properties:
56085       service-capability:
56086         type: array
56087         items:
56088           $ref: "#/patchDefinitions/service-capability"
56089   service-capability:
56090     description: |
56091       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
56092       ###### Related Nodes
56093       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
56094       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
56095
56096       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
56097
56098     required:
56099     - service-type
56100     - vnf-type
56101     properties:
56102       service-type:
56103         type: string
56104         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56105       vnf-type:
56106         type: string
56107         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
56108   service-design-and-creation:
56109     description: |
56110       Namespace for objects managed by ASDC
56111     properties:
56112       vnf-images:
56113         type: array
56114         items:
56115           $ref: "#/patchDefinitions/vnf-image"
56116       services:
56117         type: array
56118         items:
56119           $ref: "#/patchDefinitions/service"
56120       service-capabilities:
56121         type: array
56122         items:
56123           $ref: "#/patchDefinitions/service-capability"
56124       models:
56125         type: array
56126         items:
56127           $ref: "#/patchDefinitions/model"
56128       named-queries:
56129         type: array
56130         items:
56131           $ref: "#/patchDefinitions/named-query"
56132   service-instance:
56133     description: |
56134       Instance of a service
56135       ###### Related Nodes
56136       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
56137       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
56138       - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
56139       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
56140       - TO configuration( service-instance Uses configuration, ONE2MANY)
56141       - TO connector( service-instance Uses connector, MANY2MANY)
56142       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
56143       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
56144       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
56145       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
56146       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
56147       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
56148       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
56149       - TO zone( service-instance LocatedIn zone, MANY2ONE)
56150       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
56151       - TO vce( service-instance ComposedOf vce, ONE2MANY)
56152       - TO model-ver( service-instance IsA model-ver, Many2One)
56153       - FROM project( project Uses service-instance, ONE2MANY)
56154       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
56155       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
56156       - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
56157       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
56158
56159       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
56160       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
56161       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
56162     required:
56163     - service-instance-id
56164     properties:
56165       service-instance-id:
56166         type: string
56167         description: Uniquely identifies this instance of a service
56168       service-instance-name:
56169         type: string
56170         description: This field will store a name assigned to the service-instance.
56171       service-type:
56172         type: string
56173         description: String capturing type of service.
56174       service-role:
56175         type: string
56176         description: String capturing the service role.
56177       environment-context:
56178         type: string
56179         description: This field will store the environment context assigned to the service-instance.
56180       workload-context:
56181         type: string
56182         description: This field will store the workload context assigned to the service-instance.
56183       created-at:
56184         type: string
56185         description: create time of Network Service.
56186       updated-at:
56187         type: string
56188         description: last update of Network Service.
56189       description:
56190         type: string
56191         description: short description for service-instance.
56192       model-invariant-id:
56193         type: string
56194         description: the ASDC model id for this resource or service model.
56195       model-version-id:
56196         type: string
56197         description: the ASDC model version for this resource or service model.
56198       persona-model-version:
56199         type: string
56200         description: the ASDC model version for this resource or service model.
56201       widget-model-id:
56202         type: string
56203         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56204       widget-model-version:
56205         type: string
56206         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56207       bandwidth-total:
56208         type: string
56209         description: Indicates the total bandwidth to be used for this service.
56210       bandwidth-up-wan1:
56211         type: string
56212         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
56213       bandwidth-down-wan1:
56214         type: string
56215         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
56216       bandwidth-up-wan2:
56217         type: string
56218         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
56219       bandwidth-down-wan2:
56220         type: string
56221         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
56222       vhn-portal-url:
56223         type: string
56224         description: URL customers will use to access the vHN Portal.
56225       service-instance-location-id:
56226         type: string
56227         description: An identifier that customers assign to the location where this service is being used.
56228   service-instances:
56229     description: |
56230       Collection of service instances
56231     properties:
56232       service-instance:
56233         type: array
56234         items:
56235           $ref: "#/patchDefinitions/service-instance"
56236   service-subscription:
56237     description: |
56238       Object that group service instances.
56239       ###### Related Nodes
56240       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
56241       - TO tenant( service-subscription Uses tenant, MANY2MANY)
56242       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
56243
56244       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
56245       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
56246     required:
56247     - service-type
56248     properties:
56249       service-type:
56250         type: string
56251         description: Value defined by orchestration to identify this service across ECOMP.
56252       temp-ub-sub-account-id:
56253         type: string
56254         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
56255   service-subscriptions:
56256     description: |
56257       Collection of objects that group service instances.
56258     properties:
56259       service-subscription:
56260         type: array
56261         items:
56262           $ref: "#/patchDefinitions/service-subscription"
56263   services:
56264     description: |
56265       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
56266     properties:
56267       service:
56268         type: array
56269         items:
56270           $ref: "#/patchDefinitions/service"
56271   site-pair:
56272     description: |
56273       ###### Related Nodes
56274       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
56275       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
56276
56277       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
56278       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
56279     required:
56280     - site-pair-id
56281     properties:
56282       site-pair-id:
56283         type: string
56284         description: unique identifier of probe
56285       source-ip:
56286         type: string
56287         description: Prefix address
56288       destination-ip:
56289         type: string
56290         description: Prefix address
56291       ip-version:
56292         type: string
56293         description: ip version, v4, v6
56294       destination-hostname:
56295         type: string
56296         description: Hostname of the destination equipment to which SLAs are measured against.
56297       destination-equip-type:
56298         type: string
56299         description: The type of destinatination equipment. Could be Router, UCPE, etc.
56300   site-pair-set:
56301     description: |
56302       Set of instances for probes used to measure service level agreements
56303       ###### Related Nodes
56304       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
56305       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
56306
56307       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
56308     required:
56309     - site-pair-set-id
56310     properties:
56311       site-pair-set-id:
56312         type: string
56313         description: Unique id of site pair set.
56314   site-pair-sets:
56315     description: |
56316       Collection of sets of instances for probes related to generic-vnf
56317     properties:
56318       site-pair-set:
56319         type: array
56320         items:
56321           $ref: "#/patchDefinitions/site-pair-set"
56322   site-pairs:
56323     description: |
56324       probe within a set
56325     properties:
56326       site-pair:
56327         type: array
56328         items:
56329           $ref: "#/patchDefinitions/site-pair"
56330   snapshot:
56331     description: |
56332       Openstack snapshot
56333       ###### Related Nodes
56334       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
56335       - FROM vserver( vserver Uses snapshot, ONE2ONE)
56336
56337     required:
56338     - snapshot-id
56339     properties:
56340       snapshot-id:
56341         type: string
56342         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
56343       snapshot-name:
56344         type: string
56345         description: Snapshot name
56346       snapshot-architecture:
56347         type: string
56348         description: Operating system architecture
56349       snapshot-os-distro:
56350         type: string
56351         description: The common name of the operating system distribution in lowercase
56352       snapshot-os-version:
56353         type: string
56354         description: The operating system version as specified by the distributor.
56355       application:
56356         type: string
56357         description: The application that the image instantiates.
56358       application-vendor:
56359         type: string
56360         description: The vendor of the application.
56361       application-version:
56362         type: string
56363         description: The version of the application.
56364       snapshot-selflink:
56365         type: string
56366         description: URL to endpoint where AAI can get more details
56367       prev-snapshot-id:
56368         type: string
56369         description: This field contains the UUID of the previous snapshot (if any).
56370   snapshots:
56371     description: |
56372       Collection of openstack snapshots
56373     properties:
56374       snapshot:
56375         type: array
56376         items:
56377           $ref: "#/patchDefinitions/snapshot"
56378   sriov-pf:
56379     description: |
56380       SR-IOV Physical Function
56381       ###### Related Nodes
56382       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
56383       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
56384
56385       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
56386     required:
56387     - pf-pci-id
56388     properties:
56389       pf-pci-id:
56390         type: string
56391         description: Identifier for the sriov-pf
56392   sriov-pfs:
56393     description: |
56394       Collection of SR-IOV Physical Functions.
56395     properties:
56396       sriov-pf:
56397         type: array
56398         items:
56399           $ref: "#/patchDefinitions/sriov-pf"
56400   sriov-vf:
56401     description: |
56402       SR-IOV Virtual Function (not to be confused with virtual network function)
56403       ###### Related Nodes
56404       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
56405       - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
56406
56407       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
56408     required:
56409     - pci-id
56410     properties:
56411       pci-id:
56412         type: string
56413         description: PCI ID used to identify the sriov-vf
56414       vf-vlan-filter:
56415         type: string
56416         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
56417       vf-mac-filter:
56418         type: string
56419         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
56420       vf-vlan-strip:
56421         type: boolean
56422         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
56423       vf-vlan-anti-spoof-check:
56424         type: boolean
56425         description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
56426       vf-mac-anti-spoof-check:
56427         type: boolean
56428         description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
56429       vf-mirrors:
56430         type: string
56431         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
56432       vf-broadcast-allow:
56433         type: boolean
56434         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
56435       vf-unknown-multicast-allow:
56436         type: boolean
56437         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
56438       vf-unknown-unicast-allow:
56439         type: boolean
56440         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
56441       vf-insert-stag:
56442         type: boolean
56443         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
56444       vf-link-status:
56445         type: string
56446         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
56447   sriov-vfs:
56448     description: |
56449       Collection of SR-IOV Virtual Functions.
56450     properties:
56451       sriov-vf:
56452         type: array
56453         items:
56454           $ref: "#/patchDefinitions/sriov-vf"
56455   start-node-filter:
56456     properties:
56457       property-name:
56458         type: string
56459       property-value:
56460         type: string
56461   subnet:
56462     description: |
56463       ###### Related Nodes
56464       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
56465       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
56466       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
56467       - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
56468       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
56469       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
56470
56471       -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
56472       -(4) IF this TO node is deleted, this SUBNET is DELETED also
56473       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
56474
56475     required:
56476     - subnet-id
56477     - dhcp-enabled
56478     properties:
56479       subnet-id:
56480         type: string
56481         description: Subnet ID, should be UUID.
56482       subnet-name:
56483         type: string
56484         description: Name associated with the subnet.
56485       neutron-subnet-id:
56486         type: string
56487         description: Neutron id of this subnet
56488       gateway-address:
56489         type: string
56490         description: gateway ip address
56491       network-start-address:
56492         type: string
56493         description: network start address
56494       cidr-mask:
56495         type: string
56496         description: cidr mask
56497       ip-version:
56498         type: string
56499         description: ip version
56500       orchestration-status:
56501         type: string
56502         description: Orchestration status of this VNF, mastered by MSO
56503       dhcp-enabled:
56504         type: boolean
56505         description: dhcp enabled
56506       dhcp-start:
56507         type: string
56508         description: the start address reserved for use by dhcp
56509       dhcp-end:
56510         type: string
56511         description: the last address reserved for use by dhcp
56512       subnet-role:
56513         type: string
56514         description: role of the subnet, referenced when assigning IPs
56515       ip-assignment-direction:
56516         type: string
56517         description: ip address assignment direction of the subnet
56518   subnets:
56519     properties:
56520       subnet:
56521         type: array
56522         items:
56523           $ref: "#/patchDefinitions/subnet"
56524   tagged-inventory-item-list:
56525     properties:
56526       inventory-item:
56527         type: array
56528         items:
56529           $ref: "#/patchDefinitions/inventory-item"
56530   tenant:
56531     description: |
56532       Openstack tenant
56533       ###### Related Nodes
56534       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
56535       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
56536       - TO l3-network( tenant Uses l3-network, MANY2MANY)
56537       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
56538       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
56539       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
56540
56541       -TENANT cannot be deleted if related to VSERVER
56542
56543     required:
56544     - tenant-id
56545     - tenant-name
56546     properties:
56547       tenant-id:
56548         type: string
56549         description: Unique id relative to the cloud-region.
56550       tenant-name:
56551         type: string
56552         description: Readable name of tenant
56553       tenant-context:
56554         type: string
56555         description: This field will store the tenant context.
56556   tenants:
56557     description: |
56558       Collection of openstack tenants.
56559     properties:
56560       tenant:
56561         type: array
56562         items:
56563           $ref: "#/patchDefinitions/tenant"
56564   tunnel-xconnect:
56565     description: |
56566       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
56567       ###### Related Nodes
56568       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
56569
56570       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
56571     required:
56572     - id
56573     properties:
56574       id:
56575         type: string
56576         description: Allotted Resource id UUID assigned to this instance.
56577       bandwidth-up-wan1:
56578         type: string
56579         description: The WAN uplink bandwidth for WAN1
56580       bandwidth-down-wan1:
56581         type: string
56582         description: The WAN downlink bandwidth for WAN1
56583       bandwidth-up-wan2:
56584         type: string
56585         description: The WAN uplink bandwidth for WAN2
56586       bandwidth-down-wan2:
56587         type: string
56588         description: The WAN downlink bandwidth for WAN2
56589   tunnel-xconnects:
56590     description: |
56591       This object is used to store the specific tunnel cross connect aspects of an allotted resource
56592     properties:
56593       tunnel-xconnect:
56594         type: array
56595         items:
56596           $ref: "#/patchDefinitions/tunnel-xconnect"
56597   update:
56598     description: |
56599       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
56600     required:
56601     - update-node-type
56602     properties:
56603       update-node-type:
56604         type: string
56605       update-node-key:
56606         type: array
56607         items:
56608           $ref: "#/patchDefinitions/update-node-key"
56609       update-node-uri:
56610         type: string
56611       action:
56612         type: array
56613         items:
56614           $ref: "#/patchDefinitions/action"
56615   update-node-key:
56616     properties:
56617       key-name:
56618         type: string
56619       key-value:
56620         type: string
56621   vce:
56622     description: |
56623       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
56624       ###### Related Nodes
56625       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
56626       - TO complex( vce LocatedIn complex, MANY2MANY)
56627       - TO vserver( vce HostedOn vserver, ONE2MANY)
56628       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
56629       - FROM license( license BelongsTo vce, MANY2ONE)(1)
56630       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
56631       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
56632
56633       -(1) IF this VCE node is deleted, this FROM node is DELETED also
56634     required:
56635     - vnf-id
56636     - vnf-name
56637     - vnf-type
56638     properties:
56639       vnf-id:
56640         type: string
56641         description: Unique id of VNF.  This is unique across the graph.
56642       vnf-name:
56643         type: string
56644         description: Name of VNF.
56645       vnf-name2:
56646         type: string
56647         description: Alternate name of VNF.
56648       vnf-type:
56649         type: string
56650         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
56651       service-id:
56652         type: string
56653         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
56654       regional-resource-zone:
56655         type: string
56656         description: Regional way of organizing pservers, source of truth should define values
56657       prov-status:
56658         type: string
56659         description: Trigger for operational monitoring of this resource by Service Assurance systems.
56660       operational-status:
56661         type: string
56662         description: Indicator for whether the resource is considered operational
56663       license-key:
56664         type: string
56665         description: OBSOLETE -  do not use
56666       equipment-role:
56667         type: string
56668         description: Network role being played by this VNF
56669       orchestration-status:
56670         type: string
56671         description: Orchestration status of this VNF, mastered by MSO
56672       heat-stack-id:
56673         type: string
56674         description: Heat stack id corresponding to this instance, managed by MSO
56675       mso-catalog-key:
56676         type: string
56677         description: Corresponds to the SDN-C catalog id used to configure this VCE
56678       vpe-id:
56679         type: string
56680         description: Unique ID of VPE connected to this VCE.
56681       v6-vce-wan-address:
56682         type: string
56683         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
56684       ipv4-oam-address:
56685         type: string
56686         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
56687   vces:
56688     description: |
56689       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
56690     properties:
56691       vce:
56692         type: array
56693         items:
56694           $ref: "#/patchDefinitions/vce"
56695   vf-module:
56696     description: |
56697       a deployment unit of VNFCs
56698       ###### Related Nodes
56699       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
56700       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
56701       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
56702       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
56703       - TO vserver( vf-module Uses vserver, ONE2MANY)
56704       - TO model-ver( vf-module IsA model-ver, Many2One)
56705
56706       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
56707       -VF-MODULE cannot be deleted if related to VNFC
56708
56709     required:
56710     - vf-module-id
56711     - is-base-vf-module
56712     properties:
56713       vf-module-id:
56714         type: string
56715         description: Unique ID of vf-module.
56716       vf-module-name:
56717         type: string
56718         description: Name of vf-module
56719       heat-stack-id:
56720         type: string
56721         description: Heat stack id corresponding to this instance.
56722       orchestration-status:
56723         type: string
56724         description: orchestration status of this vf-module, mastered by MSO
56725       is-base-vf-module:
56726         type: boolean
56727         description: used to indicate whether or not this object is base vf module
56728   vf-modules:
56729     description: |
56730       Collection of vf-modules, a deployment unit of VNFCs
56731     properties:
56732       vf-module:
56733         type: array
56734         items:
56735           $ref: "#/patchDefinitions/vf-module"
56736   vig-server:
56737     description: |
56738       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
56739       ###### Related Nodes
56740       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
56741
56742       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
56743     required:
56744     - vig-address-type
56745     properties:
56746       vig-address-type:
56747         type: string
56748         description: indicates whether the VIG is for AVPN or INTERNET
56749       ipaddress-v4-vig:
56750         type: string
56751         description: v4 IP of the vig server
56752       ipaddress-v6-vig:
56753         type: string
56754         description: v6 IP of the vig server
56755   vig-servers:
56756     properties:
56757       vig-server:
56758         type: array
56759         items:
56760           $ref: "#/patchDefinitions/vig-server"
56761   vip-ipv4-address-list:
56762     description: |
56763       IPv4 Address Range
56764       ###### Related Nodes
56765       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
56766       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
56767       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
56768       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
56769
56770     required:
56771     - vip-ipv4-address
56772     properties:
56773       vip-ipv4-address:
56774         type: string
56775         description: IP address
56776       vip-ipv4-prefix-length:
56777         type: integer
56778         format: int64
56779         description: Prefix length, 32 for single address
56780       vlan-id-inner:
56781         type: integer
56782         format: int64
56783         description: Inner VLAN tag
56784       vlan-id-outer:
56785         type: integer
56786         format: int64
56787         description: Outer VLAN tag
56788       is-floating:
56789         type: boolean
56790         description: Indicator of fixed or floating address
56791   vip-ipv6-address-list:
56792     description: |
56793       IPv6 Address Range
56794       ###### Related Nodes
56795       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
56796       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
56797       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
56798       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
56799
56800     required:
56801     - vip-ipv6-address
56802     properties:
56803       vip-ipv6-address:
56804         type: string
56805         description: IP address
56806       vip-ipv6-prefix-length:
56807         type: integer
56808         format: int64
56809         description: Prefix length, 128 for single address
56810       vlan-id-inner:
56811         type: integer
56812         format: int64
56813         description: Inner VLAN tag
56814       vlan-id-outer:
56815         type: integer
56816         format: int64
56817         description: Outer VLAN tag
56818       is-floating:
56819         type: boolean
56820         description: Indicator of fixed or floating address
56821   virtual-data-center:
56822     description: |
56823       Virtual organization of cloud infrastructure elements in a data center context
56824       ###### Related Nodes
56825       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
56826       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
56827       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
56828
56829     required:
56830     - vdc-id
56831     - vdc-name
56832     properties:
56833       vdc-id:
56834         type: string
56835         description: Unique ID of the vdc
56836       vdc-name:
56837         type: string
56838         description: Name of the virtual data center
56839   virtual-data-centers:
56840     description: |
56841       Virtual organization of cloud infrastructure elements in a data center context
56842     properties:
56843       virtual-data-center:
56844         type: array
56845         items:
56846           $ref: "#/patchDefinitions/virtual-data-center"
56847   vlan:
56848     description: |
56849       Definition of vlan
56850       ###### Related Nodes
56851       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
56852       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
56853       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
56854       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
56855       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
56856       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
56857       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
56858
56859       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
56860       -(2) IF this VLAN node is deleted, this TO node is DELETED also
56861       -(4) IF this TO node is deleted, this VLAN is DELETED also
56862     required:
56863     - vlan-interface
56864     - in-maint
56865     - is-ip-unnumbered
56866     properties:
56867       vlan-interface:
56868         type: string
56869         description: String that identifies the interface
56870       vlan-id-inner:
56871         type: integer
56872         format: int64
56873         description: Inner VLAN tag
56874       vlan-id-outer:
56875         type: integer
56876         format: int64
56877         description: Outer VLAN tag
56878   vlans:
56879     properties:
56880       vlan:
56881         type: array
56882         items:
56883           $ref: "#/patchDefinitions/vlan"
56884   vnf:
56885     description: |
56886       Abstract vnf class
56887     required:
56888     - vnf-id
56889     properties:
56890       vnf-id:
56891         type: string
56892         description: Unique id of VNF.  This is unique across the graph.
56893   vnf-image:
56894     description: |
56895       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
56896       ###### Related Nodes
56897       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
56898
56899       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
56900
56901     required:
56902     - vnf-image-uuid
56903     - application
56904     - application-vendor
56905     properties:
56906       vnf-image-uuid:
56907         type: string
56908         description: Unique ID of this asset
56909       application:
56910         type: string
56911         description: The application that the image instantiates.
56912       application-vendor:
56913         type: string
56914         description: The vendor of the application.
56915       application-version:
56916         type: string
56917         description: The version of the application.
56918       selflink:
56919         type: string
56920         description: URL to endpoint where AAI can get more details
56921   vnf-images:
56922     description: |
56923       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
56924     properties:
56925       vnf-image:
56926         type: array
56927         items:
56928           $ref: "#/patchDefinitions/vnf-image"
56929   vnfc:
56930     description: |
56931       ###### Related Nodes
56932       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
56933       - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
56934       - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
56935       - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
56936       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
56937       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
56938       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
56939       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
56940
56941       -(1) IF this VNFC node is deleted, this FROM node is DELETED also
56942       -(4) IF this TO node is deleted, this VNFC is DELETED also
56943     required:
56944     - vnfc-name
56945     - nfc-naming-code
56946     - nfc-function
56947     - in-maint
56948     - is-closed-loop-disabled
56949     properties:
56950       vnfc-name:
56951         type: string
56952         description: Unique ID of vnfc.
56953       nfc-naming-code:
56954         type: string
56955         description: Short code that is used in naming instances of the item being modeled
56956       nfc-function:
56957         type: string
56958         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
56959       prov-status:
56960         type: string
56961         description: prov status of this vnfc
56962       orchestration-status:
56963         type: string
56964         description: Orchestration status of this VNF, mastered by APP-C
56965       ipaddress-v4-oam-vip:
56966         type: string
56967         description: Oam V4 vip address of this vnfc
56968       in-maint:
56969         type: boolean
56970         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
56971       is-closed-loop-disabled:
56972         type: boolean
56973         description: used to indicate whether closed loop function is enabled on this node
56974       group-notation:
56975         type: string
56976         description: Group notation of VNFC
56977       model-invariant-id:
56978         type: string
56979         description: the ASDC model id for this resource or service model.
56980       model-version-id:
56981         type: string
56982         description: the ASDC model version for this resource or service model.
56983   vnfcs:
56984     description: |
56985       virtual network components associated with a vserver from application controller.
56986     properties:
56987       vnfc:
56988         type: array
56989         items:
56990           $ref: "#/patchDefinitions/vnfc"
56991   volume:
56992     description: |
56993       Ephemeral Block storage volume.
56994       ###### Related Nodes
56995       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
56996
56997       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
56998     required:
56999     - volume-id
57000     - volume-selflink
57001     properties:
57002       volume-id:
57003         type: string
57004         description: Unique ID of block storage volume relative to the vserver.
57005       volume-selflink:
57006         type: string
57007         description: URL to endpoint where AAI can get more details
57008   volume-group:
57009     description: |
57010       Persistent block-level storage.
57011       ###### Related Nodes
57012       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
57013       - TO complex( volume-group LocatedIn complex, MANY2ONE)
57014       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
57015       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
57016       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
57017
57018     required:
57019     - volume-group-id
57020     - volume-group-name
57021     - vnf-type
57022     properties:
57023       volume-group-id:
57024         type: string
57025         description: Unique ID of volume-group.
57026       volume-group-name:
57027         type: string
57028         description: Name of the volume group.
57029       heat-stack-id:
57030         type: string
57031         description: Heat stack id corresponding to this volume-group
57032       vnf-type:
57033         type: string
57034         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
57035       orchestration-status:
57036         type: string
57037         description: Orchestration status of this volume-group
57038       model-customization-id:
57039         type: string
57040         description: captures the id of all the configuration used to customize the resource for the service.
57041       vf-module-model-customization-id:
57042         type: string
57043         description: helps relate the volume group to the vf-module whose components will require the volume group
57044   volume-groups:
57045     description: |
57046       Collection of persistent block-level storage.
57047     properties:
57048       volume-group:
57049         type: array
57050         items:
57051           $ref: "#/patchDefinitions/volume-group"
57052   volumes:
57053     description: |
57054       Collection of ephemeral Block storage volumes.
57055     properties:
57056       volume:
57057         type: array
57058         items:
57059           $ref: "#/patchDefinitions/volume"
57060   vpls-pe:
57061     description: |
57062       VPLS Provider Edge routers.
57063       ###### Related Nodes
57064       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
57065       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
57066       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
57067       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
57068
57069       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
57070     required:
57071     - equipment-name
57072     properties:
57073       equipment-name:
57074         type: string
57075       prov-status:
57076         type: string
57077         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57078       ipv4-oam-address:
57079         type: string
57080         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
57081       equipment-role:
57082         type: string
57083         description: Client should send valid enumerated value, e.g., VPLS-PE.
57084       vlan-id-outer:
57085         type: integer
57086         format: int64
57087         description: Temporary location for stag to get to VCE
57088   vpls-pes:
57089     description: |
57090       Collection of VPLS Provider Edge routers
57091     properties:
57092       vpls-pe:
57093         type: array
57094         items:
57095           $ref: "#/patchDefinitions/vpls-pe"
57096   vpn-binding:
57097     description: |
57098       VPN binding
57099       ###### Related Nodes
57100       - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
57101       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
57102       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
57103       - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
57104
57105       -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
57106       -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
57107
57108     required:
57109     - vpn-id
57110     - vpn-name
57111     properties:
57112       vpn-id:
57113         type: string
57114         description: VPN ID, globally unique within A&AI
57115       vpn-name:
57116         type: string
57117         description: VPN Name
57118       vpn-platform:
57119         type: string
57120         description: the platform associated with the VPN example AVPN, Mobility
57121       vpn-type:
57122         type: string
57123         description: Type of the vpn, should be taken from enumerated/valid values
57124       vpn-region:
57125         type: string
57126         description: region of customer vpn
57127       customer-vpn-id:
57128         type: string
57129         description: id for this customer vpn
57130       route-distinguisher:
57131         type: string
57132         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
57133   vpn-bindings:
57134     properties:
57135       vpn-binding:
57136         type: array
57137         items:
57138           $ref: "#/patchDefinitions/vpn-binding"
57139   vserver:
57140     description: |
57141       Virtual Servers, aka virtual machine or VM.
57142       ###### Related Nodes
57143       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
57144       - TO flavor( vserver Uses flavor, MANY2ONE)
57145       - TO image( vserver Uses image, MANY2ONE)
57146       - TO pserver( vserver HostedOn pserver, MANY2ONE)
57147       - TO snapshot( vserver Uses snapshot, ONE2ONE)
57148       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
57149       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
57150       - FROM vce( vce HostedOn vserver, ONE2MANY)
57151       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
57152       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
57153       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
57154
57155       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
57156       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
57157     required:
57158     - vserver-id
57159     - vserver-name
57160     - vserver-selflink
57161     - in-maint
57162     - is-closed-loop-disabled
57163     properties:
57164       vserver-id:
57165         type: string
57166         description: Unique identifier for this vserver relative to its tenant
57167       vserver-name:
57168         type: string
57169         description: Name of vserver
57170       vserver-name2:
57171         type: string
57172         description: Alternative name of vserver
57173       prov-status:
57174         type: string
57175         description: Trigger for operational monitoring of this resource by Service Assurance systems.
57176       vserver-selflink:
57177         type: string
57178         description: URL to endpoint where AAI can get more details
57179       in-maint:
57180         type: boolean
57181         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
57182       is-closed-loop-disabled:
57183         type: boolean
57184         description: Used to indicate whether closed loop function is enabled on this node
57185   vservers:
57186     description: |
57187       Collection of virtual Servers, aka virtual machines or VMs.
57188     properties:
57189       vserver:
57190         type: array
57191         items:
57192           $ref: "#/patchDefinitions/vserver"
57193   zone:
57194     description: |
57195       A zone is a grouping of assets in a location homing to the same connections into the CBB
57196       ###### Related Nodes
57197       - TO complex( zone LocatedIn complex, MANY2ONE)
57198       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
57199       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
57200       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
57201       - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
57202
57203     required:
57204     - zone-id
57205     - zone-name
57206     - design-type
57207     - zone-context
57208     properties:
57209       zone-id:
57210         type: string
57211         description: Code assigned by AIC to the zone
57212       zone-name:
57213         type: string
57214         description: English name associated with the zone
57215       design-type:
57216         type: string
57217         description: Design of zone [Medium/Large…]
57218       zone-context:
57219         type: string
57220         description: Context of zone [production/test]
57221       status:
57222         type: string
57223         description: Status of a zone.
57224   zones:
57225     description: |
57226       Collection of zones
57227     properties:
57228       zone:
57229         type: array
57230         items:
57231           $ref: "#/patchDefinitions/zone"
57232 getDefinitions:
57233   action:
57234     properties:
57235       action-type:
57236         type: string
57237       action-data:
57238         type: array
57239         items:
57240           $ref: "#/getDefinitions/action-data"
57241   action-data:
57242     properties:
57243       property-name:
57244         type: string
57245       property-value:
57246         type: string
57247   actions:
57248     description: |
57249       APIs that are more action related than REST (e.g., notify, update).
57250     properties:
57251       update:
57252         type: object
57253         $ref: "#/getDefinitions/update"
57254       notify:
57255         type: object
57256         $ref: "#/getDefinitions/notify"
57257   allotted-resource:
57258     description: |
57259       Represents a slice or partial piece of a resource that gets separately allotted
57260       ###### Related Nodes
57261       - TO allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
57262       - TO generic-vnf( allotted-resource PartOf generic-vnf, MANY2MANY)
57263       - TO instance-group( allotted-resource MemberOf instance-group, MANY2MANY)
57264       - TO l3-network( allotted-resource PartOf l3-network, MANY2MANY)
57265       - TO l-interface( allotted-resource Uses l-interface, ONE2MANY)
57266       - TO network-policy( allotted-resource Uses network-policy, ONE2ONE)
57267       - TO vlan( allotted-resource PartOf vlan, MANY2MANY)
57268       - TO vpn-binding( allotted-resource BelongsTo vpn-binding, MANY2MANY)
57269       - TO service-instance( allotted-resource BelongsTo service-instance, MANY2ONE)(4)
57270       - TO model-ver( allotted-resource IsA model-ver, Many2One)
57271       - FROM tunnel-xconnect( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(1)
57272       - FROM configuration( configuration Uses allotted-resource, ONE2ONE)(3)
57273       - FROM service-instance( service-instance Uses allotted-resource, MANY2MANY)
57274       - FROM allotted-resource( allotted-resource BindsTo allotted-resource, ONE2ONE)
57275
57276       -(1) IF this ALLOTTED-RESOURCE node is deleted, this FROM node is DELETED also
57277       -(3) IF this FROM node is deleted, this ALLOTTED-RESOURCE is DELETED also
57278       -(4) IF this TO node is deleted, this ALLOTTED-RESOURCE is DELETED also
57279     required:
57280     - id
57281     properties:
57282       id:
57283         type: string
57284         description: Allotted Resource id UUID assigned to this instance.
57285       description:
57286         type: string
57287         description: The descriptive information assigned to this allotted resource instance
57288       selflink:
57289         type: string
57290         description: Link back to more information in the controller
57291       model-invariant-id:
57292         type: string
57293         description: the ASDC model id for this resource or service model.
57294       model-version-id:
57295         type: string
57296         description: the ASDC model version for this resource or service model.
57297       persona-model-version:
57298         type: string
57299         description: the ASDC model version for this resource or service model.
57300       resource-version:
57301         type: string
57302         description: Concurrency value
57303       orchestration-status:
57304         type: string
57305         description: Orchestration status
57306       operational-status:
57307         type: string
57308         description: Indicator for whether the resource is considered operational
57309       type:
57310         type: string
57311         description: Generic description of the type of allotted resource.
57312       role:
57313         type: string
57314         description: role in the network that this resource will be providing.
57315       tunnel-xconnects:
57316         type: array
57317         items:
57318           $ref: "#/getDefinitions/tunnel-xconnect"
57319       relationship-list:
57320         type: array
57321         items:
57322           $ref: "#/getDefinitions/relationship"
57323   allotted-resources:
57324     description: |
57325       This object is used to store slices of services being offered
57326     properties:
57327       allotted-resource:
57328         type: array
57329         items:
57330           $ref: "#/getDefinitions/allotted-resource"
57331   availability-zone:
57332     description: |
57333       Availability zone, a collection of compute hosts/pservers
57334       ###### Related Nodes
57335       - TO complex( availability-zone LocatedIn complex, MANY2ONE)
57336       - TO service-capability( availability-zone AppliesTo service-capability, MANY2MANY)
57337       - TO cloud-region( availability-zone BelongsTo cloud-region, MANY2ONE)(4)
57338       - FROM ctag-pool( ctag-pool AppliesTo availability-zone, MANY2MANY)
57339       - FROM dvs-switch( dvs-switch AppliesTo availability-zone, MANY2MANY)
57340       - FROM generic-vnf( generic-vnf Uses availability-zone, MANY2MANY)
57341       - FROM pserver( pserver MemberOf availability-zone, MANY2ONE)
57342       - FROM vce( vce Uses availability-zone, MANY2MANY)
57343
57344       -(4) IF this TO node is deleted, this AVAILABILITY-ZONE is DELETED also
57345       -AVAILABILITY-ZONE cannot be deleted if related to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
57346
57347     required:
57348     - availability-zone-name
57349     - hypervisor-type
57350     properties:
57351       availability-zone-name:
57352         type: string
57353         description: Name of the availability zone.  Unique across a cloud region
57354       hypervisor-type:
57355         type: string
57356         description: Type of hypervisor.  Source of truth should define valid values.
57357       operational-status:
57358         type: string
57359         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
57360       resource-version:
57361         type: string
57362         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57363       relationship-list:
57364         type: array
57365         items:
57366           $ref: "#/getDefinitions/relationship"
57367   availability-zones:
57368     description: |
57369       Collection of availability zones
57370     properties:
57371       availability-zone:
57372         type: array
57373         items:
57374           $ref: "#/getDefinitions/availability-zone"
57375   az-and-dvs-switches:
57376     properties:
57377       dvs-switches:
57378         type: object
57379         $ref: "#/getDefinitions/dvs-switches"
57380       availability-zone:
57381         type: object
57382         $ref: "#/getDefinitions/availability-zone"
57383   business:
57384     description: |
57385       Namespace for business related constructs
57386     properties:
57387       connectors:
57388         type: array
57389         items:
57390           $ref: "#/getDefinitions/connector"
57391       customers:
57392         type: array
57393         items:
57394           $ref: "#/getDefinitions/customer"
57395       lines-of-business:
57396         type: array
57397         items:
57398           $ref: "#/getDefinitions/line-of-business"
57399       owning-entities:
57400         type: array
57401         items:
57402           $ref: "#/getDefinitions/owning-entity"
57403       platforms:
57404         type: array
57405         items:
57406           $ref: "#/getDefinitions/platform"
57407       projects:
57408         type: array
57409         items:
57410           $ref: "#/getDefinitions/project"
57411   class-of-service:
57412     description: |
57413       ###### Related Nodes
57414       - TO site-pair( class-of-service BelongsTo site-pair, MANY2ONE)(4)
57415
57416       -(4) IF this TO node is deleted, this CLASS-OF-SERVICE is DELETED also
57417     required:
57418     - cos
57419     properties:
57420       cos:
57421         type: string
57422         description: unique identifier of probe
57423       probe-id:
57424         type: string
57425         description: identifier of probe
57426       probe-type:
57427         type: string
57428         description: type of probe
57429       resource-version:
57430         type: string
57431         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57432       relationship-list:
57433         type: array
57434         items:
57435           $ref: "#/getDefinitions/relationship"
57436   classes-of-service:
57437     description: |
57438       class-of-service of probe
57439     properties:
57440       class-of-service:
57441         type: array
57442         items:
57443           $ref: "#/getDefinitions/class-of-service"
57444   cloud-infrastructure:
57445     description: |
57446       Namespace for cloud infrastructure.
57447     properties:
57448       complexes:
57449         type: array
57450         items:
57451           $ref: "#/getDefinitions/complex"
57452       cloud-regions:
57453         type: array
57454         items:
57455           $ref: "#/getDefinitions/cloud-region"
57456       network-profiles:
57457         type: array
57458         items:
57459           $ref: "#/getDefinitions/network-profile"
57460       pservers:
57461         type: array
57462         items:
57463           $ref: "#/getDefinitions/pserver"
57464       virtual-data-centers:
57465         type: array
57466         items:
57467           $ref: "#/getDefinitions/virtual-data-center"
57468       operational-environments:
57469         type: array
57470         items:
57471           $ref: "#/getDefinitions/operational-environment"
57472   cloud-region:
57473     description: |
57474       cloud-region designates an installation of a cloud cluster or region or instantiation.
57475       ###### Related Nodes
57476       - TO complex( cloud-region LocatedIn complex, MANY2ONE)
57477       - TO l3-network( cloud-region Uses l3-network, MANY2MANY)
57478       - TO zone( cloud-region LocatedIn zone, MANY2ONE)
57479       - FROM esr-system-info( esr-system-info BelongsTo cloud-region, MANY2ONE)(1)
57480       - FROM availability-zone( availability-zone BelongsTo cloud-region, MANY2ONE)(1)
57481       - FROM dvs-switch( dvs-switch BelongsTo cloud-region, MANY2ONE)
57482       - FROM flavor( flavor BelongsTo cloud-region, MANY2ONE)
57483       - FROM hpa-capability( hpa-capability BelongsTo cloud-region, MANY2ONE)
57484       - FROM group-assignment( group-assignment BelongsTo cloud-region, MANY2ONE)
57485       - FROM image( image BelongsTo cloud-region, MANY2ONE)
57486       - FROM oam-network( oam-network BelongsTo cloud-region, MANY2ONE)
57487       - FROM snapshot( snapshot BelongsTo cloud-region, MANY2ONE)
57488       - FROM tenant( tenant BelongsTo cloud-region, MANY2ONE)
57489       - FROM vip-ipv4-address-list( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
57490       - FROM vip-ipv6-address-list( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
57491       - FROM volume-group( volume-group BelongsTo cloud-region, MANY2ONE)
57492       - FROM logical-link( logical-link LocatedIn cloud-region, MANY2MANY)
57493       - FROM pserver( pserver LocatedIn cloud-region, MANY2ONE)
57494
57495       -(1) IF this CLOUD-REGION node is deleted, this FROM node is DELETED also
57496       -CLOUD-REGION cannot be deleted if related to DVS-SWITCH,FLAVOR,HPA-CAPABILITY,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
57497
57498     required:
57499     - cloud-owner
57500     - cloud-region-id
57501     - sriov-automation
57502     properties:
57503       cloud-owner:
57504         type: string
57505         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
57506       cloud-region-id:
57507         type: string
57508         description: Identifier used by the vendor for the region. Second part of composite key
57509       cloud-type:
57510         type: string
57511         description: Type of the cloud (e.g., openstack)
57512       owner-defined-type:
57513         type: string
57514         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
57515       cloud-region-version:
57516         type: string
57517         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
57518       identity-url:
57519         type: string
57520         description: URL of the keystone identity service
57521       cloud-zone:
57522         type: string
57523         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
57524       complex-name:
57525         type: string
57526         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
57527       sriov-automation:
57528         type: boolean
57529         description: Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
57530       cloud-extra-info:
57531         type: string
57532         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
57533       cloud-epa-caps:
57534         type: string
57535         description: MultiVIM will discover and expose EPA capabilities.
57536       resource-version:
57537         type: string
57538         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57539       volume-groups:
57540         type: array
57541         items:
57542           $ref: "#/getDefinitions/volume-group"
57543       tenants:
57544         type: array
57545         items:
57546           $ref: "#/getDefinitions/tenant"
57547       flavors:
57548         type: array
57549         items:
57550           $ref: "#/getDefinitions/flavor"
57551       group-assignments:
57552         type: array
57553         items:
57554           $ref: "#/getDefinitions/group-assignment"
57555       snapshots:
57556         type: array
57557         items:
57558           $ref: "#/getDefinitions/snapshot"
57559       images:
57560         type: array
57561         items:
57562           $ref: "#/getDefinitions/image"
57563       dvs-switches:
57564         type: array
57565         items:
57566           $ref: "#/getDefinitions/dvs-switch"
57567       oam-networks:
57568         type: array
57569         items:
57570           $ref: "#/getDefinitions/oam-network"
57571       availability-zones:
57572         type: array
57573         items:
57574           $ref: "#/getDefinitions/availability-zone"
57575       relationship-list:
57576         type: array
57577         items:
57578           $ref: "#/getDefinitions/relationship"
57579       vip-ipv4-address-list:
57580         type: array
57581         items:
57582           $ref: "#/getDefinitions/vip-ipv4-address-list"
57583       vip-ipv6-address-list:
57584         type: array
57585         items:
57586           $ref: "#/getDefinitions/vip-ipv6-address-list"
57587       hpa-capabilities:
57588         type: array
57589         items:
57590           $ref: "#/getDefinitions/hpa-capability"
57591         description: List of cloud-region specific HPA Capabilities
57592       esr-system-info-list:
57593         type: array
57594         items:
57595           $ref: "#/getDefinitions/esr-system-info"
57596   cloud-regions:
57597     properties:
57598       cloud-region:
57599         type: array
57600         items:
57601           $ref: "#/getDefinitions/cloud-region"
57602   complex:
57603     description: |
57604       Collection of physical locations that can house cloud-regions.
57605       ###### Related Nodes
57606       - TO l3-network( complex Uses l3-network, MANY2MANY)
57607       - FROM availability-zone( availability-zone LocatedIn complex, MANY2ONE)
57608       - FROM cloud-region( cloud-region LocatedIn complex, MANY2ONE)
57609       - FROM ctag-pool( ctag-pool BelongsTo complex, MANY2ONE)(1)
57610       - FROM generic-vnf( generic-vnf LocatedIn complex, MANY2MANY)
57611       - FROM oam-network( oam-network AppliesTo complex, MANY2MANY)
57612       - FROM pnf( pnf LocatedIn complex, MANY2ONE)
57613       - FROM pserver( pserver LocatedIn complex, MANY2ONE)
57614       - FROM vce( vce LocatedIn complex, MANY2MANY)
57615       - FROM volume-group( volume-group LocatedIn complex, MANY2ONE)
57616       - FROM vpls-pe( vpls-pe LocatedIn complex, MANY2ONE)
57617       - FROM zone( zone LocatedIn complex, MANY2ONE)
57618
57619       -(1) IF this COMPLEX node is deleted, this FROM node is DELETED also
57620       -COMPLEX cannot be deleted if related to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
57621
57622     required:
57623     - physical-location-id
57624     - physical-location-type
57625     - street1
57626     - city
57627     - postal-code
57628     - country
57629     - region
57630     properties:
57631       physical-location-id:
57632         type: string
57633         description: Unique identifier for physical location, e.g., CLLI
57634       data-center-code:
57635         type: string
57636         description: Data center code which can be an alternate way to identify a complex
57637       complex-name:
57638         type: string
57639         description: Gamma complex name for LCP instance.
57640       identity-url:
57641         type: string
57642         description: URL of the keystone identity service
57643       resource-version:
57644         type: string
57645         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57646       physical-location-type:
57647         type: string
57648         description: Type, e.g., central office, data center.
57649       street1:
57650         type: string
57651       street2:
57652         type: string
57653       city:
57654         type: string
57655       state:
57656         type: string
57657       postal-code:
57658         type: string
57659       country:
57660         type: string
57661       region:
57662         type: string
57663       latitude:
57664         type: string
57665       longitude:
57666         type: string
57667       elevation:
57668         type: string
57669       lata:
57670         type: string
57671       ctag-pools:
57672         type: array
57673         items:
57674           $ref: "#/getDefinitions/ctag-pool"
57675       relationship-list:
57676         type: array
57677         items:
57678           $ref: "#/getDefinitions/relationship"
57679   complexes:
57680     description: |
57681       Collection of physical locations that can house cloud-regions.
57682     properties:
57683       complex:
57684         type: array
57685         items:
57686           $ref: "#/getDefinitions/complex"
57687   configuration:
57688     description: |
57689       Port Mirror Configuration.
57690       ###### Related Nodes
57691       - TO allotted-resource( configuration Uses allotted-resource, ONE2ONE)(2)
57692       - TO logical-link( configuration Uses logical-link, ONE2MANY)(2)
57693       - TO l-interface( configuration AppliesTo l-interface, ONE2MANY)
57694       - TO pnf( configuration AppliesTo pnf, ONE2MANY)
57695       - FROM metadatum( metadatum BelongsTo configuration, MANY2ONE)(1)
57696       - FROM generic-vnf( generic-vnf Uses configuration, ONE2MANY)(3)
57697       - FROM service-instance( service-instance Uses configuration, ONE2MANY)
57698       - FROM forwarder( forwarder Uses configuration, ONE2ONE)(3)
57699       - FROM forwarding-path( forwarding-path Uses configuration, ONE2ONE)(3)
57700       - FROM evc( evc BelongsTo configuration, ONE2ONE)(1)
57701       - FROM forwarder-evc( forwarder-evc BelongsTo configuration, ONE2ONE)(1)
57702
57703       -(1) IF this CONFIGURATION node is deleted, this FROM node is DELETED also
57704       -(2) IF this CONFIGURATION node is deleted, this TO node is DELETED also
57705       -(3) IF this FROM node is deleted, this CONFIGURATION is DELETED also
57706     required:
57707     - configuration-id
57708     - configuration-type
57709     - configuration-sub-type
57710     - orchestration-status
57711     - operational-status
57712     - configuration-selflink
57713     - model-customization-id
57714     properties:
57715       configuration-id:
57716         type: string
57717         description: UUID assigned to configuration.
57718       management-option:
57719         type: string
57720         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
57721       configuration-name:
57722         type: string
57723         description: Name of the configuration.
57724       configuration-type:
57725         type: string
57726         description: port-mirroring-configuration.
57727       configuration-sub-type:
57728         type: string
57729         description: vprobe, pprobe.
57730       model-invariant-id:
57731         type: string
57732         description: the ASDC model id for this resource or service model.
57733       model-version-id:
57734         type: string
57735         description: the ASDC model version for this resource or service model.
57736       orchestration-status:
57737         type: string
57738         description: Orchestration status of the configuration.
57739       operational-status:
57740         type: string
57741         description: Indicator for whether the resource is considered operational.
57742       configuration-selflink:
57743         type: string
57744         description: URL to endpoint where AAI can get more details from SDN-GC.
57745       model-customization-id:
57746         type: string
57747         description: id of  the configuration used to customize the resource
57748       tunnel-bandwidth:
57749         type: string
57750         description: DHV Site Effective Bandwidth
57751       vendor-allowed-max-bandwidth:
57752         type: string
57753         description: Velocloud Nominal Throughput - VNT
57754       resource-version:
57755         type: string
57756         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57757       relationship-list:
57758         type: array
57759         items:
57760           $ref: "#/getDefinitions/relationship"
57761       metadata:
57762         type: array
57763         items:
57764           $ref: "#/getDefinitions/metadatum"
57765       forwarder-evcs:
57766         type: array
57767         items:
57768           $ref: "#/getDefinitions/forwarder-evc"
57769       evcs:
57770         type: array
57771         items:
57772           $ref: "#/getDefinitions/evc"
57773   configurations:
57774     description: |
57775       Collection of configurations
57776     properties:
57777       configuration:
57778         type: array
57779         items:
57780           $ref: "#/getDefinitions/configuration"
57781   connector:
57782     description: |
57783       Collection of resource instances used to connect a variety of disparate inventory widgets
57784       ###### Related Nodes
57785       - TO virtual-data-center( connector LocatedIn virtual-data-center, MANY2MANY)
57786       - FROM metadatum( metadatum BelongsTo connector, MANY2ONE)(1)
57787       - FROM service-instance( service-instance Uses connector, MANY2MANY)
57788
57789       -(1) IF this CONNECTOR node is deleted, this FROM node is DELETED also
57790     required:
57791     - resource-instance-id
57792     properties:
57793       resource-instance-id:
57794         type: string
57795         description: Unique id of resource instance.
57796       resource-version:
57797         type: string
57798         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57799       model-invariant-id:
57800         type: string
57801         description: the ASDC model id for this resource or service model.
57802       model-version-id:
57803         type: string
57804         description: the ASDC model version for this resource or service model.
57805       persona-model-version:
57806         type: string
57807         description: the ASDC model version for this resource or service model.
57808       widget-model-id:
57809         type: string
57810         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57811       widget-model-version:
57812         type: string
57813         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57814       relationship-list:
57815         type: array
57816         items:
57817           $ref: "#/getDefinitions/relationship"
57818       metadata:
57819         type: array
57820         items:
57821           $ref: "#/getDefinitions/metadatum"
57822   connectors:
57823     description: |
57824       Collection of resource instances used to connect a variety of disparate inventory widgets
57825     properties:
57826       connector:
57827         type: array
57828         items:
57829           $ref: "#/getDefinitions/connector"
57830   constrained-element-set:
57831     description: |
57832       This is how we would capture constraints defining allowed sets of elements.
57833       ###### Related Nodes
57834       - TO model-constraint( constrained-element-set BelongsTo model-constraint, MANY2ONE)(4)
57835       - TO model-element( constrained-element-set BelongsTo model-element, MANY2ONE)(4)
57836       - FROM element-choice-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(1)
57837
57838       -(1) IF this CONSTRAINED-ELEMENT-SET node is deleted, this FROM node is DELETED also
57839       -(4) IF this TO node is deleted, this CONSTRAINED-ELEMENT-SET is DELETED also
57840     required:
57841     - constrained-element-set-uuid
57842     - constraint-type
57843     - check-type
57844     properties:
57845       constrained-element-set-uuid:
57846         type: string
57847       constraint-type:
57848         type: string
57849       check-type:
57850         type: string
57851       resource-version:
57852         type: string
57853       element-choice-sets:
57854         type: array
57855         items:
57856           $ref: "#/getDefinitions/element-choice-set"
57857       relationship-list:
57858         type: array
57859         items:
57860           $ref: "#/getDefinitions/relationship"
57861   constrained-element-sets:
57862     properties:
57863       constrained-element-set:
57864         type: array
57865         items:
57866           $ref: "#/getDefinitions/constrained-element-set"
57867   ctag-assignment:
57868     description: |
57869       ###### Related Nodes
57870       - TO l3-network( ctag-assignment BelongsTo l3-network, MANY2ONE)(4)
57871       - FROM service-instance( service-instance Uses ctag-assignment, ONE2MANY)
57872
57873       -(4) IF this TO node is deleted, this CTAG-ASSIGNMENT is DELETED also
57874     required:
57875     - vlan-id-inner
57876     properties:
57877       vlan-id-inner:
57878         type: integer
57879         format: int64
57880         description: id.
57881       resource-version:
57882         type: string
57883         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57884       relationship-list:
57885         type: array
57886         items:
57887           $ref: "#/getDefinitions/relationship"
57888   ctag-assignments:
57889     properties:
57890       ctag-assignment:
57891         type: array
57892         items:
57893           $ref: "#/getDefinitions/ctag-assignment"
57894   ctag-pool:
57895     description: |
57896       A collection of C tags (vlan tags) grouped for a specific purpose.
57897       ###### Related Nodes
57898       - TO complex( ctag-pool BelongsTo complex, MANY2ONE)(4)
57899       - TO availability-zone( ctag-pool AppliesTo availability-zone, MANY2MANY)
57900       - FROM generic-vnf( generic-vnf Uses ctag-pool, MANY2MANY)
57901       - FROM vpls-pe( vpls-pe Uses ctag-pool, MANY2MANY)
57902
57903       -(4) IF this TO node is deleted, this CTAG-POOL is DELETED also
57904     required:
57905     - target-pe
57906     - availability-zone-name
57907     - ctag-pool-purpose
57908     properties:
57909       target-pe:
57910         type: string
57911         description: The Target provider edge router
57912       availability-zone-name:
57913         type: string
57914         description: Name of the availability zone
57915       ctag-pool-purpose:
57916         type: string
57917         description: Describes what the intended purpose of this pool is.
57918       ctag-values:
57919         type: string
57920         description: Comma separated list of ctags
57921       resource-version:
57922         type: string
57923         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57924       relationship-list:
57925         type: array
57926         items:
57927           $ref: "#/getDefinitions/relationship"
57928   ctag-pools:
57929     properties:
57930       ctag-pool:
57931         type: array
57932         items:
57933           $ref: "#/getDefinitions/ctag-pool"
57934   customer:
57935     description: |
57936       customer identifiers to provide linkage back to BSS information.
57937       ###### Related Nodes
57938       - FROM service-subscription( service-subscription BelongsTo customer, MANY2ONE)(1)
57939
57940       -(1) IF this CUSTOMER node is deleted, this FROM node is DELETED also
57941     required:
57942     - global-customer-id
57943     - subscriber-name
57944     - subscriber-type
57945     properties:
57946       global-customer-id:
57947         type: string
57948         description: Global customer id used across ECOMP to uniquely identify customer.
57949       subscriber-name:
57950         type: string
57951         description: Subscriber name, an alternate way to retrieve a customer.
57952       subscriber-type:
57953         type: string
57954         description: Subscriber type, a way to provide VID with only the INFRA customers.
57955       resource-version:
57956         type: string
57957         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57958       service-subscriptions:
57959         type: array
57960         items:
57961           $ref: "#/getDefinitions/service-subscription"
57962       relationship-list:
57963         type: array
57964         items:
57965           $ref: "#/getDefinitions/relationship"
57966   customers:
57967     description: |
57968       Collection of customer identifiers to provide linkage back to BSS information.
57969     properties:
57970       customer:
57971         type: array
57972         items:
57973           $ref: "#/getDefinitions/customer"
57974   cvlan-tag-entry:
57975     required:
57976     - cvlan-tag
57977     properties:
57978       cvlan-tag:
57979         type: integer
57980         format: int64
57981         description: See mis-na-virtualization-platform.yang
57982       resource-version:
57983         type: string
57984         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57985       relationship-list:
57986         type: array
57987         items:
57988           $ref: "#/getDefinitions/relationship"
57989   cvlan-tags:
57990     properties:
57991       cvlan-tag-entry:
57992         type: array
57993         items:
57994           $ref: "#/getDefinitions/cvlan-tag-entry"
57995   dvs-switch:
57996     description: |
57997       Digital virtual switch metadata, used by SDN-C to configure VCEs.  A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
57998       ###### Related Nodes
57999       - TO cloud-region( dvs-switch BelongsTo cloud-region, MANY2ONE)
58000       - TO availability-zone( dvs-switch AppliesTo availability-zone, MANY2MANY)
58001
58002     required:
58003     - switch-name
58004     - vcenter-url
58005     properties:
58006       switch-name:
58007         type: string
58008         description: DVS switch name
58009       vcenter-url:
58010         type: string
58011         description: URL used to reach the vcenter
58012       resource-version:
58013         type: string
58014         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58015       relationship-list:
58016         type: array
58017         items:
58018           $ref: "#/getDefinitions/relationship"
58019   dvs-switches:
58020     description: |
58021       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
58022     properties:
58023       dvs-switch:
58024         type: array
58025         items:
58026           $ref: "#/getDefinitions/dvs-switch"
58027   edge-prop-names:
58028     description: |
58029       Internal map to define the properties of an edge and interpret the map EdgeRules
58030     properties:
58031       edgeLabel:
58032         type: string
58033       direction:
58034         type: string
58035       multiplicityRule:
58036         type: string
58037       contains-other-v:
58038         type: string
58039       delete-other-v:
58040         type: string
58041       SVC-INFRA:
58042         type: string
58043       prevent-delete:
58044         type: string
58045       aai-uuid:
58046         type: string
58047   edge-tag-query-request:
58048     properties:
58049       edge-tag:
58050         type: string
58051       result-detail:
58052         type: string
58053       start-node-type:
58054         type: string
58055       start-node-filter:
58056         type: array
58057         items:
58058           $ref: "#/getDefinitions/start-node-filter"
58059       include-node-filter:
58060         type: array
58061         items:
58062           $ref: "#/getDefinitions/include-node-filter"
58063       secondary-filter:
58064         type: array
58065         items:
58066           $ref: "#/getDefinitions/secondary-filter"
58067   edge-tag-query-result:
58068     properties:
58069       tagged-inventory-item-list:
58070         type: array
58071         items:
58072           $ref: "#/getDefinitions/tagged-inventory-item-list"
58073   element-choice-set:
58074     description: |
58075       This is how we would capture constraints defining allowed sets of elements.
58076       ###### Related Nodes
58077       - TO constrained-element-set( element-choice-set BelongsTo constrained-element-set, MANY2ONE)(4)
58078       - FROM model-element( model-element BelongsTo element-choice-set, MANY2ONE)(1)
58079
58080       -(1) IF this ELEMENT-CHOICE-SET node is deleted, this FROM node is DELETED also
58081       -(4) IF this TO node is deleted, this ELEMENT-CHOICE-SET is DELETED also
58082     required:
58083     - element-choice-set-uuid
58084     - element-choice-set-name
58085     properties:
58086       element-choice-set-uuid:
58087         type: string
58088       element-choice-set-name:
58089         type: string
58090       cardinality:
58091         type: string
58092       resource-version:
58093         type: string
58094       model-elements:
58095         type: array
58096         items:
58097           $ref: "#/getDefinitions/model-element"
58098       relationship-list:
58099         type: array
58100         items:
58101           $ref: "#/getDefinitions/relationship"
58102   element-choice-sets:
58103     properties:
58104       element-choice-set:
58105         type: array
58106         items:
58107           $ref: "#/getDefinitions/element-choice-set"
58108   entitlement:
58109     description: |
58110       Metadata for entitlement group.
58111       ###### Related Nodes
58112       - TO generic-vnf( entitlement BelongsTo generic-vnf, MANY2ONE)(4)
58113       - TO vce( entitlement BelongsTo vce, MANY2ONE)(4)
58114
58115       -(4) IF this TO node is deleted, this ENTITLEMENT is DELETED also
58116     required:
58117     - group-uuid
58118     - resource-uuid
58119     properties:
58120       group-uuid:
58121         type: string
58122         description: Unique ID for the entitlement group the resource comes from, should be uuid.
58123       resource-uuid:
58124         type: string
58125         description: Unique ID of an entitlement resource.
58126       resource-version:
58127         type: string
58128         description: Concurrency value
58129       relationship-list:
58130         type: array
58131         items:
58132           $ref: "#/getDefinitions/relationship"
58133   entitlements:
58134     description: |
58135       Entitlements, keyed by group-uuid and resource-uuid, related to license management
58136     properties:
58137       entitlement:
58138         type: array
58139         items:
58140           $ref: "#/getDefinitions/entitlement"
58141   esr-ems:
58142     description: |
58143       Persist EMS address information used by EMS driver.
58144       ###### Related Nodes
58145       - FROM esr-system-info( esr-system-info BelongsTo esr-ems, MANY2ONE)(1)
58146
58147       -(1) IF this ESR-EMS node is deleted, this FROM node is DELETED also
58148     required:
58149     - ems-id
58150     properties:
58151       ems-id:
58152         type: string
58153         description: Unique ID of EMS.
58154       resource-version:
58155         type: string
58156         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58157       esr-system-info-list:
58158         type: object
58159         $ref: "#/getDefinitions/esr-system-info-list"
58160       relationship-list:
58161         type: object
58162         $ref: "#/getDefinitions/relationship-list"
58163   esr-ems-list:
58164     properties:
58165       esr-ems:
58166         type: array
58167         items:
58168           $ref: "#/getDefinitions/esr-ems"
58169   esr-system-info:
58170     description: |
58171       Persist common address information of external systems.
58172       ###### Related Nodes
58173       - TO esr-ems( esr-system-info BelongsTo esr-ems, MANY2ONE)(4)
58174       - TO esr-vnfm( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(4)
58175       - TO esr-thirdparty-sdnc( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(4)
58176       - TO cloud-region( esr-system-info BelongsTo cloud-region, MANY2ONE)(4)
58177
58178       -(4) IF this TO node is deleted, this ESR-SYSTEM-INFO is DELETED also
58179     required:
58180     - esr-system-info-id
58181     - user-name
58182     - password
58183     - system-type
58184     properties:
58185       esr-system-info-id:
58186         type: string
58187         description: Unique ID of esr system info.
58188       system-name:
58189         type: string
58190         description: name of external system.
58191       type:
58192         type: string
58193         description: type of external systems.
58194       vendor:
58195         type: string
58196         description: vendor of external systems.
58197       version:
58198         type: string
58199         description: version of external systems.
58200       service-url:
58201         type: string
58202         description: url used to access external systems.
58203       user-name:
58204         type: string
58205         description: username used to access external systems.
58206       password:
58207         type: string
58208         description: password used to access external systems.
58209       system-type:
58210         type: string
58211         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
58212       protocol:
58213         type: string
58214         description: protocol of third party SDNC, for example netconf/snmp.
58215       ssl-cacert:
58216         type: string
58217         description: ca file content if enabled ssl on auth-url.
58218       ssl-insecure:
58219         type: boolean
58220         description: Whether to verify VIM's certificate.
58221       ip-address:
58222         type: string
58223         description: service IP of ftp server.
58224       port:
58225         type: string
58226         description: service port of ftp server.
58227       cloud-domain:
58228         type: string
58229         description: domain info for authentication.
58230       default-tenant:
58231         type: string
58232         description: default tenant of VIM.
58233       passive:
58234         type: boolean
58235         description: ftp passive mode or not.
58236       remote-path:
58237         type: string
58238         description: resource or performance data file path.
58239       system-status:
58240         type: string
58241         description: the status of external system.
58242       resource-version:
58243         type: string
58244         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58245       relationship-list:
58246         type: array
58247         items:
58248           $ref: "#/getDefinitions/relationship"
58249   esr-system-info-list:
58250     description: |
58251       Collection of persistent block-level external system auth info.
58252     properties:
58253       esr-system-info:
58254         type: array
58255         items:
58256           $ref: "#/getDefinitions/esr-system-info"
58257   esr-thirdparty-sdnc:
58258     description: |
58259       Persist SDNC address information used by ONAP SDNC.
58260       ###### Related Nodes
58261       - TO pnf( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
58262       - FROM esr-system-info( esr-system-info BelongsTo esr-thirdparty-sdnc, ONE2ONE)(1)
58263
58264       -(1) IF this ESR-THIRDPARTY-SDNC node is deleted, this FROM node is DELETED also
58265     required:
58266     - thirdparty-sdnc-id
58267     properties:
58268       thirdparty-sdnc-id:
58269         type: string
58270         description: Unique ID of SDNC.
58271       location:
58272         type: string
58273         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
58274       product-name:
58275         type: string
58276         description: password used to access SDNC server.
58277       resource-version:
58278         type: string
58279         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58280       esr-system-info-list:
58281         type: object
58282         $ref: "#/getDefinitions/esr-system-info-list"
58283       relationship-list:
58284         type: object
58285         $ref: "#/getDefinitions/relationship-list"
58286   esr-thirdparty-sdnc-list:
58287     properties:
58288       esr-thirdparty-sdnc:
58289         type: array
58290         items:
58291           $ref: "#/getDefinitions/esr-thirdparty-sdnc"
58292   esr-vnfm:
58293     description: |
58294       Persist VNFM address information used by VF-C.
58295       ###### Related Nodes
58296       - FROM esr-system-info( esr-system-info BelongsTo esr-vnfm, ONE2ONE)(1)
58297
58298       -(1) IF this ESR-VNFM node is deleted, this FROM node is DELETED also
58299     required:
58300     - vnfm-id
58301     properties:
58302       vnfm-id:
58303         type: string
58304         description: Unique ID of VNFM.
58305       vim-id:
58306         type: string
58307         description: indecate the VIM to deploy VNF.
58308       certificate-url:
58309         type: string
58310         description: certificate url of VNFM.
58311       resource-version:
58312         type: string
58313         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58314       esr-system-info-list:
58315         type: object
58316         $ref: "#/getDefinitions/esr-system-info-list"
58317       relationship-list:
58318         type: object
58319         $ref: "#/getDefinitions/relationship-list"
58320   esr-vnfm-list:
58321     properties:
58322       esr-vnfm:
58323         type: array
58324         items:
58325           $ref: "#/getDefinitions/esr-vnfm"
58326   evc:
58327     description: |
58328       evc object is an optional child object of the Configuration object.
58329       ###### Related Nodes
58330       - TO configuration( evc BelongsTo configuration, ONE2ONE)(4)
58331
58332       -(4) IF this TO node is deleted, this EVC is DELETED also
58333     required:
58334     - evc-id
58335     properties:
58336       evc-id:
58337         type: string
58338         description: Unique/key field for the evc object
58339       forwarding-path-topology:
58340         type: string
58341         description: Point-to-Point, Multi-Point
58342       cir-value:
58343         type: string
58344         description: Commited Information Rate
58345       cir-units:
58346         type: string
58347         description: CIR units
58348       connection-diversity-group-id:
58349         type: string
58350         description: Diversity Group ID
58351       service-hours:
58352         type: string
58353         description: formerly Performance Group
58354       esp-evc-circuit-id:
58355         type: string
58356         description: EVC Circuit ID of ESP EVC
58357       esp-evc-cir-value:
58358         type: string
58359         description: Committed Information Rate (For ESP)
58360       esp-evc-cir-units:
58361         type: string
58362         description: CIR units (For ESP)
58363       esp-itu-code:
58364         type: string
58365         description: Identifies ESP
58366       collector-pop-clli:
58367         type: string
58368         description: Collector POP CLLI (from the hostname of the access pnf)
58369       inter-connect-type-ingress:
58370         type: string
58371         description: Interconnect type on ingress side of EVC.
58372       tagmode-access-ingress:
58373         type: string
58374         description: tagode for collector side of EVC
58375       tagmode-access-egress:
58376         type: string
58377         description: tagMode for network side of EVC
58378       relationship-list:
58379         type: array
58380         items:
58381           $ref: "#/getDefinitions/relationship"
58382       resource-version:
58383         type: string
58384         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58385   evcs:
58386     properties:
58387       evc:
58388         type: array
58389         items:
58390           $ref: "#/getDefinitions/evc"
58391   external-system:
58392     description: |
58393       Namespace for external system.
58394     properties:
58395       esr-ems-list:
58396         type: object
58397         $ref: "#/getDefinitions/esr-ems-list"
58398       esr-vnfm-list:
58399         type: object
58400         $ref: "#/getDefinitions/esr-vnfm-list"
58401       esr-thirdparty-sdnc-list:
58402         type: object
58403         $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
58404   extra-properties:
58405     description: |
58406       Extra properties for inventory item for response list
58407     properties:
58408       extra-property:
58409         type: array
58410         items:
58411           $ref: "#/getDefinitions/extra-property"
58412   extra-property:
58413     properties:
58414       property-name:
58415         type: string
58416       property-value:
58417         type: string
58418   flavor:
58419     description: |
58420       Openstack flavor.
58421       ###### Related Nodes
58422       - TO cloud-region( flavor BelongsTo cloud-region, MANY2ONE)
58423       - FROM hpa-capability( hpa-capability BelongsTo flavor, MANY2ONE)
58424       - FROM vserver( vserver Uses flavor, MANY2ONE)
58425
58426       -FLAVOR cannot be deleted if related to HPA-CAPABILITY,VSERVER
58427
58428     required:
58429     - flavor-id
58430     - flavor-name
58431     - flavor-selflink
58432     properties:
58433       flavor-id:
58434         type: string
58435         description: Flavor id, expected to be unique across cloud-region.
58436       flavor-name:
58437         type: string
58438         description: Cloud region Flavor name
58439       flavor-vcpus:
58440         type: integer
58441         format: int32
58442         description: Number of CPUs
58443       flavor-ram:
58444         type: integer
58445         format: int32
58446         description: Amount of memory
58447       flavor-disk:
58448         type: integer
58449         format: int32
58450         description: Disk space
58451       flavor-ephemeral:
58452         type: integer
58453         format: int32
58454         description: Amount of ephemeral disk space
58455       flavor-swap:
58456         type: string
58457         description: amount of swap space allocation
58458       flavor-is-public:
58459         type: boolean
58460         description: whether flavor is available to all users or private to the tenant it was created in.
58461       flavor-selflink:
58462         type: string
58463         description: URL to endpoint where AAI can get more details
58464       flavor-disabled:
58465         type: boolean
58466         description: Boolean as to whether this flavor is no longer enabled
58467       hpa-capabilities:
58468         type: array
58469         items:
58470           $ref: "#/getDefinitions/hpa-capability"
58471         description: List of flavor specific HPA Capabilities
58472       resource-version:
58473         type: string
58474         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58475       relationship-list:
58476         type: array
58477         items:
58478           $ref: "#/getDefinitions/relationship"
58479   flavors:
58480     description: |
58481       Collection of openstack flavors.
58482     properties:
58483       flavor:
58484         type: array
58485         items:
58486           $ref: "#/getDefinitions/flavor"
58487   forwarder:
58488     description: |
58489       Entity describing a sequenced segment of forwarding path
58490       ###### Related Nodes
58491       - TO forwarding-path( forwarder BelongsTo forwarding-path, MANY2ONE)(4)
58492       - TO l-interface( forwarder ForwardsTo l-interface, MANY2ONE)
58493       - TO configuration( forwarder Uses configuration, ONE2ONE)(2)
58494       - TO lag-interface( forwarder ForwardsTo lag-interface, MANY2ONE)
58495       - TO p-interface( forwarder ForwardsTo p-interface, MANY2ONE)
58496
58497       -(2) IF this FORWARDER node is deleted, this TO node is DELETED also
58498       -(4) IF this TO node is deleted, this FORWARDER is DELETED also
58499     required:
58500     - sequence
58501     properties:
58502       sequence:
58503         type: integer
58504         format: int32
58505         description: Unique ID of this segmentation
58506       forwarder-role:
58507         type: string
58508         description: ingress, intermediate, egress
58509       relationship-list:
58510         type: array
58511         items:
58512           $ref: "#/getDefinitions/relationship"
58513       resource-version:
58514         type: string
58515         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58516   forwarder-evc:
58517     description: |
58518       forwarder object is an optional child object of the Configuration object.
58519       ###### Related Nodes
58520       - TO configuration( forwarder-evc BelongsTo configuration, ONE2ONE)(4)
58521
58522       -(4) IF this TO node is deleted, this FORWARDER-EVC is DELETED also
58523     required:
58524     - forwarder-evc-id
58525     properties:
58526       forwarder-evc-id:
58527         type: string
58528         description: Key for forwarder-evc object
58529       circuit-id:
58530         type: string
58531         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
58532       ivlan:
58533         type: string
58534         description: Internal VLAN.
58535       svlan:
58536         type: string
58537         description: SVLAN value for ingress of egress forwarder.
58538       cvlan:
58539         type: string
58540         description: CVLAN value for ingress of egress forwarder.
58541       relationship-list:
58542         type: array
58543         items:
58544           $ref: "#/getDefinitions/relationship"
58545       resource-version:
58546         type: string
58547         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58548   forwarder-evcs:
58549     properties:
58550       forwarder-evc:
58551         type: array
58552         items:
58553           $ref: "#/getDefinitions/forwarder-evc"
58554   forwarders:
58555     properties:
58556       forwarder:
58557         type: array
58558         items:
58559           $ref: "#/getDefinitions/forwarder"
58560   forwarding-path:
58561     description: |
58562       Entity that describes the sequenced forwarding path between interfaces of services or resources
58563       ###### Related Nodes
58564       - TO service-instance( forwarding-path AppliesTo service-instance, MANY2ONE)(4)
58565       - TO configuration( forwarding-path Uses configuration, ONE2ONE)(2)
58566       - FROM forwarder( forwarder BelongsTo forwarding-path, MANY2ONE)(1)
58567
58568       -(1) IF this FORWARDING-PATH node is deleted, this FROM node is DELETED also
58569       -(2) IF this FORWARDING-PATH node is deleted, this TO node is DELETED also
58570       -(4) IF this TO node is deleted, this FORWARDING-PATH is DELETED also
58571     required:
58572     - forwarding-path-id
58573     - forwarding-path-name
58574     properties:
58575       forwarding-path-id:
58576         type: string
58577         description: Unique ID of this FP
58578       forwarding-path-name:
58579         type: string
58580         description: Name of the FP
58581       relationship-list:
58582         type: array
58583         items:
58584           $ref: "#/getDefinitions/relationship"
58585       resource-version:
58586         type: string
58587         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58588       selflink:
58589         type: string
58590         description: the self link for this FP
58591       forwarders:
58592         type: array
58593         items:
58594           $ref: "#/getDefinitions/forwarder"
58595   forwarding-paths:
58596     properties:
58597       forwarding-path:
58598         type: array
58599         items:
58600           $ref: "#/getDefinitions/forwarding-path"
58601   generic-vnf:
58602     description: |
58603       General purpose VNF
58604       ###### Related Nodes
58605       - TO availability-zone( generic-vnf Uses availability-zone, MANY2MANY)
58606       - TO complex( generic-vnf LocatedIn complex, MANY2MANY)
58607       - TO configuration( generic-vnf Uses configuration, ONE2MANY)(2)
58608       - TO ctag-pool( generic-vnf Uses ctag-pool, MANY2MANY)
58609       - TO instance-group( generic-vnf MemberOf instance-group, MANY2MANY)
58610       - TO ipsec-configuration( generic-vnf Uses ipsec-configuration, MANY2ONE)
58611       - TO l3-network( generic-vnf Uses l3-network, MANY2MANY)
58612       - TO license-key-resource( generic-vnf Uses license-key-resource, MANY2MANY)
58613       - TO pnf( generic-vnf HostedOn pnf, MANY2MANY)
58614       - TO pserver( generic-vnf HostedOn pserver, MANY2MANY)
58615       - TO vnf-image( generic-vnf Uses vnf-image, MANY2ONE)
58616       - TO volume-group( generic-vnf DependsOn volume-group, ONE2MANY)
58617       - TO vserver( generic-vnf HostedOn vserver, ONE2MANY)
58618       - TO virtual-data-center( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
58619       - TO model-ver( generic-vnf IsA model-ver, Many2One)
58620       - FROM allotted-resource( allotted-resource PartOf generic-vnf, MANY2MANY)
58621       - FROM entitlement( entitlement BelongsTo generic-vnf, MANY2ONE)(1)
58622       - FROM vnfc( vnfc BelongsTo generic-vnf, MANY2ONE)(1)
58623       - FROM lag-interface( lag-interface BelongsTo generic-vnf, MANY2ONE)(1)
58624       - FROM license( license BelongsTo generic-vnf, MANY2ONE)(1)
58625       - FROM l-interface( l-interface BelongsTo generic-vnf, MANY2ONE)(1)
58626       - FROM network-profile( network-profile AppliesTo generic-vnf, MANY2MANY)
58627       - FROM service-instance( service-instance ComposedOf generic-vnf, ONE2MANY)
58628       - FROM site-pair-set( site-pair-set AppliesTo generic-vnf, MANY2MANY)
58629       - FROM vf-module( vf-module BelongsTo generic-vnf, MANY2ONE)(1)
58630       - FROM line-of-business( line-of-business Uses generic-vnf, MANY2MANY)
58631       - FROM logical-link( logical-link BridgedTo generic-vnf, MANY2MANY)
58632       - FROM platform( platform Uses generic-vnf, MANY2MANY)
58633
58634       -(1) IF this GENERIC-VNF node is deleted, this FROM node is DELETED also
58635       -(2) IF this GENERIC-VNF node is deleted, this TO node is DELETED also
58636     required:
58637     - vnf-id
58638     - vnf-name
58639     - vnf-type
58640     - in-maint
58641     - is-closed-loop-disabled
58642     properties:
58643       vnf-id:
58644         type: string
58645         description: Unique id of VNF.  This is unique across the graph.
58646       vnf-instance-id:
58647         type: string
58648         description: vnf instance id.
58649       vnf-name:
58650         type: string
58651         description: Name of VNF.
58652       vnf-name2:
58653         type: string
58654         description: Alternate name of VNF.
58655       vnf-type:
58656         type: string
58657         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
58658       service-id:
58659         type: string
58660         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
58661       regional-resource-zone:
58662         type: string
58663         description: Regional way of organizing pservers, source of truth should define values
58664       prov-status:
58665         type: string
58666         description: Trigger for operational monitoring of this resource by Service Assurance systems.
58667       operational-status:
58668         type: string
58669         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
58670       license-key:
58671         type: string
58672         description: OBSOLETE -  do not use
58673       equipment-role:
58674         type: string
58675         description: Client should send valid enumerated value
58676       orchestration-status:
58677         type: string
58678         description: Orchestration status of this VNF, used by MSO.
58679       vnf-package-name:
58680         type: string
58681       vnf-discriptor-name:
58682         type: string
58683         description: vnf discriptor name
58684       job-id:
58685         type: string
58686         description: job id corresponding to vnf
58687       heat-stack-id:
58688         type: string
58689         description: Heat stack id corresponding to this instance, managed by MSO
58690       mso-catalog-key:
58691         type: string
58692         description: Corresponds to the SDN-C catalog id used to configure this VCE
58693       management-option:
58694         type: string
58695         description: identifier of managed by ATT or customer
58696       ipv4-oam-address:
58697         type: string
58698         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
58699       ipv4-loopback0-address:
58700         type: string
58701         description: v4 Loopback0 address
58702       nm-lan-v6-address:
58703         type: string
58704         description: v6 Loopback address
58705       management-v6-address:
58706         type: string
58707         description: v6 management address
58708       vcpu:
58709         type: integer
58710         format: int64
58711         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
58712       vcpu-units:
58713         type: string
58714         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
58715       vmemory:
58716         type: integer
58717         format: int64
58718         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
58719       vmemory-units:
58720         type: string
58721         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
58722       vdisk:
58723         type: integer
58724         format: int64
58725         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
58726       vdisk-units:
58727         type: string
58728         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
58729       nshd:
58730         type: integer
58731         format: int64
58732         description: number of associated SHD in vnf.
58733       nvm:
58734         type: integer
58735         format: int64
58736         description: number of vms in vnf.
58737       nnet:
58738         type: integer
58739         format: int64
58740         description: number of network in vnf.
58741       in-maint:
58742         type: boolean
58743         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
58744       is-closed-loop-disabled:
58745         type: boolean
58746         description: used to indicate whether closed loop function is enabled on this node
58747       resource-version:
58748         type: string
58749         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58750       summary-status:
58751         type: string
58752         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
58753       encrypted-access-flag:
58754         type: boolean
58755         description: indicates whether generic-vnf access uses SSH
58756       entitlement-assignment-group-uuid:
58757         type: string
58758         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
58759       entitlement-resource-uuid:
58760         type: string
58761         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
58762       license-assignment-group-uuid:
58763         type: string
58764         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
58765       license-key-uuid:
58766         type: string
58767         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
58768       model-invariant-id:
58769         type: string
58770         description: the ASDC model id for this resource or service model.
58771       model-version-id:
58772         type: string
58773         description: the ASDC model version for this resource or service model.
58774       persona-model-version:
58775         type: string
58776         description: the ASDC model version for this resource or service model.
58777       model-customization-id:
58778         type: string
58779         description: captures the id of all the configuration used to customize the resource for the service.
58780       widget-model-id:
58781         type: string
58782         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58783       widget-model-version:
58784         type: string
58785         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58786       as-number:
58787         type: string
58788         description: as-number of the VNF
58789       regional-resource-subzone:
58790         type: string
58791         description: represents sub zone of the rr plane
58792       nf-type:
58793         type: string
58794         description: Generic description of the type of NF
58795       nf-function:
58796         type: string
58797         description: English description of Network function that the specific VNF deployment is providing
58798       nf-role:
58799         type: string
58800         description: role in the network that this model will be providing
58801       nf-naming-code:
58802         type: string
58803         description: string assigned to this model used for naming purposes
58804       selflink:
58805         type: string
58806         description: Path to the controller object.
58807       ipv4-oam-gateway-address:
58808         type: string
58809         description: Gateway address
58810       ipv4-oam-gateway-address-prefix-length:
58811         type: integer
58812         format: int32
58813         description: Prefix length for oam-address
58814       vlan-id-outer:
58815         type: integer
58816         format: int64
58817         description: Temporary location for S-TAG to get to VCE
58818       nm-profile-name:
58819         type: string
58820         description: Network Management profile of this VNF
58821       relationship-list:
58822         type: array
58823         items:
58824           $ref: "#/getDefinitions/relationship"
58825       l-interfaces:
58826         type: array
58827         items:
58828           $ref: "#/getDefinitions/l-interface"
58829       lag-interfaces:
58830         type: array
58831         items:
58832           $ref: "#/getDefinitions/lag-interface"
58833       vf-modules:
58834         type: array
58835         items:
58836           $ref: "#/getDefinitions/vf-module"
58837       licenses:
58838         type: array
58839         items:
58840           $ref: "#/getDefinitions/license"
58841       entitlements:
58842         type: array
58843         items:
58844           $ref: "#/getDefinitions/entitlement"
58845   generic-vnfs:
58846     description: |
58847       Collection of VNFs
58848     properties:
58849       generic-vnf:
58850         type: array
58851         items:
58852           $ref: "#/getDefinitions/generic-vnf"
58853   group-assignment:
58854     description: |
58855       Openstack group-assignment used to store exclusivity groups (EG).
58856       ###### Related Nodes
58857       - TO cloud-region( group-assignment BelongsTo cloud-region, MANY2ONE)
58858       - FROM pserver( pserver MemberOf group-assignment, MANY2ONE)
58859       - FROM tenant( tenant MemberOf group-assignment, MANY2MANY)
58860
58861     required:
58862     - group-id
58863     - group-type
58864     - group-name
58865     properties:
58866       group-id:
58867         type: string
58868         description: Group id, expected to be unique across cloud-region.
58869       group-type:
58870         type: string
58871         description: Group type - the type of group this instance refers to
58872       group-name:
58873         type: string
58874         description: Group name - name assigned to the group
58875       group-description:
58876         type: string
58877         description: Group description - description of the group
58878       resource-version:
58879         type: string
58880         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58881       relationship-list:
58882         type: array
58883         items:
58884           $ref: "#/getDefinitions/relationship"
58885   group-assignments:
58886     description: |
58887       Collection of openstack group assignments
58888     properties:
58889       group-assignment:
58890         type: array
58891         items:
58892           $ref: "#/getDefinitions/group-assignment"
58893   host-route:
58894     description: |
58895       ###### Related Nodes
58896       - TO subnet( host-route BelongsTo subnet, MANY2ONE)(4)
58897
58898       -(4) IF this TO node is deleted, this HOST-ROUTE is DELETED also
58899     required:
58900     - host-route-id
58901     - route-prefix
58902     - next-hop
58903     properties:
58904       host-route-id:
58905         type: string
58906         description: host-route id
58907       route-prefix:
58908         type: string
58909         description: subnet prefix
58910       next-hop:
58911         type: string
58912         description: Could be ip-address, hostname, or service-instance
58913       next-hop-type:
58914         type: string
58915         description: Should be ip-address, hostname, or service-instance to match next-hop
58916       resource-version:
58917         type: string
58918         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58919       relationship-list:
58920         type: array
58921         items:
58922           $ref: "#/getDefinitions/relationship"
58923   host-routes:
58924     properties:
58925       host-route:
58926         type: array
58927         items:
58928           $ref: "#/getDefinitions/host-route"
58929   hpa-capabilities:
58930     description: |
58931       Collection of HPA Capabilities
58932     properties:
58933       hpa-capability:
58934         type: array
58935         items:
58936           $ref: "#/getDefinitions/hpa-capability"
58937   hpa-capability:
58938     description: |
58939       Represents a HPA capability
58940       ###### Related Nodes
58941       - TO flavor( hpa-capability BelongsTo flavor, MANY2ONE)
58942       - TO cloud-region( hpa-capability BelongsTo cloud-region, MANY2ONE)
58943       - FROM hpa-feature-attributes( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(1)
58944
58945       -(1) IF this HPA-CAPABILITY node is deleted, this FROM node is DELETED also
58946     required:
58947     - hpa-capability-id
58948     - hpa-feature
58949     properties:
58950       hpa-capability-id:
58951         type: string
58952         description: UUID to uniquely identify a HPA capability
58953       hpa-feature:
58954         type: string
58955         description: Name of the HPACapability
58956       hpa-version:
58957         type: string
58958         description: HPA schema version
58959       architecture:
58960         type: string
58961         description: Hardware architecture
58962       resource-version:
58963         type: string
58964         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58965       relationship-list:
58966         type: array
58967         items:
58968           $ref: "#/getDefinitions/relationship"
58969       hpa-feature-attributes:
58970         type: array
58971         items:
58972           $ref: "#/getDefinitions/hpa-feature-attributes"
58973   hpa-feature-attributes:
58974     description: |
58975       HPA Capability Feature attributes
58976       ###### Related Nodes
58977       - TO hpa-capability( hpa-feature-attributes BelongsTo hpa-capability, MANY2ONE)(4)
58978
58979       -(4) IF this TO node is deleted, this HPA-FEATURE-ATTRIBUTES is DELETED also
58980     required:
58981     - hpa-attribute-key
58982     properties:
58983       hpa-attribute-key:
58984         type: string
58985         description: name of the specific HPA attribute
58986       hpa-attribute-value:
58987         type: string
58988         description: JSON string specifying the value, unit and type of the specific HPA attribute
58989       resource-version:
58990         type: string
58991         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58992       relationship-list:
58993         type: array
58994         items:
58995           $ref: "#/getDefinitions/relationship"
58996   image:
58997     description: |
58998       Openstack image.
58999       ###### Related Nodes
59000       - TO cloud-region( image BelongsTo cloud-region, MANY2ONE)
59001       - FROM metadatum( metadatum BelongsTo image, MANY2ONE)(1)
59002       - FROM vserver( vserver Uses image, MANY2ONE)
59003
59004       -(1) IF this IMAGE node is deleted, this FROM node is DELETED also
59005       -IMAGE cannot be deleted if related to VSERVER
59006
59007     required:
59008     - image-id
59009     - image-name
59010     - image-os-distro
59011     - image-os-version
59012     - image-selflink
59013     properties:
59014       image-id:
59015         type: string
59016         description: Image id, expected to be unique across cloud region
59017       image-name:
59018         type: string
59019         description: Image name
59020       image-architecture:
59021         type: string
59022         description: Operating system architecture.
59023       image-os-distro:
59024         type: string
59025         description: The common name of the operating system distribution in lowercase
59026       image-os-version:
59027         type: string
59028         description: The operating system version as specified by the distributor.
59029       application:
59030         type: string
59031         description: The application that the image instantiates.
59032       application-vendor:
59033         type: string
59034         description: The vendor of the application.
59035       application-version:
59036         type: string
59037         description: The version of the application.
59038       image-selflink:
59039         type: string
59040         description: URL to endpoint where AAI can get more details
59041       resource-version:
59042         type: string
59043         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59044       relationship-list:
59045         type: array
59046         items:
59047           $ref: "#/getDefinitions/relationship"
59048       metadata:
59049         type: array
59050         items:
59051           $ref: "#/getDefinitions/metadatum"
59052   images:
59053     description: |
59054       Collectio of Openstack images.
59055     properties:
59056       image:
59057         type: array
59058         items:
59059           $ref: "#/getDefinitions/image"
59060   include-node-filter:
59061     properties:
59062       include-node-type:
59063         type: string
59064   instance-filter:
59065     description: |
59066       InstanceFilter for performing a named-query or model query
59067   instance-filters:
59068     description: |
59069       InstanceFilters for performing a named-query or model query
59070     properties:
59071       instance-filter:
59072         type: array
59073         items:
59074           $ref: "#/getDefinitions/instance-filter"
59075   instance-group:
59076     description: |
59077       General mechanism for grouping instances
59078       ###### Related Nodes
59079       - TO model( instance-group Targets model, MANY2MANY)
59080       - FROM allotted-resource( allotted-resource MemberOf instance-group, MANY2MANY)
59081       - FROM generic-vnf( generic-vnf MemberOf instance-group, MANY2MANY)
59082       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
59083       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
59084       - FROM l3-network( l3-network MemberOf instance-group, MANY2MANY)
59085       - FROM l-interface( l-interface MemberOf instance-group, MANY2MANY)
59086       - FROM pnf( pnf MemberOf instance-group, MANY2MANY)
59087       - FROM service-instance( service-instance MemberOf instance-group, MANY2MANY)
59088       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
59089       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
59090       - FROM vnfc( vnfc MemberOf instance-group, MANY2MANY)
59091
59092     required:
59093     - id
59094     - description
59095     - type
59096     properties:
59097       instance-group-role:
59098         type: string
59099         description: role of the instance group.
59100       model-invariant-id:
59101         type: string
59102         description: ASDC model id for this resource or service model.
59103       model-version-id:
59104         type: string
59105         description: ASDC model version uid for this resource model.
59106       id:
59107         type: string
59108         description: Instance Group ID, UUID assigned to this instance.
59109       description:
59110         type: string
59111         description: Descriptive text to help identify the usage of this instance-group
59112       type:
59113         type: string
59114         description: Only valid value today is lower case ha for high availability
59115       sub-type:
59116         type: string
59117         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
59118       resource-version:
59119         type: string
59120         description: Concurrency value
59121       relationship-list:
59122         type: array
59123         items:
59124           $ref: "#/getDefinitions/relationship"
59125   instance-groups:
59126     description: |
59127       Collection of openstack route table references
59128     properties:
59129       instance-group:
59130         type: array
59131         items:
59132           $ref: "#/getDefinitions/instance-group"
59133   inventory:
59134     properties:
59135       search:
59136         type: object
59137         $ref: "#/getDefinitions/search"
59138       actions:
59139         type: object
59140         $ref: "#/getDefinitions/actions"
59141       cloud-infrastructure:
59142         type: object
59143         $ref: "#/getDefinitions/cloud-infrastructure"
59144       external-system:
59145         type: object
59146         $ref: "#/getDefinitions/external-system"
59147       business:
59148         type: object
59149         $ref: "#/getDefinitions/business"
59150       service-design-and-creation:
59151         type: object
59152         $ref: "#/getDefinitions/service-design-and-creation"
59153       network:
59154         type: object
59155         $ref: "#/getDefinitions/network"
59156       nodes:
59157         type: object
59158         $ref: "#/getDefinitions/nodes"
59159   inventory-item:
59160     properties:
59161       inventory-item-type:
59162         type: string
59163       inventory-item-link:
59164         type: string
59165       inventory-item-data:
59166         type: array
59167         items:
59168           $ref: "#/getDefinitions/inventory-item-data"
59169       tagged-inventory-item-list:
59170         type: array
59171         items:
59172           $ref: "#/getDefinitions/tagged-inventory-item-list"
59173   inventory-item-data:
59174     properties:
59175       property-name:
59176         type: string
59177       property-value:
59178         type: string
59179   inventory-response-item:
59180     description: |
59181       Inventory item for response list
59182     properties:
59183       model-name:
59184         type: string
59185       extra-properties:
59186         type: object
59187         $ref: "#/getDefinitions/extra-properties"
59188       inventory-response-items:
59189         type: object
59190         $ref: "#/getDefinitions/inventory-response-items"
59191   inventory-response-items:
59192     description: |
59193       Container for inventory items in response list
59194     properties:
59195       inventory-response-item:
59196         type: array
59197         items:
59198           $ref: "#/getDefinitions/inventory-response-item"
59199   ipsec-configuration:
59200     description: |
59201       IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
59202       ###### Related Nodes
59203       - FROM generic-vnf( generic-vnf Uses ipsec-configuration, MANY2ONE)
59204       - FROM vig-server( vig-server BelongsTo ipsec-configuration, MANY2ONE)(1)
59205
59206       -(1) IF this IPSEC-CONFIGURATION node is deleted, this FROM node is DELETED also
59207     required:
59208     - ipsec-configuration-id
59209     properties:
59210       ipsec-configuration-id:
59211         type: string
59212         description: UUID of this configuration
59213       requested-vig-address-type:
59214         type: string
59215         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
59216       requested-encryption-strength:
59217         type: string
59218         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
59219       requested-dmz-type:
59220         type: string
59221         description: ATT can offer a shared DMZ or a DMZ specific to a customer
59222       shared-dmz-network-address:
59223         type: string
59224         description: Network address of shared DMZ
59225       requested-customer-name:
59226         type: string
59227         description: If the DMZ is a custom DMZ, this field will indicate the customer information
59228       ike-version:
59229         type: string
59230         description: can be 1 or 2
59231       ikev1-authentication:
59232         type: string
59233         description: Contains values like md5, sha1, sha256, sha384
59234       ikev1-encryption:
59235         type: string
59236         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
59237       ikev1-dh-group:
59238         type: string
59239         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
59240       ikev1-am-group-id:
59241         type: string
59242         description: Group name defined in VIG for clients using aggressive mode
59243       ikev1-am-password:
59244         type: string
59245         description: pre-shared key for the above group name
59246       ikev1-sa-lifetime:
59247         type: string
59248         description: Lifetime for IKEv1 SA
59249       ipsec-authentication:
59250         type: string
59251         description: md5, sha1, sha256, sha384
59252       ipsec-encryption:
59253         type: string
59254         description: 3des-cbc, des-cbc, aes-128-cbc,Â aes-192-cbc, aes-265-cbc
59255       ipsec-sa-lifetime:
59256         type: string
59257         description: Life time for IPSec SA
59258       ipsec-pfs:
59259         type: string
59260         description: enable PFS or not
59261       xauth-userid:
59262         type: string
59263         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
59264       xauth-user-password:
59265         type: string
59266         description: Encrypted using the Juniper $9$ algorithm
59267       dpd-interval:
59268         type: string
59269         description: The time between DPD probe
59270       dpd-frequency:
59271         type: string
59272         description: Maximum number of DPD before claiming the tunnel is down
59273       resource-version:
59274         type: string
59275         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59276       relationship-list:
59277         type: array
59278         items:
59279           $ref: "#/getDefinitions/relationship"
59280       vig-servers:
59281         type: array
59282         items:
59283           $ref: "#/getDefinitions/vig-server"
59284   ipsec-configurations:
59285     properties:
59286       ipsec-configuration:
59287         type: array
59288         items:
59289           $ref: "#/getDefinitions/ipsec-configuration"
59290   key-data:
59291     properties:
59292       key-name:
59293         type: string
59294       key-value:
59295         type: string
59296   l-interface:
59297     description: |
59298       Logical interfaces, e.g., a vnic.
59299       ###### Related Nodes
59300       - TO generic-vnf( l-interface BelongsTo generic-vnf, MANY2ONE)(4)
59301       - TO lag-interface( l-interface BelongsTo lag-interface, MANY2ONE)(4)
59302       - TO instance-group( l-interface MemberOf instance-group, MANY2MANY)
59303       - TO l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
59304       - TO logical-link( l-interface LinksTo logical-link, MANY2MANY)(2)
59305       - TO newvce( l-interface BelongsTo newvce, MANY2ONE)(4)
59306       - TO p-interface( l-interface BindsTo p-interface, MANY2ONE)(4)
59307       - TO vserver( l-interface BindsTo vserver, MANY2ONE)(4)
59308       - FROM allotted-resource( allotted-resource Uses l-interface, ONE2MANY)
59309       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(1)
59310       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(1)
59311       - FROM logical-link( logical-link Source l-interface, ONE2MANY)(1)
59312       - FROM logical-link( logical-link Destination l-interface, ONE2MANY)(1)
59313       - FROM sriov-vf( sriov-vf BelongsTo l-interface, ONE2ONE)(1)
59314       - FROM vlan( vlan LinksTo l-interface, MANY2ONE)(1)
59315       - FROM configuration( configuration AppliesTo l-interface, ONE2MANY)
59316       - FROM forwarder( forwarder ForwardsTo l-interface, MANY2ONE)
59317       - FROM l-interface( l-interface BelongsTo l-interface, MANY2ONE)(4)
59318
59319       -(1) IF this L-INTERFACE node is deleted, this FROM node is DELETED also
59320       -(2) IF this L-INTERFACE node is deleted, this TO node is DELETED also
59321       -(4) IF this TO node is deleted, this L-INTERFACE is DELETED also
59322     required:
59323     - interface-name
59324     - is-port-mirrored
59325     - in-maint
59326     - is-ip-unnumbered
59327     properties:
59328       interface-name:
59329         type: string
59330         description: Name given to the interface
59331       interface-role:
59332         type: string
59333         description: E.g., CUSTOMER, UPLINK, etc.
59334       v6-wan-link-ip:
59335         type: string
59336         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
59337       selflink:
59338         type: string
59339         description: URL to endpoint where AAI can get more details
59340       interface-id:
59341         type: string
59342         description: ID of interface
59343       macaddr:
59344         type: string
59345         description: MAC address for the interface
59346       network-name:
59347         type: string
59348         description: Name of the network
59349       management-option:
59350         type: string
59351         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
59352       interface-description:
59353         type: string
59354         description: Human friendly text regarding this interface.
59355       is-port-mirrored:
59356         type: boolean
59357         description: boolean indicatating whether or not port is a mirrored.
59358       resource-version:
59359         type: string
59360         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59361       in-maint:
59362         type: boolean
59363         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
59364       prov-status:
59365         type: string
59366         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
59367       is-ip-unnumbered:
59368         type: boolean
59369         description: Flag indicating the interface uses the IP Unnumbered configuration.
59370       allowed-address-pairs:
59371         type: string
59372         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
59373       vlans:
59374         type: array
59375         items:
59376           $ref: "#/getDefinitions/vlan"
59377       sriov-vfs:
59378         type: array
59379         items:
59380           $ref: "#/getDefinitions/sriov-vf"
59381       l-interfaces:
59382         type: array
59383         items:
59384           $ref: "#/getDefinitions/l-interface"
59385       relationship-list:
59386         type: array
59387         items:
59388           $ref: "#/getDefinitions/relationship"
59389       l3-interface-ipv4-address-list:
59390         type: array
59391         items:
59392           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
59393       l3-interface-ipv6-address-list:
59394         type: array
59395         items:
59396           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
59397   l-interfaces:
59398     description: |
59399       Collection of logical interfaces.
59400     properties:
59401       l-interface:
59402         type: array
59403         items:
59404           $ref: "#/getDefinitions/l-interface"
59405   l3-interface-ipv4-address-list:
59406     description: |
59407       IPv4 Address Range
59408       ###### Related Nodes
59409       - TO instance-group( l3-interface-ipv4-address-list MemberOf instance-group, MANY2MANY)
59410       - TO l3-network( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
59411       - TO subnet( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
59412       - TO l-interface( l3-interface-ipv4-address-list BelongsTo l-interface, MANY2ONE)(4)
59413       - TO vlan( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(4)
59414       - TO vnfc( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(4)
59415
59416       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV4-ADDRESS-LIST is DELETED also
59417     required:
59418     - l3-interface-ipv4-address
59419     properties:
59420       l3-interface-ipv4-address:
59421         type: string
59422         description: IP address
59423       l3-interface-ipv4-prefix-length:
59424         type: integer
59425         format: int64
59426         description: Prefix length, 32 for single address
59427       vlan-id-inner:
59428         type: integer
59429         format: int64
59430         description: Inner VLAN tag
59431       vlan-id-outer:
59432         type: integer
59433         format: int64
59434         description: Outer VLAN tag
59435       is-floating:
59436         type: boolean
59437         description: Indicator of fixed or floating address
59438       resource-version:
59439         type: string
59440         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59441       neutron-network-id:
59442         type: string
59443         description: Neutron network id of the interface that address belongs to
59444       neutron-subnet-id:
59445         type: string
59446         description: Neutron id of subnet that address belongs to
59447       relationship-list:
59448         type: array
59449         items:
59450           $ref: "#/getDefinitions/relationship"
59451   l3-interface-ipv6-address-list:
59452     description: |
59453       IPv6 Address Range
59454       ###### Related Nodes
59455       - TO instance-group( l3-interface-ipv6-address-list MemberOf instance-group, MANY2MANY)
59456       - TO l3-network( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
59457       - TO subnet( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
59458       - TO l-interface( l3-interface-ipv6-address-list BelongsTo l-interface, MANY2ONE)(4)
59459       - TO vlan( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(4)
59460       - TO vnfc( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(4)
59461
59462       -(4) IF this TO node is deleted, this L3-INTERFACE-IPV6-ADDRESS-LIST is DELETED also
59463     required:
59464     - l3-interface-ipv6-address
59465     properties:
59466       l3-interface-ipv6-address:
59467         type: string
59468         description: IP address
59469       l3-interface-ipv6-prefix-length:
59470         type: integer
59471         format: int64
59472         description: Prefix length, 128 for single address
59473       vlan-id-inner:
59474         type: integer
59475         format: int64
59476         description: Inner VLAN tag
59477       vlan-id-outer:
59478         type: integer
59479         format: int64
59480         description: Outer VLAN tag
59481       is-floating:
59482         type: boolean
59483         description: Indicator of fixed or floating address
59484       resource-version:
59485         type: string
59486         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59487       neutron-network-id:
59488         type: string
59489         description: Neutron network id of the interface that address belongs to
59490       neutron-subnet-id:
59491         type: string
59492         description: Neutron id of subnet that address belongs to
59493       relationship-list:
59494         type: array
59495         items:
59496           $ref: "#/getDefinitions/relationship"
59497   l3-network:
59498     description: |
59499       Generic network definition
59500       ###### Related Nodes
59501       - TO instance-group( l3-network MemberOf instance-group, MANY2MANY)
59502       - TO network-policy( l3-network Uses network-policy, MANY2MANY)
59503       - TO route-table-reference( l3-network Uses route-table-reference, MANY2MANY)
59504       - TO vpn-binding( l3-network Uses vpn-binding, MANY2MANY)
59505       - TO model-ver( l3-network IsA model-ver, Many2One)
59506       - FROM allotted-resource( allotted-resource PartOf l3-network, MANY2MANY)
59507       - FROM cloud-region( cloud-region Uses l3-network, MANY2MANY)
59508       - FROM complex( complex Uses l3-network, MANY2MANY)
59509       - FROM generic-vnf( generic-vnf Uses l3-network, MANY2MANY)
59510       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf l3-network, MANY2MANY)
59511       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf l3-network, MANY2MANY)
59512       - FROM ctag-assignment( ctag-assignment BelongsTo l3-network, MANY2ONE)(1)
59513       - FROM segmentation-assignment( segmentation-assignment BelongsTo l3-network, MANY2ONE)(1)
59514       - FROM service-instance( service-instance ComposedOf l3-network, ONE2MANY)
59515       - FROM subnet( subnet BelongsTo l3-network, MANY2ONE)(1)
59516       - FROM tenant( tenant Uses l3-network, MANY2MANY)
59517       - FROM vf-module( vf-module DependsOn l3-network, MANY2MANY)
59518
59519       -(1) IF this L3-NETWORK node is deleted, this FROM node is DELETED also
59520     required:
59521     - network-id
59522     - network-name
59523     - is-bound-to-vpn
59524     - is-provider-network
59525     - is-shared-network
59526     - is-external-network
59527     properties:
59528       network-id:
59529         type: string
59530         description: Network ID, should be uuid. Unique across A&AI.
59531       network-name:
59532         type: string
59533         description: Name of the network, governed by some naming convention..
59534       network-type:
59535         type: string
59536         description: Type of the network - who defines these values?
59537       network-role:
59538         type: string
59539         description: Role the network plans - who defines these values?
59540       network-technology:
59541         type: string
59542         description: Network technology - who defines these values?
59543       neutron-network-id:
59544         type: string
59545         description: Neutron network id of this Interface
59546       is-bound-to-vpn:
59547         type: boolean
59548         description: Set to true if bound to VPN
59549       service-id:
59550         type: string
59551         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
59552       network-role-instance:
59553         type: integer
59554         format: int64
59555         description: network role instance
59556       resource-version:
59557         type: string
59558         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59559       orchestration-status:
59560         type: string
59561         description: Orchestration status of this VNF, mastered by MSO
59562       heat-stack-id:
59563         type: string
59564         description: Heat stack id corresponding to this instance, managed by MSO
59565       mso-catalog-key:
59566         type: string
59567         description: Corresponds to the SDN-C catalog id used to configure this VCE
59568       contrail-network-fqdn:
59569         type: string
59570         description: Contrail FQDN for the network
59571       model-invariant-id:
59572         type: string
59573         description: the ASDC model id for this resource or service model.
59574       model-version-id:
59575         type: string
59576         description: the ASDC model version for this resource or service model.
59577       persona-model-version:
59578         type: string
59579         description: the ASDC model version for this resource or service model.
59580       model-customization-id:
59581         type: string
59582         description: captures the id of all the configuration used to customize the resource for the service.
59583       widget-model-id:
59584         type: string
59585         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59586       widget-model-version:
59587         type: string
59588         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59589       physical-network-name:
59590         type: string
59591         description: Name associated with the physical network.
59592       is-provider-network:
59593         type: boolean
59594         description: boolean indicatating whether or not network is a provider network.
59595       is-shared-network:
59596         type: boolean
59597         description: boolean indicatating whether or not network is a shared network.
59598       is-external-network:
59599         type: boolean
59600         description: boolean indicatating whether or not network is an external network.
59601       selflink:
59602         type: string
59603         description: Path to the controller object.
59604       operational-status:
59605         type: string
59606         description: Indicator for whether the resource is considered operational.
59607       subnets:
59608         type: array
59609         items:
59610           $ref: "#/getDefinitions/subnet"
59611       ctag-assignments:
59612         type: array
59613         items:
59614           $ref: "#/getDefinitions/ctag-assignment"
59615       segmentation-assignments:
59616         type: array
59617         items:
59618           $ref: "#/getDefinitions/segmentation-assignment"
59619       relationship-list:
59620         type: array
59621         items:
59622           $ref: "#/getDefinitions/relationship"
59623         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
59624   l3-networks:
59625     properties:
59626       l3-network:
59627         type: array
59628         items:
59629           $ref: "#/getDefinitions/l3-network"
59630   lag-interface:
59631     description: |
59632       Link aggregate interface
59633       ###### Related Nodes
59634       - TO generic-vnf( lag-interface BelongsTo generic-vnf, MANY2ONE)(4)
59635       - TO lag-link( lag-interface LinksTo lag-link, MANY2MANY)(2)
59636       - TO logical-link( lag-interface Uses logical-link, MANY2MANY)(2)
59637       - TO p-interface( lag-interface Uses p-interface, MANY2MANY)
59638       - TO pnf( lag-interface BindsTo pnf, MANY2ONE)(4)
59639       - TO pserver( lag-interface BindsTo pserver, MANY2ONE)(4)
59640       - TO vpls-pe( lag-interface BindsTo vpls-pe, MANY2ONE)(4)
59641       - FROM l-interface( l-interface BelongsTo lag-interface, MANY2ONE)(1)
59642       - FROM forwarder( forwarder ForwardsTo lag-interface, MANY2ONE)
59643
59644       -(1) IF this LAG-INTERFACE node is deleted, this FROM node is DELETED also
59645       -(2) IF this LAG-INTERFACE node is deleted, this TO node is DELETED also
59646       -(4) IF this TO node is deleted, this LAG-INTERFACE is DELETED also
59647     required:
59648     - interface-name
59649     - in-maint
59650     properties:
59651       interface-name:
59652         type: string
59653         description: Name that identifies the link aggregate interface
59654       interface-description:
59655         type: string
59656         description: Human friendly text regarding this interface.
59657       resource-version:
59658         type: string
59659         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59660       speed-value:
59661         type: string
59662         description: Captures the numeric part of the speed
59663       speed-units:
59664         type: string
59665         description: Captures the units corresponding to the speed
59666       interface-id:
59667         type: string
59668         description: ID of interface
59669       interface-role:
59670         type: string
59671         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
59672       prov-status:
59673         type: string
59674         description: Trigger for operational monitoring of this resource by Service Assurance systems.
59675       in-maint:
59676         type: boolean
59677         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
59678       relationship-list:
59679         type: array
59680         items:
59681           $ref: "#/getDefinitions/relationship"
59682       l-interfaces:
59683         type: array
59684         items:
59685           $ref: "#/getDefinitions/l-interface"
59686   lag-interfaces:
59687     description: |
59688       Collection of link aggregate interfaces.
59689     properties:
59690       lag-interface:
59691         type: array
59692         items:
59693           $ref: "#/getDefinitions/lag-interface"
59694   lag-link:
59695     description: |
59696       LAG links can connect lag-interfaces
59697       ###### Related Nodes
59698       - FROM lag-interface( lag-interface LinksTo lag-link, MANY2MANY)(3)
59699       - FROM logical-link( logical-link Uses lag-link, MANY2MANY)
59700
59701       -(3) IF this FROM node is deleted, this LAG-LINK is DELETED also
59702     required:
59703     - link-name
59704     properties:
59705       link-name:
59706         type: string
59707         description: Alphabetical concatenation of lag-interface names
59708       resource-version:
59709         type: string
59710         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59711       relationship-list:
59712         type: array
59713         items:
59714           $ref: "#/getDefinitions/relationship"
59715   lag-links:
59716     description: |
59717       Collection of link aggregation connections
59718     properties:
59719       lag-link:
59720         type: array
59721         items:
59722           $ref: "#/getDefinitions/lag-link"
59723   license:
59724     description: |
59725       Metadata for license group.
59726       ###### Related Nodes
59727       - TO generic-vnf( license BelongsTo generic-vnf, MANY2ONE)(4)
59728       - TO vce( license BelongsTo vce, MANY2ONE)(4)
59729
59730       -(4) IF this TO node is deleted, this LICENSE is DELETED also
59731     required:
59732     - group-uuid
59733     - resource-uuid
59734     properties:
59735       group-uuid:
59736         type: string
59737         description: Unique ID for the license group the resource belongs to, should be uuid.
59738       resource-uuid:
59739         type: string
59740         description: Unique ID of a license resource.
59741       resource-version:
59742         type: string
59743         description: Concurrency value
59744       relationship-list:
59745         type: array
59746         items:
59747           $ref: "#/getDefinitions/relationship"
59748   licenses:
59749     description: |
59750       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
59751     properties:
59752       license:
59753         type: array
59754         items:
59755           $ref: "#/getDefinitions/license"
59756   line-of-business:
59757     description: |
59758       describes a line-of-business
59759       ###### Related Nodes
59760       - TO generic-vnf( line-of-business Uses generic-vnf, MANY2MANY)
59761
59762     required:
59763     - line-of-business-name
59764     properties:
59765       line-of-business-name:
59766         type: string
59767         description: Name of the line-of-business (product)
59768       resource-version:
59769         type: string
59770         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59771       relationship-list:
59772         type: array
59773         items:
59774           $ref: "#/getDefinitions/relationship"
59775   lines-of-business:
59776     description: |
59777       Collection of lines-of-business
59778     properties:
59779       line-of-business:
59780         type: array
59781         items:
59782           $ref: "#/getDefinitions/line-of-business"
59783   logical-link:
59784     description: |
59785       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
59786       ###### Related Nodes
59787       - TO l-interface( logical-link Source l-interface, ONE2MANY)(4)
59788       - TO l-interface( logical-link Destination l-interface, ONE2MANY)(4)
59789       - TO cloud-region( logical-link LocatedIn cloud-region, MANY2MANY)
59790       - TO generic-vnf( logical-link BridgedTo generic-vnf, MANY2MANY)
59791       - TO lag-link( logical-link Uses lag-link, MANY2MANY)
59792       - TO logical-link( logical-link Uses logical-link, MANY2MANY)
59793       - TO pnf( logical-link BridgedTo pnf, MANY2MANY)
59794       - TO pserver( logical-link BridgedTo pserver, MANY2MANY)
59795       - TO vpn-binding( logical-link Uses vpn-binding, MANY2MANY)
59796       - TO virtual-data-center( logical-link LocatedIn virtual-data-center, MANY2MANY)
59797       - TO model-ver( logical-link IsA model-ver, Many2One)
59798       - FROM configuration( configuration Uses logical-link, ONE2MANY)(3)
59799       - FROM lag-interface( lag-interface Uses logical-link, MANY2MANY)(3)
59800       - FROM l-interface( l-interface LinksTo logical-link, MANY2MANY)(3)
59801       - FROM p-interface( p-interface LinksTo logical-link, MANY2ONE)
59802       - FROM service-instance( service-instance Uses logical-link, ONE2MANY)(3)
59803       - FROM vlan( vlan Uses logical-link, MANY2MANY)(3)
59804       - FROM logical-link( logical-link Uses logical-link, MANY2MANY)
59805
59806       -(3) IF this FROM node is deleted, this LOGICAL-LINK is DELETED also
59807       -(4) IF this TO node is deleted, this LOGICAL-LINK is DELETED also
59808     required:
59809     - link-name
59810     - in-maint
59811     - link-type
59812     properties:
59813       link-name:
59814         type: string
59815         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
59816       in-maint:
59817         type: boolean
59818         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
59819       link-type:
59820         type: string
59821         description: Type of logical link, e.g., evc
59822       speed-value:
59823         type: string
59824         description: Captures the numeric part of the speed
59825       speed-units:
59826         type: string
59827         description: Captures the units corresponding to the speed
59828       ip-version:
59829         type: string
59830         description: v4, v6, or ds for dual stack
59831       routing-protocol:
59832         type: string
59833         description: For example, static or BGP
59834       resource-version:
59835         type: string
59836         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59837       model-invariant-id:
59838         type: string
59839         description: the ASDC model id for this resource or service model.
59840       model-version-id:
59841         type: string
59842         description: the ASDC model version for this resource or service model.
59843       persona-model-version:
59844         type: string
59845         description: the ASDC model version for this resource or service model.
59846       widget-model-id:
59847         type: string
59848         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59849       widget-model-version:
59850         type: string
59851         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59852       operational-status:
59853         type: string
59854         description: Indication of operational status of the logical link.
59855       prov-status:
59856         type: string
59857         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
59858       link-role:
59859         type: string
59860         description: Indication of the network use of the logical link.
59861       link-name2:
59862         type: string
59863         description: Alias or alternate name (CLCI or D1 name).
59864       link-id:
59865         type: string
59866         description: UUID of the logical-link, SDNC generates this.
59867       circuit-id:
59868         type: string
59869         description: Circuit id
59870       purpose:
59871         type: string
59872         description: Reason for this entity, role it is playing
59873       relationship-list:
59874         type: array
59875         items:
59876           $ref: "#/getDefinitions/relationship"
59877   logical-links:
59878     description: |
59879       Collection of logical connections
59880     properties:
59881       logical-link:
59882         type: array
59883         items:
59884           $ref: "#/getDefinitions/logical-link"
59885   metadata:
59886     description: |
59887       Collection of metadatum (key/value pairs)
59888     properties:
59889       metadatum:
59890         type: array
59891         items:
59892           $ref: "#/getDefinitions/metadatum"
59893   metadatum:
59894     description: |
59895       Key/value pairs
59896       ###### Related Nodes
59897       - TO configuration( metadatum BelongsTo configuration, MANY2ONE)(4)
59898       - TO connector( metadatum BelongsTo connector, MANY2ONE)(4)
59899       - TO image( metadatum BelongsTo image, MANY2ONE)(4)
59900       - TO model-ver( metadatum BelongsTo model-ver, MANY2ONE)(4)
59901       - TO service-instance( metadatum BelongsTo service-instance, MANY2ONE)(4)
59902
59903       -(4) IF this TO node is deleted, this METADATUM is DELETED also
59904     required:
59905     - metaname
59906     - metaval
59907     properties:
59908       metaname:
59909         type: string
59910       metaval:
59911         type: string
59912       resource-version:
59913         type: string
59914         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59915   model:
59916     description: |
59917       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
59918       ###### Related Nodes
59919       - TO model( model-ver BelongsTo model, MANY2ONE)(1)
59920       - FROM instance-group( instance-group Targets model, MANY2MANY)
59921       - FROM model-ver( model-ver BelongsTo model, MANY2ONE)(1)
59922       - FROM named-query( named-query AppliesTo model, ONE2MANY)
59923       - FROM named-query-element( named-query-element IsA model, MANY2ONE)
59924
59925       -(1) IF this MODEL node is deleted, this FROM node is DELETED also
59926       -MODEL cannot be deleted if related to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
59927
59928     required:
59929     - model-invariant-id
59930     - model-type
59931     properties:
59932       model-invariant-id:
59933         type: string
59934         description: Unique identifier corresponding to the main definition of a model in ASDC
59935       model-type:
59936         type: string
59937         description: Type of the model, e.g., service, resource, widget, etc.
59938       resource-version:
59939         type: string
59940         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59941       model-vers:
59942         type: array
59943         items:
59944           $ref: "#/getDefinitions/model-ver"
59945       relationship-list:
59946         type: array
59947         items:
59948           $ref: "#/getDefinitions/relationship"
59949   model-and-named-query-search:
59950     description: |
59951       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
59952     properties:
59953       query-parameters:
59954         type: object
59955         $ref: "#/getDefinitions/query-parameters"
59956       instance-filters:
59957         type: object
59958         $ref: "#/getDefinitions/instance-filters"
59959       secondary-filts:
59960         type: object
59961         $ref: "#/getDefinitions/secondary-filts"
59962       top-node-type:
59963         type: string
59964       secondary-filter-cut-point:
59965         type: string
59966   model-constraint:
59967     description: |
59968       This is how we would capture constraints defining allowed sets of elements.
59969       ###### Related Nodes
59970       - TO model-element( model-constraint BelongsTo model-element, MANY2ONE)(4)
59971       - FROM constrained-element-set( constrained-element-set BelongsTo model-constraint, MANY2ONE)(1)
59972
59973       -(1) IF this MODEL-CONSTRAINT node is deleted, this FROM node is DELETED also
59974       -(4) IF this TO node is deleted, this MODEL-CONSTRAINT is DELETED also
59975     required:
59976     - model-constraint-uuid
59977     - constrained-element-set-uuid-to-replace
59978     properties:
59979       model-constraint-uuid:
59980         type: string
59981       constrained-element-set-uuid-to-replace:
59982         type: string
59983       constrained-element-sets:
59984         type: array
59985         items:
59986           $ref: "#/getDefinitions/constrained-element-set"
59987       resource-version:
59988         type: string
59989         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59990   model-constraints:
59991     properties:
59992       model-constraint:
59993         type: array
59994         items:
59995           $ref: "#/getDefinitions/model-constraint"
59996   model-element:
59997     description: |
59998       Defines how other models combine to make up a higher-level model.
59999       ###### Related Nodes
60000       - TO element-choice-set( model-element BelongsTo element-choice-set, MANY2ONE)(4)
60001       - TO model-element( model-element BelongsTo model-element, MANY2ONE)(4)
60002       - TO model-ver( model-element IsA model-ver, MANY2ONE)
60003       - TO model-ver( model-element BelongsTo model-ver, MANY2ONE)(4)
60004       - FROM constrained-element-set( constrained-element-set BelongsTo model-element, MANY2ONE)(1)
60005       - FROM model-constraint( model-constraint BelongsTo model-element, MANY2ONE)(1)
60006       - FROM model-element( model-element BelongsTo model-element, MANY2ONE)(4)
60007
60008       -(1) IF this MODEL-ELEMENT node is deleted, this FROM node is DELETED also
60009       -(4) IF this TO node is deleted, this MODEL-ELEMENT is DELETED also
60010     required:
60011     - model-element-uuid
60012     - new-data-del-flag
60013     - cardinality
60014     properties:
60015       model-element-uuid:
60016         type: string
60017       new-data-del-flag:
60018         type: string
60019         description: Indicates whether this element was created as part of instantiation from this model
60020       cardinality:
60021         type: string
60022         description: How many of this type of element are required/allowed
60023       linkage-points:
60024         type: string
60025       resource-version:
60026         type: string
60027         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60028       model-elements:
60029         type: array
60030         items:
60031           $ref: "#/getDefinitions/model-element"
60032         description: Defines how other models combine to make up a higher-level model
60033       model-constraints:
60034         type: array
60035         items:
60036           $ref: "#/getDefinitions/model-constraint"
60037         description: Describes new constraints on this model element that are not part of that model's definition
60038       relationship-list:
60039         type: array
60040         items:
60041           $ref: "#/getDefinitions/relationship"
60042   model-elements:
60043     properties:
60044       model-element:
60045         type: array
60046         items:
60047           $ref: "#/getDefinitions/model-element"
60048   model-ver:
60049     description: |
60050       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
60051       ###### Related Nodes
60052       - TO model( model-ver BelongsTo model, MANY2ONE)(4)
60053       - FROM model-element( model-element IsA model-ver, MANY2ONE)
60054       - FROM metadatum( metadatum BelongsTo model-ver, MANY2ONE)(1)
60055       - FROM model-element( model-element BelongsTo model-ver, MANY2ONE)(1)
60056       - FROM allotted-resource( allotted-resource IsA model-ver, Many2One)
60057       - FROM generic-vnf( generic-vnf IsA model-ver, Many2One)
60058       - FROM l3-network( l3-network IsA model-ver, Many2One)
60059       - FROM logical-link( logical-link IsA model-ver, Many2One)
60060       - FROM service-instance( service-instance IsA model-ver, Many2One)
60061       - FROM vf-module( vf-module IsA model-ver, Many2One)
60062
60063       -(1) IF this MODEL-VER node is deleted, this FROM node is DELETED also
60064       -(4) IF this TO node is deleted, this MODEL-VER is DELETED also
60065       -MODEL-VER cannot be deleted if related to MODEL-ELEMENT
60066
60067     required:
60068     - model-version-id
60069     - model-name
60070     - model-version
60071     properties:
60072       model-version-id:
60073         type: string
60074         description: Unique identifier corresponding to one version of a model in ASDC
60075       model-name:
60076         type: string
60077         description: Name of the model, which can change from version to version.
60078       model-version:
60079         type: string
60080         description: Version
60081       distribution-status:
60082         type: string
60083         description: Distribution Status
60084       model-description:
60085         type: string
60086         description: Description
60087       resource-version:
60088         type: string
60089         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60090       model-elements:
60091         type: array
60092         items:
60093           $ref: "#/getDefinitions/model-element"
60094       metadata:
60095         type: array
60096         items:
60097           $ref: "#/getDefinitions/metadatum"
60098       relationship-list:
60099         type: array
60100         items:
60101           $ref: "#/getDefinitions/relationship"
60102   model-vers:
60103     properties:
60104       model-ver:
60105         type: array
60106         items:
60107           $ref: "#/getDefinitions/model-ver"
60108   models:
60109     description: |
60110       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
60111     properties:
60112       model:
60113         type: array
60114         items:
60115           $ref: "#/getDefinitions/model"
60116   multicast-configuration:
60117     description: |
60118       ###### Related Nodes
60119       - FROM vlan( vlan Uses multicast-configuration, MANY2MANY)
60120
60121     required:
60122     - multicast-configuration-id
60123     - multicast-protocol
60124     - rp-type
60125     properties:
60126       multicast-configuration-id:
60127         type: string
60128         description: Unique id of multicast configuration.
60129       multicast-protocol:
60130         type: string
60131         description: protocol of multicast configuration
60132       rp-type:
60133         type: string
60134         description: rp type of multicast configuration
60135       resource-version:
60136         type: string
60137         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60138       relationship-list:
60139         type: array
60140         items:
60141           $ref: "#/getDefinitions/relationship"
60142   multicast-configurations:
60143     description: |
60144       multicast configuration of generic-vnf ip-address
60145     properties:
60146       multicast-configuration:
60147         type: array
60148         items:
60149           $ref: "#/getDefinitions/multicast-configuration"
60150   named-queries:
60151     properties:
60152       named-query:
60153         type: array
60154         items:
60155           $ref: "#/getDefinitions/named-query"
60156   named-query:
60157     description: |
60158       TBD
60159       ###### Related Nodes
60160       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(1)
60161       - TO model( named-query AppliesTo model, ONE2MANY)
60162       - FROM named-query-element( named-query-element BelongsTo named-query, ONE2ONE)(1)
60163
60164       -(1) IF this NAMED-QUERY node is deleted, this FROM node is DELETED also
60165     required:
60166     - named-query-uuid
60167     - named-query-name
60168     - named-query-version
60169     properties:
60170       named-query-uuid:
60171         type: string
60172       named-query-name:
60173         type: string
60174       named-query-version:
60175         type: string
60176       required-input-param:
60177         type: string
60178       description:
60179         type: string
60180       resource-version:
60181         type: string
60182       named-query-elements:
60183         type: array
60184         items:
60185           $ref: "#/getDefinitions/named-query-element"
60186       relationship-list:
60187         type: array
60188         items:
60189           $ref: "#/getDefinitions/relationship"
60190   named-query-element:
60191     description: |
60192       TBD
60193       ###### Related Nodes
60194       - TO named-query( named-query-element BelongsTo named-query, ONE2ONE)(4)
60195       - TO model( named-query-element IsA model, MANY2ONE)
60196       - TO named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
60197       - FROM property-constraint( property-constraint BelongsTo named-query-element, MANY2ONE)(1)
60198       - FROM related-lookup( related-lookup BelongsTo named-query-element, MANY2ONE)(1)
60199       - FROM named-query-element( named-query-element BelongsTo named-query-element, MANY2ONE)(4)
60200
60201       -(1) IF this NAMED-QUERY-ELEMENT node is deleted, this FROM node is DELETED also
60202       -(4) IF this TO node is deleted, this NAMED-QUERY-ELEMENT is DELETED also
60203     required:
60204     - named-query-element-uuid
60205     properties:
60206       named-query-element-uuid:
60207         type: string
60208       property-collect-list:
60209         type: string
60210       resource-version:
60211         type: string
60212       property-limit-desc:
60213         type: string
60214       do-not-output:
60215         type: string
60216       named-query-elements:
60217         type: array
60218         items:
60219           $ref: "#/getDefinitions/named-query-element"
60220       related-lookups:
60221         type: array
60222         items:
60223           $ref: "#/getDefinitions/related-lookup"
60224       property-constraints:
60225         type: array
60226         items:
60227           $ref: "#/getDefinitions/property-constraint"
60228       relationship-list:
60229         type: array
60230         items:
60231           $ref: "#/getDefinitions/relationship"
60232   named-query-elements:
60233     properties:
60234       named-query-element:
60235         type: array
60236         items:
60237           $ref: "#/getDefinitions/named-query-element"
60238   network:
60239     description: |
60240       Namespace for network inventory resources.
60241     properties:
60242       logical-links:
60243         type: array
60244         items:
60245           $ref: "#/getDefinitions/logical-link"
60246       site-pair-sets:
60247         type: array
60248         items:
60249           $ref: "#/getDefinitions/site-pair-set"
60250       vpn-bindings:
60251         type: array
60252         items:
60253           $ref: "#/getDefinitions/vpn-binding"
60254       vpls-pes:
60255         type: array
60256         items:
60257           $ref: "#/getDefinitions/vpls-pe"
60258       multicast-configurations:
60259         type: array
60260         items:
60261           $ref: "#/getDefinitions/multicast-configuration"
60262       vces:
60263         type: array
60264         items:
60265           $ref: "#/getDefinitions/vce"
60266       vnfcs:
60267         type: array
60268         items:
60269           $ref: "#/getDefinitions/vnfc"
60270       l3-networks:
60271         type: array
60272         items:
60273           $ref: "#/getDefinitions/l3-network"
60274       network-policies:
60275         type: array
60276         items:
60277           $ref: "#/getDefinitions/network-policy"
60278       generic-vnfs:
60279         type: array
60280         items:
60281           $ref: "#/getDefinitions/generic-vnf"
60282       lag-links:
60283         type: array
60284         items:
60285           $ref: "#/getDefinitions/lag-link"
60286       newvces:
60287         type: array
60288         items:
60289           $ref: "#/getDefinitions/newvce"
60290       pnfs:
60291         type: array
60292         items:
60293           $ref: "#/getDefinitions/pnf"
60294       physical-links:
60295         type: array
60296         items:
60297           $ref: "#/getDefinitions/physical-link"
60298       ipsec-configurations:
60299         type: array
60300         items:
60301           $ref: "#/getDefinitions/ipsec-configuration"
60302       route-table-references:
60303         type: array
60304         items:
60305           $ref: "#/getDefinitions/route-table-reference"
60306       instance-groups:
60307         type: array
60308         items:
60309           $ref: "#/getDefinitions/instance-group"
60310       zones:
60311         type: array
60312         items:
60313           $ref: "#/getDefinitions/zone"
60314       configurations:
60315         type: array
60316         items:
60317           $ref: "#/getDefinitions/configuration"
60318       forwarding-paths:
60319         type: array
60320         items:
60321           $ref: "#/getDefinitions/forwarding-path"
60322   network-policies:
60323     properties:
60324       network-policy:
60325         type: array
60326         items:
60327           $ref: "#/getDefinitions/network-policy"
60328   network-policy:
60329     description: |
60330       ###### Related Nodes
60331       - FROM allotted-resource( allotted-resource Uses network-policy, ONE2ONE)
60332       - FROM l3-network( l3-network Uses network-policy, MANY2MANY)
60333
60334     required:
60335     - network-policy-id
60336     properties:
60337       network-policy-id:
60338         type: string
60339         description: UUID representing unique key to this instance
60340       network-policy-fqdn:
60341         type: string
60342         description: Contrail FQDN for the policy
60343       heat-stack-id:
60344         type: string
60345         description: ID for the openStack Heat instance
60346       resource-version:
60347         type: string
60348         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60349       relationship-list:
60350         type: array
60351         items:
60352           $ref: "#/getDefinitions/relationship"
60353   network-profile:
60354     description: |
60355       Network profile populated by SDN-GP for SNMP
60356       ###### Related Nodes
60357       - TO generic-vnf( network-profile AppliesTo generic-vnf, MANY2MANY)
60358
60359     required:
60360     - nm-profile-name
60361     properties:
60362       nm-profile-name:
60363         type: string
60364         description: Unique name of network profile.
60365       community-string:
60366         type: string
60367         description: Encrypted SNMP community string
60368       resource-version:
60369         type: string
60370         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60371       relationship-list:
60372         type: array
60373         items:
60374           $ref: "#/getDefinitions/relationship"
60375   network-profiles:
60376     description: |
60377       Collection of network profiles
60378     properties:
60379       network-profile:
60380         type: array
60381         items:
60382           $ref: "#/getDefinitions/network-profile"
60383   newvce:
60384     description: |
60385       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
60386       ###### Related Nodes
60387       - FROM l-interface( l-interface BelongsTo newvce, MANY2ONE)(1)
60388
60389       -(1) IF this NEWVCE node is deleted, this FROM node is DELETED also
60390     required:
60391     - vnf-id2
60392     - vnf-name
60393     - vnf-type
60394     properties:
60395       vnf-id2:
60396         type: string
60397         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
60398       vnf-name:
60399         type: string
60400         description: Name of VNF.
60401       vnf-name2:
60402         type: string
60403         description: Alternate name of VNF.
60404       vnf-type:
60405         type: string
60406         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
60407       prov-status:
60408         type: string
60409         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
60410       operational-status:
60411         type: string
60412         description: Indicator for whether the resource is considered operational
60413       license-key:
60414         type: string
60415         description: OBSOLETE -  do not use
60416       ipv4-oam-address:
60417         type: string
60418         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
60419       equipment-role:
60420         type: string
60421         description: Client should send valid enumerated value.
60422       resource-version:
60423         type: string
60424         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60425       ipv4-loopback0-address:
60426         type: string
60427         description: v4 Loopback0 address
60428       orchestration-status:
60429         type: string
60430         description: Orchestration status of this VNF, mastered by MSO.
60431       heat-stack-id:
60432         type: string
60433         description: Heat stack id corresponding to this instance, managed by MSO
60434       mso-catalog-key:
60435         type: string
60436         description: Corresponds to the SDN-C catalog id used to configure this VCE
60437       relationship-list:
60438         type: array
60439         items:
60440           $ref: "#/getDefinitions/relationship"
60441       l-interfaces:
60442         type: array
60443         items:
60444           $ref: "#/getDefinitions/l-interface"
60445   newvces:
60446     description: |
60447       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
60448     properties:
60449       newvce:
60450         type: array
60451         items:
60452           $ref: "#/getDefinitions/newvce"
60453   nodes:
60454     properties:
60455       inventory-item-data:
60456         type: array
60457         items:
60458           $ref: "#/getDefinitions/inventory-item-data"
60459   notification-event:
60460     properties:
60461       cambria.partition:
60462         type: string
60463       notification-event-header:
60464         type: object
60465         $ref: "#/getDefinitions/notification-event-header"
60466   notification-event-header:
60467     properties:
60468       id:
60469         type: string
60470       timestamp:
60471         type: string
60472       source-name:
60473         type: string
60474       domain:
60475         type: string
60476       sequence-number:
60477         type: string
60478       severity:
60479         type: string
60480       event-type:
60481         type: string
60482       version:
60483         type: string
60484       action:
60485         type: string
60486       entity-type:
60487         type: string
60488       top-entity-type:
60489         type: string
60490       entity-link:
60491         type: string
60492       status:
60493         type: string
60494   notify:
60495     required:
60496     - event-id
60497     properties:
60498       event-id:
60499         type: string
60500       node-type:
60501         type: string
60502       event-trigger:
60503         type: string
60504       key-data:
60505         type: array
60506         items:
60507           $ref: "#/getDefinitions/key-data"
60508       selflink:
60509         type: string
60510   oam-network:
60511     description: |
60512       OAM network, to be deprecated shortly.  Do not use for new purposes.
60513       ###### Related Nodes
60514       - TO cloud-region( oam-network BelongsTo cloud-region, MANY2ONE)
60515       - TO complex( oam-network AppliesTo complex, MANY2MANY)
60516       - TO service-capability( oam-network AppliesTo service-capability, MANY2MANY)
60517
60518     required:
60519     - network-uuid
60520     - network-name
60521     - cvlan-tag
60522     properties:
60523       network-uuid:
60524         type: string
60525         description: UUID of the network. Unique across a cloud-region
60526       network-name:
60527         type: string
60528         description: Name of the network.
60529       cvlan-tag:
60530         type: integer
60531         format: int64
60532         description: cvlan-id
60533       ipv4-oam-gateway-address:
60534         type: string
60535         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60536       ipv4-oam-gateway-address-prefix-length:
60537         type: integer
60538         format: int32
60539         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60540       resource-version:
60541         type: string
60542         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60543       relationship-list:
60544         type: array
60545         items:
60546           $ref: "#/getDefinitions/relationship"
60547   oam-networks:
60548     description: |
60549       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
60550     properties:
60551       oam-network:
60552         type: array
60553         items:
60554           $ref: "#/getDefinitions/oam-network"
60555   operational-environment:
60556     description: |
60557       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
60558       ###### Related Nodes
60559       - TO operational-environment( operational-environment Uses operational-environment, ONE2ONE)
60560       - FROM operational-environment( operational-environment Uses operational-environment, ONE2ONE)
60561
60562     required:
60563     - operational-environment-id
60564     - operational-environment-name
60565     - operational-environment-type
60566     - operational-environment-status
60567     - tenant-context
60568     - workload-context
60569     properties:
60570       operational-environment-id:
60571         type: string
60572         description: UUID of an operational environment
60573       operational-environment-name:
60574         type: string
60575         description: Operational Environment name
60576       operational-environment-type:
60577         type: string
60578         description: Operational Environment Type.
60579       operational-environment-status:
60580         type: string
60581         description: Status
60582       tenant-context:
60583         type: string
60584         description: Tenant Context.
60585       workload-context:
60586         type: string
60587         description: Workload Context.
60588       resource-version:
60589         type: string
60590         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60591       relationship-list:
60592         type: array
60593         items:
60594           $ref: "#/getDefinitions/relationship"
60595   operational-environments:
60596     description: |
60597       a logical partition of the cloud which allows to have multiple environments in the production AIC.
60598     properties:
60599       operational-environment:
60600         type: array
60601         items:
60602           $ref: "#/getDefinitions/operational-environment"
60603   overloaded-model:
60604     description: |
60605       Allows for legacy POST of old-style and new-style models
60606     required:
60607     - model-invariant-id
60608     - model-name-version-id
60609     - model-type
60610     - model-name
60611     - model-id
60612     - model-version
60613     properties:
60614       model-invariant-id:
60615         type: string
60616         description: Unique identifier corresponding to the main definition of a model in ASDC
60617       model-name-version-id:
60618         type: string
60619         description: Unique identifier corresponding to one version of a model in ASDC
60620       model-type:
60621         type: string
60622         description: Type of the model, e.g., service, resource, widget, etc.
60623       model-name:
60624         type: string
60625         description: Name of the model, which can change from version to version.
60626       model-id:
60627         type: string
60628         description: Invariant unique ID which does not change from version to version
60629       model-version:
60630         type: string
60631         description: Version
60632       model-description:
60633         type: string
60634         description: Description
60635       resource-version:
60636         type: string
60637         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60638       model-vers:
60639         type: object
60640         $ref: "#/getDefinitions/model-vers"
60641       relationship-list:
60642         type: object
60643         $ref: "#/getDefinitions/relationship-list"
60644   owning-entities:
60645     description: |
60646       Collection of owning-entities
60647     properties:
60648       owning-entity:
60649         type: array
60650         items:
60651           $ref: "#/getDefinitions/owning-entity"
60652   owning-entity:
60653     description: |
60654       describes an owning-entity
60655       ###### Related Nodes
60656       - FROM service-instance( service-instance BelongsTo owning-entity, MANY2ONE)
60657
60658     required:
60659     - owning-entity-id
60660     - owning-entity-name
60661     properties:
60662       owning-entity-id:
60663         type: string
60664         description: UUID of an owning entity
60665       owning-entity-name:
60666         type: string
60667         description: Owning entity name
60668       resource-version:
60669         type: string
60670         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60671       relationship-list:
60672         type: array
60673         items:
60674           $ref: "#/getDefinitions/relationship"
60675   p-interface:
60676     description: |
60677       Physical interface (e.g., nic)
60678       ###### Related Nodes
60679       - TO logical-link( p-interface LinksTo logical-link, MANY2ONE)
60680       - TO physical-link( p-interface LinksTo physical-link, MANY2ONE)(2)
60681       - TO pnf( p-interface BindsTo pnf, MANY2ONE)(4)
60682       - TO pserver( p-interface BindsTo pserver, MANY2ONE)(4)
60683       - TO vpls-pe( p-interface BindsTo vpls-pe, MANY2ONE)(4)
60684       - FROM lag-interface( lag-interface Uses p-interface, MANY2MANY)
60685       - FROM l-interface( l-interface BindsTo p-interface, MANY2ONE)(1)
60686       - FROM sriov-pf( sriov-pf BelongsTo p-interface, ONE2ONE)(1)
60687       - FROM forwarder( forwarder ForwardsTo p-interface, MANY2ONE)
60688
60689       -(1) IF this P-INTERFACE node is deleted, this FROM node is DELETED also
60690       -(2) IF this P-INTERFACE node is deleted, this TO node is DELETED also
60691       -(4) IF this TO node is deleted, this P-INTERFACE is DELETED also
60692     required:
60693     - interface-name
60694     - in-maint
60695     properties:
60696       interface-name:
60697         type: string
60698         description: Name that identifies the physical interface
60699       selflink:
60700         type: string
60701         description: URL to endpoint where AAI can get more details.
60702       speed-value:
60703         type: string
60704         description: Captures the numeric part of the speed
60705       speed-units:
60706         type: string
60707         description: Captures the units corresponding to the speed
60708       port-description:
60709         type: string
60710         description: Nature of the services and connectivity on this port.
60711       equipment-identifier:
60712         type: string
60713         description: CLEI or other specification for p-interface hardware.
60714       interface-role:
60715         type: string
60716         description: Role specification for p-interface hardware.
60717       interface-type:
60718         type: string
60719         description: Indicates the physical properties of the interface.
60720       prov-status:
60721         type: string
60722         description: Trigger for operational monitoring of this resource by Service Assurance systems.
60723       mac-addresss:
60724         type: string
60725         description: MAC Address of the p-interface.
60726       resource-version:
60727         type: string
60728         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60729       in-maint:
60730         type: boolean
60731         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
60732       inv-status:
60733         type: string
60734         description: inventory status
60735       relationship-list:
60736         type: array
60737         items:
60738           $ref: "#/getDefinitions/relationship"
60739       sriov-pfs:
60740         type: array
60741         items:
60742           $ref: "#/getDefinitions/sriov-pf"
60743       l-interfaces:
60744         type: array
60745         items:
60746           $ref: "#/getDefinitions/l-interface"
60747   p-interfaces:
60748     description: |
60749       Collection of physical interfaces.
60750     properties:
60751       p-interface:
60752         type: array
60753         items:
60754           $ref: "#/getDefinitions/p-interface"
60755   physical-link:
60756     description: |
60757       Collection of physical connections, typically between p-interfaces
60758       ###### Related Nodes
60759       - FROM p-interface( p-interface LinksTo physical-link, MANY2ONE)(3)
60760
60761       -(3) IF this FROM node is deleted, this PHYSICAL-LINK is DELETED also
60762     required:
60763     - link-name
60764     properties:
60765       link-name:
60766         type: string
60767         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
60768       speed-value:
60769         type: string
60770         description: Captures the numeric part of the speed
60771       speed-units:
60772         type: string
60773         description: Captures the units corresponding to the speed
60774       circuit-id:
60775         type: string
60776         description: Circuit it
60777       dual-mode:
60778         type: string
60779         description: Dual access mode (e.g., primary, secondary
60780       management-option:
60781         type: string
60782         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
60783       service-provider-name:
60784         type: string
60785         description: Name of the service Provider on this link.
60786       service-provider-bandwidth-up-value:
60787         type: integer
60788         format: int32
60789         description: Upstream Bandwidth value agreed with the service provider
60790       service-provider-bandwidth-up-units:
60791         type: string
60792         description: Units for the upstream BW value
60793       service-provider-bandwidth-down-value:
60794         type: integer
60795         format: int32
60796         description: Downstream Bandwidth value agreed with the service provider
60797       service-provider-bandwidth-down-units:
60798         type: string
60799         description: Units for downstream BW value
60800       resource-version:
60801         type: string
60802         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60803       relationship-list:
60804         type: array
60805         items:
60806           $ref: "#/getDefinitions/relationship"
60807   physical-links:
60808     description: |
60809       Collection of physical connections, typically between p-interfaces
60810     properties:
60811       physical-link:
60812         type: array
60813         items:
60814           $ref: "#/getDefinitions/physical-link"
60815   platform:
60816     description: |
60817       describes a platform
60818       ###### Related Nodes
60819       - TO generic-vnf( platform Uses generic-vnf, MANY2MANY)
60820
60821     required:
60822     - platform-name
60823     properties:
60824       platform-name:
60825         type: string
60826         description: Name of the platform
60827       resource-version:
60828         type: string
60829         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60830       relationship-list:
60831         type: array
60832         items:
60833           $ref: "#/getDefinitions/relationship"
60834   platforms:
60835     description: |
60836       Collection of platforms
60837     properties:
60838       platform:
60839         type: array
60840         items:
60841           $ref: "#/getDefinitions/platform"
60842   pnf:
60843     description: |
60844       PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
60845       ###### Related Nodes
60846       - TO complex( pnf LocatedIn complex, MANY2ONE)
60847       - TO instance-group( pnf MemberOf instance-group, MANY2MANY)
60848       - TO zone( pnf LocatedIn zone, MANY2ONE)
60849       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc AppliesTo pnf, ONE2MANY)
60850       - FROM generic-vnf( generic-vnf HostedOn pnf, MANY2MANY)
60851       - FROM logical-link( logical-link BridgedTo pnf, MANY2MANY)
60852       - FROM lag-interface( lag-interface BindsTo pnf, MANY2ONE)(1)
60853       - FROM p-interface( p-interface BindsTo pnf, MANY2ONE)(1)
60854       - FROM service-instance( service-instance ComposedOf pnf, ONE2MANY)
60855       - FROM configuration( configuration AppliesTo pnf, ONE2MANY)
60856
60857       -(1) IF this PNF node is deleted, this FROM node is DELETED also
60858     required:
60859     - pnf-name
60860     - in-maint
60861     properties:
60862       pnf-name:
60863         type: string
60864         description: unique name of Physical Network Function.
60865       pnf-name2:
60866         type: string
60867         description: name of Physical Network Function.
60868       selflink:
60869         type: string
60870         description: URL to endpoint where AAI can get more details.
60871       pnf-name2-source:
60872         type: string
60873         description: source of name2
60874       pnf-id:
60875         type: string
60876         description: id of pnf
60877       equip-type:
60878         type: string
60879         description: Equipment type.  Source of truth should define valid values.
60880       equip-vendor:
60881         type: string
60882         description: Equipment vendor.  Source of truth should define valid values.
60883       equip-model:
60884         type: string
60885         description: Equipment model.  Source of truth should define valid values.
60886       management-option:
60887         type: string
60888         description: identifier of managed by ATT or customer
60889       ipaddress-v4-oam:
60890         type: string
60891         description: ipv4-oam-address with new naming convention for IP addresses
60892       sw-version:
60893         type: string
60894         description: sw-version is the version of SW for the hosted application on the PNF.
60895       in-maint:
60896         type: boolean
60897         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
60898       frame-id:
60899         type: string
60900         description: ID of the physical frame (relay rack) where pnf is installed.
60901       serial-number:
60902         type: string
60903         description: Serial number of the device
60904       ipaddress-v4-loopback-0:
60905         type: string
60906         description: IPV4 Loopback 0 address
60907       ipaddress-v6-loopback-0:
60908         type: string
60909         description: IPV6 Loopback 0 address
60910       ipaddress-v4-aim:
60911         type: string
60912         description: IPV4 AIM address
60913       ipaddress-v6-aim:
60914         type: string
60915         description: IPV6 AIM address
60916       ipaddress-v6-oam:
60917         type: string
60918         description: IPV6 OAM address
60919       inv-status:
60920         type: string
60921         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
60922       resource-version:
60923         type: string
60924         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60925       prov-status:
60926         type: string
60927         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
60928       nf-role:
60929         type: string
60930         description: Nf Role is the role performed by this instance in the network.
60931       relationship-list:
60932         type: array
60933         items:
60934           $ref: "#/getDefinitions/relationship"
60935       p-interfaces:
60936         type: array
60937         items:
60938           $ref: "#/getDefinitions/p-interface"
60939       lag-interfaces:
60940         type: array
60941         items:
60942           $ref: "#/getDefinitions/lag-interface"
60943   pnfs:
60944     description: |
60945       Collection of Physical Network Functions.
60946     properties:
60947       pnf:
60948         type: array
60949         items:
60950           $ref: "#/getDefinitions/pnf"
60951   port-group:
60952     description: |
60953       Used to capture the network interfaces of this VCE
60954       ###### Related Nodes
60955       - TO vce( port-group BelongsTo vce, MANY2ONE)(4)
60956       - FROM cvlan-tag( cvlan-tag BelongsTo port-group, MANY2ONE)(1)
60957
60958       -(1) IF this PORT-GROUP node is deleted, this FROM node is DELETED also
60959       -(4) IF this TO node is deleted, this PORT-GROUP is DELETED also
60960     required:
60961     - interface-id
60962     - orchestration-status
60963     properties:
60964       interface-id:
60965         type: string
60966         description: Unique ID of the interface
60967       neutron-network-id:
60968         type: string
60969         description: Neutron network id of this Interface
60970       neutron-network-name:
60971         type: string
60972         description: Neutron network name of this Interface
60973       interface-role:
60974         type: string
60975         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
60976       resource-version:
60977         type: string
60978         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60979       port-group-id:
60980         type: string
60981         description: Unique ID for port group in vmware
60982       port-group-name:
60983         type: string
60984         description: Likely to duplicate value of neutron network name
60985       switch-name:
60986         type: string
60987         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
60988       orchestration-status:
60989         type: string
60990         description: Orchestration status of this VNF, mastered by MSO
60991       heat-stack-id:
60992         type: string
60993         description: Heat stack id corresponding to this instance, managed by MSO
60994       mso-catalog-key:
60995         type: string
60996         description: Corresponds to the SDN-C catalog id used to configure this VCE
60997       cvlan-tags:
60998         type: array
60999         items:
61000           $ref: "#/getDefinitions/cvlan-tag-entry"
61001       relationship-list:
61002         type: array
61003         items:
61004           $ref: "#/getDefinitions/relationship"
61005   port-groups:
61006     properties:
61007       port-group:
61008         type: array
61009         items:
61010           $ref: "#/getDefinitions/port-group"
61011   project:
61012     description: |
61013       describes the project
61014       ###### Related Nodes
61015       - TO service-instance( project Uses service-instance, ONE2MANY)
61016
61017     required:
61018     - project-name
61019     properties:
61020       project-name:
61021         type: string
61022         description: Name of the project deploying a service
61023       resource-version:
61024         type: string
61025         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61026       relationship-list:
61027         type: array
61028         items:
61029           $ref: "#/getDefinitions/relationship"
61030   projects:
61031     description: |
61032       Collection of projects
61033     properties:
61034       project:
61035         type: array
61036         items:
61037           $ref: "#/getDefinitions/project"
61038   properties:
61039     description: |
61040       Property holder for query properties or instance properties
61041     properties:
61042       property-name:
61043         type: string
61044       property-value:
61045         type: string
61046   property-constraint:
61047     description: |
61048       TBD
61049       ###### Related Nodes
61050       - TO named-query-element( property-constraint BelongsTo named-query-element, MANY2ONE)(4)
61051
61052       -(4) IF this TO node is deleted, this PROPERTY-CONSTRAINT is DELETED also
61053     required:
61054     - property-constraint-uuid
61055     - constraint-type
61056     - property-name
61057     - property-value
61058     properties:
61059       property-constraint-uuid:
61060         type: string
61061       constraint-type:
61062         type: string
61063       property-name:
61064         type: string
61065       property-value:
61066         type: string
61067       resource-version:
61068         type: string
61069   property-constraints:
61070     properties:
61071       property-constraint:
61072         type: array
61073         items:
61074           $ref: "#/getDefinitions/property-constraint"
61075   pserver:
61076     description: |
61077       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
61078       ###### Related Nodes
61079       - TO group-assignment( pserver MemberOf group-assignment, MANY2ONE)
61080       - TO availability-zone( pserver MemberOf availability-zone, MANY2ONE)
61081       - TO cloud-region( pserver LocatedIn cloud-region, MANY2ONE)
61082       - TO complex( pserver LocatedIn complex, MANY2ONE)
61083       - TO zone( pserver LocatedIn zone, MANY2ONE)
61084       - FROM generic-vnf( generic-vnf HostedOn pserver, MANY2MANY)
61085       - FROM logical-link( logical-link BridgedTo pserver, MANY2MANY)
61086       - FROM lag-interface( lag-interface BindsTo pserver, MANY2ONE)(1)
61087       - FROM p-interface( p-interface BindsTo pserver, MANY2ONE)(1)
61088       - FROM vserver( vserver HostedOn pserver, MANY2ONE)
61089
61090       -(1) IF this PSERVER node is deleted, this FROM node is DELETED also
61091       -PSERVER cannot be deleted if related to GENERIC-VNF,LOGICAL-LINK,VSERVER,GROUP-ASSIGNMENT
61092
61093     required:
61094     - hostname
61095     - in-maint
61096     properties:
61097       hostname:
61098         type: string
61099         description: Value from executing hostname on the compute node.
61100       ptnii-equip-name:
61101         type: string
61102         description: PTNII name
61103       number-of-cpus:
61104         type: integer
61105         format: int32
61106         description: Number of cpus
61107       disk-in-gigabytes:
61108         type: integer
61109         format: int32
61110         description: Disk size, in GBs
61111       ram-in-megabytes:
61112         type: integer
61113         format: int32
61114         description: RAM size, in MBs
61115       equip-type:
61116         type: string
61117         description: Equipment type.  Source of truth should define valid values.
61118       equip-vendor:
61119         type: string
61120         description: Equipment vendor.  Source of truth should define valid values.
61121       equip-model:
61122         type: string
61123         description: Equipment model.  Source of truth should define valid values.
61124       fqdn:
61125         type: string
61126         description: Fully-qualified domain name
61127       pserver-selflink:
61128         type: string
61129         description: URL to endpoint where AAI can get more details
61130       ipv4-oam-address:
61131         type: string
61132         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
61133       serial-number:
61134         type: string
61135         description: Serial number, may be queried
61136       ipaddress-v4-loopback-0:
61137         type: string
61138         description: IPV4 Loopback 0 address
61139       ipaddress-v6-loopback-0:
61140         type: string
61141         description: IPV6 Loopback 0 address
61142       ipaddress-v4-aim:
61143         type: string
61144         description: IPV4 AIM address
61145       ipaddress-v6-aim:
61146         type: string
61147         description: IPV6 AIM address
61148       ipaddress-v6-oam:
61149         type: string
61150         description: IPV6 OAM address
61151       inv-status:
61152         type: string
61153         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
61154       pserver-id:
61155         type: string
61156         description: ID of Pserver
61157       internet-topology:
61158         type: string
61159         description: internet topology of Pserver
61160       in-maint:
61161         type: boolean
61162         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
61163       resource-version:
61164         type: string
61165         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61166       pserver-name2:
61167         type: string
61168         description: alternative pserver name
61169       purpose:
61170         type: string
61171         description: purpose of pserver
61172       prov-status:
61173         type: string
61174         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
61175       management-option:
61176         type: string
61177         description: Indicates who owns and or manages the device.
61178       host-profile:
61179         type: string
61180         description: The host profile that defines the configuration of the pserver.
61181       relationship-list:
61182         type: array
61183         items:
61184           $ref: "#/getDefinitions/relationship"
61185       p-interfaces:
61186         type: array
61187         items:
61188           $ref: "#/getDefinitions/p-interface"
61189       lag-interfaces:
61190         type: array
61191         items:
61192           $ref: "#/getDefinitions/lag-interface"
61193   pservers:
61194     description: |
61195       Collection of compute hosts.
61196     properties:
61197       pserver:
61198         type: array
61199         items:
61200           $ref: "#/getDefinitions/pserver"
61201   query-parameters:
61202     description: |
61203       QueryParameters for performing a named-query or model query
61204     properties:
61205       named-query:
61206         type: object
61207         $ref: "#/getDefinitions/named-query"
61208       overloaded-model:
61209         type: object
61210         $ref: "#/getDefinitions/overloaded-model"
61211   related-lookup:
61212     description: |
61213       TBD
61214       ###### Related Nodes
61215       - TO named-query-element( related-lookup BelongsTo named-query-element, MANY2ONE)(4)
61216
61217       -(4) IF this TO node is deleted, this RELATED-LOOKUP is DELETED also
61218     required:
61219     - related-lookup-uuid
61220     - source-node-type
61221     - source-node-property
61222     - target-node-type
61223     - target-node-property
61224     properties:
61225       related-lookup-uuid:
61226         type: string
61227       source-node-type:
61228         type: string
61229       source-node-property:
61230         type: string
61231       target-node-type:
61232         type: string
61233       target-node-property:
61234         type: string
61235       property-collect-list:
61236         type: string
61237       resource-version:
61238         type: string
61239       relationship-list:
61240         type: array
61241         items:
61242           $ref: "#/getDefinitions/relationship"
61243   related-lookups:
61244     properties:
61245       related-lookup:
61246         type: array
61247         items:
61248           $ref: "#/getDefinitions/related-lookup"
61249   related-to-property:
61250     properties:
61251       property-key:
61252         type: string
61253         description: Key part of a key/value pair
61254       property-value:
61255         type: string
61256         description: Value part of a key/value pair
61257   relationship:
61258     properties:
61259       related-to:
61260         type: string
61261         description: A keyword provided by A&AI to indicate type of node.
61262       relationship-label:
61263         type: string
61264         description: The edge label for this relationship.
61265       related-link:
61266         type: string
61267         description: URL to the object in A&AI.
61268       relationship-data:
61269         type: array
61270         items:
61271           $ref: "#/getDefinitions/relationship-data"
61272       related-to-property:
61273         type: array
61274         items:
61275           $ref: "#/getDefinitions/related-to-property"
61276   relationship-data:
61277     required:
61278     - relationship-key
61279     - relationship-value
61280     properties:
61281       relationship-key:
61282         type: string
61283         description: A keyword provided by A&AI to indicate an attribute.
61284       relationship-value:
61285         type: string
61286         description: Value of the attribute.
61287   relationship-list:
61288     properties:
61289       relationship:
61290         type: array
61291         items:
61292           $ref: "#/getDefinitions/relationship"
61293   reserved-prop-names:
61294     description: |
61295       Internal map to define some reserved properties of a vertex
61296     properties:
61297       last-mod-source-of-truth:
61298         type: string
61299       aai-node-type:
61300         type: string
61301       aai-created-ts:
61302         type: integer
61303         format: int64
61304       aai-unique-key:
61305         type: string
61306       aai-last-mod-ts:
61307         type: integer
61308         format: int64
61309       source-of-truth:
61310         type: string
61311       aai-uri:
61312         type: string
61313   response-list:
61314     description: |
61315       Response container for the results of a named-query or model query
61316     properties:
61317       inventory-response-items:
61318         type: object
61319         $ref: "#/getDefinitions/inventory-response-items"
61320   result-data:
61321     properties:
61322       resource-type:
61323         type: string
61324         description: The specific type of node in the A&AI graph
61325       resource-link:
61326         type: string
61327         description: The URL to the specific resource
61328   route-table-reference:
61329     description: |
61330       Openstack route table reference.
61331       ###### Related Nodes
61332       - FROM l3-network( l3-network Uses route-table-reference, MANY2MANY)
61333
61334     required:
61335     - route-table-reference-id
61336     - route-table-reference-fqdn
61337     properties:
61338       route-table-reference-id:
61339         type: string
61340         description: Route Table Reference id, UUID assigned to this instance.
61341       route-table-reference-fqdn:
61342         type: string
61343         description: FQDN entry in the route table.
61344       resource-version:
61345         type: string
61346         description: Concurrency value
61347       relationship-list:
61348         type: array
61349         items:
61350           $ref: "#/getDefinitions/relationship"
61351   route-table-references:
61352     description: |
61353       Collection of openstack route table references
61354     properties:
61355       route-table-reference:
61356         type: array
61357         items:
61358           $ref: "#/getDefinitions/route-table-reference"
61359   route-target:
61360     description: |
61361       Route target information
61362       ###### Related Nodes
61363       - TO vpn-binding( route-target BelongsTo vpn-binding, MANY2ONE)(4)
61364
61365       -(4) IF this TO node is deleted, this ROUTE-TARGET is DELETED also
61366     required:
61367     - global-route-target
61368     - route-target-role
61369     properties:
61370       global-route-target:
61371         type: string
61372         description: Number used to identify an RT, globally unique in the network
61373       route-target-role:
61374         type: string
61375         description: Role assigned to this route target
61376       resource-version:
61377         type: string
61378         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61379       relationship-list:
61380         type: array
61381         items:
61382           $ref: "#/getDefinitions/relationship"
61383   route-targets:
61384     description: |
61385       Collection of route target information
61386     properties:
61387       route-target:
61388         type: array
61389         items:
61390           $ref: "#/getDefinitions/route-target"
61391   routing-instance:
61392     description: |
61393       ###### Related Nodes
61394       - TO site-pair-set( routing-instance BelongsTo site-pair-set, MANY2ONE)(4)
61395       - FROM site-pair( site-pair BelongsTo routing-instance, MANY2ONE)(1)
61396
61397       -(1) IF this ROUTING-INSTANCE node is deleted, this FROM node is DELETED also
61398       -(4) IF this TO node is deleted, this ROUTING-INSTANCE is DELETED also
61399     required:
61400     - routing-instance-id
61401     properties:
61402       routing-instance-id:
61403         type: string
61404         description: Unique id of routing instance
61405       rpm-owner:
61406         type: string
61407         description: rpm owner
61408       resource-version:
61409         type: string
61410         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61411       site-pairs:
61412         type: array
61413         items:
61414           $ref: "#/getDefinitions/site-pair"
61415       relationship-list:
61416         type: array
61417         items:
61418           $ref: "#/getDefinitions/relationship"
61419   routing-instances:
61420     description: |
61421       set of probes related to generic-vnf routing instance
61422     properties:
61423       routing-instance:
61424         type: array
61425         items:
61426           $ref: "#/getDefinitions/routing-instance"
61427   sdn-zone-response:
61428     properties:
61429       oam-networks:
61430         type: object
61431         $ref: "#/getDefinitions/oam-networks"
61432       az-and-dvs-switches:
61433         type: array
61434         items:
61435           $ref: "#/getDefinitions/az-and-dvs-switches"
61436   search:
61437     properties:
61438       edge-tag-query-result:
61439         type: object
61440         $ref: "#/getDefinitions/edge-tag-query-result"
61441       edge-tag-query-request:
61442         type: object
61443         $ref: "#/getDefinitions/edge-tag-query-request"
61444       search-results:
61445         type: object
61446         $ref: "#/getDefinitions/search-results"
61447       sdn-zone-response:
61448         type: object
61449         $ref: "#/getDefinitions/sdn-zone-response"
61450   search-results:
61451     properties:
61452       result-data:
61453         type: array
61454         items:
61455           $ref: "#/getDefinitions/result-data"
61456   secondary-filt:
61457     description: |
61458       SecondaryFilt for performing a named-query or model query
61459   secondary-filter:
61460     properties:
61461       property-name:
61462         type: string
61463       filter-type:
61464         type: string
61465       property-value:
61466         type: string
61467   secondary-filts:
61468     description: |
61469       SecondaryFilts for performing a named-query or model query
61470     properties:
61471       secondary-filt:
61472         type: array
61473         items:
61474           $ref: "#/getDefinitions/secondary-filt"
61475   segmentation-assignment:
61476     description: |
61477       Openstack segmentation assignment.
61478       ###### Related Nodes
61479       - TO l3-network( segmentation-assignment BelongsTo l3-network, MANY2ONE)(4)
61480
61481       -(4) IF this TO node is deleted, this SEGMENTATION-ASSIGNMENT is DELETED also
61482     required:
61483     - segmentation-id
61484     properties:
61485       segmentation-id:
61486         type: string
61487         description: Route Table Reference id, UUID assigned to this instance.
61488       resource-version:
61489         type: string
61490         description: Concurrency value
61491       relationship-list:
61492         type: array
61493         items:
61494           $ref: "#/getDefinitions/relationship"
61495   segmentation-assignments:
61496     description: |
61497       Collection of openstack segmentation assignments
61498     properties:
61499       segmentation-assignment:
61500         type: array
61501         items:
61502           $ref: "#/getDefinitions/segmentation-assignment"
61503   service:
61504     description: |
61505       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
61506     required:
61507     - service-id
61508     - service-description
61509     properties:
61510       service-id:
61511         type: string
61512         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61513       service-description:
61514         type: string
61515         description: Description of the service
61516       service-selflink:
61517         type: string
61518         description: URL to endpoint where AAI can get more details
61519       resource-version:
61520         type: string
61521         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61522       service-version:
61523         type: string
61524         description: service version
61525       relationship-list:
61526         type: array
61527         items:
61528           $ref: "#/getDefinitions/relationship"
61529   service-capabilities:
61530     description: |
61531       Collection of service capabilities.
61532     properties:
61533       service-capability:
61534         type: array
61535         items:
61536           $ref: "#/getDefinitions/service-capability"
61537   service-capability:
61538     description: |
61539       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
61540       ###### Related Nodes
61541       - FROM availability-zone( availability-zone AppliesTo service-capability, MANY2MANY)
61542       - FROM oam-network( oam-network AppliesTo service-capability, MANY2MANY)
61543
61544       -SERVICE-CAPABILITY cannot be deleted if related to AVAILABILITY-ZONE,OAM-NETWORK
61545
61546     required:
61547     - service-type
61548     - vnf-type
61549     properties:
61550       service-type:
61551         type: string
61552         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61553       vnf-type:
61554         type: string
61555         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
61556       resource-version:
61557         type: string
61558         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61559       relationship-list:
61560         type: array
61561         items:
61562           $ref: "#/getDefinitions/relationship"
61563   service-design-and-creation:
61564     description: |
61565       Namespace for objects managed by ASDC
61566     properties:
61567       vnf-images:
61568         type: array
61569         items:
61570           $ref: "#/getDefinitions/vnf-image"
61571       services:
61572         type: array
61573         items:
61574           $ref: "#/getDefinitions/service"
61575       service-capabilities:
61576         type: array
61577         items:
61578           $ref: "#/getDefinitions/service-capability"
61579       models:
61580         type: array
61581         items:
61582           $ref: "#/getDefinitions/model"
61583       named-queries:
61584         type: array
61585         items:
61586           $ref: "#/getDefinitions/named-query"
61587   service-instance:
61588     description: |
61589       Instance of a service
61590       ###### Related Nodes
61591       - TO generic-vnf( service-instance ComposedOf generic-vnf, ONE2MANY)
61592       - TO l3-network( service-instance ComposedOf l3-network, ONE2MANY)
61593       - TO owning-entity( service-instance BelongsTo owning-entity, MANY2ONE)
61594       - TO allotted-resource( service-instance Uses allotted-resource, MANY2MANY)
61595       - TO configuration( service-instance Uses configuration, ONE2MANY)
61596       - TO connector( service-instance Uses connector, MANY2MANY)
61597       - TO ctag-assignment( service-instance Uses ctag-assignment, ONE2MANY)
61598       - TO cvlan-tag( service-instance ComposedOf cvlan-tag, MANY2MANY)
61599       - TO instance-group( service-instance MemberOf instance-group, MANY2MANY)
61600       - TO logical-link( service-instance Uses logical-link, ONE2MANY)(2)
61601       - TO pnf( service-instance ComposedOf pnf, ONE2MANY)
61602       - TO service-instance( service-instance ComposedOf service-instance, ONE2MANY)
61603       - TO vlan( service-instance ComposedOf vlan, ONE2MANY)
61604       - TO zone( service-instance LocatedIn zone, MANY2ONE)
61605       - TO service-subscription( service-instance BelongsTo service-subscription, MANY2ONE)(4)
61606       - TO vce( service-instance ComposedOf vce, ONE2MANY)
61607       - TO model-ver( service-instance IsA model-ver, Many2One)
61608       - FROM project( project Uses service-instance, ONE2MANY)
61609       - FROM allotted-resource( allotted-resource BelongsTo service-instance, MANY2ONE)(1)
61610       - FROM metadatum( metadatum BelongsTo service-instance, MANY2ONE)(1)
61611       - FROM forwarding-path( forwarding-path AppliesTo service-instance, MANY2ONE)(1)
61612       - FROM service-instance( service-instance ComposedOf service-instance, ONE2MANY)
61613
61614       -(1) IF this SERVICE-INSTANCE node is deleted, this FROM node is DELETED also
61615       -(2) IF this SERVICE-INSTANCE node is deleted, this TO node is DELETED also
61616       -(4) IF this TO node is deleted, this SERVICE-INSTANCE is DELETED also
61617     required:
61618     - service-instance-id
61619     properties:
61620       service-instance-id:
61621         type: string
61622         description: Uniquely identifies this instance of a service
61623       service-instance-name:
61624         type: string
61625         description: This field will store a name assigned to the service-instance.
61626       service-type:
61627         type: string
61628         description: String capturing type of service.
61629       service-role:
61630         type: string
61631         description: String capturing the service role.
61632       environment-context:
61633         type: string
61634         description: This field will store the environment context assigned to the service-instance.
61635       workload-context:
61636         type: string
61637         description: This field will store the workload context assigned to the service-instance.
61638       created-at:
61639         type: string
61640         description: create time of Network Service.
61641       updated-at:
61642         type: string
61643         description: last update of Network Service.
61644       description:
61645         type: string
61646         description: short description for service-instance.
61647       model-invariant-id:
61648         type: string
61649         description: the ASDC model id for this resource or service model.
61650       model-version-id:
61651         type: string
61652         description: the ASDC model version for this resource or service model.
61653       persona-model-version:
61654         type: string
61655         description: the ASDC model version for this resource or service model.
61656       widget-model-id:
61657         type: string
61658         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
61659       widget-model-version:
61660         type: string
61661         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
61662       bandwidth-total:
61663         type: string
61664         description: Indicates the total bandwidth to be used for this service.
61665       bandwidth-up-wan1:
61666         type: string
61667         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
61668       bandwidth-down-wan1:
61669         type: string
61670         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
61671       bandwidth-up-wan2:
61672         type: string
61673         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
61674       bandwidth-down-wan2:
61675         type: string
61676         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
61677       vhn-portal-url:
61678         type: string
61679         description: URL customers will use to access the vHN Portal.
61680       service-instance-location-id:
61681         type: string
61682         description: An identifier that customers assign to the location where this service is being used.
61683       resource-version:
61684         type: string
61685         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61686       selflink:
61687         type: string
61688         description: Path to the controller object.
61689       orchestration-status:
61690         type: string
61691         description: Orchestration status of this service.
61692       relationship-list:
61693         type: array
61694         items:
61695           $ref: "#/getDefinitions/relationship"
61696       metadata:
61697         type: array
61698         items:
61699           $ref: "#/getDefinitions/metadatum"
61700       allotted-resources:
61701         type: array
61702         items:
61703           $ref: "#/getDefinitions/allotted-resource"
61704   service-instances:
61705     description: |
61706       Collection of service instances
61707     properties:
61708       service-instance:
61709         type: array
61710         items:
61711           $ref: "#/getDefinitions/service-instance"
61712   service-subscription:
61713     description: |
61714       Object that group service instances.
61715       ###### Related Nodes
61716       - TO customer( service-subscription BelongsTo customer, MANY2ONE)(4)
61717       - TO tenant( service-subscription Uses tenant, MANY2MANY)
61718       - FROM service-instance( service-instance BelongsTo service-subscription, MANY2ONE)(1)
61719
61720       -(1) IF this SERVICE-SUBSCRIPTION node is deleted, this FROM node is DELETED also
61721       -(4) IF this TO node is deleted, this SERVICE-SUBSCRIPTION is DELETED also
61722     required:
61723     - service-type
61724     properties:
61725       service-type:
61726         type: string
61727         description: Value defined by orchestration to identify this service across ECOMP.
61728       temp-ub-sub-account-id:
61729         type: string
61730         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
61731       resource-version:
61732         type: string
61733         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61734       service-instances:
61735         type: array
61736         items:
61737           $ref: "#/getDefinitions/service-instance"
61738       relationship-list:
61739         type: array
61740         items:
61741           $ref: "#/getDefinitions/relationship"
61742   service-subscriptions:
61743     description: |
61744       Collection of objects that group service instances.
61745     properties:
61746       service-subscription:
61747         type: array
61748         items:
61749           $ref: "#/getDefinitions/service-subscription"
61750   services:
61751     description: |
61752       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
61753     properties:
61754       service:
61755         type: array
61756         items:
61757           $ref: "#/getDefinitions/service"
61758   site-pair:
61759     description: |
61760       ###### Related Nodes
61761       - TO routing-instance( site-pair BelongsTo routing-instance, MANY2ONE)(4)
61762       - FROM class-of-service( class-of-service BelongsTo site-pair, MANY2ONE)(1)
61763
61764       -(1) IF this SITE-PAIR node is deleted, this FROM node is DELETED also
61765       -(4) IF this TO node is deleted, this SITE-PAIR is DELETED also
61766     required:
61767     - site-pair-id
61768     properties:
61769       site-pair-id:
61770         type: string
61771         description: unique identifier of probe
61772       source-ip:
61773         type: string
61774         description: Prefix address
61775       destination-ip:
61776         type: string
61777         description: Prefix address
61778       ip-version:
61779         type: string
61780         description: ip version, v4, v6
61781       destination-hostname:
61782         type: string
61783         description: Hostname of the destination equipment to which SLAs are measured against.
61784       destination-equip-type:
61785         type: string
61786         description: The type of destinatination equipment. Could be Router, UCPE, etc.
61787       resource-version:
61788         type: string
61789         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61790       classes-of-service:
61791         type: array
61792         items:
61793           $ref: "#/getDefinitions/class-of-service"
61794       relationship-list:
61795         type: array
61796         items:
61797           $ref: "#/getDefinitions/relationship"
61798   site-pair-set:
61799     description: |
61800       Set of instances for probes used to measure service level agreements
61801       ###### Related Nodes
61802       - TO generic-vnf( site-pair-set AppliesTo generic-vnf, MANY2MANY)
61803       - FROM routing-instance( routing-instance BelongsTo site-pair-set, MANY2ONE)(1)
61804
61805       -(1) IF this SITE-PAIR-SET node is deleted, this FROM node is DELETED also
61806     required:
61807     - site-pair-set-id
61808     properties:
61809       site-pair-set-id:
61810         type: string
61811         description: Unique id of site pair set.
61812       resource-version:
61813         type: string
61814         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61815       routing-instances:
61816         type: array
61817         items:
61818           $ref: "#/getDefinitions/routing-instance"
61819       relationship-list:
61820         type: array
61821         items:
61822           $ref: "#/getDefinitions/relationship"
61823   site-pair-sets:
61824     description: |
61825       Collection of sets of instances for probes related to generic-vnf
61826     properties:
61827       site-pair-set:
61828         type: array
61829         items:
61830           $ref: "#/getDefinitions/site-pair-set"
61831   site-pairs:
61832     description: |
61833       probe within a set
61834     properties:
61835       site-pair:
61836         type: array
61837         items:
61838           $ref: "#/getDefinitions/site-pair"
61839   snapshot:
61840     description: |
61841       Openstack snapshot
61842       ###### Related Nodes
61843       - TO cloud-region( snapshot BelongsTo cloud-region, MANY2ONE)
61844       - FROM vserver( vserver Uses snapshot, ONE2ONE)
61845
61846     required:
61847     - snapshot-id
61848     properties:
61849       snapshot-id:
61850         type: string
61851         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
61852       snapshot-name:
61853         type: string
61854         description: Snapshot name
61855       snapshot-architecture:
61856         type: string
61857         description: Operating system architecture
61858       snapshot-os-distro:
61859         type: string
61860         description: The common name of the operating system distribution in lowercase
61861       snapshot-os-version:
61862         type: string
61863         description: The operating system version as specified by the distributor.
61864       application:
61865         type: string
61866         description: The application that the image instantiates.
61867       application-vendor:
61868         type: string
61869         description: The vendor of the application.
61870       application-version:
61871         type: string
61872         description: The version of the application.
61873       snapshot-selflink:
61874         type: string
61875         description: URL to endpoint where AAI can get more details
61876       prev-snapshot-id:
61877         type: string
61878         description: This field contains the UUID of the previous snapshot (if any).
61879       resource-version:
61880         type: string
61881         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61882       relationship-list:
61883         type: array
61884         items:
61885           $ref: "#/getDefinitions/relationship"
61886   snapshots:
61887     description: |
61888       Collection of openstack snapshots
61889     properties:
61890       snapshot:
61891         type: array
61892         items:
61893           $ref: "#/getDefinitions/snapshot"
61894   sriov-pf:
61895     description: |
61896       SR-IOV Physical Function
61897       ###### Related Nodes
61898       - TO p-interface( sriov-pf BelongsTo p-interface, ONE2ONE)(4)
61899       - FROM sriov-vf( sriov-vf Uses sriov-pf, MANY2ONE)
61900
61901       -(4) IF this TO node is deleted, this SRIOV-PF is DELETED also
61902     required:
61903     - pf-pci-id
61904     properties:
61905       pf-pci-id:
61906         type: string
61907         description: Identifier for the sriov-pf
61908       resource-version:
61909         type: string
61910         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61911       relationship-list:
61912         type: array
61913         items:
61914           $ref: "#/getDefinitions/relationship"
61915   sriov-pfs:
61916     description: |
61917       Collection of SR-IOV Physical Functions.
61918     properties:
61919       sriov-pf:
61920         type: array
61921         items:
61922           $ref: "#/getDefinitions/sriov-pf"
61923   sriov-vf:
61924     description: |
61925       SR-IOV Virtual Function (not to be confused with virtual network function)
61926       ###### Related Nodes
61927       - TO l-interface( sriov-vf BelongsTo l-interface, ONE2ONE)(4)
61928       - TO sriov-pf( sriov-vf Uses sriov-pf, MANY2ONE)
61929
61930       -(4) IF this TO node is deleted, this SRIOV-VF is DELETED also
61931     required:
61932     - pci-id
61933     properties:
61934       pci-id:
61935         type: string
61936         description: PCI ID used to identify the sriov-vf
61937       vf-vlan-filter:
61938         type: string
61939         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
61940       vf-mac-filter:
61941         type: string
61942         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
61943       vf-vlan-strip:
61944         type: boolean
61945         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
61946       vf-vlan-anti-spoof-check:
61947         type: boolean
61948         description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
61949       vf-mac-anti-spoof-check:
61950         type: boolean
61951         description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
61952       vf-mirrors:
61953         type: string
61954         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
61955       vf-broadcast-allow:
61956         type: boolean
61957         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
61958       vf-unknown-multicast-allow:
61959         type: boolean
61960         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
61961       vf-unknown-unicast-allow:
61962         type: boolean
61963         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
61964       vf-insert-stag:
61965         type: boolean
61966         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
61967       vf-link-status:
61968         type: string
61969         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
61970       resource-version:
61971         type: string
61972         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61973       neutron-network-id:
61974         type: string
61975         description: Neutron network id of the interface
61976       relationship-list:
61977         type: array
61978         items:
61979           $ref: "#/getDefinitions/relationship"
61980   sriov-vfs:
61981     description: |
61982       Collection of SR-IOV Virtual Functions.
61983     properties:
61984       sriov-vf:
61985         type: array
61986         items:
61987           $ref: "#/getDefinitions/sriov-vf"
61988   start-node-filter:
61989     properties:
61990       property-name:
61991         type: string
61992       property-value:
61993         type: string
61994   subnet:
61995     description: |
61996       ###### Related Nodes
61997       - TO l3-network( subnet BelongsTo l3-network, MANY2ONE)(4)
61998       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list MemberOf subnet, MANY2MANY)
61999       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list MemberOf subnet, MANY2MANY)
62000       - FROM host-route( host-route BelongsTo subnet, MANY2ONE)(1)
62001       - FROM vip-ipv4-address-list( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
62002       - FROM vip-ipv6-address-list( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
62003
62004       -(1) IF this SUBNET node is deleted, this FROM node is DELETED also
62005       -(4) IF this TO node is deleted, this SUBNET is DELETED also
62006       -SUBNET cannot be deleted if related to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
62007
62008     required:
62009     - subnet-id
62010     - dhcp-enabled
62011     properties:
62012       subnet-id:
62013         type: string
62014         description: Subnet ID, should be UUID.
62015       subnet-name:
62016         type: string
62017         description: Name associated with the subnet.
62018       neutron-subnet-id:
62019         type: string
62020         description: Neutron id of this subnet
62021       gateway-address:
62022         type: string
62023         description: gateway ip address
62024       network-start-address:
62025         type: string
62026         description: network start address
62027       cidr-mask:
62028         type: string
62029         description: cidr mask
62030       ip-version:
62031         type: string
62032         description: ip version
62033       orchestration-status:
62034         type: string
62035         description: Orchestration status of this VNF, mastered by MSO
62036       dhcp-enabled:
62037         type: boolean
62038         description: dhcp enabled
62039       dhcp-start:
62040         type: string
62041         description: the start address reserved for use by dhcp
62042       dhcp-end:
62043         type: string
62044         description: the last address reserved for use by dhcp
62045       subnet-role:
62046         type: string
62047         description: role of the subnet, referenced when assigning IPs
62048       ip-assignment-direction:
62049         type: string
62050         description: ip address assignment direction of the subnet
62051       resource-version:
62052         type: string
62053         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62054       subnet-sequence:
62055         type: integer
62056         format: int32
62057         description: sequence of the subnet
62058       host-routes:
62059         type: array
62060         items:
62061           $ref: "#/getDefinitions/host-route"
62062       relationship-list:
62063         type: array
62064         items:
62065           $ref: "#/getDefinitions/relationship"
62066   subnets:
62067     properties:
62068       subnet:
62069         type: array
62070         items:
62071           $ref: "#/getDefinitions/subnet"
62072   tagged-inventory-item-list:
62073     properties:
62074       inventory-item:
62075         type: array
62076         items:
62077           $ref: "#/getDefinitions/inventory-item"
62078   tenant:
62079     description: |
62080       Openstack tenant
62081       ###### Related Nodes
62082       - TO cloud-region( tenant BelongsTo cloud-region, MANY2ONE)
62083       - TO group-assignment( tenant MemberOf group-assignment, MANY2MANY)
62084       - TO l3-network( tenant Uses l3-network, MANY2MANY)
62085       - TO volume-group( tenant DependsOn volume-group, ONE2MANY)
62086       - FROM service-subscription( service-subscription Uses tenant, MANY2MANY)
62087       - FROM vserver( vserver BelongsTo tenant, MANY2ONE)
62088
62089       -TENANT cannot be deleted if related to VSERVER
62090
62091     required:
62092     - tenant-id
62093     - tenant-name
62094     properties:
62095       tenant-id:
62096         type: string
62097         description: Unique id relative to the cloud-region.
62098       tenant-name:
62099         type: string
62100         description: Readable name of tenant
62101       tenant-context:
62102         type: string
62103         description: This field will store the tenant context.
62104       resource-version:
62105         type: string
62106         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62107       vservers:
62108         type: array
62109         items:
62110           $ref: "#/getDefinitions/vserver"
62111       relationship-list:
62112         type: array
62113         items:
62114           $ref: "#/getDefinitions/relationship"
62115   tenants:
62116     description: |
62117       Collection of openstack tenants.
62118     properties:
62119       tenant:
62120         type: array
62121         items:
62122           $ref: "#/getDefinitions/tenant"
62123   tunnel-xconnect:
62124     description: |
62125       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
62126       ###### Related Nodes
62127       - TO allotted-resource( tunnel-xconnect BelongsTo allotted-resource, ONE2ONE)(4)
62128
62129       -(4) IF this TO node is deleted, this TUNNEL-XCONNECT is DELETED also
62130     required:
62131     - id
62132     properties:
62133       id:
62134         type: string
62135         description: Allotted Resource id UUID assigned to this instance.
62136       bandwidth-up-wan1:
62137         type: string
62138         description: The WAN uplink bandwidth for WAN1
62139       bandwidth-down-wan1:
62140         type: string
62141         description: The WAN downlink bandwidth for WAN1
62142       bandwidth-up-wan2:
62143         type: string
62144         description: The WAN uplink bandwidth for WAN2
62145       bandwidth-down-wan2:
62146         type: string
62147         description: The WAN downlink bandwidth for WAN2
62148       resource-version:
62149         type: string
62150         description: Concurrency value
62151       relationship-list:
62152         type: array
62153         items:
62154           $ref: "#/getDefinitions/relationship"
62155   tunnel-xconnects:
62156     description: |
62157       This object is used to store the specific tunnel cross connect aspects of an allotted resource
62158     properties:
62159       tunnel-xconnect:
62160         type: array
62161         items:
62162           $ref: "#/getDefinitions/tunnel-xconnect"
62163   update:
62164     description: |
62165       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
62166     required:
62167     - update-node-type
62168     properties:
62169       update-node-type:
62170         type: string
62171       update-node-key:
62172         type: array
62173         items:
62174           $ref: "#/getDefinitions/update-node-key"
62175       update-node-uri:
62176         type: string
62177       action:
62178         type: array
62179         items:
62180           $ref: "#/getDefinitions/action"
62181   update-node-key:
62182     properties:
62183       key-name:
62184         type: string
62185       key-value:
62186         type: string
62187   vce:
62188     description: |
62189       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
62190       ###### Related Nodes
62191       - TO availability-zone( vce Uses availability-zone, MANY2MANY)
62192       - TO complex( vce LocatedIn complex, MANY2MANY)
62193       - TO vserver( vce HostedOn vserver, ONE2MANY)
62194       - FROM entitlement( entitlement BelongsTo vce, MANY2ONE)(1)
62195       - FROM license( license BelongsTo vce, MANY2ONE)(1)
62196       - FROM port-group( port-group BelongsTo vce, MANY2ONE)(1)
62197       - FROM service-instance( service-instance ComposedOf vce, ONE2MANY)
62198
62199       -(1) IF this VCE node is deleted, this FROM node is DELETED also
62200     required:
62201     - vnf-id
62202     - vnf-name
62203     - vnf-type
62204     properties:
62205       vnf-id:
62206         type: string
62207         description: Unique id of VNF.  This is unique across the graph.
62208       vnf-name:
62209         type: string
62210         description: Name of VNF.
62211       vnf-name2:
62212         type: string
62213         description: Alternate name of VNF.
62214       vnf-type:
62215         type: string
62216         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
62217       service-id:
62218         type: string
62219         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
62220       regional-resource-zone:
62221         type: string
62222         description: Regional way of organizing pservers, source of truth should define values
62223       prov-status:
62224         type: string
62225         description: Trigger for operational monitoring of this resource by Service Assurance systems.
62226       operational-status:
62227         type: string
62228         description: Indicator for whether the resource is considered operational
62229       license-key:
62230         type: string
62231         description: OBSOLETE -  do not use
62232       equipment-role:
62233         type: string
62234         description: Network role being played by this VNF
62235       orchestration-status:
62236         type: string
62237         description: Orchestration status of this VNF, mastered by MSO
62238       heat-stack-id:
62239         type: string
62240         description: Heat stack id corresponding to this instance, managed by MSO
62241       mso-catalog-key:
62242         type: string
62243         description: Corresponds to the SDN-C catalog id used to configure this VCE
62244       vpe-id:
62245         type: string
62246         description: Unique ID of VPE connected to this VCE.
62247       v6-vce-wan-address:
62248         type: string
62249         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
62250       ipv4-oam-address:
62251         type: string
62252         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
62253       resource-version:
62254         type: string
62255         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62256       ipv4-loopback0-address:
62257         type: string
62258         description: Loopback0 address
62259       entitlement-resource-uuid:
62260         type: string
62261         description: OBSOLETE -  see child relationships
62262       port-groups:
62263         type: array
62264         items:
62265           $ref: "#/getDefinitions/port-group"
62266       licenses:
62267         type: array
62268         items:
62269           $ref: "#/getDefinitions/license"
62270       entitlements:
62271         type: array
62272         items:
62273           $ref: "#/getDefinitions/entitlement"
62274       relationship-list:
62275         type: array
62276         items:
62277           $ref: "#/getDefinitions/relationship"
62278   vces:
62279     description: |
62280       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
62281     properties:
62282       vce:
62283         type: array
62284         items:
62285           $ref: "#/getDefinitions/vce"
62286   vf-module:
62287     description: |
62288       a deployment unit of VNFCs
62289       ###### Related Nodes
62290       - TO generic-vnf( vf-module BelongsTo generic-vnf, MANY2ONE)(4)
62291       - TO l3-network( vf-module DependsOn l3-network, MANY2MANY)
62292       - TO vnfc( vf-module Uses vnfc, ONE2MANY)
62293       - TO volume-group( vf-module Uses volume-group, ONE2ONE)
62294       - TO vserver( vf-module Uses vserver, ONE2MANY)
62295       - TO model-ver( vf-module IsA model-ver, Many2One)
62296
62297       -(4) IF this TO node is deleted, this VF-MODULE is DELETED also
62298       -VF-MODULE cannot be deleted if related to VNFC
62299
62300     required:
62301     - vf-module-id
62302     - is-base-vf-module
62303     properties:
62304       vf-module-id:
62305         type: string
62306         description: Unique ID of vf-module.
62307       vf-module-name:
62308         type: string
62309         description: Name of vf-module
62310       heat-stack-id:
62311         type: string
62312         description: Heat stack id corresponding to this instance.
62313       orchestration-status:
62314         type: string
62315         description: orchestration status of this vf-module, mastered by MSO
62316       is-base-vf-module:
62317         type: boolean
62318         description: used to indicate whether or not this object is base vf module
62319       resource-version:
62320         type: string
62321         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62322       model-invariant-id:
62323         type: string
62324         description: the ASDC model id for this resource or service model.
62325       model-version-id:
62326         type: string
62327         description: the ASDC model version for this resource or service model.
62328       persona-model-version:
62329         type: string
62330         description: the ASDC model version for this resource or service model.
62331       model-customization-id:
62332         type: string
62333         description: captures the id of all the configuration used to customize the resource for the service.
62334       widget-model-id:
62335         type: string
62336         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
62337       widget-model-version:
62338         type: string
62339         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
62340       contrail-service-instance-fqdn:
62341         type: string
62342         description: the Contrail unique ID for a service-instance
62343       module-index:
62344         type: integer
62345         format: int32
62346         description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
62347       selflink:
62348         type: string
62349         description: Path to the controller object.
62350       relationship-list:
62351         type: array
62352         items:
62353           $ref: "#/getDefinitions/relationship"
62354   vf-modules:
62355     description: |
62356       Collection of vf-modules, a deployment unit of VNFCs
62357     properties:
62358       vf-module:
62359         type: array
62360         items:
62361           $ref: "#/getDefinitions/vf-module"
62362   vig-server:
62363     description: |
62364       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
62365       ###### Related Nodes
62366       - TO ipsec-configuration( vig-server BelongsTo ipsec-configuration, MANY2ONE)(4)
62367
62368       -(4) IF this TO node is deleted, this VIG-SERVER is DELETED also
62369     required:
62370     - vig-address-type
62371     properties:
62372       vig-address-type:
62373         type: string
62374         description: indicates whether the VIG is for AVPN or INTERNET
62375       ipaddress-v4-vig:
62376         type: string
62377         description: v4 IP of the vig server
62378       ipaddress-v6-vig:
62379         type: string
62380         description: v6 IP of the vig server
62381       resource-version:
62382         type: string
62383         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62384       relationship-list:
62385         type: array
62386         items:
62387           $ref: "#/getDefinitions/relationship"
62388   vig-servers:
62389     properties:
62390       vig-server:
62391         type: array
62392         items:
62393           $ref: "#/getDefinitions/vig-server"
62394   vip-ipv4-address-list:
62395     description: |
62396       IPv4 Address Range
62397       ###### Related Nodes
62398       - TO cloud-region( vip-ipv4-address-list BelongsTo cloud-region, MANY2ONE)
62399       - TO instance-group( vip-ipv4-address-list MemberOf instance-group, MANY2MANY)
62400       - TO subnet( vip-ipv4-address-list MemberOf subnet, MANY2MANY)
62401       - FROM vnfc( vnfc Uses vip-ipv4-address-list, MANY2MANY)
62402
62403     required:
62404     - vip-ipv4-address
62405     properties:
62406       vip-ipv4-address:
62407         type: string
62408         description: IP address
62409       vip-ipv4-prefix-length:
62410         type: integer
62411         format: int64
62412         description: Prefix length, 32 for single address
62413       vlan-id-inner:
62414         type: integer
62415         format: int64
62416         description: Inner VLAN tag
62417       vlan-id-outer:
62418         type: integer
62419         format: int64
62420         description: Outer VLAN tag
62421       is-floating:
62422         type: boolean
62423         description: Indicator of fixed or floating address
62424       resource-version:
62425         type: string
62426         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62427       neutron-network-id:
62428         type: string
62429         description: Neutron network id of the interface that address belongs to
62430       neutron-subnet-id:
62431         type: string
62432         description: Neutron id of subnet that address belongs to
62433       relationship-list:
62434         type: array
62435         items:
62436           $ref: "#/getDefinitions/relationship"
62437   vip-ipv6-address-list:
62438     description: |
62439       IPv6 Address Range
62440       ###### Related Nodes
62441       - TO cloud-region( vip-ipv6-address-list BelongsTo cloud-region, MANY2ONE)
62442       - TO instance-group( vip-ipv6-address-list MemberOf instance-group, MANY2MANY)
62443       - TO subnet( vip-ipv6-address-list MemberOf subnet, MANY2MANY)
62444       - FROM vnfc( vnfc Uses vip-ipv6-address-list, MANY2MANY)
62445
62446     required:
62447     - vip-ipv6-address
62448     properties:
62449       vip-ipv6-address:
62450         type: string
62451         description: IP address
62452       vip-ipv6-prefix-length:
62453         type: integer
62454         format: int64
62455         description: Prefix length, 128 for single address
62456       vlan-id-inner:
62457         type: integer
62458         format: int64
62459         description: Inner VLAN tag
62460       vlan-id-outer:
62461         type: integer
62462         format: int64
62463         description: Outer VLAN tag
62464       is-floating:
62465         type: boolean
62466         description: Indicator of fixed or floating address
62467       resource-version:
62468         type: string
62469         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62470       neutron-network-id:
62471         type: string
62472         description: Neutron network id of the interface that address belongs to
62473       neutron-subnet-id:
62474         type: string
62475         description: Neutron id of subnet that address belongs to
62476       relationship-list:
62477         type: array
62478         items:
62479           $ref: "#/getDefinitions/relationship"
62480   virtual-data-center:
62481     description: |
62482       Virtual organization of cloud infrastructure elements in a data center context
62483       ###### Related Nodes
62484       - FROM connector( connector LocatedIn virtual-data-center, MANY2MANY)
62485       - FROM generic-vnf( generic-vnf LocatedIn virtual-data-center, MANY2MANY)
62486       - FROM logical-link( logical-link LocatedIn virtual-data-center, MANY2MANY)
62487
62488     required:
62489     - vdc-id
62490     - vdc-name
62491     properties:
62492       vdc-id:
62493         type: string
62494         description: Unique ID of the vdc
62495       vdc-name:
62496         type: string
62497         description: Name of the virtual data center
62498       resource-version:
62499         type: string
62500         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62501       relationship-list:
62502         type: array
62503         items:
62504           $ref: "#/getDefinitions/relationship"
62505   virtual-data-centers:
62506     description: |
62507       Virtual organization of cloud infrastructure elements in a data center context
62508     properties:
62509       virtual-data-center:
62510         type: array
62511         items:
62512           $ref: "#/getDefinitions/virtual-data-center"
62513   vlan:
62514     description: |
62515       Definition of vlan
62516       ###### Related Nodes
62517       - TO l-interface( vlan LinksTo l-interface, MANY2ONE)(4)
62518       - TO logical-link( vlan Uses logical-link, MANY2MANY)(2)
62519       - TO multicast-configuration( vlan Uses multicast-configuration, MANY2MANY)
62520       - FROM allotted-resource( allotted-resource PartOf vlan, MANY2MANY)
62521       - FROM service-instance( service-instance ComposedOf vlan, ONE2MANY)
62522       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vlan, MANY2ONE)(1)
62523       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vlan, MANY2ONE)(1)
62524
62525       -(1) IF this VLAN node is deleted, this FROM node is DELETED also
62526       -(2) IF this VLAN node is deleted, this TO node is DELETED also
62527       -(4) IF this TO node is deleted, this VLAN is DELETED also
62528     required:
62529     - vlan-interface
62530     - in-maint
62531     - is-ip-unnumbered
62532     properties:
62533       vlan-interface:
62534         type: string
62535         description: String that identifies the interface
62536       vlan-id-inner:
62537         type: integer
62538         format: int64
62539         description: Inner VLAN tag
62540       vlan-id-outer:
62541         type: integer
62542         format: int64
62543         description: Outer VLAN tag
62544       resource-version:
62545         type: string
62546         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62547       speed-value:
62548         type: string
62549         description: Captures the numeric part of the speed
62550       speed-units:
62551         type: string
62552         description: Captures the units corresponding to the speed
62553       vlan-description:
62554         type: string
62555         description: Used to describe (the service associated with) the vlan
62556       backdoor-connection:
62557         type: string
62558         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
62559       vpn-key:
62560         type: string
62561         description: This indicates the customers VPN ID associated with this vlan
62562       orchestration-status:
62563         type: string
62564         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
62565       in-maint:
62566         type: boolean
62567         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
62568       prov-status:
62569         type: string
62570         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
62571       is-ip-unnumbered:
62572         type: boolean
62573         description: Flag indicating the interface uses the IP Unnumbered configuration.
62574       relationship-list:
62575         type: array
62576         items:
62577           $ref: "#/getDefinitions/relationship"
62578       l3-interface-ipv4-address-list:
62579         type: array
62580         items:
62581           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
62582       l3-interface-ipv6-address-list:
62583         type: array
62584         items:
62585           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
62586   vlans:
62587     properties:
62588       vlan:
62589         type: array
62590         items:
62591           $ref: "#/getDefinitions/vlan"
62592   vnf:
62593     description: |
62594       Abstract vnf class
62595     required:
62596     - vnf-id
62597     properties:
62598       vnf-id:
62599         type: string
62600         description: Unique id of VNF.  This is unique across the graph.
62601   vnf-image:
62602     description: |
62603       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
62604       ###### Related Nodes
62605       - FROM generic-vnf( generic-vnf Uses vnf-image, MANY2ONE)
62606
62607       -VNF-IMAGE cannot be deleted if related to GENERIC-VNF
62608
62609     required:
62610     - vnf-image-uuid
62611     - application
62612     - application-vendor
62613     properties:
62614       vnf-image-uuid:
62615         type: string
62616         description: Unique ID of this asset
62617       application:
62618         type: string
62619         description: The application that the image instantiates.
62620       application-vendor:
62621         type: string
62622         description: The vendor of the application.
62623       application-version:
62624         type: string
62625         description: The version of the application.
62626       selflink:
62627         type: string
62628         description: URL to endpoint where AAI can get more details
62629       resource-version:
62630         type: string
62631         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62632       relationship-list:
62633         type: array
62634         items:
62635           $ref: "#/getDefinitions/relationship"
62636   vnf-images:
62637     description: |
62638       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
62639     properties:
62640       vnf-image:
62641         type: array
62642         items:
62643           $ref: "#/getDefinitions/vnf-image"
62644   vnfc:
62645     description: |
62646       ###### Related Nodes
62647       - TO generic-vnf( vnfc BelongsTo generic-vnf, MANY2ONE)(4)
62648       - TO instance-group( vnfc MemberOf instance-group, MANY2MANY)
62649       - TO vip-ipv4-address-list( vnfc Uses vip-ipv4-address-list, MANY2MANY)
62650       - TO vip-ipv6-address-list( vnfc Uses vip-ipv6-address-list, MANY2MANY)
62651       - TO vserver( vnfc HostedOn vserver, ONE2MANY)
62652       - FROM vf-module( vf-module Uses vnfc, ONE2MANY)
62653       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list BelongsTo vnfc, MANY2ONE)(1)
62654       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list BelongsTo vnfc, MANY2ONE)(1)
62655
62656       -(1) IF this VNFC node is deleted, this FROM node is DELETED also
62657       -(4) IF this TO node is deleted, this VNFC is DELETED also
62658     required:
62659     - vnfc-name
62660     - nfc-naming-code
62661     - nfc-function
62662     - in-maint
62663     - is-closed-loop-disabled
62664     properties:
62665       vnfc-name:
62666         type: string
62667         description: Unique ID of vnfc.
62668       nfc-naming-code:
62669         type: string
62670         description: Short code that is used in naming instances of the item being modeled
62671       nfc-function:
62672         type: string
62673         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
62674       prov-status:
62675         type: string
62676         description: prov status of this vnfc
62677       orchestration-status:
62678         type: string
62679         description: Orchestration status of this VNF, mastered by APP-C
62680       ipaddress-v4-oam-vip:
62681         type: string
62682         description: Oam V4 vip address of this vnfc
62683       in-maint:
62684         type: boolean
62685         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
62686       is-closed-loop-disabled:
62687         type: boolean
62688         description: used to indicate whether closed loop function is enabled on this node
62689       group-notation:
62690         type: string
62691         description: Group notation of VNFC
62692       model-invariant-id:
62693         type: string
62694         description: the ASDC model id for this resource or service model.
62695       model-version-id:
62696         type: string
62697         description: the ASDC model version for this resource or service model.
62698       resource-version:
62699         type: string
62700         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62701       relationship-list:
62702         type: array
62703         items:
62704           $ref: "#/getDefinitions/relationship"
62705       l3-interface-ipv4-address-list:
62706         type: array
62707         items:
62708           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
62709       l3-interface-ipv6-address-list:
62710         type: array
62711         items:
62712           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
62713   vnfcs:
62714     description: |
62715       virtual network components associated with a vserver from application controller.
62716     properties:
62717       vnfc:
62718         type: array
62719         items:
62720           $ref: "#/getDefinitions/vnfc"
62721   volume:
62722     description: |
62723       Ephemeral Block storage volume.
62724       ###### Related Nodes
62725       - FROM vserver (PARENT of volume, vserver AttachesTo volume)(3)
62726
62727       -(3) IF this FROM node is deleted, this VOLUME is DELETED also
62728     required:
62729     - volume-id
62730     - volume-selflink
62731     properties:
62732       volume-id:
62733         type: string
62734         description: Unique ID of block storage volume relative to the vserver.
62735       volume-selflink:
62736         type: string
62737         description: URL to endpoint where AAI can get more details
62738       resource-version:
62739         type: string
62740         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62741       relationship-list:
62742         type: array
62743         items:
62744           $ref: "#/getDefinitions/relationship"
62745   volume-group:
62746     description: |
62747       Persistent block-level storage.
62748       ###### Related Nodes
62749       - TO cloud-region( volume-group BelongsTo cloud-region, MANY2ONE)
62750       - TO complex( volume-group LocatedIn complex, MANY2ONE)
62751       - FROM generic-vnf( generic-vnf DependsOn volume-group, ONE2MANY)
62752       - FROM vf-module( vf-module Uses volume-group, ONE2ONE)
62753       - FROM tenant( tenant DependsOn volume-group, ONE2MANY)
62754
62755     required:
62756     - volume-group-id
62757     - volume-group-name
62758     - vnf-type
62759     properties:
62760       volume-group-id:
62761         type: string
62762         description: Unique ID of volume-group.
62763       volume-group-name:
62764         type: string
62765         description: Name of the volume group.
62766       heat-stack-id:
62767         type: string
62768         description: Heat stack id corresponding to this volume-group
62769       vnf-type:
62770         type: string
62771         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
62772       orchestration-status:
62773         type: string
62774         description: Orchestration status of this volume-group
62775       model-customization-id:
62776         type: string
62777         description: captures the id of all the configuration used to customize the resource for the service.
62778       vf-module-model-customization-id:
62779         type: string
62780         description: helps relate the volume group to the vf-module whose components will require the volume group
62781       resource-version:
62782         type: string
62783         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62784       relationship-list:
62785         type: array
62786         items:
62787           $ref: "#/getDefinitions/relationship"
62788   volume-groups:
62789     description: |
62790       Collection of persistent block-level storage.
62791     properties:
62792       volume-group:
62793         type: array
62794         items:
62795           $ref: "#/getDefinitions/volume-group"
62796   volumes:
62797     description: |
62798       Collection of ephemeral Block storage volumes.
62799     properties:
62800       volume:
62801         type: array
62802         items:
62803           $ref: "#/getDefinitions/volume"
62804   vpls-pe:
62805     description: |
62806       VPLS Provider Edge routers.
62807       ###### Related Nodes
62808       - TO complex( vpls-pe LocatedIn complex, MANY2ONE)
62809       - TO ctag-pool( vpls-pe Uses ctag-pool, MANY2MANY)
62810       - FROM lag-interface( lag-interface BindsTo vpls-pe, MANY2ONE)(1)
62811       - FROM p-interface( p-interface BindsTo vpls-pe, MANY2ONE)(1)
62812
62813       -(1) IF this VPLS-PE node is deleted, this FROM node is DELETED also
62814     required:
62815     - equipment-name
62816     properties:
62817       equipment-name:
62818         type: string
62819       prov-status:
62820         type: string
62821         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
62822       ipv4-oam-address:
62823         type: string
62824         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
62825       equipment-role:
62826         type: string
62827         description: Client should send valid enumerated value, e.g., VPLS-PE.
62828       vlan-id-outer:
62829         type: integer
62830         format: int64
62831         description: Temporary location for stag to get to VCE
62832       resource-version:
62833         type: string
62834         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62835       relationship-list:
62836         type: array
62837         items:
62838           $ref: "#/getDefinitions/relationship"
62839       p-interfaces:
62840         type: array
62841         items:
62842           $ref: "#/getDefinitions/p-interface"
62843       lag-interfaces:
62844         type: array
62845         items:
62846           $ref: "#/getDefinitions/lag-interface"
62847   vpls-pes:
62848     description: |
62849       Collection of VPLS Provider Edge routers
62850     properties:
62851       vpls-pe:
62852         type: array
62853         items:
62854           $ref: "#/getDefinitions/vpls-pe"
62855   vpn-binding:
62856     description: |
62857       VPN binding
62858       ###### Related Nodes
62859       - FROM allotted-resource( allotted-resource BelongsTo vpn-binding, MANY2MANY)
62860       - FROM l3-network( l3-network Uses vpn-binding, MANY2MANY)
62861       - FROM logical-link( logical-link Uses vpn-binding, MANY2MANY)
62862       - FROM route-target( route-target BelongsTo vpn-binding, MANY2ONE)(1)
62863
62864       -(1) IF this VPN-BINDING node is deleted, this FROM node is DELETED also
62865       -VPN-BINDING cannot be deleted if related to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
62866
62867     required:
62868     - vpn-id
62869     - vpn-name
62870     properties:
62871       vpn-id:
62872         type: string
62873         description: VPN ID, globally unique within A&AI
62874       vpn-name:
62875         type: string
62876         description: VPN Name
62877       vpn-platform:
62878         type: string
62879         description: the platform associated with the VPN example AVPN, Mobility
62880       vpn-type:
62881         type: string
62882         description: Type of the vpn, should be taken from enumerated/valid values
62883       vpn-region:
62884         type: string
62885         description: region of customer vpn
62886       customer-vpn-id:
62887         type: string
62888         description: id for this customer vpn
62889       route-distinguisher:
62890         type: string
62891         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
62892       resource-version:
62893         type: string
62894         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62895       route-targets:
62896         type: array
62897         items:
62898           $ref: "#/getDefinitions/route-target"
62899       relationship-list:
62900         type: array
62901         items:
62902           $ref: "#/getDefinitions/relationship"
62903         description: l3-networks relate to vpn-bindings
62904   vpn-bindings:
62905     properties:
62906       vpn-binding:
62907         type: array
62908         items:
62909           $ref: "#/getDefinitions/vpn-binding"
62910   vserver:
62911     description: |
62912       Virtual Servers, aka virtual machine or VM.
62913       ###### Related Nodes
62914       - TO tenant( vserver BelongsTo tenant, MANY2ONE)
62915       - TO flavor( vserver Uses flavor, MANY2ONE)
62916       - TO image( vserver Uses image, MANY2ONE)
62917       - TO pserver( vserver HostedOn pserver, MANY2ONE)
62918       - TO snapshot( vserver Uses snapshot, ONE2ONE)
62919       - TO volume (CHILD of vserver, vserver AttachesTo volume, ONE2MANY)(2)
62920       - FROM generic-vnf( generic-vnf HostedOn vserver, ONE2MANY)
62921       - FROM vce( vce HostedOn vserver, ONE2MANY)
62922       - FROM l-interface( l-interface BindsTo vserver, MANY2ONE)(1)
62923       - FROM vf-module( vf-module Uses vserver, ONE2MANY)
62924       - FROM vnfc( vnfc HostedOn vserver, ONE2MANY)
62925
62926       -(1) IF this VSERVER node is deleted, this FROM node is DELETED also
62927       -(2) IF this VSERVER node is deleted, this TO node is DELETED also
62928     required:
62929     - vserver-id
62930     - vserver-name
62931     - vserver-selflink
62932     - in-maint
62933     - is-closed-loop-disabled
62934     properties:
62935       vserver-id:
62936         type: string
62937         description: Unique identifier for this vserver relative to its tenant
62938       vserver-name:
62939         type: string
62940         description: Name of vserver
62941       vserver-name2:
62942         type: string
62943         description: Alternative name of vserver
62944       prov-status:
62945         type: string
62946         description: Trigger for operational monitoring of this resource by Service Assurance systems.
62947       vserver-selflink:
62948         type: string
62949         description: URL to endpoint where AAI can get more details
62950       in-maint:
62951         type: boolean
62952         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
62953       is-closed-loop-disabled:
62954         type: boolean
62955         description: Used to indicate whether closed loop function is enabled on this node
62956       resource-version:
62957         type: string
62958         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62959       volumes:
62960         type: array
62961         items:
62962           $ref: "#/getDefinitions/volume"
62963       relationship-list:
62964         type: array
62965         items:
62966           $ref: "#/getDefinitions/relationship"
62967       l-interfaces:
62968         type: array
62969         items:
62970           $ref: "#/getDefinitions/l-interface"
62971   vservers:
62972     description: |
62973       Collection of virtual Servers, aka virtual machines or VMs.
62974     properties:
62975       vserver:
62976         type: array
62977         items:
62978           $ref: "#/getDefinitions/vserver"
62979   zone:
62980     description: |
62981       A zone is a grouping of assets in a location homing to the same connections into the CBB
62982       ###### Related Nodes
62983       - TO complex( zone LocatedIn complex, MANY2ONE)
62984       - FROM cloud-region( cloud-region LocatedIn zone, MANY2ONE)
62985       - FROM pnf( pnf LocatedIn zone, MANY2ONE)
62986       - FROM pserver( pserver LocatedIn zone, MANY2ONE)
62987       - FROM service-instance( service-instance LocatedIn zone, MANY2ONE)
62988
62989     required:
62990     - zone-id
62991     - zone-name
62992     - design-type
62993     - zone-context
62994     properties:
62995       zone-id:
62996         type: string
62997         description: Code assigned by AIC to the zone
62998       zone-name:
62999         type: string
63000         description: English name associated with the zone
63001       design-type:
63002         type: string
63003         description: Design of zone [Medium/Large…]
63004       zone-context:
63005         type: string
63006         description: Context of zone [production/test]
63007       status:
63008         type: string
63009         description: Status of a zone.
63010       resource-version:
63011         type: string
63012         description: Concurrency value
63013       relationship-list:
63014         type: array
63015         items:
63016           $ref: "#/getDefinitions/relationship"
63017   zones:
63018     description: |
63019       Collection of zones
63020     properties:
63021       zone:
63022         type: array
63023         items:
63024           $ref: "#/getDefinitions/zone"