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
214 name: excludePrimitives
220 description: allDataTypes
222 description: Invalid content / Missing content
224 description: Restricted operation
226 description: Data types not found
242 additionalProperties:
282 additionalProperties:
314 unicodeLocaleAttributes:
339 additionalProperties:
365 additionalProperties:
377 additionalProperties:
403 additionalProperties:
410 summary: Returns all data types from all models
415 description: Get all Archived Components
416 operationId: getArchivedComponents
426 description: Bad request
428 description: Restricted operation
430 description: Internal Error
441 summary: Get all Archived Components
444 /v1/catalog/artifactTypes:
446 description: Get Tosca ArtifactTypes
447 operationId: getAllToscaArtifactTypes
449 - description: Model name
460 description: Listing successful
462 description: Invalid content / Missing content
464 description: Restricted operation
466 description: Tosca Artifact Types not found
482 additionalProperties:
522 additionalProperties:
554 unicodeLocaleAttributes:
579 additionalProperties:
605 additionalProperties:
617 additionalProperties:
643 additionalProperties:
650 summary: Returns tosca artifact types
653 /v1/catalog/audit-records/{componentType}/{componentUniqueId}:
655 description: get component audit records
656 operationId: getComponentAuditRecords
664 name: componentUniqueId
674 description: Service found
676 description: Restricted operation
692 additionalProperties:
732 additionalProperties:
764 unicodeLocaleAttributes:
789 additionalProperties:
815 additionalProperties:
827 additionalProperties:
853 additionalProperties:
860 summary: get audit records for a service or a resource
863 /v1/catalog/capabilityTypes:
865 description: Get capability types
866 operationId: getAllCapabilityTypesServlet
879 description: capabilityTypes
881 description: Invalid content / Missing content
883 description: Restricted operation
885 description: Capability types not found
901 additionalProperties:
941 additionalProperties:
973 unicodeLocaleAttributes:
998 additionalProperties:
1024 additionalProperties:
1036 additionalProperties:
1062 additionalProperties:
1069 summary: Returns capability types
1072 /v1/catalog/customToscaFunctions/{type}:
1074 description: Retrieve default custom tosca functions values from the configuration
1076 operationId: getDefaultCustomToscaFunctionValues
1093 description: Returns default custom tosca functions values from configuration
1096 description: Default custom tosca functions not found
1098 description: Internal Server Error
1105 $ref: '#/components/schemas/User'
1106 summary: Retrieve all custom tosca functions
1109 /v1/catalog/data-types/{dataTypeId}:
1111 operationId: deleteDatatype
1113 - description: The data type id
1123 description: default response
1129 /v1/catalog/data-types/{dataTypeId}/{propertyId}:
1131 operationId: deleteProperty
1133 - description: The data type id
1139 - description: The property id to delete
1149 description: default response
1155 /v1/catalog/data-types/{dataTypeName}/models:
1157 description: Get models for type
1158 operationId: getDataTypeModels
1167 description: dataTypeModels
1169 description: Invalid content / Missing content
1171 description: Restricted operation
1173 description: Data type not found
1189 additionalProperties:
1229 additionalProperties:
1261 unicodeLocaleAttributes:
1286 additionalProperties:
1312 additionalProperties:
1324 additionalProperties:
1350 additionalProperties:
1357 summary: Returns list of models for type
1360 /v1/catalog/data-types/{dataTypeUid}:
1362 description: Get data types
1363 operationId: fetchDataType
1376 description: Data type found
1378 description: Invalid content / Missing content
1380 description: Restricted operation
1382 description: Data types not found
1387 $ref: '#/components/schemas/DataTypeDataDefinition'
1391 summary: Returns data types
1394 /v1/catalog/data-types/{id}/properties:
1396 description: Get a data type properties
1397 operationId: fetchProperties
1399 - description: The data type id
1407 description: "Data type found, properties may be empty"
1409 description: Restricted operation
1411 description: Data type not found
1418 $ref: '#/components/schemas/PropertyDefinition'
1422 summary: Returns the data type properties
1426 description: Create a property in the given data type
1427 operationId: createProperty
1429 - description: The data type id
1439 $ref: '#/components/schemas/PropertyDefinitionDto'
1440 description: Property to add
1444 description: Property created in the data type
1446 description: Invalid payload
1448 description: Restricted operation
1450 description: Data type not found
1452 description: Property already exists in the data type
1457 $ref: '#/components/schemas/PropertyDefinitionDto'
1461 summary: Create a property in the given data type
1465 description: Update a property in the given data type
1466 operationId: updateProperty
1468 - description: The data type id
1478 $ref: '#/components/schemas/PropertyDefinitionDto'
1479 description: Property to update
1483 description: Property updated in the data type
1485 description: Invalid payload
1487 description: Restricted operation
1489 description: Data type not found
1494 $ref: '#/components/schemas/PropertyDefinitionDto'
1498 summary: Update a property in the given data type
1501 /v1/catalog/dataTypes:
1503 description: Get data types
1504 operationId: getAllDataTypesServlet
1510 - description: model
1517 description: datatypes
1519 description: Invalid content / Missing content
1521 description: Restricted operation
1523 description: Data types not found
1539 additionalProperties:
1579 additionalProperties:
1611 unicodeLocaleAttributes:
1636 additionalProperties:
1662 additionalProperties:
1674 additionalProperties:
1700 additionalProperties:
1707 summary: Returns data types
1710 /v1/catalog/directives:
1712 description: Retrieve all Directives values from configuration file
1713 operationId: getConfCategoriesAndVersion
1721 description: Returns Directive values from configuration file Ok
1723 description: Directive not found
1725 description: Internal Server Error
1732 $ref: '#/components/schemas/User'
1733 summary: Retrieve all Directives
1736 /v1/catalog/downloadDataType:
1738 description: Get data types
1739 operationId: downloadDataType
1745 - description: dataTypeId
1752 description: allDataTypes
1754 description: Invalid content / Missing content
1756 description: Restricted operation
1758 description: Data types not found
1774 additionalProperties:
1814 additionalProperties:
1846 unicodeLocaleAttributes:
1871 additionalProperties:
1897 additionalProperties:
1909 additionalProperties:
1935 additionalProperties:
1942 summary: Returns all data types from all models
1945 /v1/catalog/gab/searchFor:
1947 description: Search json paths inside the yaml
1948 operationId: searchFor
1953 $ref: '#/components/schemas/GenericArtifactQueryInfo'
1954 description: Generic Artifact search model
1958 description: Returned yaml entries
1960 description: Invalid content / Missing content
1976 additionalProperties:
2016 additionalProperties:
2048 unicodeLocaleAttributes:
2073 additionalProperties:
2099 additionalProperties:
2111 additionalProperties:
2137 additionalProperties:
2144 summary: Returns found entries of json paths
2147 /v1/catalog/groupTypes:
2149 description: 'Get group types '
2150 operationId: getGroupTypes
2156 - description: An optional parameter to indicate the type of the container from
2157 where this call is executed
2159 name: internalComponentType
2163 name: componentModel
2168 description: group types found
2170 description: "field name invalid type/length, characters; mandatory field\
2171 \ is absent, already exists (name)"
2173 description: Restricted operation
2175 description: Internal Error
2182 $ref: '#/components/schemas/GroupTypeDefinition'
2186 summary: Returns group types
2189 /v1/catalog/handleException:
2191 description: Handle exception
2192 operationId: sendError
2207 additionalProperties:
2247 additionalProperties:
2279 unicodeLocaleAttributes:
2304 additionalProperties:
2330 additionalProperties:
2342 additionalProperties:
2368 additionalProperties:
2372 description: Internal Error
2378 /v1/catalog/interface-types/{interfaceTypeId}:
2380 operationId: deleteInterfaceType
2382 - description: The interface type id
2384 name: interfaceTypeId
2392 description: default response
2398 /v1/catalog/interfaceLifecycleTypes:
2400 description: Get interface lifecycle types
2401 operationId: getInterfaceLifecycleTypes
2407 - description: model
2414 description: Interface lifecycle types
2416 description: Invalid content / Missing content
2418 description: Restricted operation
2420 description: Interface lifecycle types not found
2436 additionalProperties:
2476 additionalProperties:
2508 unicodeLocaleAttributes:
2533 additionalProperties:
2559 additionalProperties:
2571 additionalProperties:
2597 additionalProperties:
2604 summary: Returns interface lifecycle types
2609 description: Toggle disable locking
2610 operationId: toggleDisableLocking
2621 description: Disable Locking
2624 description: Disable locking successfully updated
2626 description: Update disable locking failed
2640 additionalProperties:
2680 additionalProperties:
2712 unicodeLocaleAttributes:
2737 additionalProperties:
2763 additionalProperties:
2775 additionalProperties:
2801 additionalProperties:
2812 description: List all the existing TOSCA models
2813 operationId: listModels
2825 description: Listing successful
2827 description: Restricted operation
2834 $ref: '#/components/schemas/Model'
2838 summary: List TOSCA models
2842 description: "Create a TOSCA model, along with its imports files"
2843 operationId: createModel
2851 multipart/form-data:
2856 $ref: '#/components/schemas/ModelCreateRequest'
2859 description: the model TOSCA imports zipped
2865 description: Model created
2867 description: Invalid content / Missing content
2869 description: Restricted operation
2871 description: Model already exists
2887 additionalProperties:
2927 additionalProperties:
2959 unicodeLocaleAttributes:
2984 additionalProperties:
3010 additionalProperties:
3022 additionalProperties:
3048 additionalProperties:
3055 summary: Create a TOSCA model
3058 /v1/catalog/model/imports:
3060 description: Update a model TOSCA imports
3061 operationId: updateModelImports
3069 multipart/form-data:
3075 description: the model TOSCA imports zipped
3078 description: model to be created
3084 description: Model imports updated
3086 description: Invalid content / Missing content
3088 description: Restricted operation
3090 description: Model not found
3106 additionalProperties:
3146 additionalProperties:
3178 unicodeLocaleAttributes:
3203 additionalProperties:
3229 additionalProperties:
3241 additionalProperties:
3267 additionalProperties:
3274 summary: Update a model TOSCA imports
3277 /v1/catalog/nodeTypes:
3279 description: Get node types
3280 operationId: getAllNodeTypesServlet
3286 - description: model
3293 description: nodeTypes
3295 description: Invalid content / Missing content
3297 description: Restricted operation
3299 description: Node types not found
3315 additionalProperties:
3355 additionalProperties:
3387 unicodeLocaleAttributes:
3412 additionalProperties:
3438 additionalProperties:
3450 additionalProperties:
3476 additionalProperties:
3483 summary: Returns node types
3486 /v1/catalog/notif/vsp/archived:
3488 description: Notify about an archived VSP. All VFs with relation to the given
3489 CSAR IDs will be martked as vspArchived=true
3490 operationId: onVspArchived
3505 description: Success
3507 description: Bad request
3509 description: Restricted operation
3511 description: Internal Error. A list of the failed CSAR IDs may be returned.
3517 /v1/catalog/notif/vsp/restored:
3519 description: Notify about a restored VSP. All VFs with relation to the given
3520 CSAR IDs will be martked as vspArchived=false
3521 operationId: onVspRestored
3536 description: Success
3538 description: Bad request
3540 description: Restricted operation
3542 description: Internal Error. A list of the failed CSAR IDs may be returned.
3548 /v1/catalog/policyTypes:
3550 description: 'Get policy types '
3551 operationId: getPolicyTypes
3553 - description: An optional parameter to indicate the type of the container from
3554 where this call is executed
3556 name: internalComponentType
3560 name: componentModel
3563 - description: The user id
3571 description: policy types found
3573 description: Restricted operation
3575 description: The GET request failed due to internal SDC problem.
3582 $ref: '#/components/schemas/PolicyTypeDefinition'
3586 summary: Returns policy types
3589 /v1/catalog/relationshipTypes:
3591 description: Get relationship types
3592 operationId: getAllRelationshipTypesServlet
3598 - description: model
3605 description: relationshipTypes
3607 description: Invalid content / Missing content
3609 description: Restricted operation
3611 description: Relationship types not found
3627 additionalProperties:
3667 additionalProperties:
3699 unicodeLocaleAttributes:
3724 additionalProperties:
3750 additionalProperties:
3762 additionalProperties:
3788 additionalProperties:
3795 summary: Returns relationship types
3798 /v1/catalog/resources:
3800 description: Create Resource
3801 operationId: createResource
3812 description: Resource object to be created
3816 description: Resource created
3818 description: Invalid content / Missing content
3820 description: Unauthorized Tenant
3822 description: Restricted operation
3824 description: Resource already exist
3831 $ref: '#/components/schemas/Resource'
3835 summary: Returns created resource
3838 /v1/catalog/resources/certified/abstract:
3840 operationId: getCertifiedAbstractResources
3849 application/json: {}
3850 description: default response
3856 /v1/catalog/resources/certified/notabstract:
3858 operationId: getCertifiedNotAbstractResources
3867 application/json: {}
3868 description: default response
3874 /v1/catalog/resources/csar/{csaruuid}:
3876 description: Create Resource
3877 operationId: getResourceFromCsar
3890 description: Resource retrieced
3892 description: Invalid content / Missing content
3894 description: Restricted operation
3901 $ref: '#/components/schemas/Resource'
3905 summary: Returns resource created from csar uuid
3908 /v1/catalog/resources/importReplaceResource:
3910 description: Import Resource
3911 operationId: importReplaceResource
3913 - description: The user id
3919 - description: X-ECOMP-RequestID header
3921 name: X-ECOMP-RequestID
3924 - description: X-ECOMP-InstanceID header
3926 name: X-ECOMP-InstanceID
3930 - description: Determines the format of the body of the response
3935 - description: The username and password
3948 $ref: '#/components/schemas/FormDataContentDisposition'
3949 resourceZipMetadata:
3951 description: resourceMetadata
3954 description: Resource created
3956 description: Invalid content / Missing content
3958 description: Restricted operation
3960 description: Resource already exist
3964 summary: Returns imported resource
3967 /v1/catalog/resources/resourceName/{resourceName}/resourceVersion/{resourceVersion}:
3969 description: Retrieve Resource by name and version
3970 operationId: getResourceByNameAndVersion
3978 name: resourceVersion
3988 description: Resource found
3990 description: Restricted operation
3992 description: Resource not found
3999 $ref: '#/components/schemas/Resource'
4003 summary: Returns resource according to resourceId
4006 /v1/catalog/resources/validate-name/{resourceName}:
4008 description: validate resource name
4009 operationId: validateResourceName
4026 description: Resource found
4028 description: Restricted operation
4035 $ref: '#/components/schemas/Resource'
4039 summary: 'checks if the chosen resource name is available '
4042 /v1/catalog/resources/{componentId}/archive:
4044 description: Archive Resource
4045 operationId: archiveResources
4058 description: Archive successful
4060 description: Bad request
4062 description: Restricted operation
4064 description: Resource not found
4066 description: Internal Error
4077 summary: Marks a resource as archived. Can be restored with restore action
4080 /v1/catalog/resources/{componentId}/interfaceOperation:
4082 description: Update Interface Operation
4083 operationId: updateResourceInterfaceOperation
4085 - description: Component Id
4097 description: Update Interface Operation
4099 description: Invalid content / Missing content
4101 description: Restricted operation
4117 additionalProperties:
4157 additionalProperties:
4189 unicodeLocaleAttributes:
4214 additionalProperties:
4240 additionalProperties:
4252 additionalProperties:
4278 additionalProperties:
4285 summary: Update Interface Operation on ComponentInstance
4288 /v1/catalog/resources/{componentId}/restore:
4290 description: Restore Resource
4291 operationId: restoreResource
4304 description: Restore successful
4306 description: Bad request
4308 description: Restricted operation
4310 description: Resource not found
4312 description: Internal Error
4323 summary: Restores a resource from archive.
4326 /v1/catalog/resources/{resourceId}:
4328 operationId: deleteResource
4335 - description: "Optional parameter to determine the delete action: DELETE, which\
4336 \ will permanently delete the Resource from the system or MARK_AS_DELETE,\
4337 \ which will logically mark the Resource as deleted. Default action is to\
4350 description: default response
4357 description: Retrieve Resource
4358 operationId: getResourceById
4371 description: Resource found
4373 description: Restricted operation
4375 description: Resource not found
4382 $ref: '#/components/schemas/Resource'
4386 summary: Returns resource according to resourceId
4390 description: Update Resource
4391 operationId: updateResource
4407 description: Resource object to be updated
4411 description: Resource updated
4413 description: Invalid content / Missing content
4415 description: Restricted operation
4417 description: Resource already exist
4424 $ref: '#/components/schemas/Resource'
4428 summary: Returns updated resource
4431 /v1/catalog/resources/{resourceId}/additionalinfo:
4433 description: Get all Additional Information under resource
4434 operationId: getAllResourceAdditionalInformationLabel
4436 - description: resource id to update with new property
4448 description: list of additional information
4450 description: Invalid content / Missing content
4452 description: Restricted operation
4454 description: Additional information key already exist
4470 additionalProperties:
4510 additionalProperties:
4542 unicodeLocaleAttributes:
4567 additionalProperties:
4593 additionalProperties:
4605 additionalProperties:
4631 additionalProperties:
4638 summary: Returns Additional Inforamtion property
4642 description: Create Additional Information Label and Value
4643 operationId: createResourceAdditionalInformationLabel
4645 - description: resource id to update with new property
4660 description: Additional information key value to be created
4664 description: Additional information created
4666 description: Invalid content / Missing content
4668 description: Restricted operation
4670 description: Additional information key already exist
4686 additionalProperties:
4726 additionalProperties:
4758 unicodeLocaleAttributes:
4783 additionalProperties:
4809 additionalProperties:
4821 additionalProperties:
4847 additionalProperties:
4854 summary: Returns created Additional Inforamtion property
4857 /v1/catalog/resources/{resourceId}/additionalinfo/{labelId}:
4859 description: Create Additional Information Label and Value
4860 operationId: updateResourceAdditionalInformationLabel
4862 - description: resource id to update with new property
4868 - description: label id
4880 description: Additional information deleted
4882 description: Invalid content / Missing content
4884 description: Restricted operation
4886 description: Additional information key already exist
4902 additionalProperties:
4942 additionalProperties:
4974 unicodeLocaleAttributes:
4999 additionalProperties:
5025 additionalProperties:
5037 additionalProperties:
5063 additionalProperties:
5070 summary: Returns deleted Additional Inforamtion property
5074 description: Get Additional Information by id
5075 operationId: getResourceAdditionalInformationLabel
5077 - description: resource id to update with new property
5083 - description: label id
5095 description: fetched additional information
5097 description: Invalid content / Missing content
5099 description: Restricted operation
5101 description: Additional information key already exist
5117 additionalProperties:
5157 additionalProperties:
5189 unicodeLocaleAttributes:
5214 additionalProperties:
5240 additionalProperties:
5252 additionalProperties:
5278 additionalProperties:
5285 summary: Returns Additional Inforamtion property
5289 description: Update Additional Information Label and Value
5290 operationId: updateResourceAdditionalInformationLabel_1
5292 - description: resource id to update with new property
5298 - description: label id
5313 description: Additional information key value to be created
5317 description: Additional information updated
5319 description: Invalid content / Missing content
5321 description: Restricted operation
5323 description: Additional information key already exist
5339 additionalProperties:
5379 additionalProperties:
5411 unicodeLocaleAttributes:
5436 additionalProperties:
5462 additionalProperties:
5474 additionalProperties:
5500 additionalProperties:
5507 summary: Returns updated Additional Inforamtion property
5510 /v1/catalog/resources/{resourceId}/artifacts:
5512 description: Create Artifact
5513 operationId: loadArtifact
5525 description: json describe the artifact
5529 description: Resource created
5531 description: Invalid content / Missing content
5533 description: Restricted operation
5535 description: Artifact already exist
5551 additionalProperties:
5591 additionalProperties:
5623 unicodeLocaleAttributes:
5648 additionalProperties:
5674 additionalProperties:
5686 additionalProperties:
5712 additionalProperties:
5719 summary: Returns created ArtifactDefinition
5722 /v1/catalog/resources/{resourceId}/artifacts/{artifactId}:
5724 description: Delete Artifact
5725 operationId: deleteArtifact
5739 description: Resource created
5741 description: Invalid content / Missing content
5743 description: Restricted operation
5759 additionalProperties:
5799 additionalProperties:
5831 unicodeLocaleAttributes:
5856 additionalProperties:
5882 additionalProperties:
5894 additionalProperties:
5920 additionalProperties:
5927 summary: Returns delete artifact
5931 description: Download resource Artifact in Base64
5932 operationId: downloadResourceArtifactBase64
5946 description: Resource artifact downloaded
5948 description: Resource/Artifact not found
5964 additionalProperties:
6004 additionalProperties:
6036 unicodeLocaleAttributes:
6061 additionalProperties:
6087 additionalProperties:
6099 additionalProperties:
6125 additionalProperties:
6132 summary: Returns downloaded artifact
6136 description: Update Artifact
6137 operationId: updateArtifact
6154 description: json describe the artifact
6158 description: Resource created
6160 description: Invalid content / Missing content
6162 description: Restricted operation
6178 additionalProperties:
6218 additionalProperties:
6250 unicodeLocaleAttributes:
6275 additionalProperties:
6301 additionalProperties:
6313 additionalProperties:
6339 additionalProperties:
6346 summary: Returns updated artifact
6349 /v1/catalog/resources/{resourceId}/attributes:
6351 description: Get Resource Attribute
6352 operationId: getAttributeListInResource
6354 - description: resource id of attribute
6366 description: attribute
6368 description: Invalid content / Missing content
6370 description: Restricted operation
6372 description: Resource attribute not found
6388 additionalProperties:
6428 additionalProperties:
6460 unicodeLocaleAttributes:
6485 additionalProperties:
6511 additionalProperties:
6523 additionalProperties:
6549 additionalProperties:
6556 summary: Returns attribute list of resource
6560 description: Create Resource Attribute
6561 operationId: createAttribute
6563 - description: resource id to update with new attribute
6578 description: Resource attribute to be created
6582 description: Resource property created
6584 description: Invalid content / Missing content
6586 description: Restricted operation
6588 description: Resource attribute already exist
6604 additionalProperties:
6644 additionalProperties:
6676 unicodeLocaleAttributes:
6701 additionalProperties:
6727 additionalProperties:
6739 additionalProperties:
6765 additionalProperties:
6772 summary: Returns created resource attribute
6775 /v1/catalog/resources/{resourceId}/attributes/{attributeId}:
6777 description: Create Resource Attribute
6778 operationId: deleteAttribute
6780 - description: resource id of attribute
6786 - description: Attribute id to delete
6798 description: deleted attribute
6800 description: Invalid content / Missing content
6802 description: Restricted operation
6804 description: Resource property not found
6820 additionalProperties:
6860 additionalProperties:
6892 unicodeLocaleAttributes:
6917 additionalProperties:
6943 additionalProperties:
6955 additionalProperties:
6981 additionalProperties:
6988 summary: Returns deleted attribute
6992 description: Update Resource Attribute
6993 operationId: updateAttribute
6995 - description: resource id to update with new attribute
7001 - description: attribute id to update
7016 description: Resource attribute to update
7020 description: Resource attribute updated
7022 description: Invalid content / Missing content
7024 description: Restricted operation
7040 additionalProperties:
7080 additionalProperties:
7112 unicodeLocaleAttributes:
7137 additionalProperties:
7163 additionalProperties:
7175 additionalProperties:
7201 additionalProperties:
7208 summary: Returns updated attribute
7211 /v1/catalog/resources/{resourceId}/capabilities:
7213 description: Create Capabilities on resource
7214 operationId: createCapabilitiesOnResource
7216 - description: Resource Id
7231 description: Capability to create
7235 description: Create Capabilities
7237 description: Invalid content / Missing content
7239 description: Restricted operation
7241 description: Capability already exist
7257 additionalProperties:
7297 additionalProperties:
7329 unicodeLocaleAttributes:
7354 additionalProperties:
7380 additionalProperties:
7392 additionalProperties:
7418 additionalProperties:
7425 summary: Create Capabilities on resource
7429 description: Update Capabilities on resource
7430 operationId: updateCapabilitiesOnResource
7432 - description: Component Id
7447 description: Capabilities to update
7451 description: Update Capabilities
7453 description: Invalid content / Missing content
7455 description: Restricted operation
7462 $ref: '#/components/schemas/CapabilityDefinition'
7466 summary: Update Capabilities on resource
7469 /v1/catalog/resources/{resourceId}/capabilities/{capabilityId}:
7471 description: Delete capability from resource
7472 operationId: deleteCapabilityOnResource
7474 - description: capability Id
7480 - description: Resource Id
7492 description: Delete capability
7494 description: Invalid content / Missing content
7496 description: Restricted operation
7503 $ref: '#/components/schemas/CapabilityDefinition'
7507 summary: Delete capability from resource
7511 description: Get Capability from resource
7512 operationId: getCapabilityOnResource
7514 - description: Resource Id
7520 - description: Capability Id
7532 description: GET Capability
7534 description: Invalid content / Missing content
7536 description: Restricted operation
7543 $ref: '#/components/schemas/CapabilityDefinition'
7547 summary: GET Capability from resource
7550 /v1/catalog/resources/{resourceId}/interfaceOperations:
7552 description: Create Interface Operations on Resource
7553 operationId: createInterfaceOperationsOnResource
7555 - description: Resource Id
7570 description: Interface Operations to create
7574 description: Create Interface Operations on Resource
7576 description: Invalid content / Missing content
7578 description: Restricted operation
7580 description: Resource not found
7582 description: Interface Operation already exist
7589 $ref: '#/components/schemas/InterfaceDefinition'
7593 summary: Create Interface Operations on Resource
7597 description: Update Interface Operations on Resource
7598 operationId: updateInterfaceOperationsOnResource
7600 - description: Resource Id
7615 description: Interface Operations to update
7619 description: Update Interface Operations on Resource
7621 description: Invalid content / Missing content
7623 description: Restricted operation
7625 description: Resource not found
7632 $ref: '#/components/schemas/InterfaceDefinition'
7636 summary: Update Interface Operations on Resource
7639 /v1/catalog/resources/{resourceId}/interfaces/{interfaceId}/operations/{operationId}:
7641 description: Delete Interface Operation from Resource
7642 operationId: deleteInterfaceOperationsFromResource
7644 - description: Resource Id
7650 - description: Interface Id
7656 - description: Operation Id
7668 description: Delete Interface Operation from Resource
7670 description: Invalid content / Missing content
7672 description: Restricted operation
7674 description: Resource not found
7681 $ref: '#/components/schemas/InterfaceDefinition'
7685 summary: Delete Interface Operation from Resource
7689 description: Get Interface Operation from Resource
7690 operationId: getInterfaceOperationsFromResource
7692 - description: Resource Id
7698 - description: Interface Id
7704 - description: Operation Id
7716 description: Delete Interface Operation from Resource
7718 description: Invalid content / Missing content
7720 description: Restricted operation
7722 description: Resource not found
7729 $ref: '#/components/schemas/InterfaceDefinition'
7733 summary: GET Interface Operation from Resource
7736 /v1/catalog/resources/{resourceId}/metadata:
7738 description: Update Resource Metadata
7739 operationId: updateResourceMetadata
7755 description: Resource metadata to be updated
7759 description: Resource metadata updated
7761 description: Invalid content
7763 description: Restricted operation
7770 $ref: '#/components/schemas/Resource'
7774 summary: Returns updated resource metadata
7777 /v1/catalog/resources/{resourceId}/properties:
7779 description: Get Resource Property
7780 operationId: getPropertyListInResource
7782 - description: resource id of property
7794 description: property
7796 description: Invalid content / Missing content
7798 description: Restricted operation
7800 description: Resource property not found
7816 additionalProperties:
7856 additionalProperties:
7888 unicodeLocaleAttributes:
7913 additionalProperties:
7939 additionalProperties:
7951 additionalProperties:
7977 additionalProperties:
7984 summary: Returns property list of resource
7988 description: Create Resource Property
7989 operationId: createPropertyInResource
7991 - description: Resource id to update with new property
8006 description: Resource property to be created
8010 description: Resource property created
8012 description: Invalid content / Missing content
8014 description: Restricted operation
8016 description: Resource property already exist
8032 additionalProperties:
8072 additionalProperties:
8104 unicodeLocaleAttributes:
8129 additionalProperties:
8155 additionalProperties:
8167 additionalProperties:
8193 additionalProperties:
8200 summary: Returns created service property
8204 description: Update Resource Property
8205 operationId: updatePropertyInResource
8207 - description: resource id to update with new property
8222 description: Resource property to update
8226 description: Resource property updated
8228 description: Invalid content / Missing content
8230 description: Restricted operation
8246 additionalProperties:
8286 additionalProperties:
8318 unicodeLocaleAttributes:
8343 additionalProperties:
8369 additionalProperties:
8381 additionalProperties:
8407 additionalProperties:
8414 summary: Returns updated property
8417 /v1/catalog/resources/{resourceId}/properties/{propertyId}:
8419 description: Delete Resource Property
8420 operationId: deletePropertyInResource
8422 - description: resource id of property
8428 - description: Property id to delete
8440 description: deleted property
8442 description: Invalid content / Missing content
8444 description: Restricted operation
8446 description: Resource property not found
8462 additionalProperties:
8502 additionalProperties:
8534 unicodeLocaleAttributes:
8559 additionalProperties:
8585 additionalProperties:
8597 additionalProperties:
8623 additionalProperties:
8630 summary: Returns deleted property
8634 description: Get Resource Property
8635 operationId: getPropertyInResource
8637 - description: resource id of property
8643 - description: property id to get
8655 description: property
8657 description: Invalid content / Missing content
8659 description: Restricted operation
8661 description: Resource property not found
8677 additionalProperties:
8717 additionalProperties:
8749 unicodeLocaleAttributes:
8774 additionalProperties:
8800 additionalProperties:
8812 additionalProperties:
8838 additionalProperties:
8845 summary: Returns property of resource
8848 /v1/catalog/resources/{resourceId}/requirements:
8850 description: Create requirements on resource
8851 operationId: createRequirementsOnResource
8853 - description: Resource Id
8868 description: Requirement to create
8872 description: Create requirements
8874 description: Invalid content / Missing content
8876 description: Restricted operation
8878 description: requirement already exist
8894 additionalProperties:
8934 additionalProperties:
8966 unicodeLocaleAttributes:
8991 additionalProperties:
9017 additionalProperties:
9029 additionalProperties:
9055 additionalProperties:
9062 summary: Create requirements on resource
9066 description: Update Requirements on resource
9067 operationId: updateRequirementsOnResource
9069 - description: Component Id
9084 description: Requirements to update
9088 description: Update Requirements
9090 description: Invalid content / Missing content
9092 description: Restricted operation
9099 $ref: '#/components/schemas/RequirementDefinition'
9103 summary: Update Requirements on resource
9106 /v1/catalog/resources/{resourceId}/requirements/{requirementId}:
9108 description: Delete requirements from resource
9109 operationId: deleteRequirementsFromResource
9111 - description: Resource Id
9117 - description: requirement Id
9129 description: Delete requirement
9131 description: Invalid content / Missing content
9133 description: Restricted operation
9140 $ref: '#/components/schemas/RequirementDefinition'
9144 summary: Delete requirements from resource
9148 description: Get Requirement from resource
9149 operationId: getRequirementsFromResource
9151 - description: Resource Id
9157 - description: Requirement Id
9169 description: GET requirement
9171 description: Invalid content / Missing content
9173 description: Restricted operation
9180 $ref: '#/components/schemas/RequirementDefinition'
9184 summary: GET Requirement from resource
9187 /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts:
9189 description: Create Artifact and Attach to interface
9190 operationId: loadArtifactToInterface
9220 description: json describe the artifact
9224 description: Resource created
9226 description: Invalid content / Missing content
9228 description: Restricted operation
9230 description: Artifact already exist
9246 additionalProperties:
9286 additionalProperties:
9318 unicodeLocaleAttributes:
9343 additionalProperties:
9369 additionalProperties:
9381 additionalProperties:
9407 additionalProperties:
9414 summary: Returns created resource
9417 /v1/catalog/resources/{resourceId}/{interfaceType}/{operation}/artifacts/{artifactId}:
9419 description: delete Artifact from interface
9420 operationId: deleteArtifactToInterface
9444 description: delete artifact under interface deleted
9446 description: Invalid content / Missing content
9448 description: Restricted operation
9450 description: Artifact already exist
9466 additionalProperties:
9506 additionalProperties:
9538 unicodeLocaleAttributes:
9563 additionalProperties:
9589 additionalProperties:
9601 additionalProperties:
9627 additionalProperties:
9634 summary: delete matching artifact from interface
9638 description: update Artifact Attach to interface
9639 operationId: updateArtifactToInterface
9674 description: json describe the artifact
9678 description: delete artifact under interface deleted
9680 description: Invalid content / Missing content
9682 description: Restricted operation
9684 description: Artifact already exist
9700 additionalProperties:
9740 additionalProperties:
9772 unicodeLocaleAttributes:
9797 additionalProperties:
9823 additionalProperties:
9835 additionalProperties:
9861 additionalProperties:
9868 summary: updates artifact by interface
9871 /v1/catalog/resources/{resourceName}/{version}:
9873 description: Delete Resource By Name And Version
9874 operationId: deleteResourceByNameAndVersion
9888 description: Resource deleted
9890 description: Invalid content / Missing content
9892 description: Restricted operation
9894 description: Resource not found
9901 $ref: '#/components/schemas/Resource'
9905 summary: Returns no content
9908 /v1/catalog/services:
9910 description: Create Service
9911 operationId: createService
9922 description: Service object to be created
9926 description: Service created
9928 description: Invalid content / Missing content
9930 description: Unauthorized Tenant
9932 description: Restricted operation
9934 description: Service already exist
9941 $ref: '#/components/schemas/Service'
9945 summary: Returns created service
9948 /v1/catalog/services/distribution/{did}:
9950 description: Retrieve Distributions
9951 operationId: getListOfDistributionStatuses
9964 description: Service found
9966 description: Restricted operation
9968 description: Status not found
9975 $ref: '#/components/schemas/DistributionStatusListResponse'
9979 summary: Return the list of distribution status objects
9982 /v1/catalog/services/importService:
9984 description: Import Service
9985 operationId: importNsService
9996 description: Service object to be imported
10000 description: Service created
10002 description: Invalid content / Missing content
10004 description: Restricted operation
10006 description: Service already exist
10010 summary: Returns imported service
10013 /v1/catalog/services/replaceVNF:
10015 description: Replace new VNF based on the existing VNF
10016 operationId: replaceVNF
10018 - description: The user id
10024 - description: X-ECOMP-RequestID header
10026 name: X-ECOMP-RequestID
10029 - description: X-ECOMP-InstanceID header
10031 name: X-ECOMP-InstanceID
10035 - description: Determines the format of the body of the response
10040 - description: The username and password
10042 name: Authorization
10051 description: Resource object to be created
10060 $ref: '#/components/schemas/ReplaceVNFInfo'
10061 description: ECOMP component is authenticated and list of Catalog Assets
10062 Metadata is returned
10064 description: Missing 'X-ECOMP-InstanceID' HTTP header - POL5001
10066 description: ECOMP component should authenticate itself and to re-send again HTTP request with
10067 its Basic Authentication credentials - POL5002
10069 description: ECOMP component is not authorized - POL5003
10071 description: "Error: Requested '%1' (uuid) resource was not found - SVC4063"
10073 description: "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST\
10074 \ will be rejected) - POL4050"
10076 description: Service already exist
10078 description: The GET request failed either due to internal SDC problem.
10079 ECOMP Component should continue the attempts to get the needed information
10084 summary: Return whether the replace VNF is successful
10087 /v1/catalog/services/serviceName/{serviceName}/serviceVersion/{serviceVersion}:
10089 description: Retrieve Service
10090 operationId: getServiceByNameAndVersion
10098 name: serviceVersion
10108 description: Service found
10110 description: Restricted operation
10112 description: Service not found
10119 $ref: '#/components/schemas/Service'
10123 summary: Returns service according to name and version
10126 /v1/catalog/services/serviceUUID/{uuid}/importReplaceService:
10128 description: Import Service
10129 operationId: importReplaceService
10131 - description: The user id
10137 - description: X-ECOMP-RequestID header
10139 name: X-ECOMP-RequestID
10142 - description: X-ECOMP-InstanceID header
10144 name: X-ECOMP-InstanceID
10148 - description: Determines the format of the body of the response
10153 - description: The username and password
10155 name: Authorization
10159 - description: The requested asset uuid
10172 $ref: '#/components/schemas/FormDataContentDisposition'
10173 serviceZipMetadata:
10175 description: serviceMetadata
10178 description: Service created
10180 description: Invalid content / Missing content
10182 description: Restricted operation
10184 description: Service already exist
10188 summary: Returns imported service
10191 /v1/catalog/services/validate-name/{serviceName}:
10193 description: validate service name
10194 operationId: validateServiceName
10207 description: Service found
10209 description: Restricted operation
10225 additionalProperties:
10265 additionalProperties:
10297 unicodeLocaleAttributes:
10322 additionalProperties:
10348 additionalProperties:
10360 additionalProperties:
10386 additionalProperties:
10393 summary: 'checks if the chosen service name is available '
10396 /v1/catalog/services/{componentId}/archive:
10398 description: Archive Service
10399 operationId: archiveService
10412 description: Archive successful
10414 description: Bad request
10416 description: Restricted operation
10418 description: Service not found
10420 description: Internal Error
10431 summary: Marks a service as archived. Can be restored with restore action
10434 /v1/catalog/services/{componentId}/copyComponentInstance/{componentInstanceId}:
10436 description: Copy Component Instance
10437 operationId: copyComponentInstance
10439 - description: service unique id in pasted canvas
10446 name: componentInstanceId
10455 description: Data for copying
10459 description: Copy and Paste Success
10461 description: Invalid Content / Missing content
10463 description: Restricted Operation
10470 $ref: '#/components/schemas/Service'
10474 summary: Returns updated service information
10477 /v1/catalog/services/{componentId}/restore:
10479 description: Restore Service
10480 operationId: restoreService
10493 description: Restore successful
10495 description: Bad request
10497 description: Restricted operation
10499 description: Service not found
10501 description: Internal Error
10512 summary: Restores a service from archive.
10515 /v1/catalog/services/{serviceId}:
10517 description: Delete Service
10518 operationId: deleteService
10525 - description: "Optional parameter to determine the delete action: DELETE, which\
10526 \ will permanently delete theService from the system or MARK_AS_DELETE,\
10527 \ which will logically mark the service as deleted. Default action is to\
10538 description: Service deleted
10540 description: Invalid content / Missing content
10542 description: Restricted operation
10544 description: Service not found
10551 $ref: '#/components/schemas/Service'
10555 summary: Return no content
10559 description: Retrieve Service
10560 operationId: getServiceById_1
10573 description: Service found
10575 description: Restricted operation
10577 description: Service not found
10584 $ref: '#/components/schemas/Service'
10588 summary: Returns service according to serviceId
10591 /v1/catalog/services/{serviceId}/additionalinfo:
10593 description: Get all Additional Information under service
10594 operationId: getAllServiceAdditionalInformationLabel
10596 - description: service id to update with new property
10608 description: list of additional information
10610 description: Invalid content / Missing content
10612 description: Restricted operation
10614 description: Additional information key already exist
10630 additionalProperties:
10670 additionalProperties:
10702 unicodeLocaleAttributes:
10727 additionalProperties:
10753 additionalProperties:
10765 additionalProperties:
10791 additionalProperties:
10798 summary: Returns Additional Inforamtion property
10802 description: Create Additional Information Label and Value
10803 operationId: createServiceAdditionalInformationLabel
10805 - description: service id to update with new property
10820 description: Additional information key value to be created
10824 description: Additional information created
10826 description: Invalid content / Missing content
10828 description: Restricted operation
10830 description: Additional information key already exist
10846 additionalProperties:
10886 additionalProperties:
10918 unicodeLocaleAttributes:
10943 additionalProperties:
10969 additionalProperties:
10981 additionalProperties:
11007 additionalProperties:
11014 summary: Returns created Additional Inforamtion property
11017 /v1/catalog/services/{serviceId}/additionalinfo/{labelId}:
11019 description: Create Additional Information Label and Value
11020 operationId: deleteServiceAdditionalInformationLabel
11022 - description: service id to update with new property
11028 - description: label id
11040 description: Additional information deleted
11042 description: Invalid content / Missing content
11044 description: Restricted operation
11046 description: Additional information key already exist
11062 additionalProperties:
11102 additionalProperties:
11134 unicodeLocaleAttributes:
11159 additionalProperties:
11185 additionalProperties:
11197 additionalProperties:
11223 additionalProperties:
11230 summary: Returns deleted Additional Inforamtion property
11234 description: Get Additional Information by id
11235 operationId: getServiceAdditionalInformationLabel
11237 - description: service id to update with new property
11243 - description: label id
11255 description: fetched additional information
11257 description: Invalid content / Missing content
11259 description: Restricted operation
11261 description: Additional information key already exist
11277 additionalProperties:
11317 additionalProperties:
11349 unicodeLocaleAttributes:
11374 additionalProperties:
11400 additionalProperties:
11412 additionalProperties:
11438 additionalProperties:
11445 summary: Returns Additional Inforamtion property
11449 description: Update Additional Information Label and Value
11450 operationId: updateServiceAdditionalInformationLabel
11452 - description: service id to update with new property
11458 - description: label id
11473 description: Additional information key value to be created
11477 description: Additional information updated
11479 description: Invalid content / Missing content
11481 description: Restricted operation
11483 description: Additional information key already exist
11499 additionalProperties:
11539 additionalProperties:
11571 unicodeLocaleAttributes:
11596 additionalProperties:
11622 additionalProperties:
11634 additionalProperties:
11660 additionalProperties:
11667 summary: Returns updated Additional Inforamtion property
11670 /v1/catalog/services/{serviceId}/artifacts:
11672 description: Create Artifact
11673 operationId: loadInformationArtifact
11685 description: json describe the artifact
11689 description: Resource created
11691 description: Invalid content / Missing content
11693 description: Restricted operation
11695 description: Artifact already exist
11711 additionalProperties:
11751 additionalProperties:
11783 unicodeLocaleAttributes:
11808 additionalProperties:
11834 additionalProperties:
11846 additionalProperties:
11872 additionalProperties:
11879 summary: Returns created ArtifactDefinition
11882 /v1/catalog/services/{serviceId}/artifacts/api/{artifactId}:
11884 description: Delete Api Artifact
11885 operationId: deleteApiArtifact
11907 description: Api Artifact deleted
11909 description: Restricted operation
11925 additionalProperties:
11965 additionalProperties:
11997 unicodeLocaleAttributes:
12022 additionalProperties:
12048 additionalProperties:
12060 additionalProperties:
12086 additionalProperties:
12093 summary: Returns Deleted ArtifactDefinition
12097 description: Update Api Artifact
12098 operationId: updateApiArtifact
12123 description: json describe the artifact
12127 description: Api Artifact Updated
12129 description: Invalid content / Missing content
12131 description: Restricted operation
12147 additionalProperties:
12187 additionalProperties:
12219 unicodeLocaleAttributes:
12244 additionalProperties:
12270 additionalProperties:
12282 additionalProperties:
12308 additionalProperties:
12315 summary: Returns created ArtifactDefinition
12318 /v1/catalog/services/{serviceId}/artifacts/{artifactId}:
12320 description: Delete Artifact
12321 operationId: deleteInformationalArtifact
12335 description: Service artifact deleted
12337 description: Invalid content / Missing content
12339 description: Restricted operation
12355 additionalProperties:
12395 additionalProperties:
12427 unicodeLocaleAttributes:
12452 additionalProperties:
12478 additionalProperties:
12490 additionalProperties:
12516 additionalProperties:
12523 summary: Returns delete artifact
12527 description: Download service Artifact in Base64
12528 operationId: downloadServiceArtifactBase64
12542 description: Service artifact downloaded
12544 description: Service/Artifact not found
12560 additionalProperties:
12600 additionalProperties:
12632 unicodeLocaleAttributes:
12657 additionalProperties:
12683 additionalProperties:
12695 additionalProperties:
12721 additionalProperties:
12728 summary: Returns downloaded artifact
12732 description: Update Artifact
12733 operationId: updateInformationArtifact
12750 description: json describe the artifact
12754 description: Service artifact created
12756 description: Invalid content / Missing content
12758 description: Restricted operation
12774 additionalProperties:
12814 additionalProperties:
12846 unicodeLocaleAttributes:
12871 additionalProperties:
12897 additionalProperties:
12909 additionalProperties:
12935 additionalProperties:
12942 summary: Returns updated artifact
12945 /v1/catalog/services/{serviceId}/attributes:
12947 description: Get Service Attribute
12948 operationId: getAttributeListInService
12950 - description: service id of attribute
12962 description: attribute
12964 description: Invalid content / Missing content
12966 description: Restricted operation
12968 description: Service attribute not found
12984 additionalProperties:
13024 additionalProperties:
13056 unicodeLocaleAttributes:
13081 additionalProperties:
13107 additionalProperties:
13119 additionalProperties:
13145 additionalProperties:
13152 summary: Returns attribute list of service
13155 /v1/catalog/services/{serviceId}/capabilities:
13157 description: Create Capabilities on service
13158 operationId: createCapabilitiesOnService
13160 - description: Service Id
13175 description: Capability to create
13179 description: Create Capabilities
13181 description: Invalid content / Missing content
13183 description: Restricted operation
13185 description: Capability already exist
13201 additionalProperties:
13241 additionalProperties:
13273 unicodeLocaleAttributes:
13298 additionalProperties:
13324 additionalProperties:
13336 additionalProperties:
13362 additionalProperties:
13369 summary: Create Capabilities on service
13373 description: Update Capabilities on service
13374 operationId: updateCapabilitiesOnService
13376 - description: Component Id
13391 description: Capabilities to update
13395 description: Update Capabilities
13397 description: Invalid content / Missing content
13399 description: Restricted operation
13406 $ref: '#/components/schemas/CapabilityDefinition'
13410 summary: Update Capabilities on service
13413 /v1/catalog/services/{serviceId}/capabilities/{capabilityId}:
13415 description: Delete capability from service
13416 operationId: deleteCapabilityOnService
13418 - description: capability Id
13424 - description: Service Id
13436 description: Delete capability
13438 description: Invalid content / Missing content
13440 description: Restricted operation
13447 $ref: '#/components/schemas/CapabilityDefinition'
13451 summary: Delete capability from service
13455 description: Get Capability from service
13456 operationId: getCapabilityOnService
13458 - description: Service Id
13464 - description: Capability Id
13476 description: GET Capability
13478 description: Invalid content / Missing content
13480 description: Restricted operation
13487 $ref: '#/components/schemas/CapabilityDefinition'
13491 summary: GET Capability from service
13494 /v1/catalog/services/{serviceId}/consumption/{serviceInstanceId}:
13496 description: Service consumption on operation
13497 operationId: addInputToServiceOperation
13505 name: serviceInstanceId
13518 description: Service Consumption Data
13522 description: Service property created
13524 description: Invalid content / Missing content
13526 description: Restricted operation
13528 description: Service property already exist
13544 additionalProperties:
13584 additionalProperties:
13616 unicodeLocaleAttributes:
13641 additionalProperties:
13667 additionalProperties:
13679 additionalProperties:
13705 additionalProperties:
13712 summary: Returns consumption data
13715 /v1/catalog/services/{serviceId}/consumption/{serviceInstanceId}/interfaces/{interfaceId}/operations/{operationId}/inputs:
13717 operationId: getInputsListOfOperation
13725 name: serviceInstanceId
13746 application/json: {}
13747 description: default response
13753 /v1/catalog/services/{serviceId}/distribution/{did}/markDeployed:
13755 description: Mark distribution as deployed
13756 operationId: markDistributionAsDeployed
13774 description: Service was marked as deployed
13776 description: Invalid content / Missing content
13778 description: Service is not available
13780 description: Requested service was not found
13782 description: Restricted operation
13784 description: Internal Server Error. Please try again later.
13788 summary: relevant audit record will be created
13791 /v1/catalog/services/{serviceId}/distribution/{env}/activate:
13793 description: Activate distribution
13794 operationId: activateDistribution
13814 description: Requested service was not found
13816 description: Service cannot be distributed due to missing deployment artifacts
13818 description: Internal Server Error. Please try again later.
13822 summary: activate distribution
13825 /v1/catalog/services/{serviceId}/interfaceOperations:
13827 description: Create Interface Operations on Service
13828 operationId: createInterfaceOperationsOnService
13830 - description: Service Id
13845 description: Interface Operations to create
13849 description: Create Interface Operations on Service
13851 description: Invalid content / Missing content
13853 description: Restricted operation
13855 description: Service not found
13857 description: Interface Operation already exist
13864 $ref: '#/components/schemas/InterfaceDefinition'
13868 summary: Create Interface Operations on Service
13872 description: Update Interface Operations on Service
13873 operationId: updateInterfaceOperationsOnService
13875 - description: Service Id
13890 description: Interface Operations to update
13894 description: Update Interface Operations on Service
13896 description: Invalid content / Missing content
13898 description: Restricted operation
13900 description: Service not found
13907 $ref: '#/components/schemas/InterfaceDefinition'
13911 summary: Update Interface Operations on Service
13914 /v1/catalog/services/{serviceId}/interfaces/{interfaceId}/operations/{operationId}:
13916 description: Delete Interface Operation from Service
13917 operationId: deleteInterfaceOperationsFromService
13919 - description: Service Id
13925 - description: Interface Id
13931 - description: Operation Id
13943 description: Delete Interface Operation from Service
13945 description: Invalid content / Missing content
13947 description: Restricted operation
13949 description: Service not found
13956 $ref: '#/components/schemas/InterfaceDefinition'
13960 summary: Delete Interface Operation from Service
13964 description: Get Interface Operation from Service
13965 operationId: getInterfaceOperationsFromService
13967 - description: Service Id
13973 - description: Interface Id
13979 - description: Operation Id
13991 description: Get Interface Operation from Service
13993 description: Invalid content / Missing content
13995 description: Restricted operation
13997 description: Service not found
14004 $ref: '#/components/schemas/InterfaceDefinition'
14008 summary: GET Interface Operation from Service
14011 /v1/catalog/services/{serviceId}/linksMap:
14013 description: Retrieve Service component relations map
14014 operationId: getServiceComponentRelationMap
14027 description: Service found
14029 description: Restricted operation
14031 description: Service not found
14038 $ref: '#/components/schemas/ServiceRelations'
14042 summary: Returns service components relations
14045 /v1/catalog/services/{serviceId}/metadata:
14047 description: Update Service Metadata
14048 operationId: updateServiceMetadata
14064 description: Service object to be Updated
14068 description: Service Updated
14070 description: Invalid content / Missing content
14072 description: Restricted operation
14079 $ref: '#/components/schemas/Service'
14083 summary: Returns updated service
14086 /v1/catalog/services/{serviceId}/paths:
14088 description: Create Forwarding Path
14089 operationId: createForwardingPath
14091 - description: Service Id
14106 description: Forwarding Path to create
14110 description: Create Forwarding Path
14112 description: Invalid content / Missing content
14114 description: Restricted operation
14116 description: Forwarding Path already exist
14123 $ref: '#/components/schemas/Service'
14127 summary: Create Forwarding Path
14131 description: Update Forwarding Path
14132 operationId: updateForwardingPath
14134 - description: Service Id
14149 description: Update Path to create
14153 description: Update Forwarding Path
14155 description: Invalid content / Missing content
14157 description: Restricted operation
14159 description: Forwarding Path already exist
14166 $ref: '#/components/schemas/Service'
14170 summary: Update Forwarding Path
14173 /v1/catalog/services/{serviceId}/paths/{forwardingPathId}:
14175 description: Delete Forwarding Path
14176 operationId: deleteForwardingPath
14178 - description: Forwarding Path Id
14180 name: forwardingPathId
14184 - description: Service Id
14196 description: Delete Forwarding Path
14198 description: Invalid content / Missing content
14200 description: Restricted operation
14202 description: Forwarding Path already exist
14209 $ref: '#/components/schemas/Service'
14213 summary: Delete Forwarding Path
14217 description: Get Forwarding Path
14218 operationId: getForwardingPath
14220 - description: Service Id
14226 - description: Forwarding Path Id
14228 name: forwardingPathId
14241 description: Forwarding Path to create
14245 description: Get Forwarding Path
14247 description: Invalid content / Missing content
14249 description: Restricted operation
14251 description: Forwarding Path already exist
14258 $ref: '#/components/schemas/ForwardingPathDataDefinition'
14262 summary: GET Forwarding Path
14265 /v1/catalog/services/{serviceId}/properties:
14267 description: Get Service Property
14268 operationId: getPropertyListInService
14270 - description: service id of property
14282 description: property
14284 description: Invalid content / Missing content
14286 description: Restricted operation
14288 description: Service property not found
14304 additionalProperties:
14344 additionalProperties:
14376 unicodeLocaleAttributes:
14401 additionalProperties:
14427 additionalProperties:
14439 additionalProperties:
14465 additionalProperties:
14472 summary: Returns property list of service
14476 description: Create Service Property
14477 operationId: createPropertyInService
14479 - description: service id to update with new property
14494 description: Service property to be created
14498 description: Service property created
14500 description: Invalid content / Missing content
14502 description: Restricted operation
14504 description: Service property already exist
14520 additionalProperties:
14560 additionalProperties:
14592 unicodeLocaleAttributes:
14617 additionalProperties:
14643 additionalProperties:
14655 additionalProperties:
14681 additionalProperties:
14688 summary: Returns created service property
14692 description: Update Service Property
14693 operationId: updatePropertyInService
14695 - description: service id to update with new property
14710 description: Service property to update
14714 description: Service property updated
14716 description: Invalid content / Missing content
14718 description: Restricted operation
14734 additionalProperties:
14774 additionalProperties:
14806 unicodeLocaleAttributes:
14831 additionalProperties:
14857 additionalProperties:
14869 additionalProperties:
14895 additionalProperties:
14902 summary: Returns updated property
14905 /v1/catalog/services/{serviceId}/properties/{propertyId}:
14907 description: Delete Service Property
14908 operationId: deletePropertyInService
14910 - description: service id of property
14916 - description: Property id to delete
14928 description: deleted property
14930 description: Invalid content / Missing content
14932 description: Restricted operation
14934 description: Service property not found
14950 additionalProperties:
14990 additionalProperties:
15022 unicodeLocaleAttributes:
15047 additionalProperties:
15073 additionalProperties:
15085 additionalProperties:
15111 additionalProperties:
15118 summary: Returns deleted property
15122 description: Get Service Property
15123 operationId: getPropertyInService
15125 - description: service id of property
15131 - description: property id to get
15143 description: property
15145 description: Invalid content / Missing content
15147 description: Restricted operation
15149 description: Service property not found
15165 additionalProperties:
15205 additionalProperties:
15237 unicodeLocaleAttributes:
15262 additionalProperties:
15288 additionalProperties:
15300 additionalProperties:
15326 additionalProperties:
15333 summary: Returns property of service
15336 /v1/catalog/services/{serviceId}/requirements:
15338 description: Create requirements on service
15339 operationId: createRequirementsOnService
15341 - description: Service Id
15356 description: Requirements to create
15360 description: Create Requirements
15362 description: Invalid content / Missing content
15364 description: Restricted operation
15366 description: Requirement already exist
15382 additionalProperties:
15422 additionalProperties:
15454 unicodeLocaleAttributes:
15479 additionalProperties:
15505 additionalProperties:
15517 additionalProperties:
15543 additionalProperties:
15550 summary: Create requirements on service
15554 description: Update requirements on service
15555 operationId: updateRequirementsOnService
15557 - description: Component Id
15572 description: Requirements to update
15576 description: Update requirements
15578 description: Invalid content / Missing content
15580 description: Restricted operation
15587 $ref: '#/components/schemas/RequirementDefinition'
15591 summary: Update requirements on service
15594 /v1/catalog/services/{serviceId}/requirements/{requirementId}:
15596 description: Delete requirement from service
15597 operationId: deleteRequirementsOnService
15599 - description: Service Id
15605 - description: Requirement Id
15607 name: requirementId
15617 description: Delete Requirements
15619 description: Invalid content / Missing content
15621 description: Restricted operation
15628 $ref: '#/components/schemas/RequirementDefinition'
15632 summary: Delete requirement from service
15636 description: Get requirement from service
15637 operationId: getRequirementsOnService
15639 - description: Service Id
15645 - description: Requirement Id
15647 name: requirementId
15657 description: GET Requirements
15659 description: Invalid content / Missing content
15661 description: Restricted operation
15668 $ref: '#/components/schemas/RequirementDefinition'
15672 summary: GET requirement from service
15675 /v1/catalog/services/{serviceId}/tempUrlToBeDeleted:
15677 operationId: tempUrlToBeDeleted
15692 description: Internal Server Error. Please try again later.
15698 /v1/catalog/services/{serviceName}/{version}:
15700 description: Delete Service By Name And Version
15701 operationId: deleteServiceByNameAndVersion
15715 description: Service deleted
15717 description: Invalid content / Missing content
15719 description: Restricted operation
15721 description: Service not found
15728 $ref: '#/components/schemas/Resource'
15732 summary: Returns no content
15735 /v1/catalog/services/{serviceUUID}/distribution:
15737 description: Retrieve Distributions
15738 operationId: getServiceById
15751 description: Service found
15753 description: Restricted operation
15755 description: Service not found
15762 $ref: '#/components/schemas/DistributionStatusListResponse'
15766 summary: Returns list bases on the information extracted from Auditing Records
15767 according to service uuid
15770 /v1/catalog/toggle:
15772 description: Get all Toggleable features
15773 operationId: getAllFeatures
15776 description: Success
15778 description: Invalid content / Missing content
15780 description: Restricted operation
15782 description: Toggleable features not found
15798 additionalProperties:
15838 additionalProperties:
15870 unicodeLocaleAttributes:
15895 additionalProperties:
15921 additionalProperties:
15933 additionalProperties:
15959 additionalProperties:
15966 summary: Returns list of toggleable features
15969 /v1/catalog/toggle/state/{state}:
15971 description: Update all feature toggle state
15972 operationId: setAllFeatures
15981 description: Success
15983 description: Invalid content / Missing content
15985 description: Restricted operation
15987 description: Toggleable features not found
16003 additionalProperties:
16043 additionalProperties:
16075 unicodeLocaleAttributes:
16100 additionalProperties:
16126 additionalProperties:
16138 additionalProperties:
16164 additionalProperties:
16171 summary: Update all feature status
16174 /v1/catalog/toggle/{featureName}/state:
16176 description: Get Toggleable feature state
16177 operationId: getToggleableFeature
16186 description: Success
16188 description: Invalid content / Missing content
16190 description: Restricted operation
16192 description: Toggleable feature not found
16208 additionalProperties:
16248 additionalProperties:
16280 unicodeLocaleAttributes:
16305 additionalProperties:
16331 additionalProperties:
16343 additionalProperties:
16369 additionalProperties:
16376 summary: Returns one toggleable feature state
16379 /v1/catalog/toggle/{featureName}/state/{state}:
16381 description: Update feature toggle state
16382 operationId: updateFeatureState
16396 description: Success
16398 description: Invalid content / Missing content
16400 description: Restricted operation
16402 description: Toggleable features not found
16418 additionalProperties:
16458 additionalProperties:
16490 unicodeLocaleAttributes:
16515 additionalProperties:
16541 additionalProperties:
16553 additionalProperties:
16579 additionalProperties:
16586 summary: Update feature status
16589 /v1/catalog/upload/resource/import:
16591 description: "Import node types from a TOSCA yaml, along with the types metadata"
16592 operationId: bulkImport
16600 multipart/form-data:
16607 description: The model name to associate the node types to
16608 nodeTypeMetadataJson:
16609 $ref: '#/components/schemas/NodeTypesMetadataList'
16612 description: The node types TOSCA definition yaml
16614 - nodeTypeMetadataJson
16618 description: Resources created
16620 description: Invalid content / Missing content
16622 description: Restricted operation
16624 description: One of the resources already exists
16640 additionalProperties:
16680 additionalProperties:
16712 unicodeLocaleAttributes:
16737 additionalProperties:
16763 additionalProperties:
16775 additionalProperties:
16801 additionalProperties:
16808 summary: Creates node types from a TOSCA yaml file
16811 /v1/catalog/upload/{resourceAuthority}:
16813 description: Create Resource from yaml
16814 operationId: uploadMultipart
16816 - description: "validValues: normative-resource / user-resource"
16818 name: resourceAuthority
16825 - user-resource-ui-import
16831 name: createNewVersion
16837 multipart/form-data:
16843 description: resourceMetadata
16845 $ref: '#/components/schemas/FormDataContentDisposition'
16848 description: Resource created
16850 description: Invalid content / Missing content
16852 description: Restricted operation
16854 description: Resource already exist
16870 additionalProperties:
16910 additionalProperties:
16942 unicodeLocaleAttributes:
16967 additionalProperties:
16993 additionalProperties:
17005 additionalProperties:
17031 additionalProperties:
17038 summary: Returns created resource
17041 /v1/catalog/uploadType/annotationtypes:
17043 description: Create AnnotationTypes from yaml
17044 operationId: uploadAnnotationTypes
17052 multipart/form-data:
17056 annotationTypesZip:
17059 description: FileInputStream
17062 description: annotation types created
17064 description: Invalid content / Missing content
17066 description: Restricted operation
17068 description: annotation types already exist
17084 additionalProperties:
17124 additionalProperties:
17156 unicodeLocaleAttributes:
17181 additionalProperties:
17207 additionalProperties:
17219 additionalProperties:
17245 additionalProperties:
17252 summary: Returns created annotation types
17255 /v1/catalog/uploadType/artifactTypes:
17257 description: Create Tosca Artifact types from yaml
17258 operationId: uploadArtifactTypes
17266 multipart/form-data:
17273 description: Zip file containing a yaml with the TOSCA artifact
17275 includeToModelImport:
17277 description: A flag to add types to the default imports
17280 description: model name
17283 description: Tosca Artifact types created
17285 description: Invalid content / Missing content
17287 description: Restricted operation
17289 description: Tosca Artifact Type already exist
17305 additionalProperties:
17345 additionalProperties:
17377 unicodeLocaleAttributes:
17402 additionalProperties:
17428 additionalProperties:
17440 additionalProperties:
17466 additionalProperties:
17473 summary: Returns created Tosca artifact types
17476 /v1/catalog/uploadType/capability:
17478 description: Create Capability Type from yaml
17479 operationId: uploadCapabilityType
17487 multipart/form-data:
17494 description: FileInputStream
17495 includeToModelImport:
17497 description: includeToModelImport
17500 description: model name
17503 description: Capability Type created
17505 description: Invalid content / Missing content
17507 description: Restricted operation
17509 description: Capability Type already exist
17525 additionalProperties:
17565 additionalProperties:
17597 unicodeLocaleAttributes:
17622 additionalProperties:
17648 additionalProperties:
17660 additionalProperties:
17686 additionalProperties:
17693 summary: Returns created Capability Type
17696 /v1/catalog/uploadType/categories:
17698 description: Create Categories from yaml
17699 operationId: uploadCategories
17707 multipart/form-data:
17714 description: FileInputStream
17717 description: Categories created
17719 description: Invalid content / Missing content
17721 description: Restricted operation
17723 description: Category already exist
17739 additionalProperties:
17779 additionalProperties:
17811 unicodeLocaleAttributes:
17836 additionalProperties:
17862 additionalProperties:
17874 additionalProperties:
17900 additionalProperties:
17907 summary: Returns created categories
17910 /v1/catalog/uploadType/datatypes:
17912 description: Create Data Types from zip
17913 operationId: uploadDataTypes
17921 multipart/form-data:
17928 description: FileInputStream
17929 includeToModelImport:
17931 description: includeToModelImport
17934 description: model name
17937 description: Data types created
17939 description: Invalid content / Missing content
17941 description: Restricted operation
17943 description: Data types already exist
17959 additionalProperties:
17999 additionalProperties:
18031 unicodeLocaleAttributes:
18056 additionalProperties:
18082 additionalProperties:
18094 additionalProperties:
18120 additionalProperties:
18127 summary: Returns created data types
18130 /v1/catalog/uploadType/datatypesyaml:
18132 description: Create Data Types from yaml
18133 operationId: uploadDataTypesYaml
18141 multipart/form-data:
18148 description: FileInputStream
18149 includeToModelImport:
18151 description: includeToModelImport
18154 description: model name
18157 description: Data types created
18159 description: Invalid content / Missing content
18161 description: Restricted operation
18163 description: Data types already exist
18179 additionalProperties:
18219 additionalProperties:
18251 unicodeLocaleAttributes:
18276 additionalProperties:
18302 additionalProperties:
18314 additionalProperties:
18340 additionalProperties:
18347 summary: Returns created data types
18350 /v1/catalog/uploadType/grouptypes:
18352 description: Create GroupTypes from yaml
18353 operationId: uploadGroupTypes
18361 multipart/form-data:
18368 description: FileInputStream
18369 includeToModelImport:
18371 description: includeToModelImport
18374 description: model name
18377 description: toscaTypeMetadata
18380 description: group types created
18382 description: Invalid content / Missing content
18384 description: Restricted operation
18386 description: group types already exist
18402 additionalProperties:
18442 additionalProperties:
18474 unicodeLocaleAttributes:
18499 additionalProperties:
18525 additionalProperties:
18537 additionalProperties:
18563 additionalProperties:
18570 summary: Returns created group types
18573 /v1/catalog/uploadType/interfaceLifecycle:
18575 description: Create Interface Lyfecycle Type from yaml
18576 operationId: uploadInterfaceLifecycleType
18584 multipart/form-data:
18588 includeToModelImport:
18590 description: includeToModelImport
18591 interfaceLifecycleTypeZip:
18594 description: FileInputStream
18597 description: model name
18600 description: Interface Lifecycle Type created
18602 description: Invalid content / Missing content
18604 description: Restricted operation
18606 description: Interface Lifecycle Type already exist
18622 additionalProperties:
18662 additionalProperties:
18694 unicodeLocaleAttributes:
18719 additionalProperties:
18745 additionalProperties:
18757 additionalProperties:
18783 additionalProperties:
18790 summary: Returns created Interface Lifecycle Type
18793 /v1/catalog/uploadType/policytypes:
18795 description: Create PolicyTypes from yaml
18796 operationId: uploadPolicyTypes
18804 multipart/form-data:
18808 includeToModelImport:
18810 description: includeToModelImport
18813 description: model name
18817 description: FileInputStream
18820 description: toscaTypeMetadata
18823 description: policy types created
18825 description: Invalid content / Missing content
18827 description: Restricted operation
18829 description: policy types already exist
18845 additionalProperties:
18885 additionalProperties:
18917 unicodeLocaleAttributes:
18942 additionalProperties:
18968 additionalProperties:
18980 additionalProperties:
19006 additionalProperties:
19013 summary: Returns created policy types
19016 /v1/catalog/uploadType/relationship:
19018 description: Create Relationship Type from yaml
19019 operationId: uploadRelationshipType
19027 multipart/form-data:
19031 includeToModelImport:
19033 description: includeToModelImport
19036 description: model name
19037 relationshipTypeZip:
19040 description: FileInputStream
19043 description: Relationship Type created
19045 description: Invalid content / Missing content
19047 description: Restricted operation
19049 description: Relationship Type already exist
19065 additionalProperties:
19105 additionalProperties:
19137 unicodeLocaleAttributes:
19162 additionalProperties:
19188 additionalProperties:
19200 additionalProperties:
19226 additionalProperties:
19233 summary: Returns created Relationship Type
19236 /v1/catalog/{assetType}/{uuid}/interfaces/{interfaceUUID}/operations/{operationUUID}/artifacts/{artifactUUID}:
19238 description: uploads of artifact to component operation workflow
19239 operationId: uploadInterfaceOperationArtifact
19241 - description: Asset type
19247 - description: The uuid of the asset as published in the metadata
19253 - description: The uuid of the interface
19255 name: interfaceUUID
19259 - description: The uuid of the operation
19261 name: operationUUID
19265 - description: The uuid of the artifact
19286 $ref: '#/components/schemas/ArtifactDefinition'
19287 description: Artifact uploaded
19289 description: Restricted Operation – the user provided does not have role
19290 of Designer or the asset is being used by another designer - SVC4301
19292 description: Specified resource is not found - SVC4063
19296 summary: uploads of artifact to component operation workflow
19299 /v1/catalog/{componentType}/latestversion/notabstract:
19301 description: Get Component Requirments And Capabilities
19302 operationId: getLatestVersionNotAbstractCheckoutComponents
19305 name: componentType
19310 name: internalComponentType
19314 name: componentUids
19325 description: Component found
19327 description: Restricted operation
19329 description: Component not found
19336 $ref: '#/components/schemas/Resource'
19340 summary: Returns Requirments And Capabilities according to componentId
19344 description: Get Component Requirments And Capabilities
19345 operationId: getLatestVersionNotAbstractCheckoutComponentsByBody
19348 name: componentType
19353 name: internalComponentType
19367 description: Consumer Object to be created
19371 description: Component found
19373 description: Restricted operation
19375 description: Component not found
19382 $ref: '#/components/schemas/Resource'
19386 summary: Returns Requirments And Capabilities according to componentId
19389 /v1/catalog/{componentType}/latestversion/notabstract/metadata:
19391 description: Get Component uid only
19392 operationId: getLatestVersionNotAbstractCheckoutComponentsIdesOnly
19395 name: componentType
19400 name: internalComponentType
19404 name: componentModel
19408 name: includeNormativeExtensionModels
19420 description: uid list
19424 description: Component found
19426 description: Restricted operation
19428 description: Component not found
19435 $ref: '#/components/schemas/Resource'
19439 summary: Returns componentId
19442 /v1/catalog/{componentType}/{componentId}/automatedupgrade:
19444 description: Autometed upgrade
19445 operationId: autometedUpgrade
19448 name: componentType
19466 description: json describes upgrade request
19470 description: Component found
19472 description: Restricted operation
19474 description: Component not found
19490 additionalProperties:
19530 additionalProperties:
19562 unicodeLocaleAttributes:
19587 additionalProperties:
19613 additionalProperties:
19625 additionalProperties:
19651 additionalProperties:
19661 /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/interfaceOperation:
19663 description: Update Interface Operation
19664 operationId: updateComponentInstanceInterfaceOperation
19666 - description: "valid values: resources / services"
19668 name: componentType
19675 - description: Component Id
19681 - description: Component Instance Id
19683 name: componentInstanceId
19693 description: Update Interface Operation
19695 description: Invalid content / Missing content
19697 description: Restricted operation
19713 additionalProperties:
19753 additionalProperties:
19785 unicodeLocaleAttributes:
19810 additionalProperties:
19836 additionalProperties:
19848 additionalProperties:
19874 additionalProperties:
19881 summary: Update Interface Operation on ComponentInstance
19884 /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/{constraintType}/nodeFilter:
19886 description: Add Component Filter Constraint
19887 operationId: addComponentFilterConstraint
19889 - description: Component Id
19895 - description: Component Instance Id
19897 name: componentInstanceId
19901 - description: "valid values: resources / services"
19903 name: componentType
19910 - description: "Constraint type. Valid values: properties / capabilities"
19912 name: constraintType
19928 description: UIConstraint data
19932 description: Create Component Filter
19934 description: Invalid content / Missing content
19936 description: Restricted operation
19952 additionalProperties:
19992 additionalProperties:
20024 unicodeLocaleAttributes:
20049 additionalProperties:
20075 additionalProperties:
20087 additionalProperties:
20113 additionalProperties:
20117 summary: Add Component Filter Constraint
20120 /v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/{constraintType}/{constraintIndex}/nodeFilter:
20122 description: Delete Component Filter Constraint
20123 operationId: deleteComponentFilterConstraint
20125 - description: Component Id
20131 - description: Component Instance Id
20133 name: componentInstanceId
20137 - description: Constraint Index
20139 name: constraintIndex
20144 - description: "valid values: resources / services"
20146 name: componentType
20153 - description: "Constraint type. Valid values: properties / capabilities"
20155 name: constraintType
20168 description: Delete Component Filter Constraint
20170 description: Invalid content / Missing content
20172 description: Restricted operation
20188 additionalProperties:
20228 additionalProperties:
20260 unicodeLocaleAttributes:
20285 additionalProperties:
20311 additionalProperties:
20323 additionalProperties:
20349 additionalProperties:
20353 summary: Delete Component Filter Constraint
20357 description: Update Component Filter Constraint
20358 operationId: updateComponentFilterConstraint
20360 - description: Component Id
20366 - description: Component Instance Id
20368 name: componentInstanceId
20372 - description: "valid values: resources / services"
20374 name: componentType
20381 - description: "Constraint type. Valid values: properties / capabilities"
20383 name: constraintType
20390 - description: Constraint Index
20392 name: constraintIndex
20406 description: UIConstraint data
20410 description: Create Component Filter
20412 description: Invalid content / Missing content
20414 description: Restricted operation
20430 additionalProperties:
20470 additionalProperties:
20502 unicodeLocaleAttributes:
20527 additionalProperties:
20553 additionalProperties:
20565 additionalProperties:
20591 additionalProperties:
20595 summary: Update Component Filter Constraint
20598 /v1/catalog/{componentType}/{componentId}/componentInstances:
20600 description: Get Component instances
20601 operationId: getComponentInstancesFilteredByPropertiesAndInputs
20604 name: componentType
20626 description: uid list
20630 description: Component found
20632 description: Restricted operation
20634 description: Component not found
20641 $ref: '#/components/schemas/Resource'
20645 summary: Returns component instances
20648 /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{inputId}/properties:
20650 description: Get properties
20651 operationId: getInputPropertiesForComponentInstance
20654 name: componentType
20679 description: Component found
20681 description: Restricted operation
20683 description: Component not found
20690 $ref: '#/components/schemas/Resource'
20694 summary: Returns properties list
20697 /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/inputs:
20699 description: Get Inputs only
20700 operationId: getComponentInstanceInputs
20703 name: componentType
20718 name: originComponentUid
20728 description: Component found
20730 description: Restricted operation
20732 description: Component not found
20739 $ref: '#/components/schemas/Resource'
20743 summary: Returns Inputs list
20746 /v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/outputs:
20748 description: Get Outputs only
20749 operationId: getComponentInstanceOutputs
20752 name: componentType
20767 name: originComponentUid
20777 description: Component found
20779 description: Restricted operation
20781 description: Component not found
20788 $ref: '#/components/schemas/Resource'
20792 summary: Returns Outputs list
20795 /v1/catalog/{componentType}/{componentId}/create/input:
20797 description: Create inputs on service
20798 operationId: createInput
20801 name: componentType
20819 description: ComponentIns Inputs Object to be created
20823 description: Component found
20825 description: Restricted operation
20827 description: Component not found
20834 $ref: '#/components/schemas/Resource'
20838 summary: Return inputs list
20841 /v1/catalog/{componentType}/{componentId}/create/inputs:
20843 description: Create inputs on service
20844 operationId: createMultipleInputs
20847 name: componentType
20865 description: ComponentIns Inputs Object to be created
20869 description: Component found
20871 description: Restricted operation
20873 description: Component not found
20880 $ref: '#/components/schemas/Resource'
20884 summary: Return inputs list
20887 /v1/catalog/{componentType}/{componentId}/create/listInput:
20889 description: Create a list input on service
20890 operationId: createListInput
20893 name: componentType
20911 description: ComponentIns Inputs Object to be created
20915 description: Component found
20917 description: Restricted operation
20919 description: Component not found
20926 $ref: '#/components/schemas/Resource'
20930 summary: Return input
20933 /v1/catalog/{componentType}/{componentId}/create/outputs:
20935 description: Create outputs on service
20936 operationId: createMultipleOutputs
20939 name: componentType
20957 description: ComponentIns Outputs Object to be created
20961 description: Component found
20963 description: Restricted operation
20965 description: Component not found
20972 $ref: '#/components/schemas/Resource'
20976 summary: Return outputs list
20979 /v1/catalog/{componentType}/{componentId}/create/policies:
20981 description: Create policies on service
20982 operationId: declareProperties
20985 name: componentType
21003 description: ComponentIns policies Object to be created
21007 description: Component found
21009 description: Restricted operation
21011 description: Component not found
21018 $ref: '#/components/schemas/Resource'
21022 summary: Return policies list
21025 /v1/catalog/{componentType}/{componentId}/dataType/{dataTypeName}:
21027 description: Delete data type from service
21028 operationId: deleteDataType
21031 name: componentType
21047 description: Data type deleted
21049 description: Restricted operation
21051 description: Data type not found
21058 $ref: '#/components/schemas/Resource'
21062 summary: Delete service input
21066 description: Get data type in service
21067 operationId: getDataType
21070 name: componentType
21086 description: Data type found
21088 description: Restricted operation
21090 description: Data type not found
21097 $ref: '#/components/schemas/DataTypeDefinition'
21101 summary: Get data type in service
21104 /v1/catalog/{componentType}/{componentId}/dataTypes:
21106 description: Get data types that service has
21107 operationId: getDataTypes
21110 name: componentType
21121 description: Data type found
21123 description: Restricted operation
21125 description: Component not found
21132 $ref: '#/components/schemas/Resource'
21136 summary: Get data types in service
21139 /v1/catalog/{componentType}/{componentId}/delete/{inputId}/input:
21141 description: Delete input from service
21142 operationId: deleteInput
21145 name: componentType
21168 description: Service Input to be deleted
21172 description: Input deleted
21174 description: Restricted operation
21176 description: Input not found
21183 $ref: '#/components/schemas/Resource'
21187 summary: Delete service input
21190 /v1/catalog/{componentType}/{componentId}/delete/{outputId}/output:
21192 description: Delete output from service
21193 operationId: deleteOutput
21196 name: componentType
21219 description: Service Output to be deleted
21223 description: Output deleted
21225 description: Restricted operation
21227 description: Output not found
21234 $ref: '#/components/schemas/Resource'
21238 summary: Delete service output
21241 /v1/catalog/{componentType}/{componentId}/dependencies:
21243 description: Autometed upgrade
21244 operationId: getComponentDependencies
21247 name: componentType
21267 description: Consumer Object to be created
21271 description: Component found
21273 description: Restricted operation
21275 description: Component not found
21291 additionalProperties:
21331 additionalProperties:
21363 unicodeLocaleAttributes:
21388 additionalProperties:
21414 additionalProperties:
21426 additionalProperties:
21452 additionalProperties:
21462 /v1/catalog/{componentType}/{componentId}/filteredDataByParams:
21464 description: Retrieve Resource
21465 operationId: getComponentDataFilteredByParams
21468 name: componentType
21489 description: Resource found
21491 description: Restricted operation
21493 description: Resource not found
21500 $ref: '#/components/schemas/Resource'
21504 summary: Returns resource according to resourceId
21507 /v1/catalog/{componentType}/{componentId}/filteredproperties/{propertyNameFragment}:
21509 description: Retrieve properties belonging to component instances of specific
21510 component by name and optionally resource type
21511 operationId: getFilteredComponentInstanceProperties
21514 name: componentType
21524 name: propertyNameFragment
21540 description: Component found
21542 description: Restricted operation
21544 description: Component not found
21555 summary: Returns properties belonging to component instances of specific component
21556 by name and optionally resource type
21559 /v1/catalog/{componentType}/{componentId}/inputs/{inputId}:
21561 description: Get inputs
21562 operationId: getInputsAndPropertiesForComponentInput
21565 name: componentType
21585 description: Component found
21587 description: Restricted operation
21589 description: Component not found
21596 $ref: '#/components/schemas/Resource'
21600 summary: Returns inputs list
21603 /v1/catalog/{componentType}/{componentId}/inputs/{inputId}/inputs:
21605 description: Get inputs
21606 operationId: getInputsForComponentInput
21609 name: componentType
21629 description: Component found
21631 description: Restricted operation
21633 description: Component not found
21640 $ref: '#/components/schemas/Resource'
21644 summary: Returns inputs list
21647 /v1/catalog/{componentType}/{componentId}/requirmentsCapabilities:
21649 description: Get Component Requirments And Capabilities
21650 operationId: getRequirementAndCapabilities
21653 name: componentType
21668 description: Component found
21670 description: Restricted operation
21672 description: Component not found
21679 $ref: '#/components/schemas/Resource'
21683 summary: Returns Requirements And Capabilities according to componentId
21686 /v1/catalog/{componentType}/{componentId}/resource/interfaceOperation:
21688 description: Create Interface Operation
21689 operationId: createInterfaceOperationInResource
21691 - description: "valid values: resources"
21693 name: componentType
21699 - description: Component Id
21711 description: Create Interface Operation
21713 description: Invalid content / Missing content
21715 description: Restricted operation
21731 additionalProperties:
21771 additionalProperties:
21803 unicodeLocaleAttributes:
21828 additionalProperties:
21854 additionalProperties:
21866 additionalProperties:
21892 additionalProperties:
21899 summary: Create Interface Operation on ComponentInstance
21902 /v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}:
21904 description: Add Component Substitution Filter Constraint
21905 operationId: addSubstitutionFilter
21907 - description: Component Id
21913 - description: "valid value: resources / services"
21915 name: componentType
21922 - description: "Constraint type. Valid values: properties / capabilities"
21924 name: constraintType
21940 description: UIConstraint data
21944 description: Add Substitution Filter Constraint
21946 description: Invalid content / Missing content
21948 description: Restricted operation
21964 additionalProperties:
22004 additionalProperties:
22036 unicodeLocaleAttributes:
22061 additionalProperties:
22087 additionalProperties:
22099 additionalProperties:
22125 additionalProperties:
22129 summary: Add Component Substitution Filter Constraint
22133 description: Update Component Substitution Filter Constraint
22134 operationId: updateSubstitutionFilters
22136 - description: Component Id
22142 - description: "valid value: resources / services"
22144 name: componentType
22151 - description: "Constraint type. Valid values: properties / capabilities"
22153 name: constraintType
22169 description: UIConstraint data
22173 description: Update Substitution Filter Constraint
22175 description: Invalid content / Missing content
22177 description: Restricted operation
22193 additionalProperties:
22233 additionalProperties:
22265 unicodeLocaleAttributes:
22290 additionalProperties:
22316 additionalProperties:
22328 additionalProperties:
22354 additionalProperties:
22358 summary: Update Component Substitution Filter Constraint
22361 /v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}/{constraintIndex}:
22363 description: Delete Component Substitution Filter Constraint
22364 operationId: deleteSubstitutionFilterConstraint
22366 - description: Component Id
22372 - description: Constraint Index
22374 name: constraintIndex
22379 - description: "valid value: resources / services"
22381 name: componentType
22388 - description: "Constraint type. Valid values: properties / capabilities"
22390 name: constraintType
22403 description: Delete Substitution Filter Constraint
22405 description: Invalid content / Missing content
22407 description: Restricted operation
22423 additionalProperties:
22463 additionalProperties:
22495 unicodeLocaleAttributes:
22520 additionalProperties:
22546 additionalProperties:
22558 additionalProperties:
22584 additionalProperties:
22588 summary: Delete Component Substitution Filter Constraint
22592 description: Update Component Substitution Filter Constraint
22593 operationId: updateSubstitutionFilter
22595 - description: Constraint Index
22597 name: constraintIndex
22602 - description: Component Id
22608 - description: The component type
22610 name: componentType
22617 - description: "Constraint type. Valid values: properties / capabilities"
22619 name: constraintType
22634 $ref: '#/components/schemas/UIConstraint'
22635 description: Filter constraint information
22639 description: Update Substitution Filter Constraint
22641 description: Invalid content / Missing content
22643 description: Restricted operation
22659 additionalProperties:
22699 additionalProperties:
22731 unicodeLocaleAttributes:
22756 additionalProperties:
22782 additionalProperties:
22794 additionalProperties:
22820 additionalProperties:
22824 summary: Update Component Substitution Filter Constraint
22827 /v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation:
22829 description: Validate Component Conformance Level
22830 operationId: conformanceLevelValidation
22833 name: componentType
22838 name: componentUuid
22848 description: Component found
22850 description: Restricted operation
22852 description: Component not found
22859 $ref: '#/components/schemas/Resource'
22863 summary: Returns the result according to conformance level in BE config
22866 /v1/catalog/{containerComponentType}/{componentId}/artifactsByType/{artifactGroupType}:
22868 description: Get component Artifacts
22869 operationId: getComponentArtifacts
22871 - description: "valid values: resources / services"
22873 name: containerComponentType
22886 name: artifactGroupType
22892 description: Component artifacts
22894 description: Resource/Artifact not found
22910 additionalProperties:
22950 additionalProperties:
22982 unicodeLocaleAttributes:
23007 additionalProperties:
23033 additionalProperties:
23045 additionalProperties:
23071 additionalProperties:
23078 summary: Returns artifacts
23081 /v1/catalog/{containerComponentType}/{componentId}/batchDeleteResourceInstances:
23083 description: Batch Delete ResourceInstances
23084 operationId: batchDeleteResourceInstances
23086 - description: "valid values: resources / services / products"
23088 name: containerComponentType
23106 description: Component Instance Id List
23110 description: ResourceInstances deleted
23112 description: Invalid Content / Missing Content
23114 description: Restricted Operation
23120 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupId}:
23122 description: 'Get group artifacts '
23123 operationId: getGroupById
23126 name: containerComponentType
23146 description: group found
23148 description: Restricted operation
23150 description: Group not found
23157 $ref: '#/components/schemas/Resource'
23161 summary: Returns artifacts metadata according to groupId
23165 description: Update Group metadata
23166 operationId: updateGroup
23169 name: containerComponentType
23191 $ref: '#/components/schemas/GroupDefinition'
23192 description: GroupDefinition
23196 description: Group updated
23198 description: Invalid content / Missing content
23200 description: Restricted operation
23202 description: component / group Not found
23218 additionalProperties:
23258 additionalProperties:
23290 unicodeLocaleAttributes:
23315 additionalProperties:
23341 additionalProperties:
23353 additionalProperties:
23379 additionalProperties:
23386 summary: Returns updated Group
23389 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupType}:
23391 description: 'Create group '
23392 operationId: createGroup
23395 name: containerComponentType
23415 description: Group created
23417 description: "field name invalid type/length, characters; mandatory field\
23418 \ is absent, already exists (name)"
23420 description: Restricted operation
23422 description: Component not found
23424 description: Internal Error
23431 $ref: '#/components/schemas/GroupDefinition'
23435 summary: Creates new group in component and returns it
23438 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}:
23440 description: Delete Group
23441 operationId: deleteGroup
23444 name: containerComponentType
23454 name: groupUniqueId
23464 description: ResourceInstance deleted
23466 description: "field name invalid type/length, characters; mandatory field\
23467 \ is absent, already exists (name)"
23469 description: Restricted operation
23471 description: Component not found
23473 description: Internal Error
23489 additionalProperties:
23529 additionalProperties:
23561 unicodeLocaleAttributes:
23586 additionalProperties:
23612 additionalProperties:
23624 additionalProperties:
23650 additionalProperties:
23657 summary: Returns deleted group id
23660 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/members:
23662 description: 'Update group members '
23663 operationId: updateGroupMembers
23666 name: containerComponentType
23676 name: groupUniqueId
23691 description: List of members unique ids
23695 description: Group members updated
23697 description: "field name invalid type/length, characters; mandatory field\
23698 \ is absent, already exists (name)"
23700 description: Restricted operation
23702 description: Component not found
23704 description: Internal Error
23715 summary: Updates list of members and returns it
23718 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/metadata:
23720 description: Update Group Metadata
23721 operationId: updateGroupMetadata
23724 name: containerComponentType
23734 name: groupUniqueId
23747 description: Service object to be Updated
23751 description: Group Updated
23753 description: Invalid content / Missing content
23755 description: Restricted operation
23762 $ref: '#/components/schemas/GroupDefinition'
23766 summary: Returns updated group definition
23769 /v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties:
23771 description: Get List of properties on a group
23772 operationId: getGroupProperties
23775 name: containerComponentType
23785 name: groupUniqueId
23795 description: Group Updated
23797 description: Invalid content / Missing content
23799 description: Restricted operation
23806 $ref: '#/components/schemas/GroupProperty'
23810 summary: Returns list of properties
23814 description: Updates List of properties on a group (only values)
23815 operationId: updateGroupProperties
23818 name: containerComponentType
23828 name: groupUniqueId
23842 $ref: '#/components/schemas/GroupProperty'
23843 description: Group Properties to be Updated
23847 description: Group Updated
23849 description: Invalid content / Missing content
23851 description: Restricted operation
23858 $ref: '#/components/schemas/GroupProperty'
23862 summary: Returns updated list of properties
23865 /v1/catalog/{containerComponentType}/{componentId}/paths-to-delete:
23867 description: Check if forwarding path to delete on version change
23868 operationId: changeResourceInstanceVersion_1
23876 name: componentInstanceId
23880 name: newComponentInstanceId
23883 - description: "valid values: resources / services"
23885 name: containerComponentType
23908 additionalProperties:
23948 additionalProperties:
23980 unicodeLocaleAttributes:
24005 additionalProperties:
24031 additionalProperties:
24043 additionalProperties:
24069 additionalProperties:
24076 summary: Returns forwarding paths to delete
24079 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}:
24081 description: Delete Policy
24082 operationId: deletePolicy
24089 - description: "valid values: resources / services"
24091 name: containerComponentType
24103 - description: USER_ID of modifier user
24111 description: Policy was deleted
24113 description: Invalid content / Missing content
24115 description: Restricted operation
24117 description: component / policy Not found
24133 additionalProperties:
24173 additionalProperties:
24205 unicodeLocaleAttributes:
24230 additionalProperties:
24256 additionalProperties:
24268 additionalProperties:
24294 additionalProperties:
24305 description: Get Policy
24306 operationId: getPolicy
24313 - description: "valid values: resources / services"
24315 name: containerComponentType
24327 - description: USER_ID of modifier user
24335 description: Policy was found
24337 description: Invalid content / Missing content
24339 description: Restricted operation
24341 description: component / policy Not found
24357 additionalProperties:
24397 additionalProperties:
24429 unicodeLocaleAttributes:
24454 additionalProperties:
24480 additionalProperties:
24492 additionalProperties:
24518 additionalProperties:
24525 summary: Returns Policy
24529 description: Update Policy metadata
24530 operationId: updatePolicy
24537 - description: "valid values: resources / services"
24539 name: containerComponentType
24551 - description: USER_ID of modifier user
24562 description: PolicyDefinition
24566 description: Policy updated
24568 description: Invalid content / Missing content
24570 description: Restricted operation
24572 description: component / policy Not found
24588 additionalProperties:
24628 additionalProperties:
24660 unicodeLocaleAttributes:
24685 additionalProperties:
24711 additionalProperties:
24723 additionalProperties:
24749 additionalProperties:
24756 summary: Returns updated Policy
24759 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/properties:
24761 description: Get component policy properties
24762 operationId: getPolicyProperties
24764 - description: the id of the component which is the container of the policy
24770 - description: "valid values: resources / services"
24772 name: containerComponentType
24779 - description: the id of the policy which its properties are to return
24785 - description: the userid
24793 description: Properties found
24795 description: "invalid content - Error: containerComponentType is invalid"
24797 description: Restricted operation
24799 description: Componentorpolicy not found
24801 description: The GET request failed due to internal SDC problem.
24808 $ref: '#/components/schemas/PropertyDataDefinition'
24812 summary: Returns component policy properties
24816 description: Update Policy properties
24817 operationId: updatePolicyProperties
24824 - description: "valid values: resources / services"
24826 name: containerComponentType
24838 - description: USER_ID of modifier user
24849 description: PolicyDefinition
24853 description: Policy properties updated
24855 description: Invalid content / Missing content
24857 description: Restricted operation
24859 description: component / policy Not found
24875 additionalProperties:
24915 additionalProperties:
24947 unicodeLocaleAttributes:
24972 additionalProperties:
24998 additionalProperties:
25010 additionalProperties:
25036 additionalProperties:
25043 summary: Returns updated Policy
25046 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/targets:
25048 description: update policy targets
25049 operationId: updatePolicyTargets
25056 - description: "valid values: resources / services"
25058 name: containerComponentType
25070 - description: USER_ID of modifier user
25082 $ref: '#/components/schemas/PolicyTargetDTO'
25085 description: Policy target updated
25087 description: Invalid content / Missing content
25089 description: Restricted operation
25105 additionalProperties:
25145 additionalProperties:
25177 unicodeLocaleAttributes:
25202 additionalProperties:
25228 additionalProperties:
25240 additionalProperties:
25266 additionalProperties:
25273 summary: Returns updated Policy
25276 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/undeclare:
25278 description: undeclare Policy
25279 operationId: undeclarePolicy
25286 - description: "valid values: resources / services"
25288 name: containerComponentType
25300 - description: USER_ID of modifier user
25308 description: Policy was undeclared
25310 description: Invalid content / Missing content
25312 description: Restricted operation
25314 description: component / policy Not found
25330 additionalProperties:
25370 additionalProperties:
25402 unicodeLocaleAttributes:
25427 additionalProperties:
25453 additionalProperties:
25465 additionalProperties:
25491 additionalProperties:
25501 /v1/catalog/{containerComponentType}/{componentId}/policies/{policyTypeName}:
25503 description: Create Policy
25504 operationId: createPolicy
25511 - description: "valid values: resources / services"
25513 name: containerComponentType
25521 name: policyTypeName
25525 - description: USER_ID of modifier user
25533 description: Policy created
25535 description: Invalid content / Missing content
25537 description: Restricted operation
25539 description: Component not found
25541 description: Policy already exist
25557 additionalProperties:
25597 additionalProperties:
25629 unicodeLocaleAttributes:
25654 additionalProperties:
25680 additionalProperties:
25692 additionalProperties:
25718 additionalProperties:
25725 summary: Returns created Policy
25728 /v1/catalog/{containerComponentType}/{componentId}/relationId/{relationId}:
25730 description: Get relation
25731 operationId: getRelationById
25734 name: containerComponentType
25754 description: relation found
25756 description: Restricted operation
25758 description: Relation not found
25774 additionalProperties:
25814 additionalProperties:
25846 unicodeLocaleAttributes:
25871 additionalProperties:
25897 additionalProperties:
25909 additionalProperties:
25935 additionalProperties:
25942 summary: Returns relation metadata according to relationId
25945 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance:
25947 description: Create ComponentInstance
25948 operationId: createComponentInstance
25955 - description: "valid values: resources / services"
25957 name: containerComponentType
25964 - description: USER_ID of modifier user
25975 description: RI object to be created
25979 description: Component created
25981 description: Invalid content / Missing content
25983 description: Restricted operation
25985 description: Component instance already exist
26001 additionalProperties:
26041 additionalProperties:
26073 unicodeLocaleAttributes:
26098 additionalProperties:
26124 additionalProperties:
26136 additionalProperties:
26162 additionalProperties:
26169 summary: Returns created ComponentInstance
26172 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate:
26174 description: Associate RI to RI
26175 operationId: associateRIToRI
26177 - description: unique id of the container component
26183 - description: allowed values are resources /services / products
26185 name: containerComponentType
26202 description: RelationshipInfo
26206 description: Relationship created
26208 description: Invalid content / Missing content
26210 description: Missing information
26212 description: Relationship already exist
26228 additionalProperties:
26268 additionalProperties:
26300 unicodeLocaleAttributes:
26325 additionalProperties:
26351 additionalProperties:
26363 additionalProperties:
26389 additionalProperties:
26396 summary: Returns created RelationshipInfo
26399 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/batchDissociate:
26401 description: Batch Dissociate RI from RI
26402 operationId: batchDissociateRIFromRI
26404 - description: allowed values are resources/services/products
26406 name: containerComponentType
26414 - description: unique id of the container component
26429 description: RelationshipInfo
26433 description: Relationship deleted
26435 description: Invalid Content / Missing Content
26437 description: Missing Information
26453 additionalProperties:
26493 additionalProperties:
26525 unicodeLocaleAttributes:
26550 additionalProperties:
26576 additionalProperties:
26588 additionalProperties:
26614 additionalProperties:
26621 summary: Returns deleted RelationShip Info
26624 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate:
26626 description: Create RI and associate RI to RI
26627 operationId: createAndAssociateRIToRI
26634 - description: "valid values: resources / services"
26636 name: containerComponentType
26646 description: RI created
26648 description: Invalid content / Missing content
26650 description: Restricted operation
26652 description: Relationship already exist
26668 additionalProperties:
26708 additionalProperties:
26740 unicodeLocaleAttributes:
26765 additionalProperties:
26791 additionalProperties:
26803 additionalProperties:
26829 additionalProperties:
26836 summary: Returns created RI and RelationshipInfo
26839 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/dissociate:
26841 description: Dissociate RI from RI
26842 operationId: dissociateRIFromRI
26844 - description: allowed values are resources /services / products
26846 name: containerComponentType
26854 - description: unique id of the container component
26869 description: RelationshipInfo
26873 description: Relationship deleted
26875 description: Invalid content / Missing content
26877 description: Missing information
26893 additionalProperties:
26933 additionalProperties:
26965 unicodeLocaleAttributes:
26990 additionalProperties:
27016 additionalProperties:
27028 additionalProperties:
27054 additionalProperties:
27061 summary: Returns deleted RelationshipInfo
27064 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance:
27066 description: Update resource instance multiple component
27067 operationId: updateMultipleComponentInstance
27074 - description: "valid values: resources / services / products"
27076 name: containerComponentType
27089 description: Component Instance JSON Array
27093 description: Resource instance updated
27095 description: Invalid content / Missing content
27097 description: Restricted operation
27113 additionalProperties:
27153 additionalProperties:
27185 unicodeLocaleAttributes:
27210 additionalProperties:
27236 additionalProperties:
27248 additionalProperties:
27274 additionalProperties:
27281 summary: Returns updated resource instance
27284 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}:
27286 description: Update resource instance
27287 operationId: updateComponentInstanceMetadata
27295 name: componentInstanceId
27299 - description: "valid values: resources / services / products"
27301 name: containerComponentType
27311 description: Resource instance updated
27313 description: Invalid content / Missing content
27315 description: Restricted operation
27331 additionalProperties:
27371 additionalProperties:
27403 unicodeLocaleAttributes:
27428 additionalProperties:
27454 additionalProperties:
27466 additionalProperties:
27492 additionalProperties:
27499 summary: Returns updated resource instance
27502 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts:
27504 description: Load Resource Instance artifact payload
27505 operationId: loadComponentInstanceArtifact
27515 - description: "valid values: resources / services"
27517 name: containerComponentType
27530 name: componentInstanceId
27539 description: json describe the artifact
27543 description: Artifact updated
27545 description: Invalid content / Missing content
27547 description: Restricted operation
27563 additionalProperties:
27603 additionalProperties:
27635 unicodeLocaleAttributes:
27660 additionalProperties:
27686 additionalProperties:
27698 additionalProperties:
27724 additionalProperties:
27731 summary: Returns updated artifact
27734 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}:
27736 description: Delete Resource Instance artifact
27737 operationId: deleteComponentInstanceArtifact
27747 - description: "valid values: resources / services"
27749 name: containerComponentType
27762 name: componentInstanceId
27776 description: json describe the artifact
27780 description: Artifact updated
27782 description: Invalid content / Missing content
27784 description: Restricted operation
27800 additionalProperties:
27840 additionalProperties:
27872 unicodeLocaleAttributes:
27897 additionalProperties:
27923 additionalProperties:
27935 additionalProperties:
27961 additionalProperties:
27968 summary: Returns deleted artifact
27972 description: Update Resource Instance artifact payload
27973 operationId: updateComponentInstanceArtifact
27983 - description: "valid values: resources / services"
27985 name: containerComponentType
27998 name: componentInstanceId
28012 description: json describe the artifact
28016 description: Artifact updated
28018 description: Invalid content / Missing content
28020 description: Restricted operation
28036 additionalProperties:
28076 additionalProperties:
28108 unicodeLocaleAttributes:
28133 additionalProperties:
28159 additionalProperties:
28171 additionalProperties:
28197 additionalProperties:
28204 summary: Returns updated artifact
28207 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams:
28209 description: Update Resource Instance HEAT_ENV parameters
28210 operationId: updateRIArtifact
28212 - description: "valid values: resources / services"
28214 name: containerComponentType
28227 name: componentInstanceId
28241 description: json describe the artifact
28245 description: Artifact updated
28247 description: Invalid content / Missing content
28249 description: Restricted operation
28265 additionalProperties:
28305 additionalProperties:
28337 unicodeLocaleAttributes:
28362 additionalProperties:
28388 additionalProperties:
28400 additionalProperties:
28426 additionalProperties:
28433 summary: Returns updated artifact
28436 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attributes:
28438 description: Update resource instance attribute
28439 operationId: updateResourceInstanceAttribute
28441 - description: service id
28447 - description: "valid values: resources / services"
28449 name: containerComponentType
28456 - description: resource instance id
28458 name: componentInstanceId
28462 - description: id of user initiating the operation
28472 description: Component Instance Properties JSON Array
28476 description: Resource instance created
28478 description: Invalid content / Missing content
28480 description: Restricted operation
28496 additionalProperties:
28536 additionalProperties:
28568 unicodeLocaleAttributes:
28593 additionalProperties:
28619 additionalProperties:
28631 additionalProperties:
28657 additionalProperties:
28664 summary: Returns updated resource instance property
28667 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion:
28669 description: Update resource instance
28670 operationId: changeResourceInstanceVersion
28678 name: componentInstanceId
28682 - description: "valid values: resources / services"
28684 name: containerComponentType
28693 description: Resource instance created
28695 description: Invalid content / Missing content
28697 description: Restricted operation
28713 additionalProperties:
28753 additionalProperties:
28785 unicodeLocaleAttributes:
28810 additionalProperties:
28836 additionalProperties:
28848 additionalProperties:
28874 additionalProperties:
28881 summary: Returns updated resource instance
28884 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstId}:
28886 description: 'Get group artifacts '
28887 operationId: getGroupArtifactById
28890 name: containerComponentType
28900 name: componentInstanceId
28915 description: group found
28917 description: Restricted operation
28919 description: Group not found
28935 additionalProperties:
28975 additionalProperties:
29007 unicodeLocaleAttributes:
29032 additionalProperties:
29058 additionalProperties:
29070 additionalProperties:
29096 additionalProperties:
29103 summary: Returns artifacts metadata according to groupInstId
29106 ? /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property
29108 description: Update resource instance property
29109 operationId: updateGroupInstanceProperty
29111 - description: service id
29117 - description: "valid values: resources / services"
29119 name: containerComponentType
29126 - description: resource instance id
29128 name: componentInstanceId
29132 - description: group instance id
29134 name: groupInstanceId
29138 - description: id of user initiating the operation
29145 description: Resource instance created
29147 description: Invalid content / Missing content
29149 description: Restricted operation
29165 additionalProperties:
29205 additionalProperties:
29237 unicodeLocaleAttributes:
29262 additionalProperties:
29288 additionalProperties:
29300 additionalProperties:
29326 additionalProperties:
29333 summary: Returns updated resource instance property
29336 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/inputs:
29338 description: Update resource instance property
29339 operationId: updateResourceInstanceInput
29341 - description: service id
29347 - description: "valid values: resources / services"
29349 name: containerComponentType
29356 - description: resource instance id
29358 name: componentInstanceId
29362 - description: id of user initiating the operation
29372 description: Component Instance Properties JSON Array
29376 description: Resource instance created
29378 description: Invalid content / Missing content
29380 description: Restricted operation
29396 additionalProperties:
29436 additionalProperties:
29468 unicodeLocaleAttributes:
29493 additionalProperties:
29519 additionalProperties:
29531 additionalProperties:
29557 additionalProperties:
29564 summary: Returns updated resource instance property
29567 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/properties:
29569 description: Update resource instance property
29570 operationId: updateResourceInstanceProperties
29572 - description: service id
29578 - description: "valid values: resources / services"
29580 name: containerComponentType
29587 - description: resource instance id
29589 name: componentInstanceId
29593 - description: id of user initiating the operation
29603 description: Component Instance Properties JSON Array
29607 description: Resource instance created
29609 description: Invalid content / Missing content
29611 description: Restricted operation
29627 additionalProperties:
29667 additionalProperties:
29699 unicodeLocaleAttributes:
29724 additionalProperties:
29750 additionalProperties:
29762 additionalProperties:
29788 additionalProperties:
29795 summary: Returns updated resource instance property
29798 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId}:
29800 description: Update resource instance
29801 operationId: deleteResourceInstanceProperty
29803 - description: service id
29809 - description: "valid values: resources / services"
29811 name: containerComponentType
29818 - description: resource instance id
29820 name: componentInstanceId
29824 - description: property id
29830 - description: id of user initiating the operation
29837 description: Resource instance created
29839 description: Invalid content / Missing content
29841 description: Restricted operation
29857 additionalProperties:
29897 additionalProperties:
29929 unicodeLocaleAttributes:
29954 additionalProperties:
29980 additionalProperties:
29992 additionalProperties:
30018 additionalProperties:
30025 summary: Returns deleted resource instance property
30028 /v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId}:
30030 description: Delete ResourceInstance
30031 operationId: deleteResourceInstance
30039 name: resourceInstanceId
30043 - description: "valid values: resources / services / products"
30045 name: containerComponentType
30055 description: ResourceInstance deleted
30057 description: Invalid content / Missing content
30059 description: Restricted operation
30075 additionalProperties:
30115 additionalProperties:
30147 unicodeLocaleAttributes:
30172 additionalProperties:
30198 additionalProperties:
30210 additionalProperties:
30236 additionalProperties:
30243 summary: Returns delete resourceInstance
30246 /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifacts/{artifactId}:
30248 description: Download component Artifact in Base64
30249 operationId: downloadResourceInstanceArtifactBase64
30251 - description: "valid values: resources / services"
30253 name: containerComponentType
30266 name: componentInstanceId
30277 description: ResourceInstance artifact downloaded
30279 description: ResourceInstance/Artifact not found
30295 additionalProperties:
30335 additionalProperties:
30367 unicodeLocaleAttributes:
30392 additionalProperties:
30418 additionalProperties:
30430 additionalProperties:
30456 additionalProperties:
30463 summary: Returns downloaded artifact
30466 /v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType}:
30468 description: Get component Artifacts
30469 operationId: getComponentInstanceArtifacts
30471 - description: "valid values: resources / services"
30473 name: containerComponentType
30486 name: componentInstanceId
30491 name: artifactGroupType
30497 description: Component artifacts
30499 description: Resource/Artifact not found
30515 additionalProperties:
30555 additionalProperties:
30587 unicodeLocaleAttributes:
30612 additionalProperties:
30638 additionalProperties:
30650 additionalProperties:
30676 additionalProperties:
30683 summary: Returns artifacts
30686 /v1/catalog/{containerComponentType}/{componentId}/update/inputs:
30688 description: Update resource inputs
30689 operationId: updateComponentInputs
30691 - description: "valid values: resources / services"
30693 name: containerComponentType
30710 description: json describe the input
30714 description: Input updated
30716 description: Invalid content / Missing content
30718 description: Restricted operation
30734 additionalProperties:
30774 additionalProperties:
30806 unicodeLocaleAttributes:
30831 additionalProperties:
30857 additionalProperties:
30869 additionalProperties:
30895 additionalProperties:
30902 summary: Returns updated input
30905 /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/attributes:
30907 description: Get component instance attributes
30908 operationId: getInstanceAttributesById
30911 name: containerComponentType
30916 name: containerComponentId
30921 name: componentInstanceUniqueId
30931 description: Attributes found
30933 description: Restricted operation
30935 description: Component/Component Instance - not found
30951 additionalProperties:
30991 additionalProperties:
31023 unicodeLocaleAttributes:
31048 additionalProperties:
31074 additionalProperties:
31086 additionalProperties:
31112 additionalProperties:
31119 summary: Returns component instance attributes
31122 /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability:
31124 description: Update Component Instance Capability
31125 operationId: updateInstanceRequirement
31128 name: containerComponentType
31133 name: containerComponentId
31138 name: componentInstanceUniqueId
31150 $ref: '#/components/schemas/ComponentInstanceCapabilityUpdateModel'
31151 description: Component instance capability to update
31155 description: Resource instance capability successfully updated
31157 description: Invalid content / Missing content
31159 description: Restricted operation
31161 description: Component/Component Instance/Capability not found
31177 additionalProperties:
31217 additionalProperties:
31249 unicodeLocaleAttributes:
31274 additionalProperties:
31300 additionalProperties:
31312 additionalProperties:
31338 additionalProperties:
31345 summary: Returns updated Component Instance Capability
31348 ? /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability/{capabilityType}/capabilityName/{capabilityName}/ownerId/{ownerId}/properties
31350 description: Get component instance capability properties
31351 operationId: getInstanceCapabilityPropertiesById
31354 name: containerComponentType
31359 name: containerComponentId
31364 name: componentInstanceUniqueId
31369 name: capabilityType
31374 name: capabilityName
31389 description: Properties found
31391 description: Restricted operation
31393 description: Component/Component Instance/Capability - not found
31409 additionalProperties:
31449 additionalProperties:
31481 unicodeLocaleAttributes:
31506 additionalProperties:
31532 additionalProperties:
31544 additionalProperties:
31570 additionalProperties:
31577 summary: Returns component instance capability properties
31581 description: Update Instance Capabilty Property
31582 operationId: updateInstanceCapabilityProperty
31585 name: containerComponentType
31590 name: containerComponentId
31595 name: componentInstanceUniqueId
31600 name: capabilityType
31605 name: capabilityName
31623 description: Instance capabilty property to update
31627 description: Resource instance capabilty property updated
31629 description: Invalid content / Missing content
31631 description: Restricted operation
31633 description: Component/Component Instance/Capability - not found
31649 additionalProperties:
31689 additionalProperties:
31721 unicodeLocaleAttributes:
31746 additionalProperties:
31772 additionalProperties:
31784 additionalProperties:
31810 additionalProperties:
31817 summary: Returns updated property
31820 /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/properties:
31822 description: Get component instance properties
31823 operationId: getInstancePropertiesById
31826 name: containerComponentType
31831 name: containerComponentId
31836 name: componentInstanceUniqueId
31846 description: Properties found
31848 description: Restricted operation
31850 description: Component/Component Instance - not found
31866 additionalProperties:
31906 additionalProperties:
31938 unicodeLocaleAttributes:
31963 additionalProperties:
31989 additionalProperties:
32001 additionalProperties:
32027 additionalProperties:
32034 summary: Returns component instance properties
32037 ? /v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/requirement/{capabilityType}/requirementName/{requirementName}
32039 description: Update Instance Requirement
32040 operationId: updateInstanceRequirement_1
32043 name: containerComponentType
32048 name: containerComponentId
32053 name: componentInstanceUniqueId
32058 name: capabilityType
32063 name: requirementName
32076 description: Instance capabilty requirement to update
32080 description: Resource instance requirement updated
32082 description: Invalid content / Missing content
32084 description: Restricted operation
32086 description: Component/Component Instance/Requirement - not found
32102 additionalProperties:
32142 additionalProperties:
32174 unicodeLocaleAttributes:
32199 additionalProperties:
32225 additionalProperties:
32237 additionalProperties:
32263 additionalProperties:
32270 summary: Returns updated requirement
32273 /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy:
32275 description: Create service proxy
32276 operationId: createServiceProxy
32279 name: containerComponentId
32283 - description: "valid values: resources / services"
32285 name: containerComponentType
32292 - description: USER_ID of modifier user
32303 description: RI object to be created
32307 description: Service proxy created
32309 description: Invalid content / Missing content
32311 description: Restricted operation
32313 description: Service proxy already exist
32329 additionalProperties:
32369 additionalProperties:
32401 unicodeLocaleAttributes:
32426 additionalProperties:
32452 additionalProperties:
32464 additionalProperties:
32490 additionalProperties:
32497 summary: Returns created service proxy
32500 /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}:
32502 description: Delete service proxy
32503 operationId: deleteServiceProxy
32506 name: containerComponentId
32511 name: serviceProxyId
32515 - description: "valid values: resources / services / products"
32517 name: containerComponentType
32526 description: Service proxy deleted
32528 description: Invalid content / Missing content
32530 description: Restricted operation
32546 additionalProperties:
32586 additionalProperties:
32618 unicodeLocaleAttributes:
32643 additionalProperties:
32669 additionalProperties:
32681 additionalProperties:
32707 additionalProperties:
32714 summary: Returns delete service proxy
32717 /v1/catalog/{containerComponentType}/{containerComponentId}/serviceProxy/{serviceProxyId}/changeVersion/{newServiceId}:
32719 description: Update service proxy with new version
32720 operationId: changeServiceProxyVersion
32723 name: containerComponentId
32728 name: serviceProxyId
32732 - description: "valid values: resources / services"
32734 name: containerComponentType
32743 description: Service proxy created
32745 description: Invalid content / Missing content
32747 description: Restricted operation
32763 additionalProperties:
32803 additionalProperties:
32835 unicodeLocaleAttributes:
32860 additionalProperties:
32886 additionalProperties:
32898 additionalProperties:
32924 additionalProperties:
32931 summary: Returns updated service proxy
32934 /v1/catalog/{containerComponentType}/{serviceId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}:
32936 description: Update Group Instance Property Values
32937 operationId: updateGroupInstancePropertyValues
32945 name: componentInstanceId
32950 name: groupInstanceId
32963 description: Group instance object to be Updated
32967 description: Group Instance Property Values Updated
32969 description: Invalid content / Missing content
32971 description: Restricted operation
32978 $ref: '#/components/schemas/Service'
32982 summary: Returns updated group instance
32985 /v1/catalogUpdateTime:
32987 description: Retrieve previus and current catalog update time
32988 operationId: getCatalogUpdateTime
32996 description: Retrieve previus and current catalog update time
33012 additionalProperties:
33052 additionalProperties:
33084 unicodeLocaleAttributes:
33109 additionalProperties:
33135 additionalProperties:
33147 additionalProperties:
33173 additionalProperties:
33180 summary: Retrieve previus and current catalog update time
33183 /v1/categories/{componentType}:
33185 description: Retrieve the list of all resource/service/product categories/sub-categories/groupings
33186 operationId: getComponentCategories
33188 - description: allowed values are resources / services/ products
33190 name: componentType
33204 description: Returns categories Ok
33206 description: Invalid component type
33208 description: Missing information
33210 description: Restricted operation
33212 description: Internal Server Error
33228 additionalProperties:
33268 additionalProperties:
33300 unicodeLocaleAttributes:
33325 additionalProperties:
33351 additionalProperties:
33363 additionalProperties:
33389 additionalProperties:
33396 summary: Retrieve the list of all resource/service/product categories/sub-categories/groupings.
33399 /v1/category/{componentType}:
33401 description: Create new component category
33402 operationId: createComponentCategory
33404 - description: allowed values are resources /services / products
33406 name: componentType
33423 description: Category to be created
33427 description: Category created
33429 description: Invalid category data
33431 description: USER_ID header is missing
33433 description: Category already exists / User not permitted to perform the
33436 description: General Error
33440 summary: Create new component category
33443 /v1/category/{componentType}/{categoryId}/subCategory:
33445 description: Create new component sub-category
33446 operationId: createComponentSubCategory
33448 - description: allowed values are resources / products
33450 name: componentType
33457 - description: Parent category unique ID
33472 description: "Subcategory to be created. \ne.g. {\"name\":\"Resource-subcat\"\
33477 description: Subcategory created
33479 description: Invalid subcategory data
33481 description: USER_ID header is missing
33483 description: Parent category wasn't found
33485 description: Subcategory already exists / User not permitted to perform
33488 description: General Error
33492 summary: Create new component sub-category for existing category
33495 /v1/category/{componentType}/{categoryId}/subCategory/{subCategoryId}/grouping:
33497 description: Create new component grouping
33498 operationId: createComponentGrouping
33500 - description: allowed values are products
33502 name: componentType
33508 - description: Parent category unique ID
33514 - description: Parent sub-category unique ID
33516 name: subCategoryId
33529 description: Subcategory to be created
33533 description: Grouping created
33535 description: Invalid grouping data
33537 description: USER_ID header is missing
33539 description: Parent category or subcategory were not found
33541 description: Grouping already exists / User not permitted to perform the
33544 description: General Error
33548 summary: Create new component grouping for existing sub-category
33551 /v1/category/{componentType}/{categoryName}/baseTypes:
33553 description: Get base types for category
33554 operationId: getCategoryBaseTypes
33562 name: componentType
33570 - description: model
33577 description: Returns base types Ok
33579 description: No base types were found
33581 description: Internal Server Error
33585 summary: Get base types for category
33588 /v1/category/{componentType}/{categoryUniqueId}:
33590 description: Delete component category
33591 operationId: deleteComponentCategory
33594 name: categoryUniqueId
33599 name: componentType
33609 description: Category deleted
33611 description: USER_ID header is missing
33613 description: Category not found
33615 description: User not permitted to perform the action
33617 description: General Error
33624 $ref: '#/components/schemas/Category'
33628 summary: Delete component category
33631 /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}:
33633 description: Delete component category
33634 operationId: deleteComponentSubCategory
33637 name: categoryUniqueId
33642 name: subCategoryUniqueId
33647 name: componentType
33657 description: Category deleted
33659 description: USER_ID header is missing
33661 description: Category not found
33663 description: User not permitted to perform the action
33665 description: General Error
33672 $ref: '#/components/schemas/Category'
33676 summary: Delete component category
33679 /v1/category/{componentType}/{categoryUniqueId}/subCategory/{subCategoryUniqueId}/grouping/{groupingUniqueId}:
33681 description: Delete component category
33682 operationId: deleteComponentGrouping
33685 name: categoryUniqueId
33690 name: subCategoryUniqueId
33695 name: groupingUniqueId
33700 name: componentType
33710 description: Category deleted
33712 description: USER_ID header is missing
33714 description: Category not found
33716 description: User not permitted to perform the action
33718 description: General Error
33725 $ref: '#/components/schemas/Category'
33729 summary: Delete component category
33734 description: Consumer credentials
33735 operationId: createConsumer
33746 description: Consumer Object to be created
33750 description: Consumer credentials created
33752 description: Invalid content / Missing content
33754 description: Restricted operation
33770 additionalProperties:
33810 additionalProperties:
33842 unicodeLocaleAttributes:
33867 additionalProperties:
33893 additionalProperties:
33905 additionalProperties:
33931 additionalProperties:
33938 summary: Returns created ECOMP consumer credentials
33941 /v1/consumers/{consumerId}:
33943 description: Deletes Consumer
33944 operationId: deleteConsumer
33957 description: Consumer deleted
33959 description: Restricted operation
33961 description: Consumer not found
33968 $ref: '#/components/schemas/ConsumerDefinition'
33972 summary: Returns deleted consumer according to ConsumerID
33976 description: Retrieve Consumer
33977 operationId: getConsumer
33990 description: Consumer found
33992 description: Restricted operation
33994 description: Consumer not found
34001 $ref: '#/components/schemas/ConsumerDefinition'
34005 summary: Returns consumer according to ConsumerID
34008 /v1/ecompPortalMenu:
34010 description: Retrieve ecomp portal menu - MOC
34011 operationId: getListOfCsars
34014 description: Retrieve ecomp portal menu
34021 $ref: '#/components/schemas/User'
34025 summary: Retrieve ecomp portal menu
34030 description: Retrieve all followed
34031 operationId: getFollowedResourcesServices
34039 description: Returns followed Ok
34041 description: User not found
34043 description: Internal Server Error
34050 $ref: '#/components/schemas/User'
34054 summary: Retrieve all followed
34057 /v1/inactiveComponents/{componentType}:
34059 operationId: deleteMarkedResources
34062 name: componentType
34070 description: default response
34076 /v1/propertyScopes:
34078 description: Retrieve all propertyScopes
34079 operationId: getPropertyScopes
34087 description: Returns propertyScopes Ok
34089 description: No propertyScopes were found
34091 description: Internal Server Error
34098 $ref: '#/components/schemas/User'
34102 summary: Retrieve all propertyScopes
34107 description: Retrieve catalog resources and services
34108 operationId: getCatalogComponents
34133 - ServiceSubstitution
34136 description: Returns resources and services Ok
34138 description: User not found
34140 description: Internal Server Error
34147 $ref: '#/components/schemas/User'
34151 summary: Retrieve catalog resources and services
34156 description: "Retrieve all artifactTypes, ui configuration and sdc version"
34157 operationId: getConfCategoriesAndVersion_1
34165 description: "Returns artifactTypes, ui configuration and sdc version Ok"
34167 description: No artifactTypes were found/no ui configuration were found/no
34168 sdc version were found
34170 description: Internal Server Error
34177 $ref: '#/components/schemas/User'
34181 summary: "Retrieve all artifactTypes, ui configuration and sdc version"
34186 description: Retrieve all tags
34187 operationId: getTags
34195 description: Returns tags Ok
34197 description: No tags were found
34199 description: Internal Server Error
34206 $ref: '#/components/schemas/User'
34210 summary: Retrieve all tags
34215 description: add user
34216 operationId: createUser
34226 $ref: '#/components/schemas/User'
34227 description: json describe the user
34231 description: New user created
34233 description: Invalid Content.
34235 description: Missing information
34237 description: Method Not Allowed
34239 description: User already exists
34241 description: Internal Server Error
34248 $ref: '#/components/schemas/User'
34252 summary: Provision new user
34257 description: retrieve all administrators
34258 operationId: getAdminsUser
34261 description: Returns user Ok
34263 description: Method Not Allowed
34265 description: Internal Server Error
34272 $ref: '#/components/schemas/User'
34276 summary: Returns all administrators
34279 /v1/user/authorize:
34281 description: authorize
34282 operationId: authorize
34289 name: HTTP_CSP_FIRSTNAME
34293 name: HTTP_CSP_LASTNAME
34297 name: HTTP_CSP_EMAIL
34302 description: Returns user Ok
34304 description: Restricted Access
34306 description: Internal Server Error
34313 $ref: '#/components/schemas/User'
34317 summary: authorize user
34322 description: Retrieve the list of all active ASDC users or only group of users
34323 having specific roles.
34324 operationId: getUsersList
34326 - description: 'Any active user''s USER_ID '
34331 - description: "TESTER,DESIGNER,PRODUCT_STRATEGIST,OPS,PRODUCT_MANAGER,GOVERNOR,\
34332 \ ADMIN OR all users by not typing anything"
34339 description: Returns users Ok
34341 description: No provisioned ASDC users of requested role
34343 description: Missing content
34345 description: Restricted Access
34347 description: Internal Server Error
34354 $ref: '#/components/schemas/User'
34358 summary: "Returns list of users with the specified roles, or all of users in\
34359 \ the case of empty 'roles' header"
34364 description: delete user
34365 operationId: deActivateUser
34367 - description: userId of user to get
34379 description: Update deleted OK
34381 description: Invalid Content.
34383 description: Missing information
34385 description: User not found
34387 description: Method Not Allowed
34389 description: Restricted operation
34391 description: Internal Server Error
34398 $ref: '#/components/schemas/User'
34402 summary: Delete user
34406 description: retrieve user details
34409 - description: userId of user to get
34417 description: Returns user Ok
34419 description: User not found
34421 description: Method Not Allowed
34423 description: Internal Server Error
34430 $ref: '#/components/schemas/User'
34434 summary: Returns user details according to userId
34437 /v1/user/{userId}/role:
34439 description: retrieve user role
34440 operationId: getRole
34442 - description: userId of user to get
34450 description: Returns user role Ok
34452 description: User not found
34454 description: Method Not Allowed
34456 description: Internal Server Error
34467 summary: Returns user role according to userId
34471 description: update user role
34472 operationId: updateUserRole
34474 - description: userId of user to get
34488 $ref: '#/components/schemas/UserRole'
34489 description: json describe the update role
34493 description: Update user OK
34495 description: Invalid Content.
34497 description: Missing information/Restricted operation
34499 description: User not found
34501 description: Method Not Allowed
34503 description: User already exists
34505 description: Internal Server Error
34512 $ref: '#/components/schemas/User'
34516 summary: Update user role
34521 AdditionalInfoParameterInfo:
34541 AdditionalInformationDefinition:
34549 lastCreatedCounter:
34563 $ref: '#/components/schemas/AdditionalInfoParameterInfo'
34582 $ref: '#/components/schemas/PropertyDataDefinition'
34585 ApplicationL1CacheCatalogInfo:
34590 productsSizeInCache:
34593 resourcesSizeInCache:
34596 servicesSizeInCache:
34599 ApplicationL1CacheConfig:
34603 $ref: '#/components/schemas/ApplicationL1CacheInfo'
34604 ApplicationL1CacheInfo:
34615 ApplicationL2CacheConfig:
34619 $ref: '#/components/schemas/ApplicationL1CacheCatalogInfo'
34623 $ref: '#/components/schemas/QueueInfo'
34624 ArtifactConfiguration:
34649 - RESOURCE_INSTANCE
34657 ArtifactDataDefinition:
34666 artifactDisplayName:
34683 artifactRepository:
34713 $ref: '#/components/schemas/HeatParameterDataDefinition'
34714 heatParamsUpdateDate:
34735 $ref: '#/components/schemas/PropertyDataDefinition'
34757 ArtifactDefinition:
34766 artifactDisplayName:
34783 artifactRepository:
34815 $ref: '#/components/schemas/HeatParameterDataDefinition'
34816 heatParamsUpdateDate:
34824 listHeatParameters:
34827 $ref: '#/components/schemas/HeatParameterDefinition'
34852 $ref: '#/components/schemas/PropertyDataDefinition'
34874 AttributeDefinition:
34888 $ref: '#/components/schemas/EntrySchema'
34889 getOutputAttribute:
34894 $ref: '#/components/schemas/GetOutputValueDataDefinition'
34915 $ref: '#/components/schemas/SchemaDefinition'
34939 BeMonitoringConfig:
34946 probeIntervalInSeconds:
34949 CINodeFilterDataDefinition:
34953 $ref: '#/components/schemas/ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition'
34966 $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition'
35000 cadi_truststore_password:
35006 CapabilityDataDefinition:
35040 - COMPONENT_INSTANCE
35062 CapabilityDefinition:
35096 - COMPONENT_INSTANCE
35102 - COMPONENT_INSTANCE
35116 $ref: '#/components/schemas/ComponentInstanceProperty'
35129 CapabilityRequirementRelationship:
35133 $ref: '#/components/schemas/CapabilityDataDefinition'
35137 $ref: '#/components/schemas/OperationUi'
35139 $ref: '#/components/schemas/RelationshipInfo'
35141 $ref: '#/components/schemas/RequirementDataDefinition'
35157 $ref: '#/components/schemas/KeyspaceConfig'
35168 socketConnectTimeout:
35176 truststorePassword:
35188 $ref: '#/components/schemas/CategoryDefinition'
35189 categoryNormalizedName:
35196 - RESOURCE_INSTANCE
35201 distributionStatus:
35222 subCategoryNormalizedName:
35243 CategoryBaseTypeConfig:
35252 doNotExtendBaseType:
35256 CategoryDefinition:
35270 $ref: '#/components/schemas/MetadataKeyDataDefinition'
35279 notApplicableMetadataKeys:
35291 $ref: '#/components/schemas/SubCategoryDefinition'
35296 useServiceSubstitutionForNestedServices:
35300 CleanComponentsConfiguration:
35303 cleanIntervalInMinutes:
35313 actualComponentUid:
35317 additionalProperties:
35318 $ref: '#/components/schemas/ArtifactDefinition'
35319 attributeValueCounter:
35325 $ref: '#/components/schemas/AttributeDefinition'
35328 additionalProperties:
35331 $ref: '#/components/schemas/CapabilityDefinition'
35332 componentMetadataForSupportLog:
35334 additionalProperties:
35354 deploymentArtifacts:
35356 additionalProperties:
35357 $ref: '#/components/schemas/ArtifactDefinition'
35369 $ref: '#/components/schemas/GroupInstance'
35378 $ref: '#/components/schemas/InputDefinition'
35383 additionalProperties:
35399 $ref: '#/components/schemas/CINodeFilterDataDefinition'
35419 - ServiceSubstitution
35432 $ref: '#/components/schemas/PropertyDefinition'
35433 propertyValueCounter:
35438 additionalProperties:
35441 $ref: '#/components/schemas/RequirementDefinition'
35442 serviceSubstitution:
35444 sourceModelInvariant:
35454 additionalProperties:
35455 $ref: '#/components/schemas/ToscaArtifactDataDefinition'
35456 toscaComponentName:
35464 ComponentInstanceAttribute:
35469 componentInstanceId:
35471 componentInstanceName:
35482 $ref: '#/components/schemas/EntrySchema'
35483 getOutputAttribute:
35488 $ref: '#/components/schemas/GetOutputValueDataDefinition'
35515 $ref: '#/components/schemas/PropertyRule'
35517 $ref: '#/components/schemas/SchemaDefinition'
35532 ComponentInstanceCapabilityUpdateModel:
35539 maxLength: 2147483647
35543 maxLength: 2147483647
35547 maxLength: 2147483647
35551 maxLength: 2147483647
35555 maxLength: 2147483647
35564 ComponentInstanceInput:
35570 $ref: '#/components/schemas/Annotation'
35571 annotationsToInput:
35574 $ref: '#/components/schemas/Annotation'
35576 componentInstanceId:
35578 componentInstanceName:
35583 $ref: '#/components/schemas/PropertyConstraint'
35597 $ref: '#/components/schemas/GetInputValueDataDefinition'
35601 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
35612 isDeclaredListInput:
35616 mappedToComponentProperty:
35620 additionalProperties:
35631 parentPropertyType:
35644 $ref: '#/components/schemas/ComponentInstanceProperty'
35645 propertyConstraints:
35656 $ref: '#/components/schemas/PropertyRule'
35658 $ref: '#/components/schemas/SchemaDefinition'
35660 $ref: '#/components/schemas/PropertyDataDefinition'
35665 subPropertyInputPath:
35667 subPropertyToscaFunctions:
35670 $ref: '#/components/schemas/SubPropertyToscaFunction'
35672 $ref: '#/components/schemas/ToscaFunction'
35674 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
35675 toscaGetFunctionType:
35695 ComponentInstanceInterface:
35711 additionalProperties:
35712 $ref: '#/components/schemas/InputDataDefinition'
35715 interfaceInstanceDataDefinition:
35716 $ref: '#/components/schemas/InterfaceInstanceDataDefinition'
35724 additionalProperties:
35725 $ref: '#/components/schemas/OperationDataDefinition'
35741 ComponentInstanceOutput:
35745 $ref: '#/components/schemas/ComponentInstanceAttribute'
35748 componentInstanceId:
35750 componentInstanceName:
35761 $ref: '#/components/schemas/EntrySchema'
35762 getOutputAttribute:
35767 $ref: '#/components/schemas/GetOutputValueDataDefinition'
35794 $ref: '#/components/schemas/PropertyRule'
35796 $ref: '#/components/schemas/SchemaDefinition'
35811 ComponentInstanceProperty:
35817 $ref: '#/components/schemas/Annotation'
35818 componentInstanceId:
35820 componentInstanceName:
35825 $ref: '#/components/schemas/PropertyConstraint'
35839 $ref: '#/components/schemas/GetInputValueDataDefinition'
35843 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
35854 isDeclaredListInput:
35858 mappedToComponentProperty:
35862 additionalProperties:
35873 parentPropertyType:
35883 propertyConstraints:
35894 $ref: '#/components/schemas/PropertyRule'
35896 $ref: '#/components/schemas/SchemaDefinition'
35898 $ref: '#/components/schemas/PropertyDataDefinition'
35903 subPropertyInputPath:
35905 subPropertyToscaFunctions:
35908 $ref: '#/components/schemas/SubPropertyToscaFunction'
35910 $ref: '#/components/schemas/ToscaFunction'
35912 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
35913 toscaGetFunctionType:
35940 additionalInformationMaxNumberOfKeys:
35945 applicationL1Cache:
35946 $ref: '#/components/schemas/ApplicationL1CacheConfig'
35947 applicationL2Cache:
35948 $ref: '#/components/schemas/ApplicationL2CacheConfig'
35949 artifactGeneratorConfig:
35954 $ref: '#/components/schemas/ArtifactConfiguration'
35958 $ref: '#/components/schemas/CookieConfig'
35962 $ref: '#/components/schemas/BasicAuthConfig'
35976 $ref: '#/components/schemas/CadiFilterParams'
35978 $ref: '#/components/schemas/CassandrConfig'
35979 cleanComponentsConfiguration:
35980 $ref: '#/components/schemas/CleanComponentsConfiguration'
35981 componentAllowedInstanceTypes:
35983 additionalProperties:
35985 additionalProperties:
35989 componentInstanceCounterDelimiter:
35991 consumerBusinessLogic:
35994 $ref: '#/components/schemas/CsarFormat'
35995 dataValidatorFilterExcludedUrls:
35997 defaultCustomToscaFunctions:
36000 $ref: '#/components/schemas/CustomToscaFunction'
36005 additionalProperties:
36007 additionalProperties:
36009 definedResourceNamespace:
36013 deleteLockTimeoutInSeconds:
36016 deploymentResourceArtifacts:
36018 additionalProperties:
36020 deploymentResourceInstanceArtifacts:
36022 additionalProperties:
36030 dmaapConsumerConfiguration:
36031 $ref: '#/components/schemas/DmaapConsumerConfiguration'
36032 dmaapProducerConfiguration:
36033 $ref: '#/components/schemas/DmaapProducerConfiguration'
36035 $ref: '#/components/schemas/DmeConfiguration'
36037 $ref: '#/components/schemas/EcompPortalConfig'
36040 environmentContext:
36041 $ref: '#/components/schemas/EnvironmentContext'
36042 excludeResourceCategory:
36046 excludeResourceType:
36050 excludeServiceCategory:
36054 excludedGroupTypesMapping:
36056 additionalProperties:
36061 excludedPolicyTypesMapping:
36063 additionalProperties:
36069 $ref: '#/components/schemas/ExternalCsarStore'
36073 $ref: '#/components/schemas/GabConfig'
36074 genericAssetNodeTypes:
36076 additionalProperties:
36082 healthStatusExclude:
36086 heatArtifactDeploymentTimeout:
36087 $ref: '#/components/schemas/HeatDeploymentArtifactTimeout'
36088 heatEnvArtifactFooter:
36090 heatEnvArtifactHeader:
36092 heatTranslatorPath:
36094 identificationHeaderFields:
36098 informationalResourceArtifacts:
36100 additionalProperties:
36102 informationalServiceArtifacts:
36104 additionalProperties:
36108 janusGraphHealthCheckReadTimeout:
36111 janusGraphInMemoryGraph:
36113 janusGraphLockTimeout:
36116 janusGraphMigrationKeySpaceCfgFile:
36118 janusGraphReconnectIntervalInSeconds:
36125 maxDeleteComponents:
36128 minToscaConformanceLevel:
36132 additionalProperties:
36135 $ref: '#/components/schemas/OnboardingConfig'
36136 permittedAncestors:
36147 additionalProperties:
36149 additionalProperties:
36155 resourcesForUpgrade:
36157 additionalProperties:
36161 serviceApiArtifacts:
36163 additionalProperties:
36165 serviceBaseNodeTypes:
36167 additionalProperties:
36168 $ref: '#/components/schemas/CategoryBaseTypeConfig'
36169 skipUpgradeFailedVfs:
36173 startMigrationFrom:
36176 supportAllottedResourcesAndProxy:
36178 switchoverDetector:
36179 $ref: '#/components/schemas/SwitchoverDetectorConfig'
36181 $ref: '#/components/schemas/BeMonitoringConfig'
36184 additionalProperties:
36186 toscaConformanceLevel:
36191 $ref: '#/components/schemas/ToscaValidatorsConfig'
36192 uebHealthCheckReadTimeout:
36195 uebHealthCheckReconnectIntervalInSeconds:
36204 additionalProperties:
36208 vfModuleProperties:
36210 additionalProperties:
36211 $ref: '#/components/schemas/VfModuleProperty'
36246 ConsumerDefinition:
36249 consumerDetailsLastupdatedtime:
36252 consumerLastAuthenticationTime:
36293 onboardingExcludedUrls:
36303 sessionIdleTimeOut:
36325 CustomToscaFunction:
36332 DataTypeDataDefinition:
36361 $ref: '#/components/schemas/PropertyDataDefinition'
36368 DataTypeDefinition:
36374 $ref: '#/components/schemas/PropertyConstraint'
36379 $ref: '#/components/schemas/DataTypeDefinition'
36403 $ref: '#/components/schemas/PropertyDefinition'
36407 $ref: '#/components/schemas/PropertyDataDefinition'
36414 DistributionStatusInfo:
36427 DistributionStatusListResponse:
36430 distributionStatusList:
36433 $ref: '#/components/schemas/DistributionStatusInfo'
36434 DmaapConsumerConfiguration:
36439 aftDme2ClientIgnoreSslConfig:
36441 aftDme2ClientKeystore:
36443 aftDme2ClientKeystorePassword:
36445 aftDme2ClientSslCertAlias:
36447 aftDme2ConnectionTimeoutMs:
36450 aftDme2ReadTimeoutMs:
36453 aftDme2RoundtripTimeoutMs:
36467 $ref: '#/components/schemas/Credential'
36470 dme2preferredRouterFilePath:
36496 timeLimitForNotificationHandleMs:
36506 DmaapProducerConfiguration:
36511 aftDme2ClientIgnoreSslConfig:
36513 aftDme2ClientKeystore:
36515 aftDme2ClientKeystorePassword:
36517 aftDme2ClientSslCertAlias:
36519 aftDme2ConnectionTimeoutMs:
36522 aftDme2ReadTimeoutMs:
36525 aftDme2RoundtripTimeoutMs:
36539 $ref: '#/components/schemas/Credential'
36542 dme2preferredRouterFilePath:
36568 timeLimitForNotificationHandleMs:
36586 defaultFunctionalMenu:
36619 $ref: '#/components/schemas/Constraint'
36624 EnvironmentContext:
36637 $ref: '#/components/schemas/Credentials'
36639 $ref: '#/components/schemas/Endpoint'
36647 FormDataContentDisposition:
36662 additionalProperties:
36672 ForwardingPathDataDefinition:
36677 destinationPortNumber:
36689 $ref: '#/components/schemas/ListDataDefinitionForwardingPathElementDataDefinition'
36700 ForwardingPathElementDataDefinition:
36731 pathsAndNamesDefinitions:
36734 $ref: '#/components/schemas/PathsAndNamesDefinition'
36735 GenericArtifactQueryInfo:
36747 GetInputValueDataDefinition:
36753 $ref: '#/components/schemas/GetInputValueDataDefinition'
36776 GetOutputValueDataDefinition:
36784 $ref: '#/components/schemas/GetOutputValueDataDefinition'
36803 GetPolicyValueDataDefinition:
36825 additionalProperties:
36828 $ref: '#/components/schemas/CapabilityDefinition'
36846 additionalProperties:
36860 $ref: '#/components/schemas/PropertyDataDefinition'
36861 propertyValueCounter:
36879 changePriorityBody:
36903 groupInstanceArtifacts:
36907 groupInstanceArtifactsUuid:
36938 $ref: '#/components/schemas/PropertyDataDefinition'
36939 propertyValueCounter:
36954 $ref: '#/components/schemas/Annotation'
36958 $ref: '#/components/schemas/PropertyConstraint'
36972 $ref: '#/components/schemas/GetInputValueDataDefinition'
36976 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
36987 isDeclaredListInput:
36991 mappedToComponentProperty:
36995 additionalProperties:
37006 parentPropertyType:
37012 propertyConstraints:
37021 $ref: '#/components/schemas/SchemaDefinition'
37023 $ref: '#/components/schemas/PropertyDataDefinition'
37028 subPropertyInputPath:
37030 subPropertyToscaFunctions:
37033 $ref: '#/components/schemas/SubPropertyToscaFunction'
37035 $ref: '#/components/schemas/ToscaFunction'
37037 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37038 toscaGetFunctionType:
37058 GroupTypeDefinition:
37063 additionalProperties:
37064 $ref: '#/components/schemas/CapabilityDefinition'
37084 additionalProperties:
37101 $ref: '#/components/schemas/PropertyDefinition'
37108 GroupingDefinition:
37128 HeatDeploymentArtifactTimeout:
37140 HeatParameterDataDefinition:
37164 HeatParameterDefinition:
37188 InputDataDefinition:
37194 $ref: '#/components/schemas/Annotation'
37208 $ref: '#/components/schemas/GetInputValueDataDefinition'
37212 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37223 isDeclaredListInput:
37227 mappedToComponentProperty:
37231 additionalProperties:
37242 parentPropertyType:
37248 propertyConstraints:
37257 $ref: '#/components/schemas/SchemaDefinition'
37259 $ref: '#/components/schemas/PropertyDataDefinition'
37264 subPropertyInputPath:
37266 subPropertyToscaFunctions:
37269 $ref: '#/components/schemas/SubPropertyToscaFunction'
37271 $ref: '#/components/schemas/ToscaFunction'
37273 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37274 toscaGetFunctionType:
37296 $ref: '#/components/schemas/Annotation'
37297 annotationsToInput:
37300 $ref: '#/components/schemas/Annotation'
37305 $ref: '#/components/schemas/PropertyConstraint'
37319 $ref: '#/components/schemas/GetInputValueDataDefinition'
37323 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37335 $ref: '#/components/schemas/ComponentInstanceInput'
37338 isDeclaredListInput:
37342 mappedToComponentProperty:
37346 additionalProperties:
37357 parentPropertyType:
37366 $ref: '#/components/schemas/ComponentInstanceProperty'
37367 propertyConstraints:
37376 $ref: '#/components/schemas/SchemaDefinition'
37378 $ref: '#/components/schemas/PropertyDataDefinition'
37383 subPropertyInputPath:
37385 subPropertyToscaFunctions:
37388 $ref: '#/components/schemas/SubPropertyToscaFunction'
37390 $ref: '#/components/schemas/ToscaFunction'
37392 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37393 toscaGetFunctionType:
37411 InterfaceDefinition:
37427 additionalProperties:
37428 $ref: '#/components/schemas/InputDataDefinition'
37436 additionalProperties:
37437 $ref: '#/components/schemas/OperationDataDefinition'
37453 InterfaceInstanceDataDefinition:
37460 additionalProperties:
37464 additionalProperties:
37465 $ref: '#/components/schemas/OperationInstance'
37484 replicationStrategy:
37486 ListDataDefinitionForwardingPathElementDataDefinition:
37491 listToscaDataDefinition:
37494 $ref: '#/components/schemas/ForwardingPathElementDataDefinition'
37504 ListDataDefinitionOperationInputDefinition:
37509 listToscaDataDefinition:
37512 $ref: '#/components/schemas/OperationInputDefinition'
37522 ListDataDefinitionOperationOutputDefinition:
37527 listToscaDataDefinition:
37530 $ref: '#/components/schemas/OperationOutputDefinition'
37540 ListDataDefinitionPropertyFilterDataDefinition:
37545 listToscaDataDefinition:
37548 $ref: '#/components/schemas/PropertyFilterDataDefinition'
37558 ListDataDefinitionRequirementNodeFilterCapabilityDataDefinition:
37563 listToscaDataDefinition:
37566 $ref: '#/components/schemas/RequirementNodeFilterCapabilityDataDefinition'
37576 ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition:
37581 listToscaDataDefinition:
37584 $ref: '#/components/schemas/RequirementSubstitutionFilterCapabilityDataDefinition'
37594 ListDataDefinitionSubstitutionFilterPropertyDataDefinition:
37599 listToscaDataDefinition:
37602 $ref: '#/components/schemas/SubstitutionFilterPropertyDataDefinition'
37612 MetadataKeyDataDefinition:
37647 - NORMATIVE_EXTENSION
37650 ModelCreateRequest:
37659 - NORMATIVE_EXTENSION
37662 maxLength: 2147483647
37669 additionalProperties:
37682 additionalProperties:
37687 additionalProperties:
37704 additionalProperties:
37721 $ref: '#/components/schemas/CategoryDefinition'
37738 resourceVendorModelNumber:
37750 NodeTypesMetadataList:
37756 $ref: '#/components/schemas/NodeTypeMetadata'
37760 getLatestVspPackageUri:
37777 OperationDataDefinition:
37788 $ref: '#/components/schemas/ArtifactDataDefinition'
37790 $ref: '#/components/schemas/ListDataDefinitionOperationInputDefinition'
37797 $ref: '#/components/schemas/ListDataDefinitionOperationOutputDefinition'
37809 workflowAssociationType:
37819 OperationImplementation:
37828 OperationInputDefinition:
37834 $ref: '#/components/schemas/Annotation'
37848 $ref: '#/components/schemas/GetInputValueDataDefinition'
37852 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37863 isDeclaredListInput:
37867 mappedToComponentProperty:
37871 additionalProperties:
37882 parentPropertyType:
37888 propertyConstraints:
37897 $ref: '#/components/schemas/SchemaDefinition'
37899 $ref: '#/components/schemas/PropertyDataDefinition'
37908 subPropertyInputPath:
37910 subPropertyToscaFunctions:
37913 $ref: '#/components/schemas/SubPropertyToscaFunction'
37917 $ref: '#/components/schemas/ToscaFunction'
37919 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
37920 toscaGetFunctionType:
37940 $ref: '#/components/schemas/OperationImplementation'
37943 additionalProperties:
37945 OperationOutputDefinition:
37951 $ref: '#/components/schemas/Annotation'
37965 $ref: '#/components/schemas/GetInputValueDataDefinition'
37969 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
37980 isDeclaredListInput:
37984 mappedToComponentProperty:
37988 additionalProperties:
37999 parentPropertyType:
38005 propertyConstraints:
38014 $ref: '#/components/schemas/SchemaDefinition'
38016 $ref: '#/components/schemas/PropertyDataDefinition'
38021 subPropertyInputPath:
38023 subPropertyToscaFunctions:
38026 $ref: '#/components/schemas/SubPropertyToscaFunction'
38028 $ref: '#/components/schemas/ToscaFunction'
38030 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
38031 toscaGetFunctionType:
38055 $ref: '#/components/schemas/PropertyAssignmentUi'
38064 $ref: '#/components/schemas/ComponentInstanceAttribute'
38076 $ref: '#/components/schemas/EntrySchema'
38077 getOutputAttribute:
38082 $ref: '#/components/schemas/GetOutputValueDataDefinition'
38103 $ref: '#/components/schemas/SchemaDefinition'
38116 PathsAndNamesDefinition:
38131 $ref: '#/components/schemas/Annotation'
38149 $ref: '#/components/schemas/GetInputValueDataDefinition'
38153 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
38168 isDeclaredListInput:
38174 mappedToComponentProperty:
38178 additionalProperties:
38191 parentPropertyType:
38206 $ref: '#/components/schemas/PropertyDataDefinition'
38207 propertyConstraints:
38216 $ref: '#/components/schemas/SchemaDefinition'
38218 $ref: '#/components/schemas/PropertyDataDefinition'
38223 subPropertyInputPath:
38225 subPropertyToscaFunctions:
38228 $ref: '#/components/schemas/SubPropertyToscaFunction'
38231 additionalProperties:
38236 $ref: '#/components/schemas/ToscaFunction'
38238 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
38239 toscaGetFunctionType:
38264 PolicyTypeDefinition:
38282 additionalProperties:
38299 $ref: '#/components/schemas/PropertyDefinition'
38310 PropertyAssignmentUi:
38319 PropertyConstraint:
38321 PropertyDataDefinition:
38327 $ref: '#/components/schemas/Annotation'
38341 $ref: '#/components/schemas/GetInputValueDataDefinition'
38345 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
38356 isDeclaredListInput:
38360 mappedToComponentProperty:
38364 additionalProperties:
38375 parentPropertyType:
38381 propertyConstraints:
38390 $ref: '#/components/schemas/SchemaDefinition'
38392 $ref: '#/components/schemas/PropertyDataDefinition'
38397 subPropertyInputPath:
38399 subPropertyToscaFunctions:
38402 $ref: '#/components/schemas/SubPropertyToscaFunction'
38404 $ref: '#/components/schemas/ToscaFunction'
38406 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
38407 toscaGetFunctionType:
38423 PropertyDefinition:
38429 $ref: '#/components/schemas/Annotation'
38433 $ref: '#/components/schemas/PropertyConstraint'
38447 $ref: '#/components/schemas/GetInputValueDataDefinition'
38451 $ref: '#/components/schemas/GetPolicyValueDataDefinition'
38462 isDeclaredListInput:
38466 mappedToComponentProperty:
38470 additionalProperties:
38481 parentPropertyType:
38487 propertyConstraints:
38496 $ref: '#/components/schemas/SchemaDefinition'
38498 $ref: '#/components/schemas/PropertyDataDefinition'
38503 subPropertyInputPath:
38505 subPropertyToscaFunctions:
38508 $ref: '#/components/schemas/SubPropertyToscaFunction'
38510 $ref: '#/components/schemas/ToscaFunction'
38512 $ref: '#/components/schemas/ToscaGetFunctionDataDefinition'
38513 toscaGetFunctionType:
38531 PropertyDefinitionDto:
38554 PropertyFilterConstraintDataDefinition:
38596 PropertyFilterDataDefinition:
38602 $ref: '#/components/schemas/PropertyFilterConstraintDataDefinition'
38639 numberOfCacheWorkers:
38642 syncIntervalInSecondes:
38645 waitOnShutDownInMinutes:
38665 $ref: '#/components/schemas/RelationshipImpl'
38667 $ref: '#/components/schemas/RelationshipImpl'
38670 requirementOwnerId:
38677 abstractResourceUniqueId:
38679 realVNFComponentInstance:
38680 $ref: '#/components/schemas/ComponentInstance'
38683 RequirementCapabilityRelDef:
38693 $ref: '#/components/schemas/CapabilityRequirementRelationship'
38698 RequirementDataDefinition:
38744 RequirementDefinition:
38790 RequirementNodeFilterCapabilityDataDefinition:
38803 $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition'
38808 RequirementSubstitutionFilterCapabilityDataDefinition:
38821 $ref: '#/components/schemas/ListDataDefinitionPropertyFilterDataDefinition'
38831 actualComponentType:
38833 additionalInformation:
38836 $ref: '#/components/schemas/AdditionalInformationDefinition'
38839 additionalProperties:
38840 $ref: '#/components/schemas/ArtifactDefinition'
38843 additionalProperties:
38852 additionalProperties:
38853 $ref: '#/components/schemas/ArtifactDefinition'
38857 $ref: '#/components/schemas/AttributeDefinition'
38860 additionalProperties:
38863 $ref: '#/components/schemas/CapabilityDefinition'
38867 $ref: '#/components/schemas/CategoryDefinition'
38868 categorySpecificMetadata:
38870 additionalProperties:
38872 componentInstances:
38875 $ref: '#/components/schemas/ComponentInstance'
38876 componentInstancesAttributes:
38878 additionalProperties:
38881 $ref: '#/components/schemas/ComponentInstanceAttribute'
38882 componentInstancesInputs:
38884 additionalProperties:
38887 $ref: '#/components/schemas/ComponentInstanceInput'
38888 componentInstancesInterfaces:
38890 additionalProperties:
38893 $ref: '#/components/schemas/ComponentInstanceInterface'
38894 componentInstancesOutputs:
38896 additionalProperties:
38899 $ref: '#/components/schemas/ComponentInstanceOutput'
38900 componentInstancesProperties:
38902 additionalProperties:
38905 $ref: '#/components/schemas/ComponentInstanceProperty'
38906 componentInstancesRelations:
38909 $ref: '#/components/schemas/RequirementCapabilityRelDef'
38910 componentMetadataForSupportLog:
38912 additionalProperties:
38919 - RESOURCE_INSTANCE
38944 $ref: '#/components/schemas/DataTypeDefinition'
38945 deploymentArtifacts:
38947 additionalProperties:
38948 $ref: '#/components/schemas/ArtifactDefinition'
38953 derivedFromGenericInfo:
38954 $ref: '#/components/schemas/Resource'
38955 derivedFromGenericType:
38957 derivedFromGenericVersion:
38959 derivedFromMapOfIdToName:
38961 additionalProperties:
38972 $ref: '#/components/schemas/GroupDefinition'
38977 importedToscaChecksum:
38982 $ref: '#/components/schemas/InputDefinition'
38985 additionalProperties:
38986 $ref: '#/components/schemas/InterfaceDefinition'
38994 lastUpdaterFullName:
39004 - NOT_CERTIFIED_CHECKIN
39005 - NOT_CERTIFIED_CHECKOUT
39010 nodeFilterComponents:
39012 additionalProperties:
39013 $ref: '#/components/schemas/CINodeFilterDataDefinition'
39019 $ref: '#/components/schemas/OutputDefinition'
39022 additionalProperties:
39023 $ref: '#/components/schemas/PolicyDefinition'
39029 $ref: '#/components/schemas/PropertyDefinition'
39032 additionalProperties:
39035 $ref: '#/components/schemas/RequirementDefinition'
39051 resourceVendorModelNumber:
39055 specificComponetTypeArtifacts:
39057 additionalProperties:
39058 $ref: '#/components/schemas/ArtifactDefinition'
39064 - NOT_CERTIFIED_CHECKIN
39065 - NOT_CERTIFIED_CHECKOUT
39067 substitutionFilter:
39068 $ref: '#/components/schemas/SubstitutionFilterDataDefinition'
39081 additionalProperties:
39082 $ref: '#/components/schemas/ArtifactDefinition'
39119 additionalProperties:
39120 $ref: '#/components/schemas/PropertyDataDefinition'
39122 $ref: '#/components/schemas/PropertyDataDefinition'
39133 actualComponentType:
39135 additionalInformation:
39138 $ref: '#/components/schemas/AdditionalInformationDefinition'
39141 additionalProperties:
39142 $ref: '#/components/schemas/ArtifactDefinition'
39145 additionalProperties:
39154 additionalProperties:
39155 $ref: '#/components/schemas/ArtifactDefinition'
39159 $ref: '#/components/schemas/AttributeDefinition'
39162 additionalProperties:
39165 $ref: '#/components/schemas/CapabilityDefinition'
39169 $ref: '#/components/schemas/CategoryDefinition'
39170 categorySpecificMetadata:
39172 additionalProperties:
39174 componentInstances:
39177 $ref: '#/components/schemas/ComponentInstance'
39178 componentInstancesAttributes:
39180 additionalProperties:
39183 $ref: '#/components/schemas/ComponentInstanceAttribute'
39184 componentInstancesInputs:
39186 additionalProperties:
39189 $ref: '#/components/schemas/ComponentInstanceInput'
39190 componentInstancesInterfaces:
39192 additionalProperties:
39195 $ref: '#/components/schemas/ComponentInstanceInterface'
39196 componentInstancesOutputs:
39198 additionalProperties:
39201 $ref: '#/components/schemas/ComponentInstanceOutput'
39202 componentInstancesProperties:
39204 additionalProperties:
39207 $ref: '#/components/schemas/ComponentInstanceProperty'
39208 componentInstancesRelations:
39211 $ref: '#/components/schemas/RequirementCapabilityRelDef'
39212 componentMetadataForSupportLog:
39214 additionalProperties:
39221 - RESOURCE_INSTANCE
39242 $ref: '#/components/schemas/DataTypeDefinition'
39243 deploymentArtifacts:
39245 additionalProperties:
39246 $ref: '#/components/schemas/ArtifactDefinition'
39247 derivedFromGenericInfo:
39248 $ref: '#/components/schemas/Resource'
39249 derivedFromGenericType:
39251 derivedFromGenericVersion:
39255 distributionStatus:
39258 - DISTRIBUTION_NOT_APPROVED
39260 ecompGeneratedNaming:
39262 environmentContext:
39266 additionalProperties:
39267 $ref: '#/components/schemas/ForwardingPathDataDefinition'
39271 $ref: '#/components/schemas/GroupDefinition'
39276 importedToscaChecksum:
39281 $ref: '#/components/schemas/InputDefinition'
39286 additionalProperties:
39287 $ref: '#/components/schemas/InterfaceDefinition'
39295 lastUpdaterFullName:
39303 - NOT_CERTIFIED_CHECKIN
39304 - NOT_CERTIFIED_CHECKOUT
39311 nodeFilterComponents:
39313 additionalProperties:
39314 $ref: '#/components/schemas/CINodeFilterDataDefinition'
39320 $ref: '#/components/schemas/OutputDefinition'
39323 additionalProperties:
39324 $ref: '#/components/schemas/PolicyDefinition'
39330 $ref: '#/components/schemas/PropertyDefinition'
39333 additionalProperties:
39336 $ref: '#/components/schemas/RequirementDefinition'
39339 serviceApiArtifacts:
39341 additionalProperties:
39342 $ref: '#/components/schemas/ArtifactDefinition'
39349 serviceVendorModelNumber:
39352 specificComponetTypeArtifacts:
39354 additionalProperties:
39355 $ref: '#/components/schemas/ArtifactDefinition'
39361 - NOT_CERTIFIED_CHECKIN
39362 - NOT_CERTIFIED_CHECKOUT
39364 substituteCandidate:
39366 substitutionFilter:
39367 $ref: '#/components/schemas/SubstitutionFilterDataDefinition'
39380 additionalProperties:
39381 $ref: '#/components/schemas/ArtifactDefinition'
39403 $ref: '#/components/schemas/NameIdPairWrapper'
39410 $ref: '#/components/schemas/NameIdPairWrapper'
39412 SubCategoryDefinition:
39420 $ref: '#/components/schemas/GroupingDefinition'
39428 $ref: '#/components/schemas/MetadataKeyDataDefinition'
39444 SubPropertyToscaFunction:
39452 $ref: '#/components/schemas/ToscaFunction'
39453 SubstitutionFilterDataDefinition:
39457 $ref: '#/components/schemas/ListDataDefinitionRequirementSubstitutionFilterCapabilityDataDefinition'
39470 $ref: '#/components/schemas/ListDataDefinitionSubstitutionFilterPropertyDataDefinition'
39477 SubstitutionFilterPropertyDataDefinition:
39483 $ref: '#/components/schemas/PropertyFilterConstraintDataDefinition'
39497 SwitchoverDetectorConfig:
39505 changePriorityPassword:
39507 changePriorityUser:
39522 additionalProperties:
39523 $ref: '#/components/schemas/GroupInfo'
39527 publishNetworkBody:
39531 ToscaArtifactDataDefinition:
39538 additionalProperties:
39559 ToscaGetFunctionDataDefinition:
39570 propertyPathFromSource:
39599 ToscaValidatorsConfig:
39610 constraintOperator:
39614 servicePropertyName:
39655 - PRODUCT_STRATEGIST