4 email: onap-discuss@lists.onap.org
6 url: https://onap.readthedocs.io
7 description: SDC API for designing services and resources (SDCE-2) and distributing
11 url: http://www.apache.org/licenses/LICENSE-2.0
12 title: "SPC API: SDCE-2 and SDCE-5"
15 - description: SDCE-2 and SDCE-5 APIs
20 description: Gets the prometheus micrometer application metrics
21 operationId: prometheus
23 - description: The Accept header to determine the output content type
34 description: default response
38 summary: Prometheus Micrometer Metrics
43 description: Retrieve configuration
44 operationId: getConfig_1
59 operationId: getConfig
71 description: default response
79 operationId: setConfig1
84 $ref: '#/components/schemas/Configuration'
91 description: default response
99 operationId: setConfig2
104 $ref: '#/components/schemas/Configuration'
109 description: default response
117 operationId: setConfig3
122 $ref: '#/components/schemas/Configuration'
129 description: default response
137 operationId: setConfig4
142 $ref: '#/components/schemas/Configuration'
147 description: default response
155 description: Return aggregate BE health check of SDC BE components
156 operationId: getHealthCheck
159 description: SDC BE components are all up
161 description: One or more SDC BE components are down
172 summary: return BE health check
177 description: Retrieve all artifactTypes
178 operationId: getArtifactTypes
186 description: Returns artifactTypes Ok
188 description: No artifactTypes were found
190 description: Internal Server Error
197 $ref: '#/components/schemas/User'
201 summary: Retrieve all artifactTypes
204 /v1/catalog/allDataTypes:
206 description: Get data types
207 operationId: getAllDataTypesFromAllModels
215 description: allDataTypes
217 description: Invalid content / Missing content
219 description: Restricted operation
221 description: Data types not found
237 additionalProperties:
277 additionalProperties:
309 unicodeLocaleAttributes:
334 additionalProperties:
360 additionalProperties:
372 additionalProperties:
398 additionalProperties:
405 summary: Returns all data types from all models
410 description: Get all Archived Components
411 operationId: getArchivedComponents
421 description: Bad request
423 description: Restricted operation
425 description: Internal Error
436 summary: Get all Archived Components
439 /v1/catalog/artifactTypes:
441 description: Get Tosca ArtifactTypes
442 operationId: getAllToscaArtifactTypes
444 - description: Model name
455 description: Listing successful
457 description: Invalid content / Missing content
459 description: Restricted operation
461 description: Tosca Artifact Types not found
477 additionalProperties:
517 additionalProperties:
549 unicodeLocaleAttributes:
574 additionalProperties:
600 additionalProperties:
612 additionalProperties:
638 additionalProperties:
645 summary: Returns tosca artifact types
648 /v1/catalog/audit-records/{componentType}/{componentUniqueId}:
650 description: get component audit records
651 operationId: getComponentAuditRecords
659 name: componentUniqueId
669 description: Service found
671 description: Restricted operation
687 additionalProperties:
727 additionalProperties:
759 unicodeLocaleAttributes:
784 additionalProperties:
810 additionalProperties:
822 additionalProperties:
848 additionalProperties:
855 summary: get audit records for a service or a resource
858 /v1/catalog/capabilityTypes:
860 description: Get capability types
861 operationId: getAllCapabilityTypesServlet
874 description: capabilityTypes
876 description: Invalid content / Missing content
878 description: Restricted operation
880 description: Capability types not found
896 additionalProperties:
936 additionalProperties:
968 unicodeLocaleAttributes:
993 additionalProperties:
1019 additionalProperties:
1031 additionalProperties:
1057 additionalProperties:
1064 summary: Returns capability types
1067 /v1/catalog/data-types/{dataTypeUid}:
1069 description: Get data types
1070 operationId: fetchDataType
1083 description: Data type found
1085 description: Invalid content / Missing content
1087 description: Restricted operation
1089 description: Data types not found
1094 $ref: '#/components/schemas/DataTypeDataDefinition'
1098 summary: Returns data types
1101 /v1/catalog/data-types/{id}/properties:
1103 description: Get a data type properties
1104 operationId: fetchProperties
1106 - description: The data type id
1114 description: "Data type found, properties may be empty"
1116 description: Restricted operation
1118 description: Data type not found
1125 $ref: '#/components/schemas/PropertyDefinition'
1129 summary: Returns the data type properties
1133 description: Create a property in the given data type
1134 operationId: createProperty
1136 - description: The data type id
1146 $ref: '#/components/schemas/PropertyDefinitionDto'
1147 description: Property to add
1151 description: Property created in the data type
1153 description: Invalid payload
1155 description: Restricted operation
1157 description: Data type not found
1159 description: Property already exists in the data type
1164 $ref: '#/components/schemas/PropertyDefinitionDto'
1168 summary: Create a property in the given data type
1171 /v1/catalog/dataTypes:
1173 description: Get data types
1174 operationId: getAllDataTypesServlet
1180 - description: model
1187 description: datatypes
1189 description: Invalid content / Missing content
1191 description: Restricted operation
1193 description: Data types not found
1209 additionalProperties:
1249 additionalProperties:
1281 unicodeLocaleAttributes:
1306 additionalProperties:
1332 additionalProperties:
1344 additionalProperties:
1370 additionalProperties:
1377 summary: Returns data types
1380 /v1/catalog/directives:
1382 description: Retrieve all Directives values from configuration file
1383 operationId: getConfCategoriesAndVersion
1391 description: Returns Directive values from configuration file Ok
1393 description: Directive not found
1395 description: Internal Server Error
1402 $ref: '#/components/schemas/User'
1403 summary: Retrieve all Directives
1406 /v1/catalog/gab/searchFor:
1408 description: Search json paths inside the yaml
1409 operationId: searchFor
1414 $ref: '#/components/schemas/GenericArtifactQueryInfo'
1415 description: Generic Artifact search model
1419 description: Returned yaml entries
1421 description: Invalid content / Missing content
1437 additionalProperties:
1477 additionalProperties:
1509 unicodeLocaleAttributes:
1534 additionalProperties:
1560 additionalProperties:
1572 additionalProperties:
1598 additionalProperties:
1605 summary: Returns found entries of json paths
1608 /v1/catalog/groupTypes:
1610 description: 'Get group types '
1611 operationId: getGroupTypes
1617 - description: An optional parameter to indicate the type of the container from
1618 where this call is executed
1620 name: internalComponentType
1624 name: componentModel
1629 description: group types found
1631 description: "field name invalid type/length, characters; mandatory field\
1632 \ is absent, already exists (name)"
1634 description: Restricted operation
1636 description: Internal Error
1643 $ref: '#/components/schemas/GroupTypeDefinition'
1647 summary: Returns group types
1650 /v1/catalog/handleException:
1652 description: Handle exception
1653 operationId: sendError
1668 additionalProperties:
1708 additionalProperties:
1740 unicodeLocaleAttributes:
1765 additionalProperties:
1791 additionalProperties:
1803 additionalProperties:
1829 additionalProperties:
1833 description: Internal Error
1839 /v1/catalog/interfaceLifecycleTypes:
1841 description: Get interface lifecycle types
1842 operationId: getInterfaceLifecycleTypes
1848 - description: model
1855 description: Interface lifecycle types
1857 description: Invalid content / Missing content
1859 description: Restricted operation
1861 description: Interface lifecycle types not found
1877 additionalProperties:
1917 additionalProperties:
1949 unicodeLocaleAttributes:
1974 additionalProperties:
2000 additionalProperties:
2012 additionalProperties:
2038 additionalProperties:
2045 summary: Returns interface lifecycle types
2050 description: Toggle disable locking
2051 operationId: toggleDisableLocking
2062 description: Disable Locking
2065 description: Disable locking successfully updated
2067 description: Update disable locking failed
2081 additionalProperties:
2121 additionalProperties:
2153 unicodeLocaleAttributes:
2178 additionalProperties:
2204 additionalProperties:
2216 additionalProperties:
2242 additionalProperties:
2253 description: List all the existing TOSCA models
2254 operationId: listModels
2266 description: Listing successful
2268 description: Restricted operation
2275 $ref: '#/components/schemas/Model'
2279 summary: List TOSCA models
2283 description: "Create a TOSCA model, along with its imports files"
2284 operationId: createModel
2292 multipart/form-data:
2297 $ref: '#/components/schemas/ModelCreateRequest'
2300 description: the model TOSCA imports zipped
2306 description: Model created
2308 description: Invalid content / Missing content
2310 description: Restricted operation
2312 description: Model already exists
2328 additionalProperties:
2368 additionalProperties:
2400 unicodeLocaleAttributes:
2425 additionalProperties:
2451 additionalProperties:
2463 additionalProperties:
2489 additionalProperties:
2496 summary: Create a TOSCA model
2499 /v1/catalog/model/imports:
2501 description: Update a model TOSCA imports
2502 operationId: updateModelImports
2510 multipart/form-data:
2516 description: the model TOSCA imports zipped
2519 description: model to be created
2525 description: Model imports updated
2527 description: Invalid content / Missing content
2529 description: Restricted operation
2531 description: Model not found
2547 additionalProperties:
2587 additionalProperties:
2619 unicodeLocaleAttributes:
2644 additionalProperties:
2670 additionalProperties:
2682 additionalProperties:
2708 additionalProperties:
2715 summary: Update a model TOSCA imports
2718 /v1/catalog/nodeTypes:
2720 description: Get node types
2721 operationId: getAllNodeTypesServlet
2727 - description: model
2734 description: nodeTypes
2736 description: Invalid content / Missing content
2738 description: Restricted operation
2740 description: Node types not found
2756 additionalProperties:
2796 additionalProperties:
2828 unicodeLocaleAttributes:
2853 additionalProperties:
2879 additionalProperties:
2891 additionalProperties:
2917 additionalProperties:
2924 summary: Returns node types
2927 /v1/catalog/notif/vsp/archived:
2929 description: Notify about an archived VSP. All VFs with relation to the given
2930 CSAR IDs will be martked as vspArchived=true
2931 operationId: onVspArchived
2946 description: Success
2948 description: Bad request
2950 description: Restricted operation
2952 description: Internal Error. A list of the failed CSAR IDs may be returned.
2958 /v1/catalog/notif/vsp/restored:
2960 description: Notify about a restored VSP. All VFs with relation to the given
2961 CSAR IDs will be martked as vspArchived=false
2962 operationId: onVspRestored
2977 description: Success
2979 description: Bad request
2981 description: Restricted operation
2983 description: Internal Error. A list of the failed CSAR IDs may be returned.
2989 /v1/catalog/policyTypes:
2991 description: 'Get policy types '
2992 operationId: getPolicyTypes
2994 - description: An optional parameter to indicate the type of the container from
2995 where this call is executed
2997 name: internalComponentType
3001 name: componentModel
3004 - description: The user id
3012 description: policy types found
3014 description: Restricted operation
3016 description: The GET request failed due to internal SDC problem.
3023 $ref: '#/components/schemas/PolicyTypeDefinition'
3027 summary: Returns policy types
3030 /v1/catalog/relationshipTypes:
3032 description: Get relationship types
3033 operationId: getAllRelationshipTypesServlet
3039 - description: model
3046 description: relationshipTypes
3048 description: Invalid content / Missing content
3050 description: Restricted operation
3052 description: Relationship types not found
3068 additionalProperties:
3108 additionalProperties:
3140 unicodeLocaleAttributes:
3165 additionalProperties:
3191 additionalProperties:
3203 additionalProperties:
3229 additionalProperties:
3236 summary: Returns relationship types
3239 /v1/catalog/resources:
3241 description: Create Resource
3242 operationId: createResource
3253 description: Resource object to be created
3257 description: Resource created
3259 description: Invalid content / Missing content
3261 description: Restricted operation
3263 description: Resource already exist
3270 $ref: '#/components/schemas/Resource'
3274 summary: Returns created resource
3277 /v1/catalog/resources/certified/abstract:
3279 operationId: getCertifiedAbstractResources
3288 application/json: {}
3289 description: default response
3295 /v1/catalog/resources/certified/notabstract:
3297 operationId: getCertifiedNotAbstractResources
3306 application/json: {}
3307 description: default response
3313 /v1/catalog/resources/csar/{csaruuid}:
3315 description: Create Resource
3316 operationId: getResourceFromCsar
3329 description: Resource retrieced
3331 description: Invalid content / Missing content
3333 description: Restricted operation
3340 $ref: '#/components/schemas/Resource'
3344 summary: Returns resource created from csar uuid
3347 /v1/catalog/resources/importReplaceResource:
3349 description: Import Resource
3350 operationId: importReplaceResource
3352 - description: The user id
3358 - description: X-ECOMP-RequestID header
3360 name: X-ECOMP-RequestID
3363 - description: X-ECOMP-InstanceID header
3365 name: X-ECOMP-InstanceID
3369 - description: Determines the format of the body of the response
3374 - description: The username and password
3387 $ref: '#/components/schemas/FormDataContentDisposition'
3388 resourceZipMetadata:
3390 description: resourceMetadata
3393 description: Resource created
3395 description: Invalid content / Missing content
3397 description: Restricted operation
3399 description: Resource already exist
3403 summary: Returns imported resource
3406 /v1/catalog/resources/resourceName/{resourceName}/resourceVersion/{resourceVersion}:
3408 description: Retrieve Resource by name and version
3409 operationId: getResourceByNameAndVersion
3417 name: resourceVersion
3427 description: Resource found
3429 description: Restricted operation
3431 description: Resource not found
3438 $ref: '#/components/schemas/Resource'
3442 summary: Returns resource according to resourceId
3445 /v1/catalog/resources/validate-name/{resourceName}:
3447 description: validate resource name
3448 operationId: validateResourceName
3465 description: Resource found
3467 description: Restricted operation
3474 $ref: '#/components/schemas/Resource'
3478 summary: 'checks if the chosen resource name is available '
3481 /v1/catalog/resources/{componentId}/archive:
3483 description: Archive Resource
3484 operationId: archiveResources
3497 description: Archive successful
3499 description: Bad request
3501 description: Restricted operation
3503 description: Resource not found
3505 description: Internal Error
3516 summary: Marks a resource as archived. Can be restored with restore action
3519 /v1/catalog/resources/{componentId}/interfaceOperation:
3521 description: Update Interface Operation
3522 operationId: updateResourceInterfaceOperation
3524 - description: Component Id
3536 description: Update Interface Operation
3538 description: Invalid content / Missing content
3540 description: Restricted operation
3556 additionalProperties:
3596 additionalProperties:
3628 unicodeLocaleAttributes:
3653 additionalProperties:
3679 additionalProperties:
3691 additionalProperties:
3717 additionalProperties:
3724 summary: Update Interface Operation on ComponentInstance
3727 /v1/catalog/resources/{componentId}/restore:
3729 description: Restore Resource
3730 operationId: restoreResource
3743 description: Restore successful
3745 description: Bad request
3747 description: Restricted operation
3749 description: Resource not found
3751 description: Internal Error
3762 summary: Restores a resource from archive.
3765 /v1/catalog/resources/{resourceId}:
3767 operationId: deleteResource
3774 - description: "Optional parameter to determine the delete action: DELETE, which\
3775 \ will permanently delete the Resource from the system or MARK_AS_DELETE,\
3776 \ which will logically mark the Resource as deleted. Default action is to\
3789 description: default response
3796 description: Retrieve Resource
3797 operationId: getResourceById
3810 description: Resource found
3812 description: Restricted operation
3814 description: Resource not found
3821 $ref: '#/components/schemas/Resource'
3825 summary: Returns resource according to resourceId
3829 description: Update Resource
3830 operationId: updateResource
3846 description: Resource object to be updated
3850 description: Resource updated
3852 description: Invalid content / Missing content
3854 description: Restricted operation
3856 description: Resource already exist
3863 $ref: '#/components/schemas/Resource'
3867 summary: Returns updated resource
3870 /v1/catalog/resources/{resourceId}/additionalinfo:
3872 description: Get all Additional Information under resource
3873 operationId: getAllResourceAdditionalInformationLabel
3875 - description: resource id to update with new property
3887 description: list of additional information
3889 description: Invalid content / Missing content
3891 description: Restricted operation
3893 description: Additional information key already exist
3909 additionalProperties:
3949 additionalProperties:
3981 unicodeLocaleAttributes:
4006 additionalProperties:
4032 additionalProperties:
4044 additionalProperties:
4070 additionalProperties:
4077 summary: Returns Additional Inforamtion property
4081 description: Create Additional Information Label and Value
4082 operationId: createResourceAdditionalInformationLabel
4084 - description: resource id to update with new property
4099 description: Additional information key value to be created
4103 description: Additional information created
4105 description: Invalid content / Missing content
4107 description: Restricted operation
4109 description: Additional information key already exist
4125 additionalProperties:
4165 additionalProperties:
4197 unicodeLocaleAttributes:
4222 additionalProperties:
4248 additionalProperties:
4260 additionalProperties:
4286 additionalProperties:
4293 summary: Returns created Additional Inforamtion property
4296 /v1/catalog/resources/{resourceId}/additionalinfo/{labelId}:
4298 description: Create Additional Information Label and Value
4299 operationId: updateResourceAdditionalInformationLabel
4301 - description: resource id to update with new property
4307 - description: label id
4319 description: Additional information deleted
4321 description: Invalid content / Missing content
4323 description: Restricted operation
4325 description: Additional information key already exist
4341 additionalProperties:
4381 additionalProperties:
4413 unicodeLocaleAttributes:
4438 additionalProperties:
4464 additionalProperties:
4476 additionalProperties:
4502 additionalProperties:
4509 summary: Returns deleted Additional Inforamtion property
4513 description: Get Additional Information by id
4514 operationId: getResourceAdditionalInformationLabel
4516 - description: resource id to update with new property
4522 - description: label id
4534 description: fetched additional information
4536 description: Invalid content / Missing content
4538 description: Restricted operation
4540 description: Additional information key already exist
4556 additionalProperties:
4596 additionalProperties:
4628 unicodeLocaleAttributes:
4653 additionalProperties:
4679 additionalProperties:
4691 additionalProperties:
4717 additionalProperties:
4724 summary: Returns Additional Inforamtion property
4728 description: Update Additional Information Label and Value
4729 operationId: updateResourceAdditionalInformationLabel_1
4731 - description: resource id to update with new property
4737 - description: label id
4752 description: Additional information key value to be created
4756 description: Additional information updated
4758 description: Invalid content / Missing content
4760 description: Restricted operation
4762 description: Additional information key already exist
4778 additionalProperties:
4818 additionalProperties:
4850 unicodeLocaleAttributes:
4875 additionalProperties:
4901 additionalProperties:
4913 additionalProperties:
4939 additionalProperties:
4946 summary: Returns updated Additional Inforamtion property
4949 /v1/catalog/resources/{resourceId}/artifacts:
4951 description: Create Artifact
4952 operationId: loadArtifact
4964 description: json describe the artifact
4968 description: Resource created
4970 description: Invalid content / Missing content
4972 description: Restricted operation
4974 description: Artifact already exist
4990 additionalProperties:
5030 additionalProperties:
5062 unicodeLocaleAttributes:
5087 additionalProperties:
5113 additionalProperties:
5125 additionalProperties:
5151 additionalProperties:
5158 summary: Returns created ArtifactDefinition
5161 /v1/catalog/resources/{resourceId}/artifacts/{artifactId}:
5163 description: Delete Artifact
5164 operationId: deleteArtifact
5178 description: Resource created
5180 description: Invalid content / Missing content
5182 description: Restricted operation
5198 additionalProperties:
5238 additionalProperties:
5270 unicodeLocaleAttributes:
5295 additionalProperties:
5321 additionalProperties:
5333 additionalProperties:
5359 additionalProperties:
5366 summary: Returns delete artifact
5370 description: Download resource Artifact in Base64
5371 operationId: downloadResourceArtifactBase64
5385 description: Resource artifact downloaded
5387 description: Resource/Artifact not found
5403 additionalProperties:
5443 additionalProperties:
5475 unicodeLocaleAttributes:
5500 additionalProperties:
5526 additionalProperties:
5538 additionalProperties:
5564 additionalProperties:
5571 summary: Returns downloaded artifact
5575 description: Update Artifact
5576 operationId: updateArtifact
5593 description: json describe the artifact
5597 description: Resource created
5599 description: Invalid content / Missing content
5601 description: Restricted operation
5617 additionalProperties:
5657 additionalProperties:
5689 unicodeLocaleAttributes:
5714 additionalProperties:
5740 additionalProperties:
5752 additionalProperties:
5778 additionalProperties:
5785 summary: Returns updated artifact
5788 /v1/catalog/resources/{resourceId}/attributes:
5790 description: Get Resource Attribute
5791 operationId: getAttributeListInResource
5793 - description: resource id of attribute
5805 description: attribute
5807 description: Invalid content / Missing content
5809 description: Restricted operation
5811 description: Resource attribute not found
5827 additionalProperties:
5867 additionalProperties:
5899 unicodeLocaleAttributes:
5924 additionalProperties:
5950 additionalProperties:
5962 additionalProperties:
5988 additionalProperties:
5995 summary: Returns attribute list of resource
5999 description: Create Resource Attribute
6000 operationId: createAttribute
6002 - description: resource id to update with new attribute
6017 description: Resource attribute to be created
6021 description: Resource property created
6023 description: Invalid content / Missing content
6025 description: Restricted operation
6027 description: Resource attribute already exist
6043 additionalProperties:
6083 additionalProperties:
6115 unicodeLocaleAttributes:
6140 additionalProperties:
6166 additionalProperties:
6178 additionalProperties:
6204 additionalProperties:
6211 summary: Returns created resource attribute
6214 /v1/catalog/resources/{resourceId}/attributes/{attributeId}:
6216 description: Create Resource Attribute
6217 operationId: deleteAttribute
6219 - description: resource id of attribute
6225 - description: Attribute id to delete
6237 description: deleted attribute
6239 description: Invalid content / Missing content
6241 description: Restricted operation
6243 description: Resource property not found
6259 additionalProperties:
6299 additionalProperties:
6331 unicodeLocaleAttributes:
6356 additionalProperties:
6382 additionalProperties:
6394 additionalProperties:
6420 additionalProperties:
6427 summary: Returns deleted attribute
6431 description: Update Resource Attribute
6432 operationId: updateAttribute
6434 - description: resource id to update with new attribute
6440 - description: attribute id to update
6455 description: Resource attribute to update
6459 description: Resource attribute updated
6461 description: Invalid content / Missing content
6463 description: Restricted operation
6479 additionalProperties:
6519 additionalProperties:
6551 unicodeLocaleAttributes:
6576 additionalProperties:
6602 additionalProperties:
6614 additionalProperties:
6640 additionalProperties:
6647 summary: Returns updated attribute
6650 /v1/catalog/resources/{resourceId}/capabilities:
6652 description: Create Capabilities on resource
6653 operationId: createCapabilitiesOnResource
6655 - description: Resource Id
6670 description: Capability to create
6674 description: Create Capabilities
6676 description: Invalid content / Missing content
6678 description: Restricted operation
6680 description: Capability already exist
6696 additionalProperties:
6736 additionalProperties:
6768 unicodeLocaleAttributes:
6793 additionalProperties:
6819 additionalProperties:
6831 additionalProperties:
6857 additionalProperties:
6864 summary: Create Capabilities on resource
6868 description: Update Capabilities on resource
6869 operationId: updateCapabilitiesOnResource
6871 - description: Component Id
6886 description: Capabilities to update
6890 description: Update Capabilities
6892 description: Invalid content / Missing content
6894 description: Restricted operation
6901 $ref: '#/components/schemas/CapabilityDefinition'
6905 summary: Update Capabilities on resource
6908 /v1/catalog/resources/{resourceId}/capabilities/{capabilityId}:
6910 description: Delete capability from resource
6911 operationId: deleteCapabilityOnResource
6913 - description: capability Id
6919 - description: Resource Id
6931 description: Delete capability
6933 description: Invalid content / Missing content
6935 description: Restricted operation
6942 $ref: '#/components/schemas/CapabilityDefinition'
6946 summary: Delete capability from resource
6950 description: Get Capability from resource
6951 operationId: getCapabilityOnResource
6953 - description: Resource Id
6959 - description: Capability Id
6971 description: GET Capability
6973 description: Invalid content / Missing content
6975 description: Restricted operation
6982 $ref: '#/components/schemas/CapabilityDefinition'
6986 summary: GET Capability from resource
6989 /v1/catalog/resources/{resourceId}/interfaceOperations:
6991 description: Create Interface Operations on Resource
6992 operationId: createInterfaceOperationsOnResource
6994 - description: Resource Id
7009 description: Interface Operations to create
7013 description: Create Interface Operations on Resource
7015 description: Invalid content / Missing content
7017 description: Restricted operation
7019 description: Resource not found
7021 description: Interface Operation already exist
7028 $ref: '#/components/schemas/InterfaceDefinition'
7032 summary: Create Interface Operations on Resource
7036 description: Update Interface Operations on Resource
7037 operationId: updateInterfaceOperationsOnResource
7039 - description: Resource Id
7054 description: Interface Operations to update
7058 description: Update Interface Operations on Resource
7060 description: Invalid content / Missing content
7062 description: Restricted operation
7064 description: Resource not found
7071 $ref: '#/components/schemas/InterfaceDefinition'
7075 summary: Update Interface Operations on Resource
7078 /v1/catalog/resources/{resourceId}/interfaces/{interfaceId}/operations/{operationId}:
7080 description: Delete Interface Operation from Resource
7081 operationId: deleteInterfaceOperationsFromResource
7083 - description: Resource Id
7089 - description: Interface Id
7095 - description: Operation Id
7107 description: Delete Interface Operation from Resource
7109 description: Invalid content / Missing content
7111 description: Restricted operation
7113 description: Resource not found
7120 $ref: '#/components/schemas/InterfaceDefinition'
7124 summary: Delete Interface Operation from Resource
7128 description: Get Interface Operation from Resource
7129 operationId: getInterfaceOperationsFromResource
7131 - description: Resource Id
7137 - description: Interface Id
7143 - description: Operation Id
7155 description: Delete Interface Operation from Resource
7157 description: Invalid content / Missing content
7159 description: Restricted operation
7161 description: Resource not found
7168 $ref: '#/components/schemas/InterfaceDefinition'
7172 summary: GET Interface Operation from Resource
7175 /v1/catalog/resources/{resourceId}/metadata:
7177 description: Update Resource Metadata
7178 operationId: updateResourceMetadata
7194 description: Resource metadata to be updated
7198 description: Resource metadata updated
7200 description: Invalid content
7202 description: Restricted operation
7209 $ref: '#/components/schemas/Resource'
7213 summary: Returns updated resource metadata
7216 /v1/catalog/resources/{resourceId}/properties:
7218 description: Get Resource Property
7219 operationId: getPropertyListInResource
7221 - description: resource id of property
7233 description: property
7235 description: Invalid content / Missing content
7237 description: Restricted operation
7239 description: Resource property not found
7255 additionalProperties:
7295 additionalProperties:
7327 unicodeLocaleAttributes:
7352 additionalProperties:
7378 additionalProperties:
7390 additionalProperties:
7416 additionalProperties:
7423 summary: Returns property list of resource
7427 description: Create Resource Property
7428 operationId: createPropertyInResource
7430 - description: Resource id to update with new property
7445 description: Resource property to be created
7449 description: Resource property created
7451 description: Invalid content / Missing content
7453 description: Restricted operation
7455 description: Resource property already exist
7471 additionalProperties:
7511 additionalProperties:
7543 unicodeLocaleAttributes:
7568 additionalProperties:
7594 additionalProperties:
7606 additionalProperties:
7632 additionalProperties:
7639 summary: Returns created service property
7643 description: Update Resource Property
7644 operationId: updatePropertyInResource
7646 - description: resource id to update with new property
7661 description: Resource property to update
7665 description: Resource property updated
7667 description: Invalid content / Missing content
7669 description: Restricted operation
7685 additionalProperties:
7725 additionalProperties:
7757 unicodeLocaleAttributes:
7782 additionalProperties:
7808 additionalProperties:
7820 additionalProperties:
7846 additionalProperties:
7853 summary: Returns updated property
7856 /v1/catalog/resources/{resourceId}/properties/{propertyId}:
7858 description: Delete Resource Property
7859 operationId: deletePropertyInResource
7861 - description: resource id of property
7867 - description: Property id to delete
7879 description: deleted property
7881 description: Invalid content / Missing content
7883 description: Restricted operation
7885 description: Resource property not found
7901 additionalProperties:
7941 additionalProperties:
7973 unicodeLocaleAttributes:
7998 additionalProperties:
8024 additionalProperties:
8036 additionalProperties:
8062 additionalProperties:
8069 summary: Returns deleted property
8073 description: Get Resource Property
8074 operationId: getPropertyInResource
8076 - description: resource id of property
8082 - description: property id to get
8094 description: property
8096 description: Invalid content / Missing content
8098 description: Restricted operation
8100 description: Resource property not found
8116 additionalProperties:
8156 additionalProperties:
8188 unicodeLocaleAttributes:
8213 additionalProperties:
8239 additionalProperties:
8251 additionalProperties:
8277 additionalProperties:
8284 summary: Returns property of resource
8287 /v1/catalog/resources/{resourceId}/requirements:
8289 description: Create requirements on resource
8290 operationId: createRequirementsOnResource
8292 - description: Resource Id
8307 description: Requirement to create
8311 description: Create requirements
8313 description: Invalid content / Missing content
8315 description: Restricted operation
8317 description: requirement already exist
8333 additionalProperties:
8373 additionalProperties:
8405 unicodeLocaleAttributes:
8430 additionalProperties:
8456 additionalProperties:
8468 additionalProperties:
8494 additionalProperties:
8501 summary: Create requirements on resource
8505 description: Update Requirements on resource
8506 operationId: updateRequirementsOnResource
8508 - description: Component Id
8523 description: Requirements to update
8527 description: Update Requirements
8529 description: Invalid content / Missing content
8531 description: Restricted operation
8538 $ref: '#/components/schemas/RequirementDefinition'
8542 summary: Update Requirements on resource
8545 /v1/catalog/resources/{resourceId}/requirements/{requirementId}:
8547 description: Delete requirements from resource
8548 operationId: deleteRequirementsFromResource
8550 - description: Resource Id
8556 - description: requirement Id
8568 description: Delete requirement
8570 description: Invalid content / Missing content
8572 description: Restricted operation
8579 $ref: '#/components/schemas/RequirementDefinition'
8583 summary: Delete requirements from resource
8587 description: Get Requirement from resource
8588 operationId: getRequirementsFromResource
8590 - description: Resource Id
8596 - description: Requirement Id
8608 description: GET requirement
8610 description: Invalid content / Missing content
8612 description: Restricted operation
8619 $ref: '#/components/schemas/RequirementDefinition'
8623 summary: GET Requirement from resource
8626 /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts:
8628 description: Create Artifact and Attach to interface
8629 operationId: loadArtifactToInterface
8659 description: json describe the artifact
8663 description: Resource created
8665 description: Invalid content / Missing content
8667 description: Restricted operation
8669 description: Artifact already exist
8685 additionalProperties:
8725 additionalProperties:
8757 unicodeLocaleAttributes:
8782 additionalProperties:
8808 additionalProperties:
8820 additionalProperties:
8846 additionalProperties:
8853 summary: Returns created resource
8856 /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts/{artifactId}:
8858 description: delete Artifact from interface
8859 operationId: deleteArtifactToInterface
8883 description: delete artifact under interface deleted
8885 description: Invalid content / Missing content
8887 description: Restricted operation
8889 description: Artifact already exist
8905 additionalProperties:
8945 additionalProperties:
8977 unicodeLocaleAttributes:
9002 additionalProperties:
9028 additionalProperties:
9040 additionalProperties:
9066 additionalProperties:
9073 summary: delete matching artifact from interface
9077 description: update Artifact Attach to interface
9078 operationId: updateArtifactToInterface
9113 description: json describe the artifact
9117 description: delete artifact under interface deleted
9119 description: Invalid content / Missing content
9121 description: Restricted operation
9123 description: Artifact already exist
9139 additionalProperties:
9179 additionalProperties:
9211 unicodeLocaleAttributes:
9236 additionalProperties:
9262 additionalProperties:
9274 additionalProperties:
9300 additionalProperties:
9307 summary: updates artifact by interface
9310 /v1/catalog/resources/{resourceName}/{version}:
9312 description: Delete Resource By Name And Version
9313 operationId: deleteResourceByNameAndVersion
9327 description: Resource deleted
9329 description: Invalid content / Missing content
9331 description: Restricted operation
9333 description: Resource not found
9340 $ref: '#/components/schemas/Resource'
9344 summary: Returns no content
9347 /v1/catalog/services:
9349 description: Create Service
9350 operationId: createService
9361 description: Service object to be created
9365 description: Service created
9367 description: Invalid content / Missing content
9369 description: Restricted operation
9371 description: Service already exist
9378 $ref: '#/components/schemas/Service'
9382 summary: Returns created service
9385 /v1/catalog/services/distribution/{did}:
9387 description: Retrieve Distributions
9388 operationId: getListOfDistributionStatuses
9401 description: Service found
9403 description: Restricted operation
9405 description: Status not found
9412 $ref: '#/components/schemas/DistributionStatusListResponse'
9416 summary: Return the list of distribution status objects
9419 /v1/catalog/services/importService:
9421 description: Import Service
9422 operationId: importNsService
9433 description: Service object to be imported
9437 description: Service created
9439 description: Invalid content / Missing content
9441 description: Restricted operation
9443 description: Service already exist
9447 summary: Returns imported service
9450 /v1/catalog/services/replaceVNF:
9452 description: Replace new VNF based on the existing VNF
9453 operationId: replaceVNF
9455 - description: The user id
9461 - description: X-ECOMP-RequestID header
9463 name: X-ECOMP-RequestID
9466 - description: X-ECOMP-InstanceID header
9468 name: X-ECOMP-InstanceID
9472 - description: Determines the format of the body of the response
9477 - description: The username and password
9488 description: Resource object to be created
9497 $ref: '#/components/schemas/ReplaceVNFInfo'
9498 description: ECOMP component is authenticated and list of Catalog Assets
9499 Metadata is returned
9501 description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001
9503 description: ECOMP component should authenticate itself and to re-send again HTTP request with
9504 its Basic Authentication credentials - POL5002
9506 description: ECOMP component is not authorized - POL5003
9508 description: "Error: Requested '%1' (uuid) resource was not found - SVC4063"
9510 description: "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST\
9511 \ will be rejected) - POL4050"
9513 description: Service already exist
9515 description: The GET request failed either due to internal SDC problem.
9516 ECOMP Component should continue the attempts to get the needed information
9521 summary: Return whether the replace VNF is successful
9524 /v1/catalog/services/serviceName/{serviceName}/serviceVersion/{serviceVersion}:
9526 description: Retrieve Service
9527 operationId: getServiceByNameAndVersion
9535 name: serviceVersion
9545 description: Service found
9547 description: Restricted operation
9549 description: Service not found
9556 $ref: '#/components/schemas/Service'
9560 summary: Returns service according to name and version
9563 /v1/catalog/services/serviceUUID/{uuid}/importReplaceService:
9565 description: Import Service
9566 operationId: importReplaceService
9568 - description: The user id
9574 - description: X-ECOMP-RequestID header
9576 name: X-ECOMP-RequestID
9579 - description: X-ECOMP-InstanceID header
9581 name: X-ECOMP-InstanceID
9585 - description: Determines the format of the body of the response
9590 - description: The username and password
9596 - description: The requested asset uuid
9609 $ref: '#/components/schemas/FormDataContentDisposition'
9612 description: serviceMetadata
9615 description: Service created
9617 description: Invalid content / Missing content
9619 description: Restricted operation
9621 description: Service already exist
9625 summary: Returns imported service
9628 /v1/catalog/services/validate-name/{serviceName}:
9630 description: validate service name
9631 operationId: validateServiceName
9644 description: Service found
9646 description: Restricted operation
9662 additionalProperties:
9702 additionalProperties:
9734 unicodeLocaleAttributes:
9759 additionalProperties:
9785 additionalProperties:
9797 additionalProperties:
9823 additionalProperties:
9830 summary: 'checks if the chosen service name is available '
9833 /v1/catalog/services/{componentId}/archive:
9835 description: Archive Service
9836 operationId: archiveService
9849 description: Archive successful
9851 description: Bad request
9853 description: Restricted operation
9855 description: Service not found
9857 description: Internal Error
9868 summary: Marks a service as archived. Can be restored with restore action
9871 /v1/catalog/services/{componentId}/copyComponentInstance/{componentInstanceId}:
9873 description: Copy Component Instance
9874 operationId: copyComponentInstance
9876 - description: service unique id in pasted canvas
9883 name: componentInstanceId
9892 description: Data for copying
9896 description: Copy and Paste Success
9898 description: Invalid Content / Missing content
9900 description: Restricted Operation
9907 $ref: '#/components/schemas/Service'
9911 summary: Returns updated service information
9914 /v1/catalog/services/{componentId}/restore:
9916 description: Restore Service
9917 operationId: restoreService
9930 description: Restore successful
9932 description: Bad request
9934 description: Restricted operation
9936 description: Service not found
9938 description: Internal Error
9949 summary: Restores a service from archive.
9952 /v1/catalog/services/{serviceId}:
9954 description: Delete Service
9955 operationId: deleteService
9962 - description: "Optional parameter to determine the delete action: DELETE, which\
9963 \ will permanently delete theService from the system or MARK_AS_DELETE,\
9964 \ which will logically mark the service as deleted. Default action is to\
9975 description: Service deleted
9977 description: Invalid content / Missing content
9979 description: Restricted operation
9981 description: Service not found
9988 $ref: '#/components/schemas/Service'
9992 summary: Return no content
9996 description: Retrieve Service
9997 operationId: getServiceById_1
10010 description: Service found
10012 description: Restricted operation
10014 description: Service not found
10021 $ref: '#/components/schemas/Service'
10025 summary: Returns service according to serviceId
10028 /v1/catalog/services/{serviceId}/additionalinfo:
10030 description: Get all Additional Information under service
10031 operationId: getAllServiceAdditionalInformationLabel
10033 - description: service id to update with new property
10045 description: list of additional information
10047 description: Invalid content / Missing content
10049 description: Restricted operation
10051 description: Additional information key already exist
10067 additionalProperties:
10107 additionalProperties:
10139 unicodeLocaleAttributes:
10164 additionalProperties:
10190 additionalProperties:
10202 additionalProperties:
10228 additionalProperties:
10235 summary: Returns Additional Inforamtion property
10239 description: Create Additional Information Label and Value
10240 operationId: createServiceAdditionalInformationLabel
10242 - description: service id to update with new property
10257 description: Additional information key value to be created
10261 description: Additional information created
10263 description: Invalid content / Missing content
10265 description: Restricted operation
10267 description: Additional information key already exist
10283 additionalProperties:
10323 additionalProperties:
10355 unicodeLocaleAttributes:
10380 additionalProperties:
10406 additionalProperties:
10418 additionalProperties:
10444 additionalProperties:
10451 summary: Returns created Additional Inforamtion property
10454 /v1/catalog/services/{serviceId}/additionalinfo/{labelId}:
10456 description: Create Additional Information Label and Value
10457 operationId: deleteServiceAdditionalInformationLabel
10459 - description: service id to update with new property
10465 - description: label id
10477 description: Additional information deleted
10479 description: Invalid content / Missing content
10481 description: Restricted operation
10483 description: Additional information key already exist
10499 additionalProperties:
10539 additionalProperties:
10571 unicodeLocaleAttributes:
10596 additionalProperties:
10622 additionalProperties:
10634 additionalProperties:
10660 additionalProperties:
10667 summary: Returns deleted Additional Inforamtion property
10671 description: Get Additional Information by id
10672 operationId: getServiceAdditionalInformationLabel
10674 - description: service id to update with new property
10680 - description: label id
10692 description: fetched additional information
10694 description: Invalid content / Missing content
10696 description: Restricted operation
10698 description: Additional information key already exist
10714 additionalProperties:
10754 additionalProperties:
10786 unicodeLocaleAttributes:
10811 additionalProperties:
10837 additionalProperties:
10849 additionalProperties:
10875 additionalProperties:
10882 summary: Returns Additional Inforamtion property
10886 description: Update Additional Information Label and Value
10887 operationId: updateServiceAdditionalInformationLabel
10889 - description: service id to update with new property
10895 - description: label id
10910 description: Additional information key value to be created
10914 description: Additional information updated
10916 description: Invalid content / Missing content
10918 description: Restricted operation
10920 description: Additional information key already exist
10936 additionalProperties:
10976 additionalProperties:
11008 unicodeLocaleAttributes:
11033 additionalProperties:
11059 additionalProperties:
11071 additionalProperties:
11097 additionalProperties:
11104 summary: Returns updated Additional Inforamtion property
11107 /v1/catalog/services/{serviceId}/artifacts:
11109 description: Create Artifact
11110 operationId: loadInformationArtifact
11122 description: json describe the artifact
11126 description: Resource created
11128 description: Invalid content / Missing content
11130 description: Restricted operation
11132 description: Artifact already exist
11148 additionalProperties:
11188 additionalProperties:
11220 unicodeLocaleAttributes:
11245 additionalProperties:
11271 additionalProperties:
11283 additionalProperties:
11309 additionalProperties:
11316 summary: Returns created ArtifactDefinition
11319 /v1/catalog/services/{serviceId}/artifacts/api/{artifactId}:
11321 description: Delete Api Artifact
11322 operationId: deleteApiArtifact
11344 description: Api Artifact deleted
11346 description: Restricted operation
11362 additionalProperties:
11402 additionalProperties:
11434 unicodeLocaleAttributes:
11459 additionalProperties:
11485 additionalProperties:
11497 additionalProperties:
11523 additionalProperties:
11530 summary: Returns Deleted ArtifactDefinition
11534 description: Update Api Artifact
11535 operationId: updateApiArtifact
11560 description: json describe the artifact
11564 description: Api Artifact Updated
11566 description: Invalid content / Missing content
11568 description: Restricted operation
11584 additionalProperties:
11624 additionalProperties:
11656 unicodeLocaleAttributes:
11681 additionalProperties:
11707 additionalProperties:
11719 additionalProperties:
11745 additionalProperties:
11752 summary: Returns created ArtifactDefinition
11755 /v1/catalog/services/{serviceId}/artifacts/{artifactId}:
11757 description: Delete Artifact
11758 operationId: deleteInformationalArtifact
11772 description: Service artifact deleted
11774 description: Invalid content / Missing content
11776 description: Restricted operation
11792 additionalProperties:
11832 additionalProperties:
11864 unicodeLocaleAttributes:
11889 additionalProperties:
11915 additionalProperties:
11927 additionalProperties:
11953 additionalProperties:
11960 summary: Returns delete artifact
11964 description: Download service Artifact in Base64
11965 operationId: downloadServiceArtifactBase64
11979 description: Service artifact downloaded
11981 description: Service/Artifact not found
11997 additionalProperties:
12037 additionalProperties:
12069 unicodeLocaleAttributes:
12094 additionalProperties:
12120 additionalProperties:
12132 additionalProperties:
12158 additionalProperties:
12165 summary: Returns downloaded artifact
12169 description: Update Artifact
12170 operationId: updateInformationArtifact
12187 description: json describe the artifact
12191 description: Service artifact created
12193 description: Invalid content / Missing content
12195 description: Restricted operation
12211 additionalProperties:
12251 additionalProperties:
12283 unicodeLocaleAttributes:
12308 additionalProperties:
12334 additionalProperties:
12346 additionalProperties:
12372 additionalProperties:
12379 summary: Returns updated artifact
12382 /v1/catalog/services/{serviceId}/attributes:
12384 description: Get Service Attribute
12385 operationId: getAttributeListInService
12387 - description: service id of attribute
12399 description: attribute
12401 description: Invalid content / Missing content
12403 description: Restricted operation
12405 description: Service attribute not found
12421 additionalProperties:
12461 additionalProperties:
12493 unicodeLocaleAttributes:
12518 additionalProperties:
12544 additionalProperties:
12556 additionalProperties:
12582 additionalProperties:
12589 summary: Returns attribute list of service
12592 /v1/catalog/services/{serviceId}/capabilities:
12594 description: Create Capabilities on service
12595 operationId: createCapabilitiesOnService
12597 - description: Service Id
12612 description: Capability to create
12616 description: Create Capabilities
12618 description: Invalid content / Missing content
12620 description: Restricted operation
12622 description: Capability already exist
12638 additionalProperties:
12678 additionalProperties:
12710 unicodeLocaleAttributes:
12735 additionalProperties:
12761 additionalProperties:
12773 additionalProperties:
12799 additionalProperties:
12806 summary: Create Capabilities on service
12810 description: Update Capabilities on service
12811 operationId: updateCapabilitiesOnService
12813 - description: Component Id
12828 description: Capabilities to update
12832 description: Update Capabilities
12834 description: Invalid content / Missing content
12836 description: Restricted operation
12843 $ref: '#/components/schemas/CapabilityDefinition'
12847 summary: Update Capabilities on service
12850 /v1/catalog/services/{serviceId}/capabilities/{capabilityId}:
12852 description: Delete capability from service
12853 operationId: deleteCapabilityOnService
12855 - description: capability Id
12861 - description: Service Id
12873 description: Delete capability
12875 description: Invalid content / Missing content
12877 description: Restricted operation
12884 $ref: '#/components/schemas/CapabilityDefinition'
12888 summary: Delete capability from service
12892 description: Get Capability from service
12893 operationId: getCapabilityOnService
12895 - description: Service Id
12901 - description: Capability Id
12913 description: GET Capability
12915 description: Invalid content / Missing content
12917 description: Restricted operation
12924 $ref: '#/components/schemas/CapabilityDefinition'
12928 summary: GET Capability from service
12931 /v1/catalog/services/{serviceId}/consumption/{serviceInstanceId}:
12933 description: Service consumption on operation
12934 operationId: addInputToServiceOperation
12942 name: serviceInstanceId
12955 description: Service Consumption Data
12959 description: Service property created
12961 description: Invalid content / Missing content
12963 description: Restricted operation
12965 description: Service property already exist
12981 additionalProperties:
13021 additionalProperties:
13053 unicodeLocaleAttributes:
13078 additionalProperties:
13104 additionalProperties:
13116 additionalProperties:
13142 additionalProperties:
13149 summary: Returns consumption data
13152 /v1/catalog/services/{serviceId}/consumption/{serviceInstanceId}/interfaces/{interfaceId}/operations/{operationId}/inputs:
13154 operationId: getInputsListOfOperation
13162 name: serviceInstanceId
13183 application/json: {}
13184 description: default response
13190 /v1/catalog/services/{serviceId}/distribution/{did}/markDeployed:
13192 description: Mark distribution as deployed
13193 operationId: markDistributionAsDeployed
13211 description: Service was marked as deployed
13213 description: Invalid content / Missing content
13215 description: Service is not available
13217 description: Requested service was not found
13219 description: Restricted operation
13221 description: Internal Server Error. Please try again later.
13225 summary: relevant audit record will be created
13228 /v1/catalog/services/{serviceId}/distribution/{env}/activate:
13230 description: Activate distribution
13231 operationId: activateDistribution
13251 description: Requested service was not found
13253 description: Service cannot be distributed due to missing deployment artifacts
13255 description: Internal Server Error. Please try again later.
13259 summary: activate distribution
13262 /v1/catalog/services/{serviceId}/interfaceOperations:
13264 description: Create Interface Operations on Service
13265 operationId: createInterfaceOperationsOnService
13267 - description: Service Id
13282 description: Interface Operations to create
13286 description: Create Interface Operations on Service
13288 description: Invalid content / Missing content
13290 description: Restricted operation
13292 description: Service not found
13294 description: Interface Operation already exist
13301 $ref: '#/components/schemas/InterfaceDefinition'
13305 summary: Create Interface Operations on Service
13309 description: Update Interface Operations on Service
13310 operationId: updateInterfaceOperationsOnService
13312 - description: Service Id
13327 description: Interface Operations to update
13331 description: Update Interface Operations on Service
13333 description: Invalid content / Missing content
13335 description: Restricted operation
13337 description: Service not found
13344 $ref: '#/components/schemas/InterfaceDefinition'
13348 summary: Update Interface Operations on Service
13351 /v1/catalog/services/{serviceId}/interfaces/{interfaceId}/operations/{operationId}:
13353 description: Delete Interface Operation from Service
13354 operationId: deleteInterfaceOperationsFromService
13356 - description: Service Id
13362 - description: Interface Id
13368 - description: Operation Id
13380 description: Delete Interface Operation from Service
13382 description: Invalid content / Missing content
13384 description: Restricted operation
13386 description: Service not found
13393 $ref: '#/components/schemas/InterfaceDefinition'
13397 summary: Delete Interface Operation from Service
13401 description: Get Interface Operation from Service
13402 operationId: getInterfaceOperationsFromService
13404 - description: Service Id
13410 - description: Interface Id
13416 - description: Operation Id
13428 description: Get Interface Operation from Service
13430 description: Invalid content / Missing content
13432 description: Restricted operation
13434 description: Service not found
13441 $ref: '#/components/schemas/InterfaceDefinition'
13445 summary: GET Interface Operation from Service
13448 /v1/catalog/services/{serviceId}/linksMap:
13450 description: Retrieve Service component relations map
13451 operationId: getServiceComponentRelationMap
13464 description: Service found
13466 description: Restricted operation
13468 description: Service not found
13475 $ref: '#/components/schemas/ServiceRelations'
13479 summary: Returns service components relations
13482 /v1/catalog/services/{serviceId}/metadata:
13484 description: Update Service Metadata
13485 operationId: updateServiceMetadata
13501 description: Service object to be Updated
13505 description: Service Updated
13507 description: Invalid content / Missing content
13509 description: Restricted operation
13516 $ref: '#/components/schemas/Service'
13520 summary: Returns updated service
13523 /v1/catalog/services/{serviceId}/paths:
13525 description: Create Forwarding Path
13526 operationId: createForwardingPath
13528 - description: Service Id
13543 description: Forwarding Path to create
13547 description: Create Forwarding Path
13549 description: Invalid content / Missing content
13551 description: Restricted operation
13553 description: Forwarding Path already exist
13560 $ref: '#/components/schemas/Service'
13564 summary: Create Forwarding Path
13568 description: Update Forwarding Path
13569 operationId: updateForwardingPath
13571 - description: Service Id
13586 description: Update Path to create
13590 description: Update Forwarding Path
13592 description: Invalid content / Missing content
13594 description: Restricted operation
13596 description: Forwarding Path already exist
13603 $ref: '#/components/schemas/Service'
13607 summary: Update Forwarding Path
13610 /v1/catalog/services/{serviceId}/paths/{forwardingPathId}:
13612 description: Delete Forwarding Path
13613 operationId: deleteForwardingPath
13615 - description: Forwarding Path Id
13617 name: forwardingPathId
13621 - description: Service Id
13633 description: Delete Forwarding Path
13635 description: Invalid content / Missing content
13637 description: Restricted operation
13639 description: Forwarding Path already exist
13646 $ref: '#/components/schemas/Service'
13650 summary: Delete Forwarding Path
13654 description: Get Forwarding Path
13655 operationId: getForwardingPath
13657 - description: Service Id
13663 - description: Forwarding Path Id
13665 name: forwardingPathId
13678 description: Forwarding Path to create
13682 description: Get Forwarding Path
13684 description: Invalid content / Missing content
13686 description: Restricted operation
13688 description: Forwarding Path already exist
13695 $ref: '#/components/schemas/ForwardingPathDataDefinition'
13699 summary: GET Forwarding Path
13702 /v1/catalog/services/{serviceId}/properties:
13704 description: Get Service Property
13705 operationId: getPropertyListInService
13707 - description: service id of property
13719 description: property
13721 description: Invalid content / Missing content
13723 description: Restricted operation
13725 description: Service property not found
13741 additionalProperties:
13781 additionalProperties:
13813 unicodeLocaleAttributes:
13838 additionalProperties:
13864 additionalProperties:
13876 additionalProperties:
13902 additionalProperties:
13909 summary: Returns property list of service
13913 description: Create Service Property
13914 operationId: createPropertyInService
13916 - description: service id to update with new property
13931 description: Service property to be created
13935 description: Service property created
13937 description: Invalid content / Missing content
13939 description: Restricted operation
13941 description: Service property already exist
13957 additionalProperties:
13997 additionalProperties:
14029 unicodeLocaleAttributes:
14054 additionalProperties:
14080 additionalProperties:
14092 additionalProperties:
14118 additionalProperties:
14125 summary: Returns created service property
14129 description: Update Service Property
14130 operationId: updatePropertyInService
14132 - description: service id to update with new property
14147 description: Service property to update
14151 description: Service property updated
14153 description: Invalid content / Missing content
14155 description: Restricted operation
14171 additionalProperties:
14211 additionalProperties:
14243 unicodeLocaleAttributes:
14268 additionalProperties:
14294 additionalProperties:
14306 additionalProperties:
14332 additionalProperties:
14339 summary: Returns updated property
14342 /v1/catalog/services/{serviceId}/properties/{propertyId}:
14344 description: Delete Service Property
14345 operationId: deletePropertyInService
14347 - description: service id of property
14353 - description: Property id to delete
14365 description: deleted property
14367 description: Invalid content / Missing content
14369 description: Restricted operation
14371 description: Service property not found
14387 additionalProperties:
14427 additionalProperties:
14459 unicodeLocaleAttributes:
14484 additionalProperties:
14510 additionalProperties:
14522 additionalProperties:
14548 additionalProperties:
14555 summary: Returns deleted property
14559 description: Get Service Property
14560 operationId: getPropertyInService
14562 - description: service id of property
14568 - description: property id to get
14580 description: property
14582 description: Invalid content / Missing content
14584 description: Restricted operation
14586 description: Service property not found
14602 additionalProperties:
14642 additionalProperties:
14674 unicodeLocaleAttributes:
14699 additionalProperties:
14725 additionalProperties:
14737 additionalProperties:
14763 additionalProperties:
14770 summary: Returns property of service
14773 /v1/catalog/services/{serviceId}/requirements:
14775 description: Create requirements on service
14776 operationId: createRequirementsOnService
14778 - description: Service Id
14793 description: Requirements to create
14797 description: Create Requirements
14799 description: Invalid content / Missing content
14801 description: Restricted operation
14803 description: Requirement already exist
14819 additionalProperties:
14859 additionalProperties:
14891 unicodeLocaleAttributes:
14916 additionalProperties:
14942 additionalProperties:
14954 additionalProperties:
14980 additionalProperties:
14987 summary: Create requirements on service
14991 description: Update requirements on service
14992 operationId: updateRequirementsOnService
14994 - description: Component Id
15009 description: Requirements to update
15013 description: Update requirements
15015 description: Invalid content / Missing content
15017 description: Restricted operation
15024 $ref: '#/components/schemas/RequirementDefinition'
15028 summary: Update requirements on service
15031 /v1/catalog/services/{serviceId}/requirements/{requirementId}:
15033 description: Delete requirement from service
15034 operationId: deleteRequirementsOnService
15036 - description: Service Id
15042 - description: Requirement Id
15044 name: requirementId
15054 description: Delete Requirements
15056 description: Invalid content / Missing content
15058 description: Restricted operation
15065 $ref: '#/components/schemas/RequirementDefinition'
15069 summary: Delete requirement from service
15073 description: Get requirement from service
15074 operationId: getRequirementsOnService
15076 - description: Service Id
15082 - description: Requirement Id
15084 name: requirementId
15094 description: GET Requirements
15096 description: Invalid content / Missing content
15098 description: Restricted operation
15105 $ref: '#/components/schemas/RequirementDefinition'
15109 summary: GET requirement from service
15112 /v1/catalog/services/{serviceId}/tempUrlToBeDeleted:
15114 operationId: tempUrlToBeDeleted
15129 description: Internal Server Error. Please try again later.
15135 /v1/catalog/services/{serviceName}/{version}:
15137 description: Delete Service By Name And Version
15138 operationId: deleteServiceByNameAndVersion
15152 description: Service deleted
15154 description: Invalid content / Missing content
15156 description: Restricted operation
15158 description: Service not found
15165 $ref: '#/components/schemas/Resource'
15169 summary: Returns no content
15172 /v1/catalog/services/{serviceUUID}/distribution:
15174 description: Retrieve Distributions
15175 operationId: getServiceById
15188 description: Service found
15190 description: Restricted operation
15192 description: Service not found
15199 $ref: '#/components/schemas/DistributionStatusListResponse'
15203 summary: Returns list bases on the information extracted from Auditing Records
15204 according to service uuid
15207 /v1/catalog/toggle:
15209 description: Get all Toggleable features
15210 operationId: getAllFeatures
15213 description: Success
15215 description: Invalid content / Missing content
15217 description: Restricted operation
15219 description: Toggleable features not found
15235 additionalProperties:
15275 additionalProperties:
15307 unicodeLocaleAttributes:
15332 additionalProperties:
15358 additionalProperties:
15370 additionalProperties:
15396 additionalProperties:
15403 summary: Returns list of toggleable features
15406 /v1/catalog/toggle/state/{state}:
15408 description: Update all feature toggle state
15409 operationId: setAllFeatures
15418 description: Success
15420 description: Invalid content / Missing content
15422 description: Restricted operation
15424 description: Toggleable features not found
15440 additionalProperties:
15480 additionalProperties:
15512 unicodeLocaleAttributes:
15537 additionalProperties:
15563 additionalProperties:
15575 additionalProperties:
15601 additionalProperties:
15608 summary: Update all feature status
15611 /v1/catalog/toggle/{featureName}/state:
15613 description: Get Toggleable feature state
15614 operationId: getToggleableFeature
15623 description: Success
15625 description: Invalid content / Missing content
15627 description: Restricted operation
15629 description: Toggleable feature not found
15645 additionalProperties:
15685 additionalProperties:
15717 unicodeLocaleAttributes:
15742 additionalProperties:
15768 additionalProperties:
15780 additionalProperties:
15806 additionalProperties:
15813 summary: Returns one toggleable feature state
15816 /v1/catalog/toggle/{featureName}/state/{state}:
15818 description: Update feature toggle state
15819 operationId: updateFeatureState
15833 description: Success
15835 description: Invalid content / Missing content
15837 description: Restricted operation
15839 description: Toggleable features not found
15855 additionalProperties:
15895 additionalProperties:
15927 unicodeLocaleAttributes:
15952 additionalProperties:
15978 additionalProperties:
15990 additionalProperties:
16016 additionalProperties:
16023 summary: Update feature status
16026 /v1/catalog/upload/resource/import:
16028 description: "Import node types from a TOSCA yaml, along with the types metadata"
16029 operationId: bulkImport
16037 multipart/form-data:
16044 description: The model name to associate the node types to
16045 nodeTypeMetadataJson:
16046 $ref: '#/components/schemas/NodeTypesMetadataList'
16049 description: The node types TOSCA definition yaml
16051 - nodeTypeMetadataJson
16055 description: Resources created
16057 description: Invalid content / Missing content
16059 description: Restricted operation
16061 description: One of the resources already exists
16077 additionalProperties:
16117 additionalProperties:
16149 unicodeLocaleAttributes:
16174 additionalProperties:
16200 additionalProperties:
16212 additionalProperties:
16238 additionalProperties:
16245 summary: Creates node types from a TOSCA yaml file
16248 /v1/catalog/upload/{resourceAuthority}:
16250 description: Create Resource from yaml
16251 operationId: uploadMultipart
16253 - description: "validValues: normative-resource / user-resource"
16255 name: resourceAuthority
16262 - user-resource-ui-import
16268 name: createNewVersion
16274 multipart/form-data:
16280 description: resourceMetadata
16282 $ref: '#/components/schemas/FormDataContentDisposition'
16285 description: Resource created
16287 description: Invalid content / Missing content
16289 description: Restricted operation
16291 description: Resource already exist
16307 additionalProperties:
16347 additionalProperties:
16379 unicodeLocaleAttributes:
16404 additionalProperties:
16430 additionalProperties:
16442 additionalProperties:
16468 additionalProperties:
16475 summary: Returns created resource
16478 /v1/catalog/uploadType/annotationtypes:
16480 description: Create AnnotationTypes from yaml
16481 operationId: uploadAnnotationTypes
16489 multipart/form-data:
16493 annotationTypesZip:
16496 description: FileInputStream
16499 description: annotation types created
16501 description: Invalid content / Missing content
16503 description: Restricted operation
16505 description: annotation types already exist
16521 additionalProperties:
16561 additionalProperties:
16593 unicodeLocaleAttributes:
16618 additionalProperties:
16644 additionalProperties:
16656 additionalProperties:
16682 additionalProperties:
16689 summary: Returns created annotation types
16692 /v1/catalog/uploadType/artifactTypes:
16694 description: Create Tosca Artifact types from yaml
16695 operationId: uploadArtifactTypes
16703 multipart/form-data:
16710 description: Zip file containing a yaml with the TOSCA artifact
16712 includeToModelImport:
16714 description: A flag to add types to the default imports
16717 description: model name
16720 description: Tosca Artifact types created
16722 description: Invalid content / Missing content
16724 description: Restricted operation
16726 description: Tosca Artifact Type already exist
16742 additionalProperties:
16782 additionalProperties:
16814 unicodeLocaleAttributes:
16839 additionalProperties:
16865 additionalProperties:
16877 additionalProperties:
16903 additionalProperties:
16910 summary: Returns created Tosca artifact types
16913 /v1/catalog/uploadType/capability:
16915 description: Create Capability Type from yaml
16916 operationId: uploadCapabilityType
16924 multipart/form-data:
16931 description: FileInputStream
16932 includeToModelImport:
16934 description: includeToModelImport
16940 description: Capability Type created
16942 description: Invalid content / Missing content
16944 description: Restricted operation
16946 description: Capability Type already exist
16962 additionalProperties:
17002 additionalProperties:
17034 unicodeLocaleAttributes:
17059 additionalProperties:
17085 additionalProperties:
17097 additionalProperties:
17123 additionalProperties:
17130 summary: Returns created Capability Type
17133 /v1/catalog/uploadType/categories:
17135 description: Create Categories from yaml
17136 operationId: uploadCategories
17144 multipart/form-data:
17151 description: FileInputStream
17154 description: Categories created
17156 description: Invalid content / Missing content
17158 description: Restricted operation
17160 description: Category already exist
17176 additionalProperties:
17216 additionalProperties:
17248 unicodeLocaleAttributes:
17273 additionalProperties:
17299 additionalProperties:
17311 additionalProperties:
17337 additionalProperties:
17344 summary: Returns created categories
17347 /v1/catalog/uploadType/datatypes:
17349 description: Create Categories from yaml
17350 operationId: uploadDataTypes
17358 multipart/form-data:
17365 description: FileInputStream
17366 includeToModelImport:
17368 description: includeToModelImport
17374 description: Data types created
17376 description: Invalid content / Missing content
17378 description: Restricted operation
17380 description: Data types already exist
17396 additionalProperties:
17436 additionalProperties:
17468 unicodeLocaleAttributes:
17493 additionalProperties:
17519 additionalProperties:
17531 additionalProperties:
17557 additionalProperties:
17564 summary: Returns created data types
17567 /v1/catalog/uploadType/grouptypes:
17569 description: Create GroupTypes from yaml
17570 operationId: uploadGroupTypes
17578 multipart/form-data:
17585 description: FileInputStream
17586 includeToModelImport:
17588 description: includeToModelImport
17594 description: toscaTypeMetadata
17597 description: group types created
17599 description: Invalid content / Missing content
17601 description: Restricted operation
17603 description: group types already exist
17619 additionalProperties:
17659 additionalProperties:
17691 unicodeLocaleAttributes:
17716 additionalProperties:
17742 additionalProperties:
17754 additionalProperties:
17780 additionalProperties:
17787 summary: Returns created group types
17790 /v1/catalog/uploadType/interfaceLifecycle:
17792 description: Create Interface Lyfecycle Type from yaml
17793 operationId: uploadInterfaceLifecycleType
17801 multipart/form-data:
17805 includeToModelImport:
17807 description: includeToModelImport
17808 interfaceLifecycleTypeZip:
17811 description: FileInputStream
17817 description: Interface Lifecycle Type created
17819 description: Invalid content / Missing content
17821 description: Restricted operation
17823 description: Interface Lifecycle Type already exist
17839 additionalProperties:
17879 additionalProperties:
17911 unicodeLocaleAttributes:
17936 additionalProperties:
17962 additionalProperties:
17974 additionalProperties:
18000 additionalProperties:
18007 summary: Returns created Interface Lifecycle Type
18010 /v1/catalog/uploadType/policytypes:
18012 description: Create PolicyTypes from yaml
18013 operationId: uploadPolicyTypes
18021 multipart/form-data:
18025 includeToModelImport:
18027 description: includeToModelImport
18034 description: FileInputStream
18037 description: toscaTypeMetadata
18040 description: policy types created
18042 description: Invalid content / Missing content
18044 description: Restricted operation
18046 description: policy types already exist
18062 additionalProperties:
18102 additionalProperties:
18134 unicodeLocaleAttributes:
18159 additionalProperties:
18185 additionalProperties:
18197 additionalProperties:
18223 additionalProperties:
18230 summary: Returns created policy types
18233 /v1/catalog/uploadType/relationship:
18235 description: Create Relationship Type from yaml
18236 operationId: uploadRelationshipType
18244 multipart/form-data:
18248 includeToModelImport:
18250 description: includeToModelImport
18254 relationshipTypeZip:
18257 description: FileInputStream
18260 description: Relationship Type created
18262 description: Invalid content / Missing content
18264 description: Restricted operation
18266 description: Relationship Type already exist
18282 additionalProperties:
18322 additionalProperties:
18354 unicodeLocaleAttributes:
18379 additionalProperties:
18405 additionalProperties:
18417 additionalProperties:
18443 additionalProperties:
18450 summary: Returns created Relationship Type
18453 /v1/catalog/{assetType}/{uuid}/interfaces/{interfaceUUID}/operations/{operationUUID}/artifacts/{artifactUUID}:
18455 description: uploads of artifact to component operation workflow
18456 operationId: uploadInterfaceOperationArtifact
18458 - description: Asset type
18464 - description: The uuid of the asset as published in the metadata
18470 - description: The uuid of the interface
18472 name: interfaceUUID
18476 - description: The uuid of the operation
18478 name: operationUUID
18482 - description: The uuid of the artifact
18503 $ref: '#/components/schemas/ArtifactDefinition'
18504 description: Artifact uploaded
18506 description: Restricted Operation – the user provided does not have role
18507 of Designer or the asset is being used by another designer - SVC4301
18509 description: Specified resource is not found - SVC4063
18513 summary: uploads of artifact to component operation workflow
18516 /v1/catalog/{componentType}/latestversion/notabstract:
18518 description: Get Component Requirments And Capabilities
18519 operationId: getLatestVersionNotAbstractCheckoutComponents
18522 name: componentType
18527 name: internalComponentType
18531 name: componentUids
18542 description: Component found
18544 description: Restricted operation
18546 description: Component not found
18553 $ref: '#/components/schemas/Resource'
18557 summary: Returns Requirments And Capabilities according to componentId
18561 description: Get Component Requirments And Capabilities
18562 operationId: getLatestVersionNotAbstractCheckoutComponentsByBody
18565 name: componentType
18570 name: internalComponentType
18584 description: Consumer Object to be created
18588 description: Component found
18590 description: Restricted operation
18592 description: Component not found
18599 $ref: '#/components/schemas/Resource'
18603 summary: Returns Requirments And Capabilities according to componentId
18606 /v1/catalog/{componentType}/latestversion/notabstract/metadata:
18608 description: Get Component uid only
18609 operationId: getLatestVersionNotAbstractCheckoutComponentsIdesOnly
18612 name: componentType
18617 name: internalComponentType
18621 name: componentModel
18625 name: includeNormativeExtensionModels
18637 description: uid list
18641 description: Component found
18643 description: Restricted operation
18645 description: Component not found
18652 $ref: '#/components/schemas/Resource'
18656 summary: Returns componentId
18659 /v1/catalog/{componentType}/{componentId}/automatedupgrade:
18661 description: Autometed upgrade
18662 operationId: autometedUpgrade
18665 name: componentType
18683 description: json describes upgrade request
18687 description: Component found
18689 description: Restricted operation
18691 description: Component not found
18707 additionalProperties:
18747 additionalProperties:
18779 unicodeLocaleAttributes:
18804 additionalProperties:
18830 additionalProperties:
18842 additionalProperties:
18868 additionalProperties:
18878 /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/interfaceOperation:
18880 description: Update Interface Operation
18881 operationId: updateComponentInstanceInterfaceOperation
18883 - description: "valid values: resources / services"
18885 name: componentType
18892 - description: Component Id
18898 - description: Component Instance Id
18900 name: componentInstanceId
18910 description: Update Interface Operation
18912 description: Invalid content / Missing content
18914 description: Restricted operation
18930 additionalProperties:
18970 additionalProperties:
19002 unicodeLocaleAttributes:
19027 additionalProperties:
19053 additionalProperties:
19065 additionalProperties:
19091 additionalProperties:
19098 summary: Update Interface Operation on ComponentInstance
19101 /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/{constraintType}/nodeFilter:
19103 description: Add Component Filter Constraint
19104 operationId: addComponentFilterConstraint
19106 - description: Component Id
19112 - description: Component Instance Id
19114 name: componentInstanceId
19118 - description: "valid values: resources / services"
19120 name: componentType
19127 - description: "Constraint type. Valid values: properties / capabilities"
19129 name: constraintType
19145 description: UIConstraint data
19149 description: Create Component Filter
19151 description: Invalid content / Missing content
19153 description: Restricted operation
19169 additionalProperties:
19209 additionalProperties:
19241 unicodeLocaleAttributes:
19266 additionalProperties:
19292 additionalProperties:
19304 additionalProperties:
19330 additionalProperties:
19334 summary: Add Component Filter Constraint
19337 /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/{constraintType}/{constraintIndex}/nodeFilter:
19339 description: Delete Component Filter Constraint
19340 operationId: deleteComponentFilterConstraint
19342 - description: Component Id
19348 - description: Component Instance Id
19350 name: componentInstanceId
19354 - description: Constraint Index
19356 name: constraintIndex
19361 - description: "valid values: resources / services"
19363 name: componentType
19370 - description: "Constraint type. Valid values: properties / capabilities"
19372 name: constraintType
19385 description: Delete Component Filter Constraint
19387 description: Invalid content / Missing content
19389 description: Restricted operation
19405 additionalProperties:
19445 additionalProperties:
19477 unicodeLocaleAttributes:
19502 additionalProperties:
19528 additionalProperties:
19540 additionalProperties:
19566 additionalProperties:
19570 summary: Delete Component Filter Constraint
19574 description: Update Component Filter Constraint
19575 operationId: updateComponentFilterConstraint
19577 - description: Component Id
19583 - description: Component Instance Id
19585 name: componentInstanceId
19589 - description: "valid values: resources / services"
19591 name: componentType
19598 - description: "Constraint type. Valid values: properties / capabilities"
19600 name: constraintType
19607 - description: Constraint Index
19609 name: constraintIndex
19623 description: UIConstraint data
19627 description: Create Component Filter
19629 description: Invalid content / Missing content
19631 description: Restricted operation
19647 additionalProperties:
19687 additionalProperties:
19719 unicodeLocaleAttributes:
19744 additionalProperties:
19770 additionalProperties:
19782 additionalProperties:
19808 additionalProperties:
19812 summary: Update Component Filter Constraint
19815 /v1/catalog/{componentType}/{componentId}/componentInstances:
19817 description: Get Component instances
19818 operationId: getComponentInstancesFilteredByPropertiesAndInputs
19821 name: componentType
19843 description: uid list
19847 description: Component found
19849 description: Restricted operation
19851 description: Component not found
19858 $ref: '#/components/schemas/Resource'
19862 summary: Returns component instances
19865 /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{inputId}/properties:
19867 description: Get properties
19868 operationId: getInputPropertiesForComponentInstance
19871 name: componentType
19896 description: Component found
19898 description: Restricted operation
19900 description: Component not found
19907 $ref: '#/components/schemas/Resource'
19911 summary: Returns properties list
19914 /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/inputs:
19916 description: Get Inputs only
19917 operationId: getComponentInstanceInputs
19920 name: componentType
19935 name: originComponentUid
19945 description: Component found
19947 description: Restricted operation
19949 description: Component not found
19956 $ref: '#/components/schemas/Resource'
19960 summary: Returns Inputs list
19963 /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/outputs:
19965 description: Get Outputs only
19966 operationId: getComponentInstanceOutputs
19969 name: componentType
19984 name: originComponentUid
19994 description: Component found
19996 description: Restricted operation
19998 description: Component not found
20005 $ref: '#/components/schemas/Resource'
20009 summary: Returns Outputs list
20012 /v1/catalog/{componentType}/{componentId}/create/input:
20014 description: Create inputs on service
20015 operationId: createInput
20018 name: componentType
20036 description: ComponentIns Inputs Object to be created
20040 description: Component found
20042 description: Restricted operation
20044 description: Component not found
20051 $ref: '#/components/schemas/Resource'
20055 summary: Return inputs list
20058 /v1/catalog/{componentType}/{componentId}/create/inputs:
20060 description: Create inputs on service
20061 operationId: createMultipleInputs
20064 name: componentType
20082 description: ComponentIns Inputs Object to be created
20086 description: Component found
20088 description: Restricted operation
20090 description: Component not found
20097 $ref: '#/components/schemas/Resource'
20101 summary: Return inputs list
20104 /v1/catalog/{componentType}/{componentId}/create/listInput:
20106 description: Create a list input on service
20107 operationId: createListInput
20110 name: componentType
20128 description: ComponentIns Inputs Object to be created
20132 description: Component found
20134 description: Restricted operation
20136 description: Component not found
20143 $ref: '#/components/schemas/Resource'
20147 summary: Return input
20150 /v1/catalog/{componentType}/{componentId}/create/outputs:
20152 description: Create outputs on service
20153 operationId: createMultipleOutputs
20156 name: componentType
20174 description: ComponentIns Outputs Object to be created
20178 description: Component found
20180 description: Restricted operation
20182 description: Component not found
20189 $ref: '#/components/schemas/Resource'
20193 summary: Return outputs list
20196 /v1/catalog/{componentType}/{componentId}/create/policies:
20198 description: Create policies on service
20199 operationId: declareProperties
20202 name: componentType
20220 description: ComponentIns policies Object to be created
20224 description: Component found
20226 description: Restricted operation
20228 description: Component not found
20235 $ref: '#/components/schemas/Resource'
20239 summary: Return policies list
20242 /v1/catalog/{componentType}/{componentId}/dataType/{dataTypeName}:
20244 description: Delete data type from service
20245 operationId: deleteDataType
20248 name: componentType
20264 description: Data type deleted
20266 description: Restricted operation
20268 description: Data type not found
20275 $ref: '#/components/schemas/Resource'
20279 summary: Delete service input
20283 description: Get data type in service
20284 operationId: getDataType
20287 name: componentType
20303 description: Data type found
20305 description: Restricted operation
20307 description: Data type not found
20314 $ref: '#/components/schemas/DataTypeDefinition'
20318 summary: Get data type in service
20321 /v1/catalog/{componentType}/{componentId}/dataTypes:
20323 description: Get data types that service has
20324 operationId: getDataTypes
20327 name: componentType
20338 description: Data type found
20340 description: Restricted operation
20342 description: Component not found
20349 $ref: '#/components/schemas/Resource'
20353 summary: Get data types in service
20356 /v1/catalog/{componentType}/{componentId}/delete/{inputId}/input:
20358 description: Delete input from service
20359 operationId: deleteInput
20362 name: componentType
20385 description: Service Input to be deleted
20389 description: Input deleted
20391 description: Restricted operation
20393 description: Input not found
20400 $ref: '#/components/schemas/Resource'
20404 summary: Delete service input
20407 /v1/catalog/{componentType}/{componentId}/delete/{outputId}/output:
20409 description: Delete output from service
20410 operationId: deleteOutput
20413 name: componentType
20436 description: Service Output to be deleted
20440 description: Output deleted
20442 description: Restricted operation
20444 description: Output not found
20451 $ref: '#/components/schemas/Resource'
20455 summary: Delete service output
20458 /v1/catalog/{componentType}/{componentId}/dependencies:
20460 description: Autometed upgrade
20461 operationId: getComponentDependencies
20464 name: componentType
20484 description: Consumer Object to be created
20488 description: Component found
20490 description: Restricted operation
20492 description: Component not found
20508 additionalProperties:
20548 additionalProperties:
20580 unicodeLocaleAttributes:
20605 additionalProperties:
20631 additionalProperties:
20643 additionalProperties:
20669 additionalProperties:
20679 /v1/catalog/{componentType}/{componentId}/filteredDataByParams:
20681 description: Retrieve Resource
20682 operationId: getComponentDataFilteredByParams
20685 name: componentType
20706 description: Resource found
20708 description: Restricted operation
20710 description: Resource not found
20717 $ref: '#/components/schemas/Resource'
20721 summary: Returns resource according to resourceId
20724 /v1/catalog/{componentType}/{componentId}/filteredproperties/{propertyNameFragment}:
20726 description: Retrieve properties belonging to component instances of specific
20727 component by name and optionally resource type
20728 operationId: getFilteredComponentInstanceProperties
20731 name: componentType
20741 name: propertyNameFragment
20757 description: Component found
20759 description: Restricted operation
20761 description: Component not found
20772 summary: Returns properties belonging to component instances of specific component
20773 by name and optionally resource type
20776 /v1/catalog/{componentType}/{componentId}/inputs/{inputId}:
20778 description: Get inputs
20779 operationId: getInputsAndPropertiesForComponentInput
20782 name: componentType
20802 description: Component found
20804 description: Restricted operation
20806 description: Component not found
20813 $ref: '#/components/schemas/Resource'
20817 summary: Returns inputs list
20820 /v1/catalog/{componentType}/{componentId}/inputs/{inputId}/inputs:
20822 description: Get inputs
20823 operationId: getInputsForComponentInput
20826 name: componentType
20846 description: Component found
20848 description: Restricted operation
20850 description: Component not found
20857 $ref: '#/components/schemas/Resource'
20861 summary: Returns inputs list
20864 /v1/catalog/{componentType}/{componentId}/requirmentsCapabilities:
20866 description: Get Component Requirments And Capabilities
20867 operationId: getRequirementAndCapabilities
20870 name: componentType
20885 description: Component found
20887 description: Restricted operation
20889 description: Component not found
20896 $ref: '#/components/schemas/Resource'
20900 summary: Returns Requirements And Capabilities according to componentId
20903 /v1/catalog/{componentType}/{componentId}/resource/interfaceOperation:
20905 description: Create Interface Operation
20906 operationId: createInterfaceOperationInResource
20908 - description: "valid values: resources"
20910 name: componentType
20916 - description: Component Id
20928 description: Create Interface Operation
20930 description: Invalid content / Missing content
20932 description: Restricted operation
20948 additionalProperties:
20988 additionalProperties:
21020 unicodeLocaleAttributes:
21045 additionalProperties:
21071 additionalProperties:
21083 additionalProperties:
21109 additionalProperties:
21116 summary: Create Interface Operation on ComponentInstance
21119 /v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}:
21121 description: Add Component Substitution Filter Constraint
21122 operationId: addSubstitutionFilter
21124 - description: Component Id
21130 - description: "valid value: resources / services"
21132 name: componentType
21139 - description: "Constraint type. Valid values: properties / capabilities"
21141 name: constraintType
21157 description: UIConstraint data
21161 description: Add Substitution Filter Constraint
21163 description: Invalid content / Missing content
21165 description: Restricted operation
21181 additionalProperties:
21221 additionalProperties:
21253 unicodeLocaleAttributes:
21278 additionalProperties:
21304 additionalProperties:
21316 additionalProperties:
21342 additionalProperties:
21346 summary: Add Component Substitution Filter Constraint
21350 description: Update Component Substitution Filter Constraint
21351 operationId: updateSubstitutionFilters
21353 - description: Component Id
21359 - description: "valid value: resources / services"
21361 name: componentType
21368 - description: "Constraint type. Valid values: properties / capabilities"
21370 name: constraintType
21386 description: UIConstraint data
21390 description: Update Substitution Filter Constraint
21392 description: Invalid content / Missing content
21394 description: Restricted operation
21410 additionalProperties:
21450 additionalProperties:
21482 unicodeLocaleAttributes:
21507 additionalProperties:
21533 additionalProperties:
21545 additionalProperties:
21571 additionalProperties:
21575 summary: Update Component Substitution Filter Constraint
21578 /v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}/{constraintIndex}:
21580 description: Delete Component Substitution Filter Constraint
21581 operationId: deleteSubstitutionFilterConstraint
21583 - description: Component Id
21589 - description: Constraint Index
21591 name: constraintIndex
21596 - description: "valid value: resources / services"
21598 name: componentType
21605 - description: "Constraint type. Valid values: properties / capabilities"
21607 name: constraintType
21620 description: Delete Substitution Filter Constraint
21622 description: Invalid content / Missing content
21624 description: Restricted operation
21640 additionalProperties:
21680 additionalProperties:
21712 unicodeLocaleAttributes:
21737 additionalProperties:
21763 additionalProperties:
21775 additionalProperties:
21801 additionalProperties:
21805 summary: Delete Component Substitution Filter Constraint
21809 description: Update Component Substitution Filter Constraint
21810 operationId: updateSubstitutionFilter
21812 - description: Constraint Index
21814 name: constraintIndex
21819 - description: Component Id
21825 - description: The component type
21827 name: componentType
21834 - description: "Constraint type. Valid values: properties / capabilities"
21836 name: constraintType
21851 $ref: '#/components/schemas/UIConstraint'
21852 description: Filter constraint information
21856 description: Update Substitution Filter Constraint
21858 description: Invalid content / Missing content
21860 description: Restricted operation
21876 additionalProperties:
21916 additionalProperties:
21948 unicodeLocaleAttributes:
21973 additionalProperties:
21999 additionalProperties:
22011 additionalProperties:
22037 additionalProperties:
22041 summary: Update Component Substitution Filter Constraint
22044 /v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation:
22046 description: Validate Component Conformance Level
22047 operationId: conformanceLevelValidation
22050 name: componentType
22055 name: componentUuid
22065 description: Component found
22067 description: Restricted operation
22069 description: Component not found
22076 $ref: '#/components/schemas/Resource'
22080 summary: Returns the result according to conformance level in BE config
22083 /v1/catalog/{containerComponentType}/{componentId}/artifactsByType/{artifactGroupType}:
22085 description: Get component Artifacts
22086 operationId: getComponentArtifacts
22088 - description: "valid values: resources / services"
22090 name: containerComponentType
22103 name: artifactGroupType
22109 description: Component artifacts
22111 description: Resource/Artifact not found
22127 additionalProperties:
22167 additionalProperties:
22199 unicodeLocaleAttributes:
22224 additionalProperties:
22250 additionalProperties:
22262 additionalProperties:
22288 additionalProperties:
22295 summary: Returns artifacts
22298 /v1/catalog/{containerComponentType}/{componentId}/batchDeleteResourceInstances:
22300 description: Batch Delete ResourceInstances
22301 operationId: batchDeleteResourceInstances
22303 - description: "valid values: resources / services / products"
22305 name: containerComponentType
22323 description: Component Instance Id List
22327 description: ResourceInstances deleted
22329 description: Invalid Content / Missing Content
22331 description: Restricted Operation
22337 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupId}:
22339 description: 'Get group artifacts '
22340 operationId: getGroupById
22343 name: containerComponentType
22363 description: group found
22365 description: Restricted operation
22367 description: Group not found
22374 $ref: '#/components/schemas/Resource'
22378 summary: Returns artifacts metadata according to groupId
22382 description: Update Group metadata
22383 operationId: updateGroup
22386 name: containerComponentType
22408 $ref: '#/components/schemas/GroupDefinition'
22409 description: GroupDefinition
22413 description: Group updated
22415 description: Invalid content / Missing content
22417 description: Restricted operation
22419 description: component / group Not found
22435 additionalProperties:
22475 additionalProperties:
22507 unicodeLocaleAttributes:
22532 additionalProperties:
22558 additionalProperties:
22570 additionalProperties:
22596 additionalProperties:
22603 summary: Returns updated Group
22606 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupType}:
22608 description: 'Create group '
22609 operationId: createGroup
22612 name: containerComponentType
22632 description: Group created
22634 description: "field name invalid type/length, characters; mandatory field\
22635 \ is absent, already exists (name)"
22637 description: Restricted operation
22639 description: Component not found
22641 description: Internal Error
22648 $ref: '#/components/schemas/GroupDefinition'
22652 summary: Creates new group in component and returns it
22655 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}:
22657 description: Delete Group
22658 operationId: deleteGroup
22661 name: containerComponentType
22671 name: groupUniqueId
22681 description: ResourceInstance deleted
22683 description: "field name invalid type/length, characters; mandatory field\
22684 \ is absent, already exists (name)"
22686 description: Restricted operation
22688 description: Component not found
22690 description: Internal Error
22706 additionalProperties:
22746 additionalProperties:
22778 unicodeLocaleAttributes:
22803 additionalProperties:
22829 additionalProperties:
22841 additionalProperties:
22867 additionalProperties:
22874 summary: Returns deleted group id
22877 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/members:
22879 description: 'Update group members '
22880 operationId: updateGroupMembers
22883 name: containerComponentType
22893 name: groupUniqueId
22908 description: List of members unique ids
22912 description: Group members updated
22914 description: "field name invalid type/length, characters; mandatory field\
22915 \ is absent, already exists (name)"
22917 description: Restricted operation
22919 description: Component not found
22921 description: Internal Error
22932 summary: Updates list of members and returns it
22935 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/metadata:
22937 description: Update Group Metadata
22938 operationId: updateGroupMetadata
22941 name: containerComponentType
22951 name: groupUniqueId
22964 description: Service object to be Updated
22968 description: Group Updated
22970 description: Invalid content / Missing content
22972 description: Restricted operation
22979 $ref: '#/components/schemas/GroupDefinition'
22983 summary: Returns updated group definition
22986 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties:
22988 description: Get List of properties on a group
22989 operationId: getGroupProperties
22992 name: containerComponentType
23002 name: groupUniqueId
23012 description: Group Updated
23014 description: Invalid content / Missing content
23016 description: Restricted operation
23023 $ref: '#/components/schemas/GroupProperty'
23027 summary: Returns list of properties
23031 description: Updates List of properties on a group (only values)
23032 operationId: updateGroupProperties
23035 name: containerComponentType
23045 name: groupUniqueId
23059 $ref: '#/components/schemas/GroupProperty'
23060 description: Group Properties to be Updated
23064 description: Group Updated
23066 description: Invalid content / Missing content
23068 description: Restricted operation
23075 $ref: '#/components/schemas/GroupProperty'
23079 summary: Returns updated list of properties
23082 /v1/catalog/{containerComponentType}/{componentId}/paths-to-delete:
23084 description: Check if forwarding path to delete on version change
23085 operationId: changeResourceInstanceVersion_1
23093 name: componentInstanceId
23097 name: newComponentInstanceId
23100 - description: "valid values: resources / services"
23102 name: containerComponentType
23125 additionalProperties:
23165 additionalProperties:
23197 unicodeLocaleAttributes:
23222 additionalProperties:
23248 additionalProperties:
23260 additionalProperties:
23286 additionalProperties:
23293 summary: Returns forwarding paths to delete
23296 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}:
23298 description: Delete Policy
23299 operationId: deletePolicy
23306 - description: "valid values: resources / services"
23308 name: containerComponentType
23320 - description: USER_ID of modifier user
23328 description: Policy was deleted
23330 description: Invalid content / Missing content
23332 description: Restricted operation
23334 description: component / policy Not found
23350 additionalProperties:
23390 additionalProperties:
23422 unicodeLocaleAttributes:
23447 additionalProperties:
23473 additionalProperties:
23485 additionalProperties:
23511 additionalProperties:
23522 description: Get Policy
23523 operationId: getPolicy
23530 - description: "valid values: resources / services"
23532 name: containerComponentType
23544 - description: USER_ID of modifier user
23552 description: Policy was found
23554 description: Invalid content / Missing content
23556 description: Restricted operation
23558 description: component / policy Not found
23574 additionalProperties:
23614 additionalProperties:
23646 unicodeLocaleAttributes:
23671 additionalProperties:
23697 additionalProperties:
23709 additionalProperties:
23735 additionalProperties:
23742 summary: Returns Policy
23746 description: Update Policy metadata
23747 operationId: updatePolicy
23754 - description: "valid values: resources / services"
23756 name: containerComponentType
23768 - description: USER_ID of modifier user
23779 description: PolicyDefinition
23783 description: Policy updated
23785 description: Invalid content / Missing content
23787 description: Restricted operation
23789 description: component / policy Not found
23805 additionalProperties:
23845 additionalProperties:
23877 unicodeLocaleAttributes:
23902 additionalProperties:
23928 additionalProperties:
23940 additionalProperties:
23966 additionalProperties:
23973 summary: Returns updated Policy
23976 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/properties:
23978 description: Get component policy properties
23979 operationId: getPolicyProperties
23981 - description: the id of the component which is the container of the policy
23987 - description: "valid values: resources / services"
23989 name: containerComponentType
23996 - description: the id of the policy which its properties are to return
24002 - description: the userid
24010 description: Properties found
24012 description: "invalid content - Error: containerComponentType is invalid"
24014 description: Restricted operation
24016 description: Componentorpolicy not found
24018 description: The GET request failed due to internal SDC problem.
24025 $ref: '#/components/schemas/PropertyDataDefinition'
24029 summary: Returns component policy properties
24033 description: Update Policy properties
24034 operationId: updatePolicyProperties
24041 - description: "valid values: resources / services"
24043 name: containerComponentType
24055 - description: USER_ID of modifier user
24066 description: PolicyDefinition
24070 description: Policy properties updated
24072 description: Invalid content / Missing content
24074 description: Restricted operation
24076 description: component / policy Not found
24092 additionalProperties:
24132 additionalProperties:
24164 unicodeLocaleAttributes:
24189 additionalProperties:
24215 additionalProperties:
24227 additionalProperties:
24253 additionalProperties:
24260 summary: Returns updated Policy
24263 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/targets:
24265 description: update policy targets
24266 operationId: updatePolicyTargets
24273 - description: "valid values: resources / services"
24275 name: containerComponentType
24287 - description: USER_ID of modifier user
24299 $ref: '#/components/schemas/PolicyTargetDTO'
24302 description: Policy target updated
24304 description: Invalid content / Missing content
24306 description: Restricted operation
24322 additionalProperties:
24362 additionalProperties:
24394 unicodeLocaleAttributes:
24419 additionalProperties:
24445 additionalProperties:
24457 additionalProperties:
24483 additionalProperties:
24490 summary: Returns updated Policy
24493 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/undeclare:
24495 description: undeclare Policy
24496 operationId: undeclarePolicy
24503 - description: "valid values: resources / services"
24505 name: containerComponentType
24517 - description: USER_ID of modifier user
24525 description: Policy was undeclared
24527 description: Invalid content / Missing content
24529 description: Restricted operation
24531 description: component / policy Not found
24547 additionalProperties:
24587 additionalProperties:
24619 unicodeLocaleAttributes:
24644 additionalProperties:
24670 additionalProperties:
24682 additionalProperties:
24708 additionalProperties:
24718 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyTypeName}:
24720 description: Create Policy
24721 operationId: createPolicy
24728 - description: "valid values: resources / services"
24730 name: containerComponentType
24738 name: policyTypeName
24742 - description: USER_ID of modifier user
24750 description: Policy created
24752 description: Invalid content / Missing content
24754 description: Restricted operation
24756 description: Component not found
24758 description: Policy already exist
24774 additionalProperties:
24814 additionalProperties:
24846 unicodeLocaleAttributes:
24871 additionalProperties:
24897 additionalProperties:
24909 additionalProperties:
24935 additionalProperties:
24942 summary: Returns created Policy
24945 /v1/catalog/{containerComponentType}/{componentId}/relationId/{relationId}:
24947 description: Get relation
24948 operationId: getRelationById
24951 name: containerComponentType
24971 description: relation found
24973 description: Restricted operation
24975 description: Relation not found
24991 additionalProperties:
25031 additionalProperties:
25063 unicodeLocaleAttributes:
25088 additionalProperties:
25114 additionalProperties:
25126 additionalProperties:
25152 additionalProperties:
25159 summary: Returns relation metadata according to relationId
25162 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance:
25164 description: Create ComponentInstance
25165 operationId: createComponentInstance
25172 - description: "valid values: resources / services"
25174 name: containerComponentType
25181 - description: USER_ID of modifier user
25192 description: RI object to be created
25196 description: Component created
25198 description: Invalid content / Missing content
25200 description: Restricted operation
25202 description: Component instance already exist
25218 additionalProperties:
25258 additionalProperties:
25290 unicodeLocaleAttributes:
25315 additionalProperties:
25341 additionalProperties:
25353 additionalProperties:
25379 additionalProperties:
25386 summary: Returns created ComponentInstance
25389 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate:
25391 description: Associate RI to RI
25392 operationId: associateRIToRI
25394 - description: unique id of the container component
25400 - description: allowed values are resources /services / products
25402 name: containerComponentType
25419 description: RelationshipInfo
25423 description: Relationship created
25425 description: Invalid content / Missing content
25427 description: Missing information
25429 description: Relationship already exist
25445 additionalProperties:
25485 additionalProperties:
25517 unicodeLocaleAttributes:
25542 additionalProperties:
25568 additionalProperties:
25580 additionalProperties:
25606 additionalProperties:
25613 summary: Returns created RelationshipInfo
25616 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/batchDissociate:
25618 description: Batch Dissociate RI from RI
25619 operationId: batchDissociateRIFromRI
25621 - description: allowed values are resources/services/products
25623 name: containerComponentType
25631 - description: unique id of the container component
25646 description: RelationshipInfo
25650 description: Relationship deleted
25652 description: Invalid Content / Missing Content
25654 description: Missing Information
25670 additionalProperties:
25710 additionalProperties:
25742 unicodeLocaleAttributes:
25767 additionalProperties:
25793 additionalProperties:
25805 additionalProperties:
25831 additionalProperties:
25838 summary: Returns deleted RelationShip Info
25841 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate:
25843 description: Create RI and associate RI to RI
25844 operationId: createAndAssociateRIToRI
25851 - description: "valid values: resources / services"
25853 name: containerComponentType
25863 description: RI created
25865 description: Invalid content / Missing content
25867 description: Restricted operation
25869 description: Relationship already exist
25885 additionalProperties:
25925 additionalProperties:
25957 unicodeLocaleAttributes:
25982 additionalProperties:
26008 additionalProperties:
26020 additionalProperties:
26046 additionalProperties:
26053 summary: Returns created RI and RelationshipInfo
26056 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/dissociate:
26058 description: Dissociate RI from RI
26059 operationId: dissociateRIFromRI
26061 - description: allowed values are resources /services / products
26063 name: containerComponentType
26071 - description: unique id of the container component
26086 description: RelationshipInfo
26090 description: Relationship deleted
26092 description: Invalid content / Missing content
26094 description: Missing information
26110 additionalProperties:
26150 additionalProperties:
26182 unicodeLocaleAttributes:
26207 additionalProperties:
26233 additionalProperties:
26245 additionalProperties:
26271 additionalProperties:
26278 summary: Returns deleted RelationshipInfo
26281 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance:
26283 description: Update resource instance multiple component
26284 operationId: updateMultipleComponentInstance
26291 - description: "valid values: resources / services / products"
26293 name: containerComponentType
26306 description: Component Instance JSON Array
26310 description: Resource instance updated
26312 description: Invalid content / Missing content
26314 description: Restricted operation
26330 additionalProperties:
26370 additionalProperties:
26402 unicodeLocaleAttributes:
26427 additionalProperties:
26453 additionalProperties:
26465 additionalProperties:
26491 additionalProperties:
26498 summary: Returns updated resource instance
26501 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}:
26503 description: Update resource instance
26504 operationId: updateComponentInstanceMetadata
26512 name: componentInstanceId
26516 - description: "valid values: resources / services / products"
26518 name: containerComponentType
26528 description: Resource instance updated
26530 description: Invalid content / Missing content
26532 description: Restricted operation
26548 additionalProperties:
26588 additionalProperties:
26620 unicodeLocaleAttributes:
26645 additionalProperties:
26671 additionalProperties:
26683 additionalProperties:
26709 additionalProperties:
26716 summary: Returns updated resource instance
26719 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts:
26721 description: Load Resource Instance artifact payload
26722 operationId: loadComponentInstanceArtifact
26732 - description: "valid values: resources / services"
26734 name: containerComponentType
26747 name: componentInstanceId
26756 description: json describe the artifact
26760 description: Artifact updated
26762 description: Invalid content / Missing content
26764 description: Restricted operation
26780 additionalProperties:
26820 additionalProperties:
26852 unicodeLocaleAttributes:
26877 additionalProperties:
26903 additionalProperties:
26915 additionalProperties:
26941 additionalProperties:
26948 summary: Returns updated artifact
26951 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}:
26953 description: Delete Resource Instance artifact
26954 operationId: deleteComponentInstanceArtifact
26964 - description: "valid values: resources / services"
26966 name: containerComponentType
26979 name: componentInstanceId
26993 description: json describe the artifact
26997 description: Artifact updated
26999 description: Invalid content / Missing content
27001 description: Restricted operation
27017 additionalProperties:
27057 additionalProperties:
27089 unicodeLocaleAttributes:
27114 additionalProperties:
27140 additionalProperties:
27152 additionalProperties:
27178 additionalProperties:
27185 summary: Returns deleted artifact
27189 description: Update Resource Instance artifact payload
27190 operationId: updateComponentInstanceArtifact
27200 - description: "valid values: resources / services"
27202 name: containerComponentType
27215 name: componentInstanceId
27229 description: json describe the artifact
27233 description: Artifact updated
27235 description: Invalid content / Missing content
27237 description: Restricted operation
27253 additionalProperties:
27293 additionalProperties:
27325 unicodeLocaleAttributes:
27350 additionalProperties:
27376 additionalProperties:
27388 additionalProperties:
27414 additionalProperties:
27421 summary: Returns updated artifact
27424 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams:
27426 description: Update Resource Instance HEAT_ENV parameters
27427 operationId: updateRIArtifact
27429 - description: "valid values: resources / services"
27431 name: containerComponentType
27444 name: componentInstanceId
27458 description: json describe the artifact
27462 description: Artifact updated
27464 description: Invalid content / Missing content
27466 description: Restricted operation
27482 additionalProperties:
27522 additionalProperties:
27554 unicodeLocaleAttributes:
27579 additionalProperties:
27605 additionalProperties:
27617 additionalProperties:
27643 additionalProperties:
27650 summary: Returns updated artifact
27653 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attributes:
27655 description: Update resource instance attribute
27656 operationId: updateResourceInstanceAttribute
27658 - description: service id
27664 - description: "valid values: resources / services"
27666 name: containerComponentType
27673 - description: resource instance id
27675 name: componentInstanceId
27679 - description: id of user initiating the operation
27689 description: Component Instance Properties JSON Array
27693 description: Resource instance created
27695 description: Invalid content / Missing content
27697 description: Restricted operation
27713 additionalProperties:
27753 additionalProperties:
27785 unicodeLocaleAttributes:
27810 additionalProperties:
27836 additionalProperties:
27848 additionalProperties:
27874 additionalProperties:
27881 summary: Returns updated resource instance property
27884 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion:
27886 description: Update resource instance
27887 operationId: changeResourceInstanceVersion
27895 name: componentInstanceId
27899 - description: "valid values: resources / services"
27901 name: containerComponentType
27910 description: Resource instance created
27912 description: Invalid content / Missing content
27914 description: Restricted operation
27930 additionalProperties:
27970 additionalProperties:
28002 unicodeLocaleAttributes:
28027 additionalProperties:
28053 additionalProperties:
28065 additionalProperties:
28091 additionalProperties:
28098 summary: Returns updated resource instance
28101 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstId}:
28103 description: 'Get group artifacts '
28104 operationId: getGroupArtifactById
28107 name: containerComponentType
28117 name: componentInstanceId
28132 description: group found
28134 description: Restricted operation
28136 description: Group not found
28152 additionalProperties:
28192 additionalProperties:
28224 unicodeLocaleAttributes:
28249 additionalProperties:
28275 additionalProperties:
28287 additionalProperties:
28313 additionalProperties:
28320 summary: Returns artifacts metadata according to groupInstId
28323 ? /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property
28325 description: Update resource instance property
28326 operationId: updateGroupInstanceProperty
28328 - description: service id
28334 - description: "valid values: resources / services"
28336 name: containerComponentType
28343 - description: resource instance id
28345 name: componentInstanceId
28349 - description: group instance id
28351 name: groupInstanceId
28355 - description: id of user initiating the operation
28362 description: Resource instance created
28364 description: Invalid content / Missing content
28366 description: Restricted operation
28382 additionalProperties:
28422 additionalProperties:
28454 unicodeLocaleAttributes:
28479 additionalProperties:
28505 additionalProperties:
28517 additionalProperties:
28543 additionalProperties:
28550 summary: Returns updated resource instance property
28553 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/inputs:
28555 description: Update resource instance property
28556 operationId: updateResourceInstanceInput
28558 - description: service id
28564 - description: "valid values: resources / services"
28566 name: containerComponentType
28573 - description: resource instance id
28575 name: componentInstanceId
28579 - description: id of user initiating the operation
28589 description: Component Instance Properties JSON Array
28593 description: Resource instance created
28595 description: Invalid content / Missing content
28597 description: Restricted operation
28613 additionalProperties:
28653 additionalProperties:
28685 unicodeLocaleAttributes:
28710 additionalProperties:
28736 additionalProperties:
28748 additionalProperties:
28774 additionalProperties:
28781 summary: Returns updated resource instance property
28784 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/properties:
28786 description: Update resource instance property
28787 operationId: updateResourceInstanceProperties
28789 - description: service id
28795 - description: "valid values: resources / services"
28797 name: containerComponentType
28804 - description: resource instance id
28806 name: componentInstanceId
28810 - description: id of user initiating the operation
28820 description: Component Instance Properties JSON Array
28824 description: Resource instance created
28826 description: Invalid content / Missing content
28828 description: Restricted operation
28844 additionalProperties:
28884 additionalProperties:
28916 unicodeLocaleAttributes:
28941 additionalProperties:
28967 additionalProperties:
28979 additionalProperties:
29005 additionalProperties:
29012 summary: Returns updated resource instance property
29015 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId}:
29017 description: Update resource instance
29018 operationId: deleteResourceInstanceProperty
29020 - description: service id
29026 - description: "valid values: resources / services"
29028 name: containerComponentType
29035 - description: resource instance id
29037 name: componentInstanceId
29041 - description: property id
29047 - description: id of user initiating the operation
29054 description: Resource instance created
29056 description: Invalid content / Missing content
29058 description: Restricted operation
29074 additionalProperties:
29114 additionalProperties:
29146 unicodeLocaleAttributes:
29171 additionalProperties:
29197 additionalProperties:
29209 additionalProperties:
29235 additionalProperties:
29242 summary: Returns deleted resource instance property
29245 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId}:
29247 description: Delete ResourceInstance
29248 operationId: deleteResourceInstance
29256 name: resourceInstanceId
29260 - description: "valid values: resources / services / products"
29262 name: containerComponentType
29272 description: ResourceInstance deleted
29274 description: Invalid content / Missing content
29276 description: Restricted operation
29292 additionalProperties:
29332 additionalProperties:
29364 unicodeLocaleAttributes:
29389 additionalProperties:
29415 additionalProperties:
29427 additionalProperties:
29453 additionalProperties:
29460 summary: Returns delete resourceInstance
29463 /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifacts/{artifactId}:
29465 description: Download component Artifact in Base64
29466 operationId: downloadResourceInstanceArtifactBase64
29468 - description: "valid values: resources / services"
29470 name: containerComponentType
29483 name: componentInstanceId
29494 description: ResourceInstance artifact downloaded
29496 description: ResourceInstance/Artifact not found
29512 additionalProperties:
29552 additionalProperties:
29584 unicodeLocaleAttributes:
29609 additionalProperties:
29635 additionalProperties:
29647 additionalProperties:
29673 additionalProperties:
29680 summary: Returns downloaded artifact
29683 /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType}:
29685 description: Get component Artifacts
29686 operationId: getComponentInstanceArtifacts
29688 - description: "valid values: resources / services"
29690 name: containerComponentType
29703 name: componentInstanceId
29708 name: artifactGroupType
29714 description: Component artifacts
29716 description: Resource/Artifact not found
29732 additionalProperties:
29772 additionalProperties:
29804 unicodeLocaleAttributes:
29829 additionalProperties:
29855 additionalProperties:
29867 additionalProperties:
29893 additionalProperties:
29900 summary: Returns artifacts
29903 /v1/catalog/{containerComponentType}/{componentId}/update/inputs:
29905 description: Update resource inputs
29906 operationId: updateComponentInputs
29908 - description: "valid values: resources / services"
29910 name: containerComponentType
29927 description: json describe the input
29931 description: Input updated
29933 description: Invalid content / Missing content
29935 description: Restricted operation
29951 additionalProperties:
29991 additionalProperties:
30023 unicodeLocaleAttributes:
30048 additionalProperties:
30074 additionalProperties:
30086 additionalProperties:
30112 additionalProperties:
30119 summary: Returns updated input
30122 /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/attributes:
30124 description: Get component instance attributes
30125 operationId: getInstanceAttributesById
30128 name: containerComponentType
30133 name: containerComponentId
30138 name: componentInstanceUniqueId
30148 description: Attributes found
30150 description: Restricted operation
30152 description: Component/Component Instance - not found
30168 additionalProperties:
30208 additionalProperties:
30240 unicodeLocaleAttributes:
30265 additionalProperties:
30291 additionalProperties:
30303 additionalProperties:
30329 additionalProperties:
30336 summary: Returns component instance attributes
30339 /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability:
30341 description: Update Component Instance Capability
30342 operationId: updateInstanceRequirement
30345 name: containerComponentType
30350 name: containerComponentId
30355 name: componentInstanceUniqueId
30367 $ref: '#/components/schemas/ComponentInstanceCapabilityUpdateModel'
30368 description: Component instance capability to update
30372 description: Resource instance capability successfully updated
30374 description: Invalid content / Missing content
30376 description: Restricted operation
30378 description: Component/Component Instance/Capability not found
30394 additionalProperties:
30434 additionalProperties:
30466 unicodeLocaleAttributes:
30491 additionalProperties:
30517 additionalProperties:
30529 additionalProperties:
30555 additionalProperties:
30562 summary: Returns updated Component Instance Capability
30565 ? /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability/{capabilityType}/capabilityName/{capabilityName}/ownerId/{ownerId}/properties
30567 description: Get component instance capability properties
30568 operationId: getInstanceCapabilityPropertiesById
30571 name: containerComponentType
30576 name: containerComponentId
30581 name: componentInstanceUniqueId
30586 name: capabilityType
30591 name: capabilityName
30606 description: Properties found
30608 description: Restricted operation
30610 description: Component/Component Instance/Capability - not found
30626 additionalProperties:
30666 additionalProperties:
30698 unicodeLocaleAttributes:
30723 additionalProperties:
30749 additionalProperties:
30761 additionalProperties:
30787 additionalProperties:
30794 summary: Returns component instance capability properties
30798 description: Update Instance Capabilty Property
30799 operationId: updateInstanceCapabilityProperty
30802 name: containerComponentType
30807 name: containerComponentId
30812 name: componentInstanceUniqueId
30817 name: capabilityType
30822 name: capabilityName
30840 description: Instance capabilty property to update
30844 description: Resource instance capabilty property updated
30846 description: Invalid content / Missing content
30848 description: Restricted operation
30850 description: Component/Component Instance/Capability - not found
30866 additionalProperties:
30906 additionalProperties:
30938 unicodeLocaleAttributes:
30963 additionalProperties:
30989 additionalProperties:
31001 additionalProperties:
31027 additionalProperties:
31034 summary: Returns updated property
31037 /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/properties:
31039 description: Get component instance properties
31040 operationId: getInstancePropertiesById
31043 name: containerComponentType
31048 name: containerComponentId
31053 name: componentInstanceUniqueId
31063 description: Properties found
31065 description: Restricted operation
31067 description: Component/Component Instance - not found
31083 additionalProperties:
31123 additionalProperties:
31155 unicodeLocaleAttributes:
31180 additionalProperties:
31206 additionalProperties:
31218 additionalProperties:
31244 additionalProperties:
31251 summary: Returns component instance properties
31254 ? /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/requirement/{capabilityType}/requirementName/{requirementName}
31256 description: Update Instance Requirement
31257 operationId: updateInstanceRequirement_1
31260 name: containerComponentType
31265 name: containerComponentId
31270 name: componentInstanceUniqueId
31275 name: capabilityType
31280 name: requirementName
31293 description: Instance capabilty requirement to update
31297 description: Resource instance requirement updated
31299 description: Invalid content / Missing content
31301 description: Restricted operation
31303 description: Component/Component Instance/Requirement - not found
31319 additionalProperties:
31359 additionalProperties:
31391 unicodeLocaleAttributes:
31416 additionalProperties:
31442 additionalProperties:
31454 additionalProperties:
31480 additionalProperties:
31487 summary: Returns updated requirement
31490 /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy:
31492 description: Create service proxy
31493 operationId: createServiceProxy
31496 name: containerComponentId
31500 - description: "valid values: resources / services"
31502 name: containerComponentType
31509 - description: USER_ID of modifier user
31520 description: RI object to be created
31524 description: Service proxy created
31526 description: Invalid content / Missing content
31528 description: Restricted operation
31530 description: Service proxy already exist
31546 additionalProperties:
31586 additionalProperties:
31618 unicodeLocaleAttributes:
31643 additionalProperties:
31669 additionalProperties:
31681 additionalProperties:
31707 additionalProperties:
31714 summary: Returns created service proxy
31717 /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}:
31719 description: Delete service proxy
31720 operationId: deleteServiceProxy
31723 name: containerComponentId
31728 name: serviceProxyId
31732 - description: "valid values: resources / services / products"
31734 name: containerComponentType
31743 description: Service proxy deleted
31745 description: Invalid content / Missing content
31747 description: Restricted operation
31763 additionalProperties:
31803 additionalProperties:
31835 unicodeLocaleAttributes:
31860 additionalProperties:
31886 additionalProperties:
31898 additionalProperties:
31924 additionalProperties:
31931 summary: Returns delete service proxy
31934 /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}/changeVersion/{newServiceId}:
31936 description: Update service proxy with new version
31937 operationId: changeServiceProxyVersion
31940 name: containerComponentId
31945 name: serviceProxyId
31949 - description: "valid values: resources / services"
31951 name: containerComponentType
31960 description: Service proxy created
31962 description: Invalid content / Missing content
31964 description: Restricted operation
31980 additionalProperties:
32020 additionalProperties:
32052 unicodeLocaleAttributes:
32077 additionalProperties:
32103 additionalProperties:
32115 additionalProperties:
32141 additionalProperties:
32148 summary: Returns updated service proxy
32151 /v1/catalog/{containerComponentType}/{serviceId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}:
32153 description: Update Group Instance Property Values
32154 operationId: updateGroupInstancePropertyValues
32162 name: componentInstanceId
32167 name: groupInstanceId
32180 description: Group instance object to be Updated
32184 description: Group Instance Property Values Updated
32186 description: Invalid content / Missing content
32188 description: Restricted operation
32195 $ref: '#/components/schemas/Service'
32199 summary: Returns updated group instance
32202 /v1/catalogUpdateTime:
32204 description: Retrieve previus and current catalog update time
32205 operationId: getCatalogUpdateTime
32213 description: Retrieve previus and current catalog update time
32229 additionalProperties:
32269 additionalProperties:
32301 unicodeLocaleAttributes:
32326 additionalProperties:
32352 additionalProperties:
32364 additionalProperties:
32390 additionalProperties:
32397 summary: Retrieve previus and current catalog update time
32400 /v1/categories/{componentType}:
32402 description: Retrieve the list of all resource/service/product categories/sub-categories/groupings
32403 operationId: getComponentCategories
32405 - description: allowed values are resources / services/ products
32407 name: componentType
32421 description: Returns categories Ok
32423 description: Invalid component type
32425 description: Missing information
32427 description: Restricted operation
32429 description: Internal Server Error
32445 additionalProperties:
32485 additionalProperties:
32517 unicodeLocaleAttributes:
32542 additionalProperties:
32568 additionalProperties:
32580 additionalProperties:
32606 additionalProperties:
32613 summary: Retrieve the list of all resource/service/product categories/sub-categories/groupings.
32616 /v1/category/{componentType}:
32618 description: Create new component category
32619 operationId: createComponentCategory
32621 - description: allowed values are resources /services / products
32623 name: componentType
32640 description: Category to be created
32644 description: Category created
32646 description: Invalid category data
32648 description: USER_ID header is missing
32650 description: Category already exists / User not permitted to perform the
32653 description: General Error
32657 summary: Create new component category
32660 /v1/category/{componentType}/{categoryId}/subCategory:
32662 description: Create new component sub-category
32663 operationId: createComponentSubCategory
32665 - description: allowed values are resources / products
32667 name: componentType
32674 - description: Parent category unique ID
32689 description: "Subcategory to be created. \ne.g. {\"name\":\"Resource-subcat\"\
32694 description: Subcategory created
32696 description: Invalid subcategory data
32698 description: USER_ID header is missing
32700 description: Parent category wasn't found
32702 description: Subcategory already exists / User not permitted to perform
32705 description: General Error
32709 summary: Create new component sub-category for existing category
32712 /v1/category/{componentType}/{categoryId}/subCategory/{subCategoryId}/grouping:
32714 description: Create new component grouping
32715 operationId: createComponentGrouping
32717 - description: allowed values are products
32719 name: componentType
32725 - description: Parent category unique ID
32731 - description: Parent sub-category unique ID
32733 name: subCategoryId
32746 description: Subcategory to be created
32750 description: Grouping created
32752 description: Invalid grouping data
32754 description: USER_ID header is missing
32756 description: Parent category or subcategory were not found
32758 description: Grouping already exists / User not permitted to perform the
32761 description: General Error
32765 summary: Create new component grouping for existing sub-category
32768 /v1/category/{componentType}/{categoryName}/baseTypes:
32770 description: Get base types for category
32771 operationId: getCategoryBaseTypes
32779 name: componentType
32787 - description: model
32794 description: Returns base types Ok
32796 description: No base types were found
32798 description: Internal Server Error
32802 summary: Get base types for category
32805 /v1/category/{componentType}/{categoryUniqueId}:
32807 description: Delete component category
32808 operationId: deleteComponentCategory
32811 name: categoryUniqueId
32816 name: componentType
32826 description: Category deleted
32828 description: USER_ID header is missing
32830 description: Category not found
32832 description: User not permitted to perform the action
32834 description: General Error
32841 $ref: '#/components/schemas/Category'
32845 summary: Delete component category
32848 /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}:
32850 description: Delete component category
32851 operationId: deleteComponentSubCategory
32854 name: categoryUniqueId
32859 name: subCategoryUniqueId
32864 name: componentType
32874 description: Category deleted
32876 description: USER_ID header is missing
32878 description: Category not found
32880 description: User not permitted to perform the action
32882 description: General Error
32889 $ref: '#/components/schemas/Category'
32893 summary: Delete component category
32896 /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}/grouping/{groupingUniqueId}:
32898 description: Delete component category
32899 operationId: deleteComponentGrouping
32902 name: categoryUniqueId
32907 name: subCategoryUniqueId
32912 name: groupingUniqueId
32917 name: componentType
32927 description: Category deleted
32929 description: USER_ID header is missing
32931 description: Category not found
32933 description: User not permitted to perform the action
32935 description: General Error
32942 $ref: '#/components/schemas/Category'
32946 summary: Delete component category
32951 description: Consumer credentials
32952 operationId: createConsumer
32963 description: Consumer Object to be created
32967 description: Consumer credentials created
32969 description: Invalid content / Missing content
32971 description: Restricted operation
32987 additionalProperties:
33027 additionalProperties:
33059 unicodeLocaleAttributes:
33084 additionalProperties:
33110 additionalProperties:
33122 additionalProperties:
33148 additionalProperties:
33155 summary: Returns created ECOMP consumer credentials
33158 /v1/consumers/{consumerId}:
33160 description: Deletes Consumer
33161 operationId: deleteConsumer
33174 description: Consumer deleted
33176 description: Restricted operation
33178 description: Consumer not found
33185 $ref: '#/components/schemas/ConsumerDefinition'
33189 summary: Returns deleted consumer according to ConsumerID
33193 description: Retrieve Consumer
33194 operationId: getConsumer
33207 description: Consumer found
33209 description: Restricted operation
33211 description: Consumer not found
33218 $ref: '#/components/schemas/ConsumerDefinition'
33222 summary: Returns consumer according to ConsumerID
33225 /v1/ecompPortalMenu:
33227 description: Retrieve ecomp portal menu - MOC
33228 operationId: getListOfCsars
33231 description: Retrieve ecomp portal menu
33238 $ref: '#/components/schemas/User'
33242 summary: Retrieve ecomp portal menu
33247 description: Retrieve all followed
33248 operationId: getFollowedResourcesServices
33256 description: Returns followed Ok
33258 description: User not found
33260 description: Internal Server Error
33267 $ref: '#/components/schemas/User'
33271 summary: Retrieve all followed
33274 /v1/inactiveComponents/{componentType}:
33276 operationId: deleteMarkedResources
33279 name: componentType
33287 description: default response
33293 /v1/propertyScopes:
33295 description: Retrieve all propertyScopes
33296 operationId: getPropertyScopes
33304 description: Returns propertyScopes Ok
33306 description: No propertyScopes were found
33308 description: Internal Server Error
33315 $ref: '#/components/schemas/User'
33319 summary: Retrieve all propertyScopes
33324 description: Retrieve catalog resources and services
33325 operationId: getCatalogComponents
33350 - ServiceSubstitution
33353 description: Returns resources and services Ok
33355 description: User not found
33357 description: Internal Server Error
33364 $ref: '#/components/schemas/User'
33368 summary: Retrieve catalog resources and services
33373 description: "Retrieve all artifactTypes, ui configuration and sdc version"
33374 operationId: getConfCategoriesAndVersion_1
33382 description: "Returns artifactTypes, ui configuration and sdc version Ok"
33384 description: No artifactTypes were found/no ui configuration were found/no
33385 sdc version were found
33387 description: Internal Server Error
33394 $ref: '#/components/schemas/User'
33398 summary: "Retrieve all artifactTypes, ui configuration and sdc version"
33403 description: Retrieve all tags
33404 operationId: getTags
33412 description: Returns tags Ok
33414 description: No tags were found
33416 description: Internal Server Error
33423 $ref: '#/components/schemas/User'
33427 summary: Retrieve all tags
33432 description: add user
33433 operationId: createUser
33443 $ref: '#/components/schemas/User'
33444 description: json describe the user
33448 description: New user created
33450 description: Invalid Content.
33452 description: Missing information
33454 description: Method Not Allowed
33456 description: User already exists
33458 description: Internal Server Error
33465 $ref: '#/components/schemas/User'
33469 summary: Provision new user
33474 description: retrieve all administrators
33475 operationId: getAdminsUser
33478 description: Returns user Ok
33480 description: Method Not Allowed
33482 description: Internal Server Error
33489 $ref: '#/components/schemas/User'
33493 summary: Returns all administrators
33496 /v1/user/authorize:
33498 description: authorize
33499 operationId: authorize
33506 name: HTTP_CSP_FIRSTNAME
33510 name: HTTP_CSP_LASTNAME
33514 name: HTTP_CSP_EMAIL
33519 description: Returns user Ok
33521 description: Restricted Access
33523 description: Internal Server Error
33530 $ref: '#/components/schemas/User'
33534 summary: authorize user
33539 description: Retrieve the list of all active ASDC users or only group of users
33540 having specific roles.
33541 operationId: getUsersList
33543 - description: 'Any active user''s USER_ID '
33548 - description: "TESTER,DESIGNER,PRODUCT_STRATEGIST,OPS,PRODUCT_MANAGER,GOVERNOR,\
33549 \ ADMIN OR all users by not typing anything"
33556 description: Returns users Ok
33558 description: No provisioned ASDC users of requested role
33560 description: Missing content
33562 description: Restricted Access
33564 description: Internal Server Error
33571 $ref: '#/components/schemas/User'
33575 summary: "Returns list of users with the specified roles, or all of users in\
33576 \ the case of empty 'roles' header"
33581 description: delete user
33582 operationId: deActivateUser
33584 - description: userId of user to get
33596 description: Update deleted OK
33598 description: Invalid Content.
33600 description: Missing information
33602 description: User not found
33604 description: Method Not Allowed
33606 description: Restricted operation
33608 description: Internal Server Error
33615 $ref: '#/components/schemas/User'
33619 summary: Delete user
33623 description: retrieve user details
33626 - description: userId of user to get
33634 description: Returns user Ok
33636 description: User not found
33638 description: Method Not Allowed
33640 description: Internal Server Error
33647 $ref: '#/components/schemas/User'
33651 summary: Returns user details according to userId
33654 /v1/user/{userId}/role:
33656 description: retrieve user role
33657 operationId: getRole
33659 - description: userId of user to get
33667 description: Returns user role Ok
33669 description: User not found
33671 description: Method Not Allowed
33673 description: Internal Server Error
33684 summary: Returns user role according to userId
33688 description: update user role
33689 operationId: updateUserRole
33691 - description: userId of user to get
33705 $ref: '#/components/schemas/UserRole'
33706 description: json describe the update role
33710 description: Update user OK
33712 description: Invalid Content.
33714 description: Missing information/Restricted operation
33716 description: User not found
33718 description: Method Not Allowed
33720 description: User already exists
33722 description: Internal Server Error
33729 $ref: '#/components/schemas/User'
33733 summary: Update user role
33738 AdditionalInfoParameterInfo:
33758 AdditionalInformationDefinition:
33766 lastCreatedCounter:
33780 $ref: '#/components/schemas/AdditionalInfoParameterInfo'
33799 $ref: '#/components/schemas/PropertyDataDefinition'
33802 ApplicationL1CacheCatalogInfo:
33807 productsSizeInCache:
33810 resourcesSizeInCache:
33813 servicesSizeInCache:
33816 ApplicationL1CacheConfig:
33820 $ref: '#/components/schemas/ApplicationL1CacheInfo'
33821 ApplicationL1CacheInfo:
33832 ApplicationL2CacheConfig:
33836 $ref: '#/components/schemas/ApplicationL1CacheCatalogInfo'
33840 $ref: '#/components/schemas/QueueInfo'
33841 ArtifactConfiguration:
33866 - RESOURCE_INSTANCE
33874 ArtifactDataDefinition:
33883 artifactDisplayName:
33900 artifactRepository:
33930 $ref: '#/components/schemas/HeatParameterDataDefinition'
33931 heatParamsUpdateDate:
33952 $ref: '#/components/schemas/PropertyDataDefinition'
33974 ArtifactDefinition:
33983 artifactDisplayName:
34000 artifactRepository:
34032 $ref: '#/components/schemas/HeatParameterDataDefinition'
34033 heatParamsUpdateDate:
34041 listHeatParameters:
34044 $ref: '#/components/schemas/HeatParameterDefinition'
34069 $ref: '#/components/schemas/PropertyDataDefinition'
34091 AttributeDefinition:
34105 $ref: '#/components/schemas/EntrySchema'
34106 getOutputAttribute:
34111 $ref: '#/components/schemas/GetOutputValueDataDefinition'
34132 $ref: '#/components/schemas/SchemaDefinition'
34156 BeMonitoringConfig:
34163 probeIntervalInSeconds:
34166 CINodeFilterDataDefinition:
34170 $ref: '#/components/schemas/ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition'
34183 $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition'
34217 cadi_truststore_password:
34223 CapabilityDataDefinition:
34257 - COMPONENT_INSTANCE
34279 CapabilityDefinition:
34313 - COMPONENT_INSTANCE
34319 - COMPONENT_INSTANCE
34333 $ref: '#/components/schemas/ComponentInstanceProperty'
34346 CapabilityRequirementRelationship:
34350 $ref: '#/components/schemas/CapabilityDataDefinition'
34354 $ref: '#/components/schemas/OperationUi'
34356 $ref: '#/components/schemas/RelationshipInfo'
34358 $ref: '#/components/schemas/RequirementDataDefinition'
34374 $ref: '#/components/schemas/KeyspaceConfig'
34385 socketConnectTimeout:
34393 truststorePassword:
34405 $ref: '#/components/schemas/CategoryDefinition'
34406 categoryNormalizedName:
34413 - RESOURCE_INSTANCE
34418 distributionStatus:
34439 subCategoryNormalizedName:
34458 CategoryBaseTypeConfig:
34469 CategoryDefinition:
34483 $ref: '#/components/schemas/MetadataKeyDataDefinition'
34500 $ref: '#/components/schemas/SubCategoryDefinition'
34505 useServiceSubstitutionForNestedServices:
34509 CleanComponentsConfiguration:
34512 cleanIntervalInMinutes:
34522 actualComponentUid:
34526 additionalProperties:
34527 $ref: '#/components/schemas/ArtifactDefinition'
34528 attributeValueCounter:
34534 $ref: '#/components/schemas/AttributeDefinition'
34537 additionalProperties:
34540 $ref: '#/components/schemas/CapabilityDefinition'
34541 componentMetadataForSupportLog:
34543 additionalProperties:
34563 deploymentArtifacts:
34565 additionalProperties:
34566 $ref: '#/components/schemas/ArtifactDefinition'
34578 $ref: '#/components/schemas/GroupInstance'
34587 $ref: '#/components/schemas/InputDefinition'
34592 additionalProperties:
34608 $ref: '#/components/schemas/CINodeFilterDataDefinition'
34628 - ServiceSubstitution
34641 $ref: '#/components/schemas/PropertyDefinition'
34642 propertyValueCounter:
34647 additionalProperties:
34650 $ref: '#/components/schemas/RequirementDefinition'
34651 serviceSubstitution:
34653 sourceModelInvariant:
34663 additionalProperties:
34664 $ref: '#/components/schemas/ToscaArtifactDataDefinition'
34665 toscaComponentName:
34673 ComponentInstanceAttribute:
34678 componentInstanceId:
34680 componentInstanceName:
34691 $ref: '#/components/schemas/EntrySchema'
34692 getOutputAttribute:
34697 $ref: '#/components/schemas/GetOutputValueDataDefinition'
34724 $ref: '#/components/schemas/PropertyRule'
34726 $ref: '#/components/schemas/SchemaDefinition'
34741 ComponentInstanceCapabilityUpdateModel:
34748 maxLength: 2147483647
34752 maxLength: 2147483647
34756 maxLength: 2147483647
34760 maxLength: 2147483647
34764 maxLength: 2147483647
34773 ComponentInstanceInput:
34779 $ref: '#/components/schemas/Annotation'
34780 annotationsToInput:
34783 $ref: '#/components/schemas/Annotation'
34785 componentInstanceId:
34787 componentInstanceName:
34792 $ref: '#/components/schemas/PropertyConstraint'
34806 $ref: '#/components/schemas/GetInputValueDataDefinition'
34810 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
34821 isDeclaredListInput:
34825 mappedToComponentProperty:
34829 additionalProperties:
34840 parentPropertyType:
34853 $ref: '#/components/schemas/ComponentInstanceProperty'
34854 propertyConstraints:
34865 $ref: '#/components/schemas/PropertyRule'
34867 $ref: '#/components/schemas/SchemaDefinition'
34869 $ref: '#/components/schemas/PropertyDataDefinition'
34874 subPropertyInputPath:
34876 subPropertyToscaFunctions:
34879 $ref: '#/components/schemas/SubPropertyToscaFunction'
34881 $ref: '#/components/schemas/ToscaFunction'
34883 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
34884 toscaGetFunctionType:
34902 ComponentInstanceInterface:
34918 additionalProperties:
34919 $ref: '#/components/schemas/InputDataDefinition'
34922 interfaceInstanceDataDefinition:
34923 $ref: '#/components/schemas/InterfaceInstanceDataDefinition'
34931 additionalProperties:
34932 $ref: '#/components/schemas/OperationDataDefinition'
34948 ComponentInstanceOutput:
34952 $ref: '#/components/schemas/ComponentInstanceAttribute'
34955 componentInstanceId:
34957 componentInstanceName:
34968 $ref: '#/components/schemas/EntrySchema'
34969 getOutputAttribute:
34974 $ref: '#/components/schemas/GetOutputValueDataDefinition'
35001 $ref: '#/components/schemas/PropertyRule'
35003 $ref: '#/components/schemas/SchemaDefinition'
35018 ComponentInstanceProperty:
35024 $ref: '#/components/schemas/Annotation'
35025 componentInstanceId:
35027 componentInstanceName:
35032 $ref: '#/components/schemas/PropertyConstraint'
35046 $ref: '#/components/schemas/GetInputValueDataDefinition'
35050 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
35061 isDeclaredListInput:
35065 mappedToComponentProperty:
35069 additionalProperties:
35080 parentPropertyType:
35090 propertyConstraints:
35101 $ref: '#/components/schemas/PropertyRule'
35103 $ref: '#/components/schemas/SchemaDefinition'
35105 $ref: '#/components/schemas/PropertyDataDefinition'
35110 subPropertyInputPath:
35112 subPropertyToscaFunctions:
35115 $ref: '#/components/schemas/SubPropertyToscaFunction'
35117 $ref: '#/components/schemas/ToscaFunction'
35119 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
35120 toscaGetFunctionType:
35145 additionalInformationMaxNumberOfKeys:
35150 applicationL1Cache:
35151 $ref: '#/components/schemas/ApplicationL1CacheConfig'
35152 applicationL2Cache:
35153 $ref: '#/components/schemas/ApplicationL2CacheConfig'
35154 artifactGeneratorConfig:
35159 $ref: '#/components/schemas/ArtifactConfiguration'
35163 $ref: '#/components/schemas/CookieConfig'
35167 $ref: '#/components/schemas/BasicAuthConfig'
35181 $ref: '#/components/schemas/CadiFilterParams'
35183 $ref: '#/components/schemas/CassandrConfig'
35184 cleanComponentsConfiguration:
35185 $ref: '#/components/schemas/CleanComponentsConfiguration'
35186 componentAllowedInstanceTypes:
35188 additionalProperties:
35190 additionalProperties:
35194 componentInstanceCounterDelimiter:
35196 consumerBusinessLogic:
35199 $ref: '#/components/schemas/CsarFormat'
35200 dataValidatorFilterExcludedUrls:
35206 additionalProperties:
35208 additionalProperties:
35210 definedResourceNamespace:
35214 deleteLockTimeoutInSeconds:
35217 deploymentResourceArtifacts:
35219 additionalProperties:
35221 deploymentResourceInstanceArtifacts:
35223 additionalProperties:
35231 dmaapConsumerConfiguration:
35232 $ref: '#/components/schemas/DmaapConsumerConfiguration'
35233 dmaapProducerConfiguration:
35234 $ref: '#/components/schemas/DmaapProducerConfiguration'
35236 $ref: '#/components/schemas/DmeConfiguration'
35238 $ref: '#/components/schemas/EcompPortalConfig'
35241 environmentContext:
35242 $ref: '#/components/schemas/EnvironmentContext'
35243 excludeResourceCategory:
35247 excludeResourceType:
35251 excludeServiceCategory:
35255 excludedGroupTypesMapping:
35257 additionalProperties:
35262 excludedPolicyTypesMapping:
35264 additionalProperties:
35270 $ref: '#/components/schemas/ExternalCsarStore'
35274 $ref: '#/components/schemas/GabConfig'
35275 genericAssetNodeTypes:
35277 additionalProperties:
35283 healthStatusExclude:
35287 heatArtifactDeploymentTimeout:
35288 $ref: '#/components/schemas/HeatDeploymentArtifactTimeout'
35289 heatEnvArtifactFooter:
35291 heatEnvArtifactHeader:
35293 heatTranslatorPath:
35295 identificationHeaderFields:
35299 informationalResourceArtifacts:
35301 additionalProperties:
35303 informationalServiceArtifacts:
35305 additionalProperties:
35309 janusGraphHealthCheckReadTimeout:
35312 janusGraphInMemoryGraph:
35314 janusGraphLockTimeout:
35317 janusGraphMigrationKeySpaceCfgFile:
35319 janusGraphReconnectIntervalInSeconds:
35326 maxDeleteComponents:
35329 minToscaConformanceLevel:
35333 additionalProperties:
35336 $ref: '#/components/schemas/OnboardingConfig'
35337 permittedAncestors:
35348 additionalProperties:
35350 additionalProperties:
35356 resourcesForUpgrade:
35358 additionalProperties:
35362 serviceApiArtifacts:
35364 additionalProperties:
35366 serviceBaseNodeTypes:
35368 additionalProperties:
35369 $ref: '#/components/schemas/CategoryBaseTypeConfig'
35370 skipUpgradeFailedVfs:
35374 startMigrationFrom:
35377 supportAllottedResourcesAndProxy:
35379 switchoverDetector:
35380 $ref: '#/components/schemas/SwitchoverDetectorConfig'
35382 $ref: '#/components/schemas/BeMonitoringConfig'
35385 additionalProperties:
35387 toscaConformanceLevel:
35392 $ref: '#/components/schemas/ToscaValidatorsConfig'
35393 uebHealthCheckReadTimeout:
35396 uebHealthCheckReconnectIntervalInSeconds:
35405 additionalProperties:
35409 vfModuleProperties:
35411 additionalProperties:
35412 $ref: '#/components/schemas/VfModuleProperty'
35447 ConsumerDefinition:
35450 consumerDetailsLastupdatedtime:
35453 consumerLastAuthenticationTime:
35494 onboardingExcludedUrls:
35504 sessionIdleTimeOut:
35526 DataTypeDataDefinition:
35553 $ref: '#/components/schemas/PropertyDataDefinition'
35560 DataTypeDefinition:
35566 $ref: '#/components/schemas/PropertyConstraint'
35571 $ref: '#/components/schemas/DataTypeDefinition'
35593 $ref: '#/components/schemas/PropertyDefinition'
35597 $ref: '#/components/schemas/PropertyDataDefinition'
35604 DistributionStatusInfo:
35617 DistributionStatusListResponse:
35620 distributionStatusList:
35623 $ref: '#/components/schemas/DistributionStatusInfo'
35624 DmaapConsumerConfiguration:
35629 aftDme2ClientIgnoreSslConfig:
35631 aftDme2ClientKeystore:
35633 aftDme2ClientKeystorePassword:
35635 aftDme2ClientSslCertAlias:
35637 aftDme2ConnectionTimeoutMs:
35640 aftDme2ReadTimeoutMs:
35643 aftDme2RoundtripTimeoutMs:
35657 $ref: '#/components/schemas/Credential'
35660 dme2preferredRouterFilePath:
35686 timeLimitForNotificationHandleMs:
35696 DmaapProducerConfiguration:
35701 aftDme2ClientIgnoreSslConfig:
35703 aftDme2ClientKeystore:
35705 aftDme2ClientKeystorePassword:
35707 aftDme2ClientSslCertAlias:
35709 aftDme2ConnectionTimeoutMs:
35712 aftDme2ReadTimeoutMs:
35715 aftDme2RoundtripTimeoutMs:
35729 $ref: '#/components/schemas/Credential'
35732 dme2preferredRouterFilePath:
35758 timeLimitForNotificationHandleMs:
35776 defaultFunctionalMenu:
35809 $ref: '#/components/schemas/Constraint'
35814 EnvironmentContext:
35827 $ref: '#/components/schemas/Credentials'
35829 $ref: '#/components/schemas/Endpoint'
35837 FormDataContentDisposition:
35852 additionalProperties:
35862 ForwardingPathDataDefinition:
35867 destinationPortNumber:
35879 $ref: '#/components/schemas/ListDataDefinitionForwardingPathElementDataDefinition'
35890 ForwardingPathElementDataDefinition:
35921 pathsAndNamesDefinitions:
35924 $ref: '#/components/schemas/PathsAndNamesDefinition'
35925 GenericArtifactQueryInfo:
35937 GetInputValueDataDefinition:
35943 $ref: '#/components/schemas/GetInputValueDataDefinition'
35966 GetOutputValueDataDefinition:
35974 $ref: '#/components/schemas/GetOutputValueDataDefinition'
35993 GetPolicyValueDataDefinition:
36015 additionalProperties:
36018 $ref: '#/components/schemas/CapabilityDefinition'
36036 additionalProperties:
36050 $ref: '#/components/schemas/PropertyDataDefinition'
36051 propertyValueCounter:
36069 changePriorityBody:
36093 groupInstanceArtifacts:
36097 groupInstanceArtifactsUuid:
36128 $ref: '#/components/schemas/PropertyDataDefinition'
36129 propertyValueCounter:
36144 $ref: '#/components/schemas/Annotation'
36148 $ref: '#/components/schemas/PropertyConstraint'
36162 $ref: '#/components/schemas/GetInputValueDataDefinition'
36166 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
36177 isDeclaredListInput:
36181 mappedToComponentProperty:
36185 additionalProperties:
36196 parentPropertyType:
36202 propertyConstraints:
36211 $ref: '#/components/schemas/SchemaDefinition'
36213 $ref: '#/components/schemas/PropertyDataDefinition'
36218 subPropertyInputPath:
36220 subPropertyToscaFunctions:
36223 $ref: '#/components/schemas/SubPropertyToscaFunction'
36225 $ref: '#/components/schemas/ToscaFunction'
36227 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
36228 toscaGetFunctionType:
36246 GroupTypeDefinition:
36251 additionalProperties:
36252 $ref: '#/components/schemas/CapabilityDefinition'
36272 additionalProperties:
36289 $ref: '#/components/schemas/PropertyDefinition'
36296 GroupingDefinition:
36316 HeatDeploymentArtifactTimeout:
36328 HeatParameterDataDefinition:
36352 HeatParameterDefinition:
36376 InputDataDefinition:
36382 $ref: '#/components/schemas/Annotation'
36396 $ref: '#/components/schemas/GetInputValueDataDefinition'
36400 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
36411 isDeclaredListInput:
36415 mappedToComponentProperty:
36419 additionalProperties:
36430 parentPropertyType:
36436 propertyConstraints:
36445 $ref: '#/components/schemas/SchemaDefinition'
36447 $ref: '#/components/schemas/PropertyDataDefinition'
36452 subPropertyInputPath:
36454 subPropertyToscaFunctions:
36457 $ref: '#/components/schemas/SubPropertyToscaFunction'
36459 $ref: '#/components/schemas/ToscaFunction'
36461 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
36462 toscaGetFunctionType:
36484 $ref: '#/components/schemas/Annotation'
36485 annotationsToInput:
36488 $ref: '#/components/schemas/Annotation'
36493 $ref: '#/components/schemas/PropertyConstraint'
36507 $ref: '#/components/schemas/GetInputValueDataDefinition'
36511 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
36523 $ref: '#/components/schemas/ComponentInstanceInput'
36526 isDeclaredListInput:
36530 mappedToComponentProperty:
36534 additionalProperties:
36545 parentPropertyType:
36554 $ref: '#/components/schemas/ComponentInstanceProperty'
36555 propertyConstraints:
36564 $ref: '#/components/schemas/SchemaDefinition'
36566 $ref: '#/components/schemas/PropertyDataDefinition'
36571 subPropertyInputPath:
36573 subPropertyToscaFunctions:
36576 $ref: '#/components/schemas/SubPropertyToscaFunction'
36578 $ref: '#/components/schemas/ToscaFunction'
36580 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
36581 toscaGetFunctionType:
36597 InterfaceDefinition:
36613 additionalProperties:
36614 $ref: '#/components/schemas/InputDataDefinition'
36622 additionalProperties:
36623 $ref: '#/components/schemas/OperationDataDefinition'
36639 InterfaceInstanceDataDefinition:
36646 additionalProperties:
36650 additionalProperties:
36651 $ref: '#/components/schemas/OperationInstance'
36670 replicationStrategy:
36672 ListDataDefinitionForwardingPathElementDataDefinition:
36677 listToscaDataDefinition:
36680 $ref: '#/components/schemas/ForwardingPathElementDataDefinition'
36690 ListDataDefinitionOperationInputDefinition:
36695 listToscaDataDefinition:
36698 $ref: '#/components/schemas/OperationInputDefinition'
36708 ListDataDefinitionOperationOutputDefinition:
36713 listToscaDataDefinition:
36716 $ref: '#/components/schemas/OperationOutputDefinition'
36726 ListDataDefinitionPropertyFilterDataDefinition:
36731 listToscaDataDefinition:
36734 $ref: '#/components/schemas/PropertyFilterDataDefinition'
36744 ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition:
36749 listToscaDataDefinition:
36752 $ref: '#/components/schemas/RequirementNodeFilterCapabilityDataDefinition'
36762 ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition:
36767 listToscaDataDefinition:
36770 $ref: '#/components/schemas/RequirementSubstitutionFilterCapabilityDataDefinition'
36780 ListDataDefinitionSubstitutionFilterPropertyDataDefinition:
36785 listToscaDataDefinition:
36788 $ref: '#/components/schemas/SubstitutionFilterPropertyDataDefinition'
36798 MetadataKeyDataDefinition:
36833 - NORMATIVE_EXTENSION
36836 ModelCreateRequest:
36845 - NORMATIVE_EXTENSION
36848 maxLength: 2147483647
36855 additionalProperties:
36868 additionalProperties:
36873 additionalProperties:
36890 additionalProperties:
36907 $ref: '#/components/schemas/CategoryDefinition'
36924 resourceVendorModelNumber:
36936 NodeTypesMetadataList:
36942 $ref: '#/components/schemas/NodeTypeMetadata'
36946 getLatestVspPackageUri:
36963 OperationDataDefinition:
36974 $ref: '#/components/schemas/ArtifactDataDefinition'
36976 $ref: '#/components/schemas/ListDataDefinitionOperationInputDefinition'
36983 $ref: '#/components/schemas/ListDataDefinitionOperationOutputDefinition'
36995 workflowAssociationType:
37005 OperationImplementation:
37014 OperationInputDefinition:
37020 $ref: '#/components/schemas/Annotation'
37034 $ref: '#/components/schemas/GetInputValueDataDefinition'
37038 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37049 isDeclaredListInput:
37053 mappedToComponentProperty:
37057 additionalProperties:
37068 parentPropertyType:
37074 propertyConstraints:
37083 $ref: '#/components/schemas/SchemaDefinition'
37085 $ref: '#/components/schemas/PropertyDataDefinition'
37094 subPropertyInputPath:
37096 subPropertyToscaFunctions:
37099 $ref: '#/components/schemas/SubPropertyToscaFunction'
37103 $ref: '#/components/schemas/ToscaFunction'
37105 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37106 toscaGetFunctionType:
37126 $ref: '#/components/schemas/OperationImplementation'
37129 additionalProperties:
37131 OperationOutputDefinition:
37137 $ref: '#/components/schemas/Annotation'
37151 $ref: '#/components/schemas/GetInputValueDataDefinition'
37155 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37166 isDeclaredListInput:
37170 mappedToComponentProperty:
37174 additionalProperties:
37185 parentPropertyType:
37191 propertyConstraints:
37200 $ref: '#/components/schemas/SchemaDefinition'
37202 $ref: '#/components/schemas/PropertyDataDefinition'
37207 subPropertyInputPath:
37209 subPropertyToscaFunctions:
37212 $ref: '#/components/schemas/SubPropertyToscaFunction'
37214 $ref: '#/components/schemas/ToscaFunction'
37216 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37217 toscaGetFunctionType:
37241 $ref: '#/components/schemas/PropertyAssignmentUi'
37250 $ref: '#/components/schemas/ComponentInstanceAttribute'
37262 $ref: '#/components/schemas/EntrySchema'
37263 getOutputAttribute:
37268 $ref: '#/components/schemas/GetOutputValueDataDefinition'
37289 $ref: '#/components/schemas/SchemaDefinition'
37302 PathsAndNamesDefinition:
37317 $ref: '#/components/schemas/Annotation'
37335 $ref: '#/components/schemas/GetInputValueDataDefinition'
37339 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37354 isDeclaredListInput:
37360 mappedToComponentProperty:
37364 additionalProperties:
37377 parentPropertyType:
37392 $ref: '#/components/schemas/PropertyDataDefinition'
37393 propertyConstraints:
37402 $ref: '#/components/schemas/SchemaDefinition'
37404 $ref: '#/components/schemas/PropertyDataDefinition'
37409 subPropertyInputPath:
37411 subPropertyToscaFunctions:
37414 $ref: '#/components/schemas/SubPropertyToscaFunction'
37417 additionalProperties:
37422 $ref: '#/components/schemas/ToscaFunction'
37424 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37425 toscaGetFunctionType:
37450 PolicyTypeDefinition:
37468 additionalProperties:
37485 $ref: '#/components/schemas/PropertyDefinition'
37496 PropertyAssignmentUi:
37505 PropertyConstraint:
37507 PropertyDataDefinition:
37513 $ref: '#/components/schemas/Annotation'
37527 $ref: '#/components/schemas/GetInputValueDataDefinition'
37531 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37542 isDeclaredListInput:
37546 mappedToComponentProperty:
37550 additionalProperties:
37561 parentPropertyType:
37567 propertyConstraints:
37576 $ref: '#/components/schemas/SchemaDefinition'
37578 $ref: '#/components/schemas/PropertyDataDefinition'
37583 subPropertyInputPath:
37585 subPropertyToscaFunctions:
37588 $ref: '#/components/schemas/SubPropertyToscaFunction'
37590 $ref: '#/components/schemas/ToscaFunction'
37592 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37593 toscaGetFunctionType:
37609 PropertyDefinition:
37615 $ref: '#/components/schemas/Annotation'
37619 $ref: '#/components/schemas/PropertyConstraint'
37633 $ref: '#/components/schemas/GetInputValueDataDefinition'
37637 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37648 isDeclaredListInput:
37652 mappedToComponentProperty:
37656 additionalProperties:
37667 parentPropertyType:
37673 propertyConstraints:
37682 $ref: '#/components/schemas/SchemaDefinition'
37684 $ref: '#/components/schemas/PropertyDataDefinition'
37689 subPropertyInputPath:
37691 subPropertyToscaFunctions:
37694 $ref: '#/components/schemas/SubPropertyToscaFunction'
37696 $ref: '#/components/schemas/ToscaFunction'
37698 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37699 toscaGetFunctionType:
37715 PropertyDefinitionDto:
37721 $ref: '#/components/schemas/PropertyConstraint'
37738 PropertyFilterConstraintDataDefinition:
37776 PropertyFilterDataDefinition:
37782 $ref: '#/components/schemas/PropertyFilterConstraintDataDefinition'
37819 numberOfCacheWorkers:
37822 syncIntervalInSecondes:
37825 waitOnShutDownInMinutes:
37845 $ref: '#/components/schemas/RelationshipImpl'
37847 $ref: '#/components/schemas/RelationshipImpl'
37850 requirementOwnerId:
37857 abstractResourceUniqueId:
37859 realVNFComponentInstance:
37860 $ref: '#/components/schemas/ComponentInstance'
37863 RequirementCapabilityRelDef:
37873 $ref: '#/components/schemas/CapabilityRequirementRelationship'
37878 RequirementDataDefinition:
37924 RequirementDefinition:
37970 RequirementNodeFilterCapabilityDataDefinition:
37983 $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition'
37988 RequirementSubstitutionFilterCapabilityDataDefinition:
38001 $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition'
38011 actualComponentType:
38013 additionalInformation:
38016 $ref: '#/components/schemas/AdditionalInformationDefinition'
38019 additionalProperties:
38020 $ref: '#/components/schemas/ArtifactDefinition'
38023 additionalProperties:
38032 additionalProperties:
38033 $ref: '#/components/schemas/ArtifactDefinition'
38037 $ref: '#/components/schemas/AttributeDefinition'
38040 additionalProperties:
38043 $ref: '#/components/schemas/CapabilityDefinition'
38047 $ref: '#/components/schemas/CategoryDefinition'
38048 categorySpecificMetadata:
38050 additionalProperties:
38052 componentInstances:
38055 $ref: '#/components/schemas/ComponentInstance'
38056 componentInstancesAttributes:
38058 additionalProperties:
38061 $ref: '#/components/schemas/ComponentInstanceAttribute'
38062 componentInstancesInputs:
38064 additionalProperties:
38067 $ref: '#/components/schemas/ComponentInstanceInput'
38068 componentInstancesInterfaces:
38070 additionalProperties:
38073 $ref: '#/components/schemas/ComponentInstanceInterface'
38074 componentInstancesOutputs:
38076 additionalProperties:
38079 $ref: '#/components/schemas/ComponentInstanceOutput'
38080 componentInstancesProperties:
38082 additionalProperties:
38085 $ref: '#/components/schemas/ComponentInstanceProperty'
38086 componentInstancesRelations:
38089 $ref: '#/components/schemas/RequirementCapabilityRelDef'
38090 componentMetadataForSupportLog:
38092 additionalProperties:
38099 - RESOURCE_INSTANCE
38124 $ref: '#/components/schemas/DataTypeDefinition'
38125 deploymentArtifacts:
38127 additionalProperties:
38128 $ref: '#/components/schemas/ArtifactDefinition'
38133 derivedFromGenericInfo:
38134 $ref: '#/components/schemas/Resource'
38135 derivedFromGenericType:
38137 derivedFromGenericVersion:
38139 derivedFromMapOfIdToName:
38141 additionalProperties:
38152 $ref: '#/components/schemas/GroupDefinition'
38157 importedToscaChecksum:
38162 $ref: '#/components/schemas/InputDefinition'
38165 additionalProperties:
38166 $ref: '#/components/schemas/InterfaceDefinition'
38174 lastUpdaterFullName:
38184 - NOT_CERTIFIED_CHECKIN
38185 - NOT_CERTIFIED_CHECKOUT
38190 nodeFilterComponents:
38192 additionalProperties:
38193 $ref: '#/components/schemas/CINodeFilterDataDefinition'
38199 $ref: '#/components/schemas/OutputDefinition'
38202 additionalProperties:
38203 $ref: '#/components/schemas/PolicyDefinition'
38209 $ref: '#/components/schemas/PropertyDefinition'
38212 additionalProperties:
38215 $ref: '#/components/schemas/RequirementDefinition'
38231 resourceVendorModelNumber:
38235 specificComponetTypeArtifacts:
38237 additionalProperties:
38238 $ref: '#/components/schemas/ArtifactDefinition'
38244 - NOT_CERTIFIED_CHECKIN
38245 - NOT_CERTIFIED_CHECKOUT
38247 substitutionFilter:
38248 $ref: '#/components/schemas/SubstitutionFilterDataDefinition'
38259 additionalProperties:
38260 $ref: '#/components/schemas/ArtifactDefinition'
38297 additionalProperties:
38298 $ref: '#/components/schemas/PropertyDataDefinition'
38300 $ref: '#/components/schemas/PropertyDataDefinition'
38311 actualComponentType:
38313 additionalInformation:
38316 $ref: '#/components/schemas/AdditionalInformationDefinition'
38319 additionalProperties:
38320 $ref: '#/components/schemas/ArtifactDefinition'
38323 additionalProperties:
38332 additionalProperties:
38333 $ref: '#/components/schemas/ArtifactDefinition'
38337 $ref: '#/components/schemas/AttributeDefinition'
38340 additionalProperties:
38343 $ref: '#/components/schemas/CapabilityDefinition'
38347 $ref: '#/components/schemas/CategoryDefinition'
38348 categorySpecificMetadata:
38350 additionalProperties:
38352 componentInstances:
38355 $ref: '#/components/schemas/ComponentInstance'
38356 componentInstancesAttributes:
38358 additionalProperties:
38361 $ref: '#/components/schemas/ComponentInstanceAttribute'
38362 componentInstancesInputs:
38364 additionalProperties:
38367 $ref: '#/components/schemas/ComponentInstanceInput'
38368 componentInstancesInterfaces:
38370 additionalProperties:
38373 $ref: '#/components/schemas/ComponentInstanceInterface'
38374 componentInstancesOutputs:
38376 additionalProperties:
38379 $ref: '#/components/schemas/ComponentInstanceOutput'
38380 componentInstancesProperties:
38382 additionalProperties:
38385 $ref: '#/components/schemas/ComponentInstanceProperty'
38386 componentInstancesRelations:
38389 $ref: '#/components/schemas/RequirementCapabilityRelDef'
38390 componentMetadataForSupportLog:
38392 additionalProperties:
38399 - RESOURCE_INSTANCE
38420 $ref: '#/components/schemas/DataTypeDefinition'
38421 deploymentArtifacts:
38423 additionalProperties:
38424 $ref: '#/components/schemas/ArtifactDefinition'
38425 derivedFromGenericInfo:
38426 $ref: '#/components/schemas/Resource'
38427 derivedFromGenericType:
38429 derivedFromGenericVersion:
38433 distributionStatus:
38436 - DISTRIBUTION_NOT_APPROVED
38438 ecompGeneratedNaming:
38440 environmentContext:
38444 additionalProperties:
38445 $ref: '#/components/schemas/ForwardingPathDataDefinition'
38449 $ref: '#/components/schemas/GroupDefinition'
38454 importedToscaChecksum:
38459 $ref: '#/components/schemas/InputDefinition'
38464 additionalProperties:
38465 $ref: '#/components/schemas/InterfaceDefinition'
38473 lastUpdaterFullName:
38481 - NOT_CERTIFIED_CHECKIN
38482 - NOT_CERTIFIED_CHECKOUT
38489 nodeFilterComponents:
38491 additionalProperties:
38492 $ref: '#/components/schemas/CINodeFilterDataDefinition'
38498 $ref: '#/components/schemas/OutputDefinition'
38501 additionalProperties:
38502 $ref: '#/components/schemas/PolicyDefinition'
38508 $ref: '#/components/schemas/PropertyDefinition'
38511 additionalProperties:
38514 $ref: '#/components/schemas/RequirementDefinition'
38517 serviceApiArtifacts:
38519 additionalProperties:
38520 $ref: '#/components/schemas/ArtifactDefinition'
38527 serviceVendorModelNumber:
38530 specificComponetTypeArtifacts:
38532 additionalProperties:
38533 $ref: '#/components/schemas/ArtifactDefinition'
38539 - NOT_CERTIFIED_CHECKIN
38540 - NOT_CERTIFIED_CHECKOUT
38542 substituteCandidate:
38544 substitutionFilter:
38545 $ref: '#/components/schemas/SubstitutionFilterDataDefinition'
38556 additionalProperties:
38557 $ref: '#/components/schemas/ArtifactDefinition'
38579 $ref: '#/components/schemas/NameIdPairWrapper'
38586 $ref: '#/components/schemas/NameIdPairWrapper'
38588 SubCategoryDefinition:
38596 $ref: '#/components/schemas/GroupingDefinition'
38604 $ref: '#/components/schemas/MetadataKeyDataDefinition'
38620 SubPropertyToscaFunction:
38628 $ref: '#/components/schemas/ToscaFunction'
38629 SubstitutionFilterDataDefinition:
38633 $ref: '#/components/schemas/ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition'
38646 $ref: '#/components/schemas/ListDataDefinitionSubstitutionFilterPropertyDataDefinition'
38653 SubstitutionFilterPropertyDataDefinition:
38659 $ref: '#/components/schemas/PropertyFilterConstraintDataDefinition'
38673 SwitchoverDetectorConfig:
38681 changePriorityPassword:
38683 changePriorityUser:
38698 additionalProperties:
38699 $ref: '#/components/schemas/GroupInfo'
38703 publishNetworkBody:
38707 ToscaArtifactDataDefinition:
38714 additionalProperties:
38734 ToscaGetFunctionDataDefinition:
38745 propertyPathFromSource:
38769 ToscaValidatorsConfig:
38780 constraintOperator:
38782 servicePropertyName:
38823 - PRODUCT_STRATEGIST