parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
description: Identifier used by the vendor for the region. Second part of composite key
required: true
type: string
+ /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:
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns esr-system-info
+ description: returns esr-system-info
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-system-info"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
+ - name: system-name
+ in: query
+ description: name of external system.
+ required: false
+ type: string
+ - name: system-type
+ in: query
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ required: false
+ type: string
+ put:
+ tags:
+ - CloudInfrastructure
+ summary: create or update an existing esr-system-info
+ description: create or update an existing esr-system-info
+ operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: esr-system-info object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/esr-system-info"
+ delete:
+ tags:
+ - CloudInfrastructure
+ summary: delete an existing esr-system-info
+ description: delete an existing esr-system-info
+ operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list:
+ get:
+ tags:
+ - CloudInfrastructure
+ summary: returns esr-system-info-list
+ description: returns esr-system-info-list
+ operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-system-info-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: cloud-owner
+ in: path
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
+ required: true
+ type: string
+ - name: cloud-region-id
+ in: path
+ description: Identifier used by the vendor for the region. Second part of composite key
+ required: true
+ type: string
+ - name: cloud-type
+ in: query
+ description: Type of the cloud (e.g., openstack)
+ required: false
+ type: string
+ - name: owner-defined-type
+ in: query
+ description: Cloud-owner defined type indicator (e.g., dcp, lcp)
+ required: false
+ type: string
/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
get:
tags:
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
parameters:
- name: cloud-owner
in: path
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
required: true
type: string
- name: cloud-region-id
$ref: "#/definitions/virtual-data-centers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /license-management/license-key-resources/license-key-resource/{att-uuid}/relationship-list/relationship:
+ /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
put:
tags:
- - LicenseManagement
+ - ExternalSystem
summary: see node definition for valid relationships
- operationId: createOrUpdateLicenseManagementLicenseKeyResourcesLicenseKeyResourceRelationshipListRelationship
+ operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
in: path
+ description: Unique ID of esr system info.
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - LicenseManagement
+ - ExternalSystem
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteLicenseManagementLicenseKeyResourcesLicenseKeyResourceRelationshipListRelationship
+ operationId: deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
in: path
+ description: Unique ID of esr system info.
required: true
type: string
- /license-management/license-key-resources/license-key-resource/{att-uuid}:
+ /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
get:
tags:
- - LicenseManagement
- summary: returns license-key-resource
- description: returns license-key-resource
- operationId: getLicenseManagementLicenseKeyResourcesLicenseKeyResource
+ - ExternalSystem
+ summary: returns esr-system-info
+ description: returns esr-system-info
+ operationId: getExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/license-key-resource"
+ $ref: "#/definitions/esr-system-info"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
in: path
+ description: Unique ID of esr system info.
required: true
type: string
- - name: assignment-group-uuid
+ - name: system-name
in: query
+ description: name of external system.
required: false
type: string
- - name: name
+ - name: system-type
in: query
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
required: false
type: string
put:
tags:
- - LicenseManagement
- summary: create or update an existing license-key-resource
- description: create or update an existing license-key-resource
- operationId: createOrUpdateLicenseManagementLicenseKeyResourcesLicenseKeyResource
+ - ExternalSystem
+ summary: create or update an existing esr-system-info
+ description: create or update an existing esr-system-info
+ operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: ems-id
in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
required: true
type: string
- name: body
in: body
- description: license-key-resource object that needs to be created or updated
+ description: esr-system-info object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/license-key-resource"
+ $ref: "#/definitions/esr-system-info"
delete:
tags:
- - LicenseManagement
- summary: delete an existing license-key-resource
- description: delete an existing license-key-resource
- operationId: deleteLicenseManagementLicenseKeyResourcesLicenseKeyResource
+ - ExternalSystem
+ summary: delete an existing esr-system-info
+ description: delete an existing esr-system-info
+ operationId: deleteExternalSystemEsrEmsListEsrEmsEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: att-uuid
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ - name: esr-system-info-id
in: path
+ description: Unique ID of esr system info.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /license-management/license-key-resources:
+ /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list:
get:
tags:
- - LicenseManagement
- summary: returns license-key-resources
- description: returns license-key-resources
- operationId: getLicenseManagementLicenseKeyResources
+ - ExternalSystem
+ summary: returns esr-system-info-list
+ description: returns esr-system-info-list
+ operationId: getExternalSystemEsrEmsListEsrEmsEsrSystemInfoList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/license-key-resources"
+ $ref: "#/definitions/esr-system-info-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
+ type: string
+ /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship:
put:
tags:
- - Business
+ - ExternalSystem
summary: see node definition for valid relationships
- operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
+ operationId: createOrUpdateExternalSystemEsrEmsListEsrEmsRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: ems-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of EMS.
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - Business
+ - ExternalSystem
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
+ operationId: deleteExternalSystemEsrEmsListEsrEmsRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: ems-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of EMS.
required: true
type: string
- /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
+ /external-system/esr-ems-list/esr-ems/{ems-id}:
get:
tags:
- - Business
- summary: returns metadatum
- description: returns metadatum
- operationId: getBusinessConnectorsConnectorMetadataMetadatum
+ - ExternalSystem
+ summary: returns esr-ems
+ description: returns esr-ems
+ operationId: getExternalSystemEsrEmsListEsrEms
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/definitions/esr-ems"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: ems-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of EMS.
required: true
type: string
- - name: metaname
+ put:
+ tags:
+ - ExternalSystem
+ summary: create or update an existing esr-ems
+ description: create or update an existing esr-ems
+ operationId: createOrUpdateExternalSystemEsrEmsListEsrEms
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ems-id
in: path
+ description: Unique ID of EMS.
required: true
type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
+ - name: body
+ in: body
+ description: esr-ems object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/esr-ems"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing esr-ems
+ description: delete an existing esr-ems
+ operationId: deleteExternalSystemEsrEmsListEsrEms
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: ems-id
+ in: path
+ description: Unique ID of EMS.
+ required: true
type: string
- - name: model-version-id
+ - name: resource-version
in: query
- description: the ASDC model version for this resource or service model.
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
- - name: widget-model-id
+ /external-system/esr-ems-list:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-ems-list
+ description: returns esr-ems-list
+ operationId: getExternalSystemEsrEmsList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-ems-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ExternalSystem
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-system-info
+ description: returns esr-system-info
+ operationId: getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-system-info"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
+ type: string
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
+ type: string
+ - name: system-name
in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ description: name of external system.
required: false
type: string
- - name: widget-model-version
+ - name: system-type
in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
required: false
type: string
put:
tags:
- - Business
- summary: create or update an existing metadatum
- description: create or update an existing metadatum
- operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
+ - ExternalSystem
+ summary: create or update an existing esr-system-info
+ description: create or update an existing esr-system-info
+ operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: vnfm-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of VNFM.
required: true
type: string
- - name: metaname
+ - name: esr-system-info-id
in: path
+ description: Unique ID of esr system info.
required: true
type: string
- name: body
in: body
- description: metadatum object that needs to be created or updated
+ description: esr-system-info object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/definitions/esr-system-info"
delete:
tags:
- - Business
- summary: delete an existing metadatum
- description: delete an existing metadatum
- operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
+ - ExternalSystem
+ summary: delete an existing esr-system-info
+ description: delete an existing esr-system-info
+ operationId: deleteExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoListEsrSystemInfo
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: vnfm-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of VNFM.
required: true
type: string
- - name: metaname
+ - name: esr-system-info-id
in: path
+ description: Unique ID of esr system info.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /business/connectors/connector/{resource-instance-id}/metadata:
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list:
get:
tags:
- - Business
- summary: returns metadata
- description: returns metadata
- operationId: getBusinessConnectorsConnectorMetadata
+ - ExternalSystem
+ summary: returns esr-system-info-list
+ description: returns esr-system-info-list
+ operationId: getExternalSystemEsrVnfmListEsrVnfmEsrSystemInfoList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadata"
+ $ref: "#/definitions/esr-system-info-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: vnfm-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of VNFM.
required: true
type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: model-version-id
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ExternalSystem
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteExternalSystemEsrVnfmListEsrVnfmRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfm-id
+ in: path
+ description: Unique ID of VNFM.
+ required: true
type: string
- /business/connectors/connector/{resource-instance-id}:
+ /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}:
get:
tags:
- - Business
- summary: returns connector
- description: returns connector
- operationId: getBusinessConnectorsConnector
+ - ExternalSystem
+ summary: returns esr-vnfm
+ description: returns esr-vnfm
+ operationId: getExternalSystemEsrVnfmListEsrVnfm
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/connector"
+ $ref: "#/definitions/esr-vnfm"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: vnfm-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of VNFM.
required: true
type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: model-version-id
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: widget-model-id
- in: query
- description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
- required: false
- type: string
- - name: widget-model-version
- in: query
- description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
- required: false
- type: string
put:
tags:
- - Business
- summary: create or update an existing connector
- description: create or update an existing connector
- operationId: createOrUpdateBusinessConnectorsConnector
+ - ExternalSystem
+ summary: create or update an existing esr-vnfm
+ description: create or update an existing esr-vnfm
+ operationId: createOrUpdateExternalSystemEsrVnfmListEsrVnfm
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: vnfm-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of VNFM.
required: true
type: string
- name: body
in: body
- description: connector object that needs to be created or updated
+ description: esr-vnfm object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/connector"
+ $ref: "#/definitions/esr-vnfm"
delete:
tags:
- - Business
- summary: delete an existing connector
- description: delete an existing connector
- operationId: deleteBusinessConnectorsConnector
+ - ExternalSystem
+ summary: delete an existing esr-vnfm
+ description: delete an existing esr-vnfm
+ operationId: deleteExternalSystemEsrVnfmListEsrVnfm
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: resource-instance-id
+ - name: vnfm-id
in: path
- description: Unique id of resource instance.
+ description: Unique ID of VNFM.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /business/connectors:
+ /external-system/esr-vnfm-list:
get:
tags:
- - Business
- summary: returns connectors
- description: returns connectors
- operationId: getBusinessConnectors
+ - ExternalSystem
+ summary: returns esr-vnfm-list
+ description: returns esr-vnfm-list
+ operationId: getExternalSystemEsrVnfmList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/connectors"
+ $ref: "#/definitions/esr-vnfm-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
put:
tags:
- - Business
+ - ExternalSystem
summary: see node definition for valid relationships
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
+ operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
+ - name: thirdparty-sdnc-id
in: path
- description: Value defined by orchestration to identify this service across ECOMP.
+ description: Unique ID of SDNC.
required: true
type: string
- - name: service-instance-id
+ - name: esr-system-info-id
in: path
- description: Uniquely identifies this instance of a service
+ description: Unique ID of esr system info.
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - Business
+ - ExternalSystem
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
+ operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
+ - name: thirdparty-sdnc-id
in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
+ description: Unique ID of SDNC.
required: true
type: string
- - name: service-instance-id
+ - name: esr-system-info-id
in: path
- description: Uniquely identifies this instance of a service
+ description: Unique ID of esr system info.
required: true
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
get:
tags:
- - Business
- summary: returns metadatum
- description: returns metadatum
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
+ - ExternalSystem
+ summary: returns esr-system-info
+ description: returns esr-system-info
+ operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/definitions/esr-system-info"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
+ - name: thirdparty-sdnc-id
in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
+ description: Unique ID of SDNC.
required: true
type: string
- - name: service-type
+ - name: esr-system-info-id
in: path
- description: Value defined by orchestration to identify this service across ECOMP.
+ description: Unique ID of esr system info.
required: true
type: string
- - name: service-instance-id
- in: path
- description: Uniquely identifies this instance of a service
- required: true
+ - name: system-name
+ in: query
+ description: name of external system.
+ required: false
type: string
- - name: metaname
+ - name: system-type
+ in: query
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ required: false
+ type: string
+ put:
+ tags:
+ - ExternalSystem
+ summary: create or update an existing esr-system-info
+ description: create or update an existing esr-system-info
+ operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
in: path
+ description: Unique ID of SDNC.
required: true
type: string
- - name: subscriber-name
- in: query
- description: Subscriber name, an alternate way to retrieve a customer.
- required: false
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
type: string
- - name: subscriber-type
- in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
- required: false
+ - name: body
+ in: body
+ description: esr-system-info object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/esr-system-info"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing esr-system-info
+ description: delete an existing esr-system-info
+ operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoListEsrSystemInfo
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
type: string
- - name: service-instance-name
- in: query
- description: This field will store a name assigned to the service-instance.
- required: false
+ - name: esr-system-info-id
+ in: path
+ description: Unique ID of esr system info.
+ required: true
type: string
- - name: environment-context
+ - name: resource-version
in: query
- description: This field will store the environment context assigned to the service-instance.
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
- - name: workload-context
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-system-info-list
+ description: returns esr-system-info-list
+ operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdncEsrSystemInfoList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-system-info-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ExternalSystem
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdncRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-thirdparty-sdnc
+ description: returns esr-thirdparty-sdnc
+ operationId: getExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ put:
+ tags:
+ - ExternalSystem
+ summary: create or update an existing esr-thirdparty-sdnc
+ description: create or update an existing esr-thirdparty-sdnc
+ operationId: createOrUpdateExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: esr-thirdparty-sdnc object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
+ delete:
+ tags:
+ - ExternalSystem
+ summary: delete an existing esr-thirdparty-sdnc
+ description: delete an existing esr-thirdparty-sdnc
+ operationId: deleteExternalSystemEsrThirdpartySdncListEsrThirdpartySdnc
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: thirdparty-sdnc-id
+ in: path
+ description: Unique ID of SDNC.
+ required: true
+ type: string
+ - name: resource-version
in: query
- description: This field will store the workload context assigned to the service-instance.
- required: false
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /external-system/esr-thirdparty-sdnc-list:
+ get:
+ tags:
+ - ExternalSystem
+ summary: returns esr-thirdparty-sdnc-list
+ description: returns esr-thirdparty-sdnc-list
+ operationId: getExternalSystemEsrThirdpartySdncList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/esr-thirdparty-sdnc-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
+ get:
+ tags:
+ - Business
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getBusinessConnectorsConnectorMetadataMetadatum
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/metadatum"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ - name: metaname
+ in: path
+ required: true
type: string
- name: model-invariant-id
in: query
description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
required: false
type: string
- - name: service-instance-location-id
- in: query
- description: An identifier that customers assign to the location where this service is being used.
- required: false
- type: string
- - name: orchestration-status
- in: query
- description: Orchestration status of this service.
- required: false
- type: string
put:
tags:
- Business
summary: create or update an existing metadatum
description: create or update an existing metadatum
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
+ operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
+ - name: resource-instance-id
in: path
- description: Uniquely identifies this instance of a service
+ description: Unique id of resource instance.
required: true
type: string
- name: metaname
- Business
summary: delete an existing metadatum
description: delete an existing metadatum
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
+ operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
+ - name: resource-instance-id
in: path
- description: Uniquely identifies this instance of a service
+ description: Unique id of resource instance.
required: true
type: string
- name: metaname
description: resource-version for concurrency
required: true
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
+ /business/connectors/connector/{resource-instance-id}/metadata:
get:
tags:
- Business
summary: returns metadata
description: returns metadata
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
+ operationId: getBusinessConnectorsConnectorMetadata
produces:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: global-customer-id
- in: path
- description: Global customer id used across ECOMP to uniquely identify customer.
- required: true
- type: string
- - name: service-type
- in: path
- description: Value defined by orchestration to identify this service across ECOMP.
- required: true
- type: string
- - name: service-instance-id
+ - name: resource-instance-id
in: path
- description: Uniquely identifies this instance of a service
+ description: Unique id of resource instance.
required: true
type: string
- - name: subscriber-name
+ - name: model-invariant-id
in: query
- description: Subscriber name, an alternate way to retrieve a customer.
+ description: the ASDC model id for this resource or service model.
required: false
type: string
- - name: subscriber-type
+ - name: model-version-id
in: query
- description: Subscriber type, a way to provide VID with only the INFRA customers.
+ description: the ASDC model version for this resource or service model.
required: false
type: string
- - name: service-instance-name
+ - name: widget-model-id
in: query
- description: This field will store a name assigned to the service-instance.
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
required: false
type: string
- - name: environment-context
+ - name: widget-model-version
in: query
- description: This field will store the environment context assigned to the service-instance.
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
required: false
type: string
- - name: workload-context
- in: query
- description: This field will store the workload context assigned to the service-instance.
- required: false
+ /business/connectors/connector/{resource-instance-id}:
+ get:
+ tags:
+ - Business
+ summary: returns connector
+ description: returns connector
+ operationId: getBusinessConnectorsConnector
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/connector"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
type: string
- name: model-invariant-id
in: query
description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
required: false
type: string
- - name: service-instance-location-id
- in: query
- description: An identifier that customers assign to the location where this service is being used.
- required: false
+ put:
+ tags:
+ - Business
+ summary: create or update an existing connector
+ description: create or update an existing connector
+ operationId: createOrUpdateBusinessConnectorsConnector
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
type: string
- - name: orchestration-status
+ - name: body
+ in: body
+ description: connector object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/connector"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing connector
+ description: delete an existing connector
+ operationId: deleteBusinessConnectorsConnector
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: resource-instance-id
+ in: path
+ description: Unique id of resource instance.
+ required: true
+ type: string
+ - name: resource-version
in: query
- description: Orchestration status of this service.
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
- /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:
+ /business/connectors:
+ get:
+ tags:
+ - Business
+ summary: returns connectors
+ description: returns connectors
+ operationId: getBusinessConnectors
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/connectors"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
put:
tags:
- Business
summary: see node definition for valid relationships
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Uniquely identifies this instance of a service
required: true
type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
- required: true
- type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
- required: true
- type: string
- name: body
in: body
description: relationship object that needs to be created or updated
- Business
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Uniquely identifies this instance of a service
required: true
type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
- required: true
- type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
- required: true
- type: string
- /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}:
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
get:
tags:
- Business
- summary: returns tunnel-xconnect
- description: returns tunnel-xconnect
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/tunnel-xconnect"
+ $ref: "#/definitions/metadatum"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Uniquely identifies this instance of a service
required: true
type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
- required: true
- type: string
- - name: id
+ - name: metaname
in: path
- description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
- name: subscriber-name
description: Orchestration status of this service.
required: false
type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: model-version-id
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: type
- in: query
- description: Generic description of the type of allotted resource.
- required: false
- type: string
- - name: role
- in: query
- description: role in the network that this resource will be providing.
- required: false
- type: string
put:
tags:
- Business
- summary: create or update an existing tunnel-xconnect
- description: create or update an existing tunnel-xconnect
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
+ summary: create or update an existing metadatum
+ description: create or update an existing metadatum
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
consumes:
- application/json
- application/xml
description: Uniquely identifies this instance of a service
required: true
type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
- required: true
- type: string
- - name: id
+ - name: metaname
in: path
- description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
- name: body
in: body
- description: tunnel-xconnect object that needs to be created or updated
+ description: metadatum object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/tunnel-xconnect"
+ $ref: "#/definitions/metadatum"
delete:
tags:
- Business
- summary: delete an existing tunnel-xconnect
- description: delete an existing tunnel-xconnect
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
+ summary: delete an existing metadatum
+ description: delete an existing metadatum
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
consumes:
- application/json
- application/xml
description: Uniquely identifies this instance of a service
required: true
type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
- required: true
- type: string
- - name: id
+ - name: metaname
in: path
- description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /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:
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
get:
tags:
- Business
- summary: returns tunnel-xconnects
- description: returns tunnel-xconnects
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
+ summary: returns metadata
+ description: returns metadata
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/tunnel-xconnects"
+ $ref: "#/definitions/metadata"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Uniquely identifies this instance of a service
required: true
type: string
- - name: id
- in: path
- description: Allotted Resource id UUID assigned to this instance.
- required: true
- type: string
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
description: Orchestration status of this service.
required: false
type: string
- - name: model-invariant-id
- in: query
- description: the ASDC model id for this resource or service model.
- required: false
- type: string
- - name: model-version-id
- in: query
- description: the ASDC model version for this resource or service model.
- required: false
- type: string
- - name: type
- in: query
- description: Generic description of the type of allotted resource.
- required: false
- type: string
- - name: role
- in: query
- description: role in the network that this resource will be providing.
- required: false
- type: string
- /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:
+ /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:
put:
tags:
- Business
summary: see node definition for valid relationships
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: body
in: body
description: relationship object that needs to be created or updated
- Business
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ /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}:
get:
tags:
- Business
- summary: returns allotted-resource
- description: returns allotted-resource
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ summary: returns tunnel-xconnect
+ description: returns tunnel-xconnect
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/allotted-resource"
+ $ref: "#/definitions/tunnel-xconnect"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
put:
tags:
- Business
- summary: create or update an existing allotted-resource
- description: create or update an existing allotted-resource
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ summary: create or update an existing tunnel-xconnect
+ description: create or update an existing tunnel-xconnect
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
consumes:
- application/json
- application/xml
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: body
in: body
- description: allotted-resource object that needs to be created or updated
+ description: tunnel-xconnect object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/allotted-resource"
+ $ref: "#/definitions/tunnel-xconnect"
delete:
tags:
- Business
- summary: delete an existing allotted-resource
- description: delete an existing allotted-resource
- operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ summary: delete an existing tunnel-xconnect
+ description: delete an existing tunnel-xconnect
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
consumes:
- application/json
- application/xml
description: Allotted Resource id UUID assigned to this instance.
required: true
type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: resource-version
in: query
description: resource-version for concurrency
required: true
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
+ /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:
get:
tags:
- Business
- summary: returns allotted-resources
- description: returns allotted-resources
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
+ summary: returns tunnel-xconnects
+ description: returns tunnel-xconnects
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/allotted-resources"
+ $ref: "#/definitions/tunnel-xconnects"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Uniquely identifies this instance of a service
required: true
type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
description: Orchestration status of this service.
required: false
type: string
- /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: type
+ in: query
+ description: Generic description of the type of allotted resource.
+ required: false
+ type: string
+ - name: role
+ in: query
+ description: role in the network that this resource will be providing.
+ required: false
+ type: string
+ /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:
+ put:
+ tags:
+ - Business
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
get:
tags:
- Business
- summary: returns service-instance
- description: returns service-instance
- operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
+ summary: returns allotted-resource
+ description: returns allotted-resource
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-instance"
+ $ref: "#/definitions/allotted-resource"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Uniquely identifies this instance of a service
required: true
type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
- name: subscriber-name
in: query
description: Subscriber name, an alternate way to retrieve a customer.
description: Orchestration status of this service.
required: false
type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: type
+ in: query
+ description: Generic description of the type of allotted resource.
+ required: false
+ type: string
+ - name: role
+ in: query
+ description: role in the network that this resource will be providing.
+ required: false
+ type: string
put:
tags:
- Business
- summary: create or update an existing service-instance
- description: create or update an existing service-instance
- operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
+ summary: create or update an existing allotted-resource
+ description: create or update an existing allotted-resource
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: allotted-resource object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/allotted-resource"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing allotted-resource
+ description: delete an existing allotted-resource
+ operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: id
+ in: path
+ description: Allotted Resource id UUID assigned to this instance.
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
+ get:
+ tags:
+ - Business
+ summary: returns allotted-resources
+ description: returns allotted-resources
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/allotted-resources"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ - name: service-instance-name
+ in: query
+ description: This field will store a name assigned to the service-instance.
+ required: false
+ type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: service-instance-location-id
+ in: query
+ description: An identifier that customers assign to the location where this service is being used.
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
+ get:
+ tags:
+ - Business
+ summary: returns service-instance
+ description: returns service-instance
+ operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/service-instance"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: global-customer-id
+ in: path
+ description: Global customer id used across ECOMP to uniquely identify customer.
+ required: true
+ type: string
+ - name: service-type
+ in: path
+ description: Value defined by orchestration to identify this service across ECOMP.
+ required: true
+ type: string
+ - name: service-instance-id
+ in: path
+ description: Uniquely identifies this instance of a service
+ required: true
+ type: string
+ - name: subscriber-name
+ in: query
+ description: Subscriber name, an alternate way to retrieve a customer.
+ required: false
+ type: string
+ - name: subscriber-type
+ in: query
+ description: Subscriber type, a way to provide VID with only the INFRA customers.
+ required: false
+ type: string
+ - name: service-instance-name
+ in: query
+ description: This field will store a name assigned to the service-instance.
+ required: false
+ type: string
+ - name: environment-context
+ in: query
+ description: This field will store the environment context assigned to the service-instance.
+ required: false
+ type: string
+ - name: workload-context
+ in: query
+ description: This field will store the workload context assigned to the service-instance.
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: service-instance-location-id
+ in: query
+ description: An identifier that customers assign to the location where this service is being used.
+ required: false
+ type: string
+ - name: orchestration-status
+ in: query
+ description: Orchestration status of this service.
+ required: false
+ type: string
+ put:
+ tags:
+ - Business
+ summary: create or update an existing service-instance
+ description: create or update an existing service-instance
+ operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
consumes:
- application/json
- application/xml
$ref: "#/definitions/customers"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
+ /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
put:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
+ operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-image-uuid
+ - name: line-of-business-name
in: path
- description: Unique ID of this asset
+ description: Name of the line-of-business (product)
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
+ operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-image-uuid
+ - name: line-of-business-name
in: path
- description: Unique ID of this asset
+ description: Name of the line-of-business (product)
required: true
type: string
- /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
+ /business/lines-of-business/line-of-business/{line-of-business-name}:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns vnf-image
- description: returns vnf-image
- operationId: getServiceDesignAndCreationVnfImagesVnfImage
+ - Business
+ summary: returns line-of-business
+ description: returns line-of-business
+ operationId: getBusinessLinesOfBusinessLineOfBusiness
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vnf-image"
+ $ref: "#/definitions/line-of-business"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-image-uuid
+ - name: line-of-business-name
in: path
- description: Unique ID of this asset
+ description: Name of the line-of-business (product)
required: true
type: string
- - name: application
- in: query
- description: The application that the image instantiates.
- required: false
- type: string
- - name: application-vendor
- in: query
- description: The vendor of the application.
- required: false
- type: string
- - name: application-version
- in: query
- description: The version of the application.
- required: false
- type: string
put:
tags:
- - ServiceDesignAndCreation
- summary: create or update an existing vnf-image
- description: create or update an existing vnf-image
- operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
+ - Business
+ summary: create or update an existing line-of-business
+ description: create or update an existing line-of-business
+ operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-image-uuid
+ - name: line-of-business-name
in: path
- description: Unique ID of this asset
+ description: Name of the line-of-business (product)
required: true
type: string
- name: body
in: body
- description: vnf-image object that needs to be created or updated
+ description: line-of-business object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/vnf-image"
+ $ref: "#/definitions/line-of-business"
delete:
tags:
- - ServiceDesignAndCreation
- summary: delete an existing vnf-image
- description: delete an existing vnf-image
- operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
+ - Business
+ summary: delete an existing line-of-business
+ description: delete an existing line-of-business
+ operationId: deleteBusinessLinesOfBusinessLineOfBusiness
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-image-uuid
+ - name: line-of-business-name
in: path
- description: Unique ID of this asset
+ description: Name of the line-of-business (product)
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/vnf-images:
+ /business/lines-of-business:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns vnf-images
- description: returns vnf-images
- operationId: getServiceDesignAndCreationVnfImages
+ - Business
+ summary: returns lines-of-business
+ description: returns lines-of-business
+ operationId: getBusinessLinesOfBusiness
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vnf-images"
+ $ref: "#/definitions/lines-of-business"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
+ /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
put:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
+ operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-id
+ - name: owning-entity-id
in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ description: UUID of an owning entity
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
+ operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-id
+ - name: owning-entity-id
in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ description: UUID of an owning entity
required: true
type: string
- /service-design-and-creation/services/service/{service-id}:
+ /business/owning-entities/owning-entity/{owning-entity-id}:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns service
- description: returns service
- operationId: getServiceDesignAndCreationServicesService
+ - Business
+ summary: returns owning-entity
+ description: returns owning-entity
+ operationId: getBusinessOwningEntitiesOwningEntity
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/service"
+ $ref: "#/definitions/owning-entity"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-id
+ - name: owning-entity-id
in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ description: UUID of an owning entity
required: true
type: string
- - name: service-description
- in: query
- description: Description of the service
- required: false
- type: string
put:
tags:
- - ServiceDesignAndCreation
- summary: create or update an existing service
- description: create or update an existing service
- operationId: createOrUpdateServiceDesignAndCreationServicesService
+ - Business
+ summary: create or update an existing owning-entity
+ description: create or update an existing owning-entity
+ operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-id
+ - name: owning-entity-id
in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ description: UUID of an owning entity
required: true
type: string
- name: body
in: body
- description: service object that needs to be created or updated
+ description: owning-entity object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/service"
+ $ref: "#/definitions/owning-entity"
delete:
tags:
- - ServiceDesignAndCreation
- summary: delete an existing service
- description: delete an existing service
- operationId: deleteServiceDesignAndCreationServicesService
+ - Business
+ summary: delete an existing owning-entity
+ description: delete an existing owning-entity
+ operationId: deleteBusinessOwningEntitiesOwningEntity
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-id
+ - name: owning-entity-id
in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
+ description: UUID of an owning entity
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/services:
+ /business/owning-entities:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns services
- description: returns services
- operationId: getServiceDesignAndCreationServices
+ - Business
+ summary: returns owning-entities
+ description: returns owning-entities
+ operationId: getBusinessOwningEntities
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/services"
+ $ref: "#/definitions/owning-entities"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
+ /business/platforms/platform/{platform-name}/relationship-list/relationship:
put:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
+ operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-type
- in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
- required: true
- type: string
- - name: vnf-type
+ - name: platform-name
in: path
- 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.
+ description: Name of the platform
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
+ operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-type
- in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
- required: true
- type: string
- - name: vnf-type
+ - name: platform-name
in: path
- 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.
+ description: Name of the platform
required: true
type: string
- /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
+ /business/platforms/platform/{platform-name}:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns service-capability
- description: returns service-capability
- operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
+ - Business
+ summary: returns platform
+ description: returns platform
+ operationId: getBusinessPlatformsPlatform
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-capability"
+ $ref: "#/definitions/platform"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-type
- in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
- required: true
- type: string
- - name: vnf-type
+ - name: platform-name
in: path
- 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.
+ description: Name of the platform
required: true
type: string
put:
tags:
- - ServiceDesignAndCreation
- summary: create or update an existing service-capability
- description: create or update an existing service-capability
- operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
+ - Business
+ summary: create or update an existing platform
+ description: create or update an existing platform
+ operationId: createOrUpdateBusinessPlatformsPlatform
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-type
- in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
- required: true
- type: string
- - name: vnf-type
+ - name: platform-name
in: path
- 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.
+ description: Name of the platform
required: true
type: string
- name: body
in: body
- description: service-capability object that needs to be created or updated
+ description: platform object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/service-capability"
+ $ref: "#/definitions/platform"
delete:
tags:
- - ServiceDesignAndCreation
- summary: delete an existing service-capability
- description: delete an existing service-capability
- operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
+ - Business
+ summary: delete an existing platform
+ description: delete an existing platform
+ operationId: deleteBusinessPlatformsPlatform
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: service-type
- in: path
- description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
- required: true
- type: string
- - name: vnf-type
+ - name: platform-name
in: path
- 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.
+ description: Name of the platform
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /service-design-and-creation/service-capabilities:
+ /business/platforms:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns service-capabilities
- description: returns service-capabilities
- operationId: getServiceDesignAndCreationServiceCapabilities
+ - Business
+ summary: returns platforms
+ description: returns platforms
+ operationId: getBusinessPlatforms
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/service-capabilities"
+ $ref: "#/definitions/platforms"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /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:
+ /business/projects/project/{project-name}/relationship-list/relationship:
put:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
+ operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
- in: path
- required: true
- type: string
- - name: element-choice-set-uuid
+ - name: project-name
in: path
+ description: Name of the project deploying a service
required: true
type: string
- name: body
$ref: "#/definitions/relationship"
delete:
tags:
- - ServiceDesignAndCreation
+ - Business
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
+ operationId: deleteBusinessProjectsProjectRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- - name: constrained-element-set-uuid
- in: path
- required: true
- type: string
- - name: element-choice-set-uuid
+ - name: project-name
in: path
+ description: Name of the project deploying a service
required: true
type: string
- /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}:
+ /business/projects/project/{project-name}:
get:
tags:
- - ServiceDesignAndCreation
- summary: returns element-choice-set
- description: returns element-choice-set
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ - Business
+ summary: returns project
+ description: returns project
+ operationId: getBusinessProjectsProject
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/element-choice-set"
+ $ref: "#/definitions/project"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
+ - name: project-name
in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
+ description: Name of the project deploying a service
required: true
type: string
- - name: model-version-id
+ put:
+ tags:
+ - Business
+ summary: create or update an existing project
+ description: create or update an existing project
+ operationId: createOrUpdateBusinessProjectsProject
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
in: path
- description: Unique identifier corresponding to one version of a model in ASDC
+ description: Name of the project deploying a service
required: true
type: string
- - name: model-element-uuid
- in: path
+ - name: body
+ in: body
+ description: project object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/project"
+ delete:
+ tags:
+ - Business
+ summary: delete an existing project
+ description: delete an existing project
+ operationId: deleteBusinessProjectsProject
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: project-name
+ in: path
+ description: Name of the project deploying a service
required: true
type: string
- - name: model-constraint-uuid
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /business/projects:
+ get:
+ tags:
+ - Business
+ summary: returns projects
+ description: returns projects
+ operationId: getBusinessProjects
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/projects"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-image-uuid
in: path
+ description: Unique ID of this asset
required: true
type: string
- - name: constrained-element-set-uuid
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-image-uuid
in: path
+ description: Unique ID of this asset
required: true
type: string
- - name: element-choice-set-uuid
+ /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns vnf-image
+ description: returns vnf-image
+ operationId: getServiceDesignAndCreationVnfImagesVnfImage
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/vnf-image"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-image-uuid
in: path
+ description: Unique ID of this asset
required: true
type: string
- - name: model-type
+ - name: application
in: query
- description: Type of the model, e.g., service, resource, widget, etc.
+ description: The application that the image instantiates.
required: false
type: string
- - name: model-name
+ - name: application-vendor
in: query
- description: Name of the model, which can change from version to version.
+ description: The vendor of the application.
required: false
type: string
- - name: model-version
+ - name: application-version
in: query
- description: Version
+ description: The version of the application.
required: false
type: string
put:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing element-choice-set
- description: create or update an existing element-choice-set
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ summary: create or update an existing vnf-image
+ description: create or update an existing vnf-image
+ operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
+ - name: vnf-image-uuid
in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
+ description: Unique ID of this asset
required: true
type: string
- - name: model-version-id
+ - name: body
+ in: body
+ description: vnf-image object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/vnf-image"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing vnf-image
+ description: delete an existing vnf-image
+ operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-image-uuid
in: path
- description: Unique identifier corresponding to one version of a model in ASDC
+ description: Unique ID of this asset
required: true
type: string
- - name: model-element-uuid
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/vnf-images:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns vnf-images
+ description: returns vnf-images
+ operationId: getServiceDesignAndCreationVnfImages
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/vnf-images"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-id
in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: model-constraint-uuid
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-id
in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: constrained-element-set-uuid
+ /service-design-and-creation/services/service/{service-id}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns service
+ description: returns service
+ operationId: getServiceDesignAndCreationServicesService
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/service"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-id
in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: element-choice-set-uuid
+ - name: service-description
+ in: query
+ description: Description of the service
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing service
+ description: create or update an existing service
+ operationId: createOrUpdateServiceDesignAndCreationServicesService
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-id
in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- name: body
in: body
- description: element-choice-set object that needs to be created or updated
+ description: service object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/element-choice-set"
+ $ref: "#/definitions/service"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing element-choice-set
- description: delete an existing element-choice-set
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
+ summary: delete an existing service
+ description: delete an existing service
+ operationId: deleteServiceDesignAndCreationServicesService
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
+ - name: service-id
in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
required: true
type: string
- - name: model-element-uuid
+ /service-design-and-creation/services:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns services
+ description: returns services
+ operationId: getServiceDesignAndCreationServices
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/services"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-type
in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: model-constraint-uuid
+ - name: vnf-type
in: path
+ 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.
required: true
type: string
- - name: constrained-element-set-uuid
- in: path
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
required: true
- type: string
- - name: element-choice-set-uuid
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-type
in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ - name: vnf-type
+ in: path
+ 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.
required: true
type: string
- /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:
+ /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
get:
tags:
- ServiceDesignAndCreation
- summary: returns element-choice-sets
- description: returns element-choice-sets
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
+ summary: returns service-capability
+ description: returns service-capability
+ operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/element-choice-sets"
+ $ref: "#/definitions/service-capability"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: model-invariant-id
+ - name: service-type
in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: model-version-id
+ - name: vnf-type
in: path
- description: Unique identifier corresponding to one version of a model in ASDC
+ 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.
required: true
type: string
- - name: model-element-uuid
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing service-capability
+ description: create or update an existing service-capability
+ operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-type
in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: model-constraint-uuid
+ - name: vnf-type
in: path
+ 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.
required: true
type: string
- - name: constrained-element-set-uuid
+ - name: body
+ in: body
+ description: service-capability object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/service-capability"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing service-capability
+ description: delete an existing service-capability
+ operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: service-type
in: path
+ description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
+ - name: vnf-type
+ in: path
+ 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.
+ required: true
type: string
- - name: model-version
+ - name: resource-version
in: query
- description: Version
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
- /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:
+ /service-design-and-creation/service-capabilities:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns service-capabilities
+ description: returns service-capabilities
+ operationId: getServiceDesignAndCreationServiceCapabilities
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/service-capabilities"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /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:
put:
tags:
- ServiceDesignAndCreation
summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
consumes:
- application/json
- application/xml
in: path
required: true
type: string
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
- name: body
in: body
description: relationship object that needs to be created or updated
- ServiceDesignAndCreation
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
consumes:
- application/json
- application/xml
in: path
required: true
type: string
- /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}:
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
+ /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}:
get:
tags:
- ServiceDesignAndCreation
- summary: returns constrained-element-set
- description: returns constrained-element-set
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
+ summary: returns element-choice-set
+ description: returns element-choice-set
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/constrained-element-set"
+ $ref: "#/definitions/element-choice-set"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
- name: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
put:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing constrained-element-set
- description: create or update an existing constrained-element-set
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
+ summary: create or update an existing element-choice-set
+ description: create or update an existing element-choice-set
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
consumes:
- application/json
- application/xml
in: path
required: true
type: string
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
- name: body
in: body
- description: constrained-element-set object that needs to be created or updated
+ description: element-choice-set object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/constrained-element-set"
+ $ref: "#/definitions/element-choice-set"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing constrained-element-set
- description: delete an existing constrained-element-set
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
+ summary: delete an existing element-choice-set
+ description: delete an existing element-choice-set
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
consumes:
- application/json
- application/xml
in: path
required: true
type: string
+ - name: element-choice-set-uuid
+ in: path
+ required: true
+ type: string
- name: resource-version
in: query
description: resource-version for concurrency
required: true
type: string
- /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:
+ /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:
get:
tags:
- ServiceDesignAndCreation
- summary: returns constrained-element-sets
- description: returns constrained-element-sets
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
+ summary: returns element-choice-sets
+ description: returns element-choice-sets
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/constrained-element-sets"
+ $ref: "#/definitions/element-choice-sets"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
- type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
- type: string
- - name: model-version
- in: query
- description: Version
- required: false
- type: string
- /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}:
- get:
- tags:
- - ServiceDesignAndCreation
- summary: returns model-constraint
- description: returns model-constraint
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/model-constraint"
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: model-invariant-id
- in: path
- description: Unique identifier corresponding to the main definition of a model in ASDC
- required: true
- type: string
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- - name: model-element-uuid
- in: path
- required: true
- type: string
- - name: model-constraint-uuid
+ - name: constrained-element-set-uuid
in: path
required: true
type: string
description: Version
required: false
type: string
+ /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:
put:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing model-constraint
- description: create or update an existing model-constraint
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
consumes:
- application/json
- application/xml
in: path
required: true
type: string
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
- name: body
in: body
- description: model-constraint object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/model-constraint"
+ $ref: "#/definitions/relationship"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing model-constraint
- description: delete an existing model-constraint
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
consumes:
- application/json
- application/xml
in: path
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ - name: constrained-element-set-uuid
+ in: path
required: true
type: string
- /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:
+ /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}:
get:
tags:
- ServiceDesignAndCreation
- summary: returns model-constraints
- description: returns model-constraints
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
+ summary: returns constrained-element-set
+ description: returns constrained-element-set
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-constraints"
+ $ref: "#/definitions/constrained-element-set"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
- name: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
description: Version
required: false
type: string
- /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:
put:
tags:
- ServiceDesignAndCreation
- summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
+ summary: create or update an existing constrained-element-set
+ description: create or update an existing constrained-element-set
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
consumes:
- application/json
- application/xml
in: path
required: true
type: string
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: constrained-element-set object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/constrained-element-set"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
+ summary: delete an existing constrained-element-set
+ description: delete an existing constrained-element-set
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
consumes:
- application/json
- application/xml
in: path
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
+ - name: constrained-element-set-uuid
+ in: path
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /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:
get:
tags:
- ServiceDesignAndCreation
- summary: returns model-element
- description: returns model-element
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
+ summary: returns constrained-element-sets
+ description: returns constrained-element-sets
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-element"
+ $ref: "#/definitions/constrained-element-sets"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
+ - name: model-constraint-uuid
+ in: path
+ required: true
+ type: string
- name: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
description: Version
required: false
type: string
- put:
+ /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}:
+ get:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing model-element
- description: create or update an existing model-element
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
- consumes:
- - application/json
- - application/xml
+ summary: returns model-constraint
+ description: returns model-constraint
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
produces:
- application/json
- application/xml
responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/model-constraint"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
in: path
required: true
type: string
- - name: body
- in: body
- description: model-element object that needs to be created or updated
+ - name: model-constraint-uuid
+ in: path
required: true
- schema:
- $ref: "#/definitions/model-element"
- delete:
+ type: string
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ put:
tags:
- ServiceDesignAndCreation
- summary: delete an existing model-element
- description: delete an existing model-element
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
+ summary: create or update an existing model-constraint
+ description: create or update an existing model-constraint
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
consumes:
- application/json
- application/xml
in: path
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ - name: model-constraint-uuid
+ in: path
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
- get:
+ - name: body
+ in: body
+ description: model-constraint object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/model-constraint"
+ delete:
tags:
- ServiceDesignAndCreation
- summary: returns model-elements
- description: returns model-elements
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
+ summary: delete an existing model-constraint
+ description: delete an existing model-constraint
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/model-elements"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: model-type
- in: query
- description: Type of the model, e.g., service, resource, widget, etc.
- required: false
+ - name: model-element-uuid
+ in: path
+ required: true
type: string
- - name: model-name
- in: query
- description: Name of the model, which can change from version to version.
- required: false
+ - name: model-constraint-uuid
+ in: path
+ required: true
type: string
- - name: model-version
+ - name: resource-version
in: query
- description: Version
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
+ /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:
get:
tags:
- ServiceDesignAndCreation
- summary: returns metadatum
- description: returns metadatum
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ summary: returns model-constraints
+ description: returns model-constraints
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/definitions/model-constraints"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: metaname
+ - name: model-element-uuid
in: path
required: true
type: string
description: Version
required: false
type: string
+ /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:
put:
tags:
- ServiceDesignAndCreation
- summary: create or update an existing metadatum
- description: create or update an existing metadatum
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: metaname
+ - name: model-element-uuid
in: path
required: true
type: string
- name: body
in: body
- description: metadatum object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/metadatum"
+ $ref: "#/definitions/relationship"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing metadatum
- description: delete an existing metadatum
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- - name: metaname
+ - name: model-element-uuid
in: path
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
- required: true
- type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
get:
tags:
- ServiceDesignAndCreation
- summary: returns metadata
- description: returns metadata
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
+ summary: returns model-element
+ description: returns model-element
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/metadata"
+ $ref: "#/definitions/model-element"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
- name: model-type
in: query
description: Type of the model, e.g., service, resource, widget, etc.
description: Version
required: false
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
put:
tags:
- ServiceDesignAndCreation
- summary: see node definition for valid relationships
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
+ summary: create or update an existing model-element
+ description: create or update an existing model-element
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
consumes:
- application/json
- application/xml
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: model-element object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/model-element"
delete:
tags:
- ServiceDesignAndCreation
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
+ summary: delete an existing model-element
+ description: delete an existing model-element
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
consumes:
- application/json
- application/xml
description: Unique identifier corresponding to one version of a model in ASDC
required: true
type: string
- /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
+ - name: model-element-uuid
+ in: path
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
get:
tags:
- ServiceDesignAndCreation
- summary: returns model-ver
- description: returns model-ver
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
+ summary: returns model-elements
+ description: returns model-elements
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/model-ver"
+ $ref: "#/definitions/model-elements"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns metadatum
+ description: returns metadatum
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/metadatum"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: create or update an existing metadatum
+ description: create or update an existing metadatum
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: metadatum object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/metadatum"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing metadatum
+ description: delete an existing metadatum
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: metaname
+ in: path
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns metadata
+ description: returns metadata
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/metadata"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: model-type
+ in: query
+ description: Type of the model, e.g., service, resource, widget, etc.
+ required: false
+ type: string
+ - name: model-name
+ in: query
+ description: Name of the model, which can change from version to version.
+ required: false
+ type: string
+ - name: model-version
+ in: query
+ description: Version
+ required: false
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
+ put:
+ tags:
+ - ServiceDesignAndCreation
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - ServiceDesignAndCreation
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: model-invariant-id
+ in: path
+ description: Unique identifier corresponding to the main definition of a model in ASDC
+ required: true
+ type: string
+ - name: model-version-id
+ in: path
+ description: Unique identifier corresponding to one version of a model in ASDC
+ required: true
+ type: string
+ /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
+ get:
+ tags:
+ - ServiceDesignAndCreation
+ summary: returns model-ver
+ description: returns model-ver
+ operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/model-ver"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
+ operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ - name: cvlan-tag
+ in: path
+ description: See mis-na-virtualization-platform.yang
+ required: true
+ type: integer
+ format: int64
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
+ get:
+ tags:
+ - Network
+ summary: returns cvlan-tag-entry
+ description: returns cvlan-tag-entry
+ operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/cvlan-tag-entry"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ - name: cvlan-tag
+ in: path
+ description: See mis-na-virtualization-platform.yang
+ required: true
+ type: integer
+ format: int64
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ 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.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ - name: port-group-id
+ in: query
+ description: Unique ID for port group in vmware
+ required: false
+ type: string
+ - name: switch-name
+ in: query
+ description: DVS or standard switch name (should be non-null for port groups associated with DVS)
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing cvlan-tag-entry
+ description: create or update an existing cvlan-tag-entry
+ operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ - name: cvlan-tag
+ in: path
+ description: See mis-na-virtualization-platform.yang
+ required: true
+ type: integer
+ format: int64
+ - name: body
+ in: body
+ description: cvlan-tag-entry object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/cvlan-tag-entry"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing cvlan-tag-entry
+ description: delete an existing cvlan-tag-entry
+ operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ - name: cvlan-tag
+ in: path
+ description: See mis-na-virtualization-platform.yang
+ required: true
+ type: integer
+ format: int64
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
+ get:
+ tags:
+ - Network
+ summary: returns cvlan-tags
+ description: returns cvlan-tags
+ operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/cvlan-tags"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ 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.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ - name: port-group-id
+ in: query
+ description: Unique ID for port group in vmware
+ required: false
+ type: string
+ - name: switch-name
+ in: query
+ description: DVS or standard switch name (should be non-null for port groups associated with DVS)
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
+ get:
+ tags:
+ - Network
+ summary: returns port-group
+ description: returns port-group
+ operationId: getNetworkVcesVcePortGroupsPortGroup
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/port-group"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ 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.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ - name: port-group-id
+ in: query
+ description: Unique ID for port group in vmware
+ required: false
+ type: string
+ - name: switch-name
+ in: query
+ description: DVS or standard switch name (should be non-null for port groups associated with DVS)
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing port-group
+ description: create or update an existing port-group
+ operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: port-group object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/port-group"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing port-group
+ description: delete an existing port-group
+ operationId: deleteNetworkVcesVcePortGroupsPortGroup
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ - name: interface-id
+ in: path
+ description: Unique ID of the interface
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vces/vce/{vnf-id}/port-groups:
+ get:
+ tags:
+ - Network
+ summary: returns port-groups
+ description: returns port-groups
+ operationId: getNetworkVcesVcePortGroups
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/port-groups"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ - name: vnf-name
+ in: query
+ description: Name of VNF.
+ required: false
+ type: string
+ - name: vnf-name2
+ in: query
+ description: Alternate name of VNF.
+ required: false
+ type: string
+ - name: vnf-type
+ in: query
+ 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.
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ required: false
+ type: string
+ - name: regional-resource-zone
+ in: query
+ description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: string
+ - name: prov-status
+ in: query
+ description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: vpe-id
+ in: query
+ description: Unique ID of VPE connected to this VCE.
+ required: false
+ type: string
+ /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
+ in: path
+ description: Unique id of VNF. This is unique across the graph.
+ required: true
+ type: string
+ - name: group-uuid
+ in: path
+ description: Unique ID for the license group the resource belongs to, should be uuid.
+ required: true
+ type: string
+ - name: resource-uuid
+ in: path
+ description: Unique ID of a license resource.
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: interface-id
+ - name: group-uuid
in: path
- description: Unique ID of the interface
+ description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
- - name: cvlan-tag
+ - name: resource-uuid
in: path
- description: See mis-na-virtualization-platform.yang
+ description: Unique ID of a license resource.
required: true
- type: integer
- format: int64
- /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
+ type: string
+ /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
get:
tags:
- Network
- summary: returns cvlan-tag-entry
- description: returns cvlan-tag-entry
- operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
+ summary: returns license
+ description: returns license
+ operationId: getNetworkVcesVceLicensesLicense
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/cvlan-tag-entry"
+ $ref: "#/definitions/license"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: interface-id
+ - name: group-uuid
in: path
- description: Unique ID of the interface
+ description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
- - name: cvlan-tag
+ - name: resource-uuid
in: path
- description: See mis-na-virtualization-platform.yang
+ description: Unique ID of a license resource.
required: true
- type: integer
- format: int64
+ type: string
- name: vnf-name
in: query
description: Name of VNF.
description: Unique ID of VPE connected to this VCE.
required: false
type: string
- - name: port-group-id
- in: query
- description: Unique ID for port group in vmware
- required: false
- type: string
- - name: switch-name
- in: query
- description: DVS or standard switch name (should be non-null for port groups associated with DVS)
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
put:
tags:
- Network
- summary: create or update an existing cvlan-tag-entry
- description: create or update an existing cvlan-tag-entry
- operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
+ summary: create or update an existing license
+ description: create or update an existing license
+ operationId: createOrUpdateNetworkVcesVceLicensesLicense
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: interface-id
+ - name: group-uuid
in: path
- description: Unique ID of the interface
+ description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
- - name: cvlan-tag
+ - name: resource-uuid
in: path
- description: See mis-na-virtualization-platform.yang
+ description: Unique ID of a license resource.
required: true
- type: integer
- format: int64
+ type: string
- name: body
in: body
- description: cvlan-tag-entry object that needs to be created or updated
+ description: license object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/cvlan-tag-entry"
+ $ref: "#/definitions/license"
delete:
tags:
- Network
- summary: delete an existing cvlan-tag-entry
- description: delete an existing cvlan-tag-entry
- operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
+ summary: delete an existing license
+ description: delete an existing license
+ operationId: deleteNetworkVcesVceLicensesLicense
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: interface-id
+ - name: group-uuid
in: path
- description: Unique ID of the interface
+ description: Unique ID for the license group the resource belongs to, should be uuid.
required: true
type: string
- - name: cvlan-tag
+ - name: resource-uuid
in: path
- description: See mis-na-virtualization-platform.yang
+ description: Unique ID of a license resource.
required: true
- type: integer
- format: int64
+ type: string
- name: resource-version
in: query
description: resource-version for concurrency
required: true
type: string
- /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
+ /network/vces/vce/{vnf-id}/licenses:
get:
tags:
- Network
- summary: returns cvlan-tags
- description: returns cvlan-tags
- operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
+ summary: returns licenses
+ description: returns licenses
+ operationId: getNetworkVcesVceLicenses
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/cvlan-tags"
+ $ref: "#/definitions/licenses"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: interface-id
- in: path
- description: Unique ID of the interface
- required: true
- type: string
- name: vnf-name
in: query
description: Name of VNF.
description: Unique ID of VPE connected to this VCE.
required: false
type: string
- - name: port-group-id
- in: query
- description: Unique ID for port group in vmware
- required: false
- type: string
- - name: switch-name
- in: query
- description: DVS or standard switch name (should be non-null for port groups associated with DVS)
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
+ /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
+ operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: interface-id
+ - name: group-uuid
in: path
- description: Unique ID of the interface
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
required: true
type: string
- name: body
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
+ operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: interface-id
+ - name: group-uuid
in: path
- description: Unique ID of the interface
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
required: true
type: string
- /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
+ required: true
+ type: string
+ /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
get:
tags:
- Network
- summary: returns port-group
- description: returns port-group
- operationId: getNetworkVcesVcePortGroupsPortGroup
+ summary: returns entitlement
+ description: returns entitlement
+ operationId: getNetworkVcesVceEntitlementsEntitlement
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/port-group"
+ $ref: "#/definitions/entitlement"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: interface-id
+ - name: group-uuid
in: path
- description: Unique ID of the interface
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
required: true
type: string
- name: vnf-name
description: Unique ID of VPE connected to this VCE.
required: false
type: string
- - name: port-group-id
- in: query
- description: Unique ID for port group in vmware
- required: false
- type: string
- - name: switch-name
- in: query
- description: DVS or standard switch name (should be non-null for port groups associated with DVS)
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
put:
tags:
- Network
- summary: create or update an existing port-group
- description: create or update an existing port-group
- operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
+ summary: create or update an existing entitlement
+ description: create or update an existing entitlement
+ operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: interface-id
+ - name: group-uuid
in: path
- description: Unique ID of the interface
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
required: true
type: string
- name: body
in: body
- description: port-group object that needs to be created or updated
+ description: entitlement object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/port-group"
+ $ref: "#/definitions/entitlement"
delete:
tags:
- Network
- summary: delete an existing port-group
- description: delete an existing port-group
- operationId: deleteNetworkVcesVcePortGroupsPortGroup
+ summary: delete an existing entitlement
+ description: delete an existing entitlement
+ operationId: deleteNetworkVcesVceEntitlementsEntitlement
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: interface-id
+ - name: group-uuid
in: path
- description: Unique ID of the interface
+ description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ required: true
+ type: string
+ - name: resource-uuid
+ in: path
+ description: Unique ID of an entitlement resource.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/vces/vce/{vnf-id}/port-groups:
+ /network/vces/vce/{vnf-id}/entitlements:
get:
tags:
- Network
- summary: returns port-groups
- description: returns port-groups
- operationId: getNetworkVcesVcePortGroups
+ summary: returns entitlements
+ description: returns entitlements
+ operationId: getNetworkVcesVceEntitlements
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/port-groups"
+ $ref: "#/definitions/entitlements"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique ID of VPE connected to this VCE.
required: false
type: string
- /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
+ /network/vces/vce/{vnf-id}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
+ operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: group-uuid
- in: path
- description: Unique ID for the license group the resource belongs to, should be uuid.
- required: true
- type: string
- - name: resource-uuid
- in: path
- description: Unique ID of a license resource.
- required: true
- type: string
- name: body
in: body
description: relationship object that needs to be created or updated
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
+ operationId: deleteNetworkVcesVceRelationshipListRelationship
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: group-uuid
- in: path
- description: Unique ID for the license group the resource belongs to, should be uuid.
- required: true
- type: string
- - name: resource-uuid
- in: path
- description: Unique ID of a license resource.
- required: true
- type: string
- /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
+ /network/vces/vce/{vnf-id}:
get:
tags:
- Network
- summary: returns license
- description: returns license
- operationId: getNetworkVcesVceLicensesLicense
+ summary: returns vce
+ description: returns vce
+ operationId: getNetworkVcesVce
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/license"
+ $ref: "#/definitions/vce"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: group-uuid
- in: path
- description: Unique ID for the license group the resource belongs to, should be uuid.
- required: true
- type: string
- - name: resource-uuid
- in: path
- description: Unique ID of a license resource.
- required: true
- type: string
- name: vnf-name
in: query
description: Name of VNF.
put:
tags:
- Network
- summary: create or update an existing license
- description: create or update an existing license
- operationId: createOrUpdateNetworkVcesVceLicensesLicense
+ summary: create or update an existing vce
+ description: create or update an existing vce
+ operationId: createOrUpdateNetworkVcesVce
consumes:
- application/json
- application/xml
description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: group-uuid
+ - name: body
+ in: body
+ description: vce object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/vce"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vce
+ description: delete an existing vce
+ operationId: deleteNetworkVcesVce
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnf-id
in: path
- description: Unique ID for the license group the resource belongs to, should be uuid.
+ description: Unique id of VNF. This is unique across the graph.
required: true
type: string
- - name: resource-uuid
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vces:
+ get:
+ tags:
+ - Network
+ summary: returns vces
+ description: returns vces
+ operationId: getNetworkVces
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/vces"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
in: path
- description: Unique ID of a license resource.
+ description: Unique ID of vnfc.
required: true
type: string
- name: body
in: body
- description: license object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/license"
+ $ref: "#/definitions/relationship"
delete:
tags:
- Network
- summary: delete an existing license
- description: delete an existing license
- operationId: deleteNetworkVcesVceLicensesLicense
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: vnfc-name
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Unique ID of vnfc.
required: true
type: string
- - name: group-uuid
+ /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
in: path
- description: Unique ID for the license group the resource belongs to, should be uuid.
+ description: Unique ID of vnfc.
required: true
type: string
- - name: resource-uuid
+ - name: l3-interface-ipv4-address
in: path
- description: Unique ID of a license resource.
+ description: IP address
required: true
type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vnfc-name
+ in: path
+ description: Unique ID of vnfc.
required: true
type: string
- /network/vces/vce/{vnf-id}/licenses:
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
get:
tags:
- Network
- summary: returns licenses
- description: returns licenses
- operationId: getNetworkVcesVceLicenses
+ summary: returns l3-interface-ipv4-address-list
+ description: returns l3-interface-ipv4-address-list
+ operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/licenses"
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: vnfc-name
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Unique ID of vnfc.
required: true
type: string
- - name: vnf-name
+ - name: l3-interface-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: nfc-naming-code
in: query
- description: Name of VNF.
+ description: Short code that is used in naming instances of the item being modeled
required: false
type: string
- - name: vnf-name2
+ - name: nfc-function
in: query
- description: Alternate name of VNF.
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
required: false
type: string
- - name: vnf-type
+ - name: prov-status
in: query
- 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.
+ description: prov status of this vnfc
required: false
type: string
- - name: service-id
+ - name: ipaddress-v4-oam-vip
in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ description: Oam V4 vip address of this vnfc
required: false
type: string
- - name: regional-resource-zone
+ - name: in-maint
in: query
- description: Regional way of organizing pservers, source of truth should define values
required: false
- type: string
- - name: prov-status
+ type: boolean
+ - name: is-closed-loop-disabled
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
required: false
- type: string
- - name: heat-stack-id
+ type: boolean
+ - name: group-notation
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description: Group notation of VNFC
required: false
type: string
- - name: vpe-id
+ - name: model-invariant-id
in: query
- description: Unique ID of VPE connected to this VCE.
+ description: the ASDC model id for this resource or service model.
required: false
type: string
- /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
- put:
- tags:
- - Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
- consumes:
- - application/json
- - application/xml
- produces:
- - application/json
- - application/xml
- responses:
- "default":
- description: Response codes found in [response codes](https://wiki.onap.org/).
- parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: group-uuid
- in: path
- description: Unique ID for the entitlement group the resource comes from, should be uuid.
- required: true
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
type: string
- - name: resource-uuid
- in: path
- description: Unique ID of an entitlement resource.
- required: true
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
type: string
- - name: body
- in: body
- description: relationship object that needs to be created or updated
- required: true
- schema:
- $ref: "#/definitions/relationship"
- delete:
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
+ summary: create or update an existing l3-interface-ipv4-address-list
+ description: create or update an existing l3-interface-ipv4-address-list
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: vnfc-name
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Unique ID of vnfc.
required: true
type: string
- - name: group-uuid
+ - name: l3-interface-ipv4-address
in: path
- description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ description: IP address
required: true
type: string
- - name: resource-uuid
- in: path
- description: Unique ID of an entitlement resource.
+ - name: body
+ in: body
+ description: l3-interface-ipv4-address-list object that needs to be created or updated
required: true
- type: string
- /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
- get:
+ schema:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ delete:
tags:
- Network
- summary: returns entitlement
- description: returns entitlement
- operationId: getNetworkVcesVceEntitlementsEntitlement
+ summary: delete an existing l3-interface-ipv4-address-list
+ description: delete an existing l3-interface-ipv4-address-list
+ operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
produces:
- application/json
- application/xml
responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/definitions/entitlement"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: group-uuid
+ - name: vnfc-name
in: path
- description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ description: Unique ID of vnfc.
required: true
type: string
- - name: resource-uuid
+ - name: l3-interface-ipv4-address
in: path
- description: Unique ID of an entitlement resource.
+ description: IP address
required: true
type: string
- - name: vnf-name
- in: query
- description: Name of VNF.
- required: false
- type: string
- - name: vnf-name2
- in: query
- description: Alternate name of VNF.
- required: false
- type: string
- - name: vnf-type
- in: query
- 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.
- required: false
- type: string
- - name: service-id
- in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
- required: false
- type: string
- - name: regional-resource-zone
- in: query
- description: Regional way of organizing pservers, source of truth should define values
- required: false
- type: string
- - name: prov-status
- in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
- required: false
- type: string
- - name: heat-stack-id
- in: query
- description: Heat stack id corresponding to this instance, managed by MSO
- required: false
- type: string
- - name: vpe-id
+ - name: resource-version
in: query
- description: Unique ID of VPE connected to this VCE.
- required: false
+ description: resource-version for concurrency
+ required: true
type: string
+ /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
put:
tags:
- Network
- summary: create or update an existing entitlement
- description: create or update an existing entitlement
- operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: group-uuid
+ - name: vnfc-name
in: path
- description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ description: Unique ID of vnfc.
required: true
type: string
- - name: resource-uuid
+ - name: l3-interface-ipv6-address
in: path
- description: Unique ID of an entitlement resource.
+ description: IP address
required: true
type: string
- name: body
in: body
- description: entitlement object that needs to be created or updated
+ description: relationship object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/entitlement"
+ $ref: "#/definitions/relationship"
delete:
tags:
- Network
- summary: delete an existing entitlement
- description: delete an existing entitlement
- operationId: deleteNetworkVcesVceEntitlementsEntitlement
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
- in: path
- description: Unique id of VNF. This is unique across the graph.
- required: true
- type: string
- - name: group-uuid
+ - name: vnfc-name
in: path
- description: Unique ID for the entitlement group the resource comes from, should be uuid.
+ description: Unique ID of vnfc.
required: true
type: string
- - name: resource-uuid
+ - name: l3-interface-ipv6-address
in: path
- description: Unique ID of an entitlement resource.
- required: true
- type: string
- - name: resource-version
- in: query
- description: resource-version for concurrency
+ description: IP address
required: true
type: string
- /network/vces/vce/{vnf-id}/entitlements:
+ /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
get:
tags:
- Network
- summary: returns entitlements
- description: returns entitlements
- operationId: getNetworkVcesVceEntitlements
+ summary: returns l3-interface-ipv6-address-list
+ description: returns l3-interface-ipv6-address-list
+ operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/entitlements"
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: vnfc-name
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Unique ID of vnfc.
required: true
type: string
- - name: vnf-name
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: nfc-naming-code
in: query
- description: Name of VNF.
+ description: Short code that is used in naming instances of the item being modeled
required: false
type: string
- - name: vnf-name2
+ - name: nfc-function
in: query
- description: Alternate name of VNF.
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
required: false
type: string
- - name: vnf-type
+ - name: prov-status
in: query
- 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.
+ description: prov status of this vnfc
required: false
type: string
- - name: service-id
+ - name: ipaddress-v4-oam-vip
in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ description: Oam V4 vip address of this vnfc
required: false
type: string
- - name: regional-resource-zone
+ - name: in-maint
in: query
- description: Regional way of organizing pservers, source of truth should define values
+ required: false
+ type: boolean
+ - name: is-closed-loop-disabled
+ in: query
+ required: false
+ type: boolean
+ - name: group-notation
+ in: query
+ description: Group notation of VNFC
required: false
type: string
- - name: prov-status
+ - name: model-invariant-id
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ description: the ASDC model id for this resource or service model.
required: false
type: string
- - name: heat-stack-id
+ - name: model-version-id
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description: the ASDC model version for this resource or service model.
required: false
type: string
- - name: vpe-id
+ - name: vlan-id-inner
in: query
- description: Unique ID of VPE connected to this VCE.
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
required: false
type: string
- /network/vces/vce/{vnf-id}/relationship-list/relationship:
put:
tags:
- Network
- summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
+ summary: create or update an existing l3-interface-ipv6-address-list
+ description: create or update an existing l3-interface-ipv6-address-list
+ operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: vnfc-name
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Unique ID of vnfc.
+ required: true
+ type: string
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
required: true
type: string
- name: body
in: body
- description: relationship object that needs to be created or updated
+ description: l3-interface-ipv6-address-list object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/relationship"
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
delete:
tags:
- Network
- summary: delete an existing relationship
- description: delete an existing relationship
- operationId: deleteNetworkVcesVceRelationshipListRelationship
+ summary: delete an existing l3-interface-ipv6-address-list
+ description: delete an existing l3-interface-ipv6-address-list
+ operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: vnfc-name
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Unique ID of vnfc.
required: true
type: string
- /network/vces/vce/{vnf-id}:
+ - name: l3-interface-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vnfcs/vnfc/{vnfc-name}:
get:
tags:
- Network
- summary: returns vce
- description: returns vce
- operationId: getNetworkVcesVce
+ summary: returns vnfc
+ description: returns vnfc
+ operationId: getNetworkVnfcsVnfc
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vce"
+ $ref: "#/definitions/vnfc"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: vnfc-name
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Unique ID of vnfc.
required: true
type: string
- - name: vnf-name
+ - name: nfc-naming-code
in: query
- description: Name of VNF.
+ description: Short code that is used in naming instances of the item being modeled
required: false
type: string
- - name: vnf-name2
+ - name: nfc-function
in: query
- description: Alternate name of VNF.
+ description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
required: false
type: string
- - name: vnf-type
+ - name: prov-status
in: query
- 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.
+ description: prov status of this vnfc
required: false
type: string
- - name: service-id
+ - name: ipaddress-v4-oam-vip
in: query
- description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
+ description: Oam V4 vip address of this vnfc
required: false
type: string
- - name: regional-resource-zone
+ - name: in-maint
in: query
- description: Regional way of organizing pservers, source of truth should define values
required: false
- type: string
- - name: prov-status
+ type: boolean
+ - name: is-closed-loop-disabled
in: query
- description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ required: false
+ type: boolean
+ - name: group-notation
+ in: query
+ description: Group notation of VNFC
required: false
type: string
- - name: heat-stack-id
+ - name: model-invariant-id
in: query
- description: Heat stack id corresponding to this instance, managed by MSO
+ description: the ASDC model id for this resource or service model.
required: false
type: string
- - name: vpe-id
+ - name: model-version-id
in: query
- description: Unique ID of VPE connected to this VCE.
+ description: the ASDC model version for this resource or service model.
required: false
type: string
put:
tags:
- Network
- summary: create or update an existing vce
- description: create or update an existing vce
- operationId: createOrUpdateNetworkVcesVce
+ summary: create or update an existing vnfc
+ description: create or update an existing vnfc
+ operationId: createOrUpdateNetworkVnfcsVnfc
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: vnfc-name
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Unique ID of vnfc.
required: true
type: string
- name: body
in: body
- description: vce object that needs to be created or updated
+ description: vnfc object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/vce"
+ $ref: "#/definitions/vnfc"
delete:
tags:
- Network
- summary: delete an existing vce
- description: delete an existing vce
- operationId: deleteNetworkVcesVce
+ summary: delete an existing vnfc
+ description: delete an existing vnfc
+ operationId: deleteNetworkVnfcsVnfc
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnf-id
+ - name: vnfc-name
in: path
- description: Unique id of VNF. This is unique across the graph.
+ description: Unique ID of vnfc.
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/vces:
+ /network/vnfcs:
get:
tags:
- Network
- summary: returns vces
- description: returns vces
- operationId: getNetworkVces
+ summary: returns vnfcs
+ description: returns vnfcs
+ operationId: getNetworkVnfcs
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vces"
+ $ref: "#/definitions/vnfcs"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
- /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
put:
tags:
- Network
summary: see node definition for valid relationships
- operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfc-name
+ - name: network-id
in: path
- description: Unique ID of vnfc.
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ - name: host-route-id
+ in: path
+ description: host-route id
required: true
type: string
- name: body
- Network
summary: delete an existing relationship
description: delete an existing relationship
- operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
+ operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfc-name
+ - name: network-id
in: path
- description: Unique ID of vnfc.
+ description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- /network/vnfcs/vnfc/{vnfc-name}:
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ - name: host-route-id
+ in: path
+ description: host-route id
+ required: true
+ type: string
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
get:
tags:
- Network
- summary: returns vnfc
- description: returns vnfc
- operationId: getNetworkVnfcsVnfc
+ summary: returns host-route
+ description: returns host-route
+ operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vnfc"
+ $ref: "#/definitions/host-route"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfc-name
+ - name: network-id
in: path
- description: Unique ID of vnfc.
+ description: Network ID, should be uuid. Unique across A&AI.
required: true
type: string
- - name: nfc-naming-code
- in: query
- description: Short code that is used in naming instances of the item being modeled
- required: false
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
type: string
- - name: nfc-function
- in: query
- description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
- required: false
+ - name: host-route-id
+ in: path
+ description: host-route id
+ required: true
type: string
- - name: prov-status
+ - name: network-name
in: query
- description: prov status of this vnfc
+ description: Name of the network, governed by some naming convention..
required: false
type: string
- - name: ipaddress-v4-oam-vip
+ - name: network-role
in: query
- description: Oam V4 vip address of this vnfc
+ description: Role the network plans - who defines these values?
required: false
type: string
- - name: in-maint
+ - name: service-id
in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
required: false
- type: boolean
- - name: is-closed-loop-disabled
+ type: string
+ - name: heat-stack-id
in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
required: false
- type: boolean
- - name: group-notation
+ type: string
+ - name: contrail-network-fqdn
in: query
- description: Group notation of VNFC
+ description: Contrail FQDN for the network
required: false
type: string
- name: model-invariant-id
description: the ASDC model version for this resource or service model.
required: false
type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: subnet-name
+ in: query
+ description: Name associated with the subnet.
+ required: false
+ type: string
put:
tags:
- Network
- summary: create or update an existing vnfc
- description: create or update an existing vnfc
- operationId: createOrUpdateNetworkVnfcsVnfc
+ summary: create or update an existing host-route
+ description: create or update an existing host-route
+ operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfc-name
+ - name: network-id
in: path
- description: Unique ID of vnfc.
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ - name: host-route-id
+ in: path
+ description: host-route id
required: true
type: string
- name: body
in: body
- description: vnfc object that needs to be created or updated
+ description: host-route object that needs to be created or updated
required: true
schema:
- $ref: "#/definitions/vnfc"
+ $ref: "#/definitions/host-route"
delete:
tags:
- Network
- summary: delete an existing vnfc
- description: delete an existing vnfc
- operationId: deleteNetworkVnfcsVnfc
+ summary: delete an existing host-route
+ description: delete an existing host-route
+ operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
consumes:
- application/json
- application/xml
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
parameters:
- - name: vnfc-name
+ - name: network-id
in: path
- description: Unique ID of vnfc.
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ - name: host-route-id
+ in: path
+ description: host-route id
required: true
type: string
- name: resource-version
description: resource-version for concurrency
required: true
type: string
- /network/vnfcs:
+ /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
get:
tags:
- Network
- summary: returns vnfcs
- description: returns vnfcs
- operationId: getNetworkVnfcs
+ summary: returns host-routes
+ description: returns host-routes
+ operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
produces:
- application/json
- application/xml
"200":
description: successful operation
schema:
- $ref: "#/definitions/vnfcs"
+ $ref: "#/definitions/host-routes"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: network-id
+ in: path
+ description: Network ID, should be uuid. Unique across A&AI.
+ required: true
+ type: string
+ - name: subnet-id
+ in: path
+ description: Subnet ID, should be UUID.
+ required: true
+ type: string
+ - name: network-name
+ in: query
+ description: Name of the network, governed by some naming convention..
+ required: false
+ type: string
+ - name: network-role
+ in: query
+ description: Role the network plans - who defines these values?
+ required: false
+ type: string
+ - name: service-id
+ in: query
+ description: Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
+ required: false
+ type: string
+ - name: heat-stack-id
+ in: query
+ description: Heat stack id corresponding to this instance, managed by MSO
+ required: false
+ type: string
+ - name: contrail-network-fqdn
+ in: query
+ description: Contrail FQDN for the network
+ required: false
+ type: string
+ - name: model-invariant-id
+ in: query
+ description: the ASDC model id for this resource or service model.
+ required: false
+ type: string
+ - name: model-version-id
+ in: query
+ description: the ASDC model version for this resource or service model.
+ required: false
+ type: string
+ - name: widget-model-id
+ in: query
+ description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
+ required: false
+ type: string
+ - name: widget-model-version
+ in: query
+ description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
+ required: false
+ type: string
+ - name: subnet-name
+ in: query
+ description: Name associated with the subnet.
+ required: false
+ type: string
/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
put:
tags:
$ref: "#/definitions/zones"
"default":
description: Response codes found in [response codes](https://wiki.onap.org/).
+ /network/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVipIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVipIpv4AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ /network/vip-ipv4-address-list/{vip-ipv4-address}:
+ get:
+ tags:
+ - Network
+ summary: returns vip-ipv4-address-list
+ description: returns vip-ipv4-address-list
+ operationId: getNetworkVipIpv4AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/vip-ipv4-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vip-ipv4-address-list
+ description: create or update an existing vip-ipv4-address-list
+ operationId: createOrUpdateNetworkVipIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: vip-ipv4-address-list object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/vip-ipv4-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vip-ipv4-address-list
+ description: delete an existing vip-ipv4-address-list
+ operationId: deleteNetworkVipIpv4AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv4-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
+ /network/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
+ put:
+ tags:
+ - Network
+ summary: see node definition for valid relationships
+ operationId: createOrUpdateNetworkVipIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: relationship object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/relationship"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing relationship
+ description: delete an existing relationship
+ operationId: deleteNetworkVipIpv6AddressListRelationshipListRelationship
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ /network/vip-ipv6-address-list/{vip-ipv6-address}:
+ get:
+ tags:
+ - Network
+ summary: returns vip-ipv6-address-list
+ description: returns vip-ipv6-address-list
+ operationId: getNetworkVipIpv6AddressList
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "200":
+ description: successful operation
+ schema:
+ $ref: "#/definitions/vip-ipv6-address-list"
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: vlan-id-inner
+ in: query
+ description: Inner VLAN tag
+ required: false
+ type: integer
+ format: int64
+ - name: neutron-network-id
+ in: query
+ description: Neutron network id of the interface that address belongs to
+ required: false
+ type: string
+ - name: neutron-subnet-id
+ in: query
+ description: Neutron id of subnet that address belongs to
+ required: false
+ type: string
+ put:
+ tags:
+ - Network
+ summary: create or update an existing vip-ipv6-address-list
+ description: create or update an existing vip-ipv6-address-list
+ operationId: createOrUpdateNetworkVipIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: body
+ in: body
+ description: vip-ipv6-address-list object that needs to be created or updated
+ required: true
+ schema:
+ $ref: "#/definitions/vip-ipv6-address-list"
+ delete:
+ tags:
+ - Network
+ summary: delete an existing vip-ipv6-address-list
+ description: delete an existing vip-ipv6-address-list
+ operationId: deleteNetworkVipIpv6AddressList
+ consumes:
+ - application/json
+ - application/xml
+ produces:
+ - application/json
+ - application/xml
+ responses:
+ "default":
+ description: Response codes found in [response codes](https://wiki.onap.org/).
+ parameters:
+ - name: vip-ipv6-address
+ in: path
+ description: IP address
+ required: true
+ type: string
+ - name: resource-version
+ in: query
+ description: resource-version for concurrency
+ required: true
+ type: string
definitions:
search:
properties:
ctag-pool:
description: |
A collection of C tags (vlan tags) grouped for a specific purpose.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO availability-zone (Many2Many)
- FROM complex (is composed of ctag-pool)
complex:
description: |
Collection of physical locations that can house cloud-regions.
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO ctag-pool (comprises complex, Many2Many)
- TO l3-network (Many2Many)
volume-group:
description: |
Persistent block-level storage.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO complex (Many2Many)
- TO tenant (Many2Many)
volume:
description: |
Ephemeral Block storage volume.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM vserver (is composed of volume)
required:
l3-interface-ipv4-address-list:
description: |
IPv4 Address Range
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO instance-group (Many2Many)
- TO l3-network (Many2Many)
- TO subnet (Many2Many)
+ - TO vnfc (is composed of l3-interface-ipv4-address-list, Many2One)
- FROM l-interface (is composed of l3-interface-ipv4-address-list)
- FROM vlan (is composed of l3-interface-ipv4-address-list)
required:
l3-interface-ipv6-address-list:
description: |
IPv6 Address Range
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO instance-group (Many2Many)
- TO l3-network (Many2Many)
- TO subnet (Many2Many)
+ - TO vnfc (is composed of l3-interface-ipv6-address-list, Many2One)
- FROM l-interface (is composed of l3-interface-ipv6-address-list)
- FROM vlan (is composed of l3-interface-ipv6-address-list)
required:
vlan:
description: |
Definition of vlan
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO l3-interface-ipv4-address-list (comprises vlan, Many2Many)
- TO l3-interface-ipv6-address-list (comprises vlan, Many2Many)
sriov-vf:
description: |
SR-IOV Virtual Function (not to be confused with virtual network function)
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO sriov-pf (Many2One)
- FROM l-interface (is composed of sriov-vf)
l-interface:
description: |
Logical interfaces, e.g., a vnic.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO instance-group (Many2Many)
- TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
is-ip-unnumbered:
type: boolean
+ allowed-address-pairs:
+ type: string
+ description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
vlans:
type: array
items:
vserver:
description: |
Virtual Servers, aka virtual machine or VM.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO flavor (Many2One)
- TO image (Many2One)
tenant:
description: |
Openstack tenant
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO l3-network (Many2Many)
- TO service-subscription (Many2Many)
flavor:
description: |
Openstack flavor.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- FROM cloud-region (is composed of flavor)
- FROM vserver
group-assignment:
description: |
Openstack group-assignment used to store exclusivity groups (EG).
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO tenant (Many2Many)
- TO pserver (One2Many)
snapshot:
description: |
Openstack snapshot
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM cloud-region (is composed of snapshot)
- FROM vserver
metadatum:
description: |
Key/value pairs
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
+ - FROM configuration (is composed of metadatum)
- FROM image (is composed of metadatum)
- FROM model-ver (is composed of metadatum)
- FROM service-instance (is composed of metadatum)
metadata:
description: |
Collection of metadatum (key/value pairs)
- ###### Default Delete Scope
- THIS_NODE_ONLY
properties:
metadatum:
type: array
image:
description: |
Openstack image.
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO metadatum (comprises image, Many2Many)
- FROM cloud-region (is composed of image)
dvs-switch:
description: |
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.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO availability-zone (Many2Many)
- FROM cloud-region (is composed of dvs-switch)
oam-network:
description: |
OAM network, to be deprecated shortly. Do not use for new purposes.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- TO complex (Many2Many)
- TO service-capability (Many2Many)
availability-zone:
description: |
Availability zone, a collection of compute hosts/pservers
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- TO complex (Many2Many)
- TO service-capability (Many2Many)
type: array
items:
$ref: "#/definitions/availability-zone"
+ esr-system-info:
+ description: |
+ Persist common address information of external systems.
+ ###### Related Nodes
+ - FROM esr-ems (is composed of esr-system-info)
+ - FROM esr-vnfm (is composed of esr-system-info)
+ - FROM esr-thirdparty-sdnc (is composed of esr-system-info)
+ - FROM cloud-region (is composed of esr-system-info)
+ required:
+ - esr-system-info-id
+ - user-name
+ - password
+ - system-type
+ properties:
+ esr-system-info-id:
+ type: string
+ description: Unique ID of esr system info.
+ system-name:
+ type: string
+ description: name of external system.
+ type:
+ type: string
+ description: type of external systems.
+ vendor:
+ type: string
+ description: vendor of external systems.
+ version:
+ type: string
+ description: version of external systems.
+ service-url:
+ type: string
+ description: url used to access external systems.
+ user-name:
+ type: string
+ description: username used to access external systems.
+ password:
+ type: string
+ description: password used to access external systems.
+ system-type:
+ type: string
+ description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
+ protocol:
+ type: string
+ description: protocol of third party SDNC, for example netconf/snmp.
+ ssl-cacert:
+ type: string
+ description: ca file content if enabled ssl on auth-url.
+ ssl-insecure:
+ type: boolean
+ description: Whether to verify VIM's certificate.
+ ip-address:
+ type: string
+ description: service IP of ftp server.
+ port:
+ type: string
+ description: service port of ftp server.
+ cloud-domain:
+ type: string
+ description: domain info for authentication.
+ default-tenant:
+ type: string
+ description: default tenant of VIM.
+ passive:
+ type: boolean
+ description: ftp passive mode or not.
+ remote-path:
+ type: string
+ description: resource or performance data file path.
+ system-status:
+ type: string
+ description: the status of external system.
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ esr-system-info-list:
+ description: |
+ Collection of persistent block-level external system auth info.
+ properties:
+ esr-system-info:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
cloud-region:
description: |
- cloud-region designates an installation of a cloud cluster or region or instantiation. In AT&Ts AIC cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname and we will use att-aic for AT&T's AIC.
- ###### Default Delete Scope
- THIS_NODE_ONLY
+ cloud-region designates an installation of a cloud cluster or region or instantiation.
###### Related Nodes
+ - TO esr-system-info (comprises cloud-region, One2Many)
- TO complex (Many2One)
- TO l3-network (Many2Many)
- TO tenant (comprises cloud-region, One2Many)
properties:
cloud-owner:
type: string
- description: Identifies the vendor and cloud name, e.g., att-aic. First part of composite key should be formatted as vendor-cloudname
+ description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id:
type: string
description: Identifier used by the vendor for the region. Second part of composite key
description: complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
sriov-automation:
type: boolean
+ cloud-extra-info:
+ type: string
+ description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
+ cloud-epa-caps:
+ type: string
+ description: MultiVIM will discover and expose EPA capabilities.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
type: array
items:
$ref: "#/definitions/relationship"
+ esr-system-info-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
cloud-regions:
properties:
cloud-region:
network-profile:
description: |
Network profile populated by SDN-GP for SNMP
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM generic-vnf
required:
sriov-pf:
description: |
SR-IOV Physical Function
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM p-interface (is composed of sriov-pf)
- FROM sriov-vf
p-interface:
description: |
Physical interface (e.g., nic)
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO l-interface (comprises p-interface, Many2Many)
- TO physical-link (Many2Many)
prov-status:
type: string
description: Trigger for operational monitoring of this resource by Service Assurance systems.
+ mac-addresss:
+ type: string
+ description: MAC Address of the p-interface.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
lag-interface:
description: |
Link aggregate interface
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO logical-link (Many2Many)
- TO lag-link (Many2Many)
pserver:
description: |
Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO complex (Many2One)
- TO cloud-region (Many2One)
virtual-data-center:
description: |
Virtual organization of cloud infrastructure elements in a data center context
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO generic-vnf (Many2Many)
- TO logical-link (Many2Many)
type: array
items:
$ref: "#/definitions/virtual-data-center"
- license-key-resource:
+ esr-ems:
description: |
- OBSOLETE OBJECT: do not use
+ Persist EMS address information used by EMS driver.
###### Related Nodes
- - FROM generic-vnf
+ - TO esr-system-info (comprises esr-ems, One2Many)
required:
- - att-uuid
- - assignment-group-uuid
+ - ems-id
properties:
- att-uuid:
- type: string
- assignment-type:
- type: string
- assignment-status:
+ ems-id:
type: string
- assignment-group-uuid:
+ description: Unique ID of EMS.
+ resource-version:
type: string
- assignment-date:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ esr-ems-list:
+ properties:
+ esr-ems:
+ type: array
+ items:
+ $ref: "#/definitions/esr-ems"
+ esr-vnfm:
+ description: |
+ Persist VNFM address information used by VF-C.
+ ###### Related Nodes
+ - TO esr-system-info (comprises esr-vnfm, One2One)
+ required:
+ - vnfm-id
+ properties:
+ vnfm-id:
type: string
- name:
+ description: Unique ID of VNFM.
+ vim-id:
type: string
- model-uuid:
+ description: indecate the VIM to deploy VNF.
+ certificate-url:
type: string
- model-version:
+ description: certificate url of VNFM.
+ resource-version:
type: string
- license-key:
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ esr-vnfm-list:
+ properties:
+ esr-vnfm:
+ type: array
+ items:
+ $ref: "#/definitions/esr-vnfm"
+ esr-thirdparty-sdnc:
+ description: |
+ Persist SDNC address information used by ONAP SDNC.
+ ###### Related Nodes
+ - TO esr-system-info (comprises esr-thirdparty-sdnc, One2One)
+ - TO pnf (One2Many)
+ required:
+ - thirdparty-sdnc-id
+ properties:
+ thirdparty-sdnc-id:
type: string
- license-key-file-url:
+ description: Unique ID of SDNC.
+ location:
type: string
- supplier-release-list:
+ description: used for DC type to indicate the location of SDNC, such as Core or Edge.
+ product-name:
type: string
+ description: password used to access SDNC server.
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ esr-system-info-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-system-info"
relationship-list:
type: array
items:
$ref: "#/definitions/relationship"
- license-key-resources:
+ esr-thirdparty-sdnc-list:
properties:
- license-key-resource:
+ esr-thirdparty-sdnc:
type: array
items:
- $ref: "#/definitions/license-key-resource"
- license-management:
+ $ref: "#/definitions/esr-thirdparty-sdnc"
+ external-system:
+ description: |
+ Namespace for external system.
properties:
- license-key-resources:
+ esr-ems-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-ems"
+ esr-vnfm-list:
+ type: array
+ items:
+ $ref: "#/definitions/esr-vnfm"
+ esr-thirdparty-sdnc-list:
type: array
items:
- $ref: "#/definitions/license-key-resource"
+ $ref: "#/definitions/esr-thirdparty-sdnc"
connector:
description: |
Collection of resource instances used to connect a variety of disparate inventory widgets
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO virtual-data-center (Many2Many)
- TO metadatum (comprises connector, Many2Many)
tunnel-xconnect:
description: |
Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM allotted-resource (is composed of tunnel-xconnect)
required:
allotted-resource:
description: |
Represents a slice or partial piece of a resource that gets separately allotted
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO generic-vnf (Many2Many)
- TO l3-network (Many2Many)
- TO tunnel-xconnect (comprises allotted-resource, One2One)
- TO vpn-binding (Many2Many)
- TO allotted-resource (One2One)
+ - FROM configuration
- FROM service-instance (is composed of allotted-resource)
- FROM service-instance
- FROM allotted-resource
service-instance:
description: |
Instance of a service
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
+ - TO configuration (One2Many)
- TO zone (Many2One)
- TO cvlan-tag (Many2Many)
- TO pnf (One2Many)
- TO allotted-resource (Many2Many)
- FROM generic-vnf
- FROM l3-network
+ - FROM owning-entity
+ - FROM project
- FROM service-subscription (is composed of service-instance)
- FROM vce
- FROM service-instance
service-subscription:
description: |
Object that group service instances.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO service-instance (comprises service-subscription, Many2Many)
- FROM customer (is composed of service-subscription)
customer:
description: |
customer identifiers to provide linkage back to BSS information.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO service-subscription (comprises customer, Many2Many)
required:
type: array
items:
$ref: "#/definitions/customer"
+ line-of-business:
+ description: |
+ describes a line-of-business
+ ###### Related Nodes
+ - TO generic-vnf (Many2Many)
+ required:
+ - line-of-business-name
+ properties:
+ line-of-business-name:
+ type: string
+ description: Name of the line-of-business (product)
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ lines-of-business:
+ description: |
+ Collection of lines-of-business
+ properties:
+ line-of-business:
+ type: array
+ items:
+ $ref: "#/definitions/line-of-business"
+ owning-entity:
+ description: |
+ describes an owning-entity
+ ###### Related Nodes
+ - TO service-instance (One2Many)
+ required:
+ - owning-entity-id
+ - owning-entity-name
+ properties:
+ owning-entity-id:
+ type: string
+ description: UUID of an owning entity
+ owning-entity-name:
+ type: string
+ description: Owning entity name
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ owning-entities:
+ description: |
+ Collection of owning-entities
+ properties:
+ owning-entity:
+ type: array
+ items:
+ $ref: "#/definitions/owning-entity"
+ platform:
+ description: |
+ describes a platform
+ ###### Related Nodes
+ - TO generic-vnf (Many2Many)
+ required:
+ - platform-name
+ properties:
+ platform-name:
+ type: string
+ description: Name of the platform
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ platforms:
+ description: |
+ Collection of platforms
+ properties:
+ platform:
+ type: array
+ items:
+ $ref: "#/definitions/platform"
+ project:
+ description: |
+ describes the project
+ ###### Related Nodes
+ - TO service-instance (One2Many)
+ required:
+ - project-name
+ properties:
+ project-name:
+ type: string
+ description: Name of the project deploying a service
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ projects:
+ description: |
+ Collection of projects
+ properties:
+ project:
+ type: array
+ items:
+ $ref: "#/definitions/project"
business:
description: |
Namespace for business related constructs
type: array
items:
$ref: "#/definitions/customer"
+ lines-of-business:
+ type: array
+ items:
+ $ref: "#/definitions/line-of-business"
+ owning-entities:
+ type: array
+ items:
+ $ref: "#/definitions/owning-entity"
+ platforms:
+ type: array
+ items:
+ $ref: "#/definitions/platform"
+ projects:
+ type: array
+ items:
+ $ref: "#/definitions/project"
vnf-image:
description: |
Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- FROM generic-vnf
required:
service:
description: |
Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
required:
- service-id
- service-description
service-capability:
description: |
Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
- FROM availability-zone
- FROM oam-network
element-choice-set:
description: |
This is how we would capture constraints defining allowed sets of elements.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO model-element (comprises element-choice-set, One2Many)
- FROM constrained-element-set (is composed of element-choice-set)
constrained-element-set:
description: |
This is how we would capture constraints defining allowed sets of elements.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO element-choice-set (comprises constrained-element-set, One2Many)
- FROM model-element (is composed of constrained-element-set)
model-constraint:
description: |
This is how we would capture constraints defining allowed sets of elements.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO constrained-element-set (comprises model-constraint, One2Many)
- FROM model-element (is composed of model-constraint)
model-element:
description: |
Defines how other models combine to make up a higher-level model.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO model-ver (Many2One)
- TO model-element (comprises model-element, One2Many)
model-ver:
description: |
Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO model-element (comprises model-ver, One2Many)
- TO metadatum (comprises model-ver, One2Many)
model:
description: |
Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO model-ver (comprises model, One2Many)
- FROM named-query
related-lookup:
description: |
TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- FROM named-query-element (is composed of related-lookup)
required:
property-constraint:
description: |
TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- FROM named-query-element (is composed of property-constraint)
required:
named-query-element:
description: |
TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO named-query-element (comprises named-query-element, Many2Many)
- TO model (Many2One)
named-query:
description: |
TBD
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO model (One2Many)
- TO named-query-element (comprises named-query, One2One)
logical-link:
description: |
Logical links generally connect l-interfaces but are used to express logical connectivity between two points
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO lag-link (Many2Many)
- TO pnf (Many2Many)
- TO pserver (Many2Many)
- TO cloud-region (Many2Many)
- TO vpn-binding (Many2Many)
+ - FROM configuration
- FROM l-interface
- FROM lag-interface
- FROM p-interface
description: Captures the units corresponding to the speed
ip-version:
type: string
- description: v4, v6, or ds for dual stack (should be att-ip-version)
+ description: v4, v6, or ds for dual stack
routing-protocol:
type: string
description: For example, static or BGP
$ref: "#/definitions/logical-link"
class-of-service:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM site-pair (is composed of class-of-service)
required:
$ref: "#/definitions/class-of-service"
site-pair:
description: |
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO class-of-service (comprises site-pair, Many2Many)
- FROM routing-instance (is composed of site-pair)
$ref: "#/definitions/site-pair"
routing-instance:
description: |
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO site-pair (comprises routing-instance, Many2Many)
- FROM site-pair-set (is composed of routing-instance)
site-pair-set:
description: |
Set of instances for probes used to measure service level agreements
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO routing-instance (comprises site-pair-set, Many2Many)
- FROM generic-vnf
route-target:
description: |
Route target information
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- FROM vpn-binding (is composed of route-target)
required:
vpn-binding:
description: |
VPN binding
- ###### Default Delete Scope
- ERROR_4_IN_EDGES_OR_CASCADE
###### Related Nodes
- TO route-target (comprises vpn-binding, One2Many)
- FROM l3-network
vpls-pe:
description: |
VPLS Provider Edge routers.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO complex (Many2Many)
- TO ctag-pool (Many2Many)
$ref: "#/definitions/vpls-pe"
multicast-configuration:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM vlan
required:
port-group:
description: |
Used to capture the network interfaces of this VCE
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO cvlan-tag (comprises port-group, Many2Many)
- FROM vce (is composed of port-group)
license:
description: |
Metadata for license group.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM generic-vnf (is composed of license)
- FROM vce (is composed of license)
entitlement:
description: |
Metadata for entitlement group.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM generic-vnf (is composed of entitlement)
- FROM vce (is composed of entitlement)
vce:
description: |
Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO availability-zone (Many2Many)
- TO complex (Many2Many)
$ref: "#/definitions/vce"
vnfc:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO instance-group (Many2Many)
+ - TO vip-ipv4-address-list (Many2Many)
+ - TO vip-ipv6-address-list (Many2Many)
- FROM vserver
- FROM vf-module
- FROM generic-vnf
+ - FROM l3-interface-ipv4-address-list (comprises vnfc)
+ - FROM l3-interface-ipv6-address-list (comprises vnfc)
required:
- vnfc-name
- nfc-naming-code
type: array
items:
$ref: "#/definitions/relationship"
+ l3-interface-ipv4-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv4-address-list"
+ l3-interface-ipv6-address-list:
+ type: array
+ items:
+ $ref: "#/definitions/l3-interface-ipv6-address-list"
vnfcs:
description: |
virtual network components associated with a vserver from application controller.
type: array
items:
$ref: "#/definitions/vnfc"
+ host-route:
+ description: |
+ ###### Related Nodes
+ - FROM subnet (is composed of host-route)
+ required:
+ - host-route-id
+ - route-prefix
+ - next-hop
+ properties:
+ host-route-id:
+ type: string
+ description: host-route id
+ route-prefix:
+ type: string
+ description: subnet prefix
+ next-hop:
+ type: string
+ description: Could be ip-address, hostname, or service-instance
+ next-hop-type:
+ type: string
+ description: Should be ip-address, hostname, or service-instance to match next-hop
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ host-routes:
+ properties:
+ host-route:
+ type: array
+ items:
+ $ref: "#/definitions/host-route"
subnet:
description: |
- ###### Default Delete Scope
- ERROR_IF_ANY_IN_EDGES
###### Related Nodes
+ - TO host-route (comprises subnet, One2Many)
- FROM l3-interface-ipv4-address-list
- FROM l3-interface-ipv6-address-list
- FROM l3-network (is composed of subnet)
subnet-role:
type: string
description: role of the subnet, referenced when assigning IPs
+ ip-assignment-direction:
+ type: string
+ description: ip address assignment direction of the subnet
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ subnet-sequence:
+ type: integer
+ format: int32
+ description: sequence of the subnet
+ host-routes:
+ type: array
+ items:
+ $ref: "#/definitions/host-route"
relationship-list:
type: array
items:
$ref: "#/definitions/subnet"
ctag-assignment:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM l3-network (is composed of ctag-assignment)
- FROM service-instance
segmentation-assignment:
description: |
Openstack segmentation assignment.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM l3-network (is composed of segmentation-assignment)
required:
l3-network:
description: |
Generic network definition
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO vpn-binding (Many2Many)
- TO instance-group (Many2Many)
$ref: "#/definitions/l3-network"
network-policy:
description: |
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM l3-network
- FROM allotted-resource
vf-module:
description: |
a deployment unit of VNFCs
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO volume-group (One2One)
- TO l3-network (Many2Many)
generic-vnf:
description: |
General purpose VNF
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO license-key-resource (Many2Many)
- TO l-interface (comprises generic-vnf, Many2Many)
- TO network-profile (Many2Many)
- TO pnf (Many2Many)
- TO ipsec-configuration (Many2One)
+ - TO configuration (One2Many)
- TO vf-module (comprises generic-vnf, One2Many)
- TO volume-group (One2Many)
- TO vnfc (One2Many)
- TO license (comprises generic-vnf, One2Many)
- TO complex (Many2Many)
- TO ctag-pool (Many2Many)
+ - FROM line-of-business
+ - FROM platform
- FROM virtual-data-center
- FROM logical-link
- FROM allotted-resource
lag-link:
description: |
LAG links can connect lag-interfaces
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM lag-interface
- FROM logical-link
newvce:
description: |
This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO l-interface (comprises newvce, Many2Many)
required:
pnf:
description: |
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.
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO p-interface (comprises pnf, Many2Many)
- TO lag-interface (comprises pnf, One2Many)
- TO complex (Many2One)
- TO instance-group (Many2Many)
- TO zone (Many2One)
+ - FROM esr-thirdparty-sdnc
- FROM generic-vnf
- FROM logical-link
- FROM service-instance
physical-link:
description: |
Collection of physical connections, typically between p-interfaces
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM p-interface
required:
service-provider-name:
type: string
description: Name of the service Provider on this link.
+ service-provider-bandwidth-up-value:
+ type: integer
+ format: int32
+ description: Upstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-up-units:
+ type: string
+ description: Units for the upstream BW value
+ service-provider-bandwidth-down-value:
+ type: integer
+ format: int32
+ description: Downstream Bandwidth value agreed with the service provider
+ service-provider-bandwidth-down-units:
+ type: string
+ description: Units for downstream BW value
resource-version:
type: string
description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vig-server:
description: |
vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM ipsec-configuration (is composed of vig-server)
required:
ipsec-configuration:
description: |
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
- ###### Default Delete Scope
- CASCADE_TO_CHILDREN
###### Related Nodes
- TO vig-server (comprises ipsec-configuration, One2Many)
- FROM generic-vnf
route-table-reference:
description: |
Openstack route table reference.
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- FROM l3-network
required:
instance-group:
description: |
General mechanism for grouping instances
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO model (Many2Many)
- FROM l-interface
zone:
description: |
A zone is a grouping of assets in a location homing to the same connections into the CBB
- ###### Default Delete Scope
- THIS_NODE_ONLY
###### Related Nodes
- TO complex (Many2One)
- FROM cloud-region
type: array
items:
$ref: "#/definitions/zone"
+ vip-ipv4-address-list:
+ description: |
+ IPv4 Address Range
+ ###### Related Nodes
+ - FROM vnfc
+ required:
+ - vip-ipv4-address
+ properties:
+ vip-ipv4-address:
+ type: string
+ description: IP address
+ vip-ipv4-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 32 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
+ vip-ipv6-address-list:
+ description: |
+ IPv6 Address Range
+ ###### Related Nodes
+ - FROM vnfc
+ required:
+ - vip-ipv6-address
+ properties:
+ vip-ipv6-address:
+ type: string
+ description: IP address
+ vip-ipv6-prefix-length:
+ type: integer
+ format: int64
+ description: Prefix length, 128 for single address
+ vlan-id-inner:
+ type: integer
+ format: int64
+ description: Inner VLAN tag
+ vlan-id-outer:
+ type: integer
+ format: int64
+ description: Outer VLAN tag
+ is-floating:
+ type: boolean
+ description: Indicator of fixed or floating address
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ neutron-network-id:
+ type: string
+ description: Neutron network id of the interface that address belongs to
+ neutron-subnet-id:
+ type: string
+ description: Neutron id of subnet that address belongs to
+ relationship-list:
+ type: array
+ items:
+ $ref: "#/definitions/relationship"
network:
description: |
Namespace for network inventory resources.
type: array
items:
$ref: "#/definitions/zone"
+ vip-ipv4-address-list:
+ type: object
+ $ref: "#/definitions/vip-ipv4-address-list"
+ vip-ipv6-address-list:
+ type: object
+ $ref: "#/definitions/vip-ipv6-address-list"
inventory:
properties:
search:
cloud-infrastructure:
type: object
$ref: "#/definitions/cloud-infrastructure"
- license-management:
+ external-system:
type: object
- $ref: "#/definitions/license-management"
+ $ref: "#/definitions/external-system"
business:
type: object
$ref: "#/definitions/business"
type: string
key-value:
type: string
+ configurations:
+ description: |
+ Collection of configurations
+ properties:
+ configuration:
+ type: array
+ items:
+ $ref: "#/definitions/configuration"
+ configuration:
+ description: |
+ Port Mirror Configuration.
+ ###### Related Nodes
+ - TO logical-link (One2Many)
+ - TO metadatum (comprises configuration, One2Many)
+ - TO allotted-resource (One2One)
+ - FROM service-instance
+ - FROM generic-vnf
+ required:
+ - configuration-id
+ - configuration-type
+ - configuration-sub-type
+ - orchestration-status
+ - operational-status
+ - configuration-selflink
+ - model-customization-id
+ properties:
+ management-option:
+ type: string
+ description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
+ configuration-id:
+ type: string
+ description: UUID assigned to configuration.
+ configuration-name:
+ type: string
+ description: Name of the configuration.
+ configuration-type:
+ type: string
+ description: port-mirroring-configuration.
+ configuration-sub-type:
+ type: string
+ description: vprobe, pprobe.
+ model-invariant-id:
+ type: string
+ description: the ASDC model id for this resource or service model.
+ model-version-id:
+ type: string
+ description: the ASDC model version for this resource or service model.
+ orchestration-status:
+ type: string
+ description: Orchestration status of the configuration.
+ operational-status:
+ type: string
+ description: Indicator for whether the resource is considered operational.
+ configuration-selflink:
+ type: string
+ description: URL to endpoint where AAI can get more details from SDN-GC.
+ model-customization-id:
+ type: string
+ description: id of the configuration used to customize the resource
+ resource-version:
+ type: string
+ description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
+ relationship-list:
+ type: object
+ $ref: "#/definitions/relationship-list"
+ metadata:
+ type: object
+ $ref: "#/definitions/metadata"
notification-event:
properties:
cambria.partition:
Code Review / aai / aai-common.git / blobdiff