- summary: create or update an existing model-constraint
- description: |
- Create or update an existing model-constraint.
- #
- Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement. An example can be found in the [PATCH section] below
- operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
- 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
- example: __MODEL-INVARIANT-ID__
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- example: __MODEL-VERSION-ID__
- - name: model-element-uuid
- in: path
- required: true
- type: string
- example: __MODEL-ELEMENT-UUID__
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- example: __MODEL-CONSTRAINT-UUID__
- - name: body
- in: body
- description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
- required: true
- schema:
- $ref: "#/definitions/model-constraint"
- patch:
- tags:
- - ServiceDesignAndCreation
- summary: update an existing model-constraint
- description: |
- Update an existing model-constraint
- #
- Note: Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
- The PUT operation will entirely replace an existing object.
- The PATCH operation sends a "description of changes" for an existing object. The entire set of changes must be applied. An error result means no change occurs.
- #
- Other differences between PUT and PATCH are:
- #
- - For PATCH, you can send any of the values shown in sample REQUEST body. There are no required values.
- - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
- - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
- operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
- 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
- example: __MODEL-INVARIANT-ID__
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- example: __MODEL-VERSION-ID__
- - name: model-element-uuid
- in: path
- required: true
- type: string
- example: __MODEL-ELEMENT-UUID__
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- example: __MODEL-CONSTRAINT-UUID__
- - name: body
- in: body
- description: model-constraint object that needs to be created or updated.
- required: true
- schema:
- $ref: "#/patchDefinitions/model-constraint"
- delete:
- tags:
- - ServiceDesignAndCreation
- 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:
- "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
- example: __MODEL-INVARIANT-ID__
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- example: __MODEL-VERSION-ID__
- - name: model-element-uuid
- in: path
- required: true
- type: string
- example: __MODEL-ELEMENT-UUID__
- - name: model-constraint-uuid
- in: path
- required: true
- type: string
- example: __MODEL-CONSTRAINT-UUID__
- - 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:
- get:
- tags:
- - ServiceDesignAndCreation
- summary: returns model-constraints
- description: returns model-constraints
- operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
- produces:
- - application/json
- - application/xml
- responses:
- "200":
- description: successful operation
- schema:
- $ref: "#/getDefinitions/model-constraints"
- "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
- example: __MODEL-INVARIANT-ID__
- - name: model-version-id
- in: path
- description: Unique identifier corresponding to one version of a model in ASDC
- required: true
- type: string
- example: __MODEL-VERSION-ID__
- - name: model-element-uuid
- in: path
- required: true
- type: string
- example: __MODEL-ELEMENT-UUID__
- - 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
- - name: distribution-status
- in: query
- description: Distribution Status
- 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