1. Overview
1.1. Version information
Version : 3.0.1-SNAPSHOT
1.2. URI scheme
Host : 0.0.0.0
BasePath : /restservices/clds/v1/
Schemes : HTTP
2. Paths
2.1. PUT /clds/action/{action}/{modelName}?test={test}
2.1.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
action |
string |
Path |
modelName}?test={test |
string |
Body |
body |
2.1.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.1.3. Consumes
-
application/json
2.1.4. Produces
-
application/json
2.2. GET /clds/cldsDetails
2.2.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.2.2. Produces
-
application/json
2.3. GET /clds/cldsInfo
2.3.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.3.2. Produces
-
application/json
2.4. POST /clds/dcae/event?test={test}
2.4.1. Parameters
Type | Name | Schema |
---|---|---|
Body |
body |
2.4.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.4.3. Consumes
-
application/json
2.4.4. Produces
-
application/json
2.5. PUT /clds/deploy/{modelName}
2.5.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
modelName |
string |
Body |
body |
2.5.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.5.3. Consumes
-
application/json
2.5.4. Produces
-
application/json
2.6. GET /clds/model-names
2.6.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.6.2. Produces
-
application/json
2.7. GET /clds/model/bpmn/{modelName}
2.7.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
modelName |
string |
2.7.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.7.3. Produces
-
text/xml
2.8. GET /clds/model/image/{modelName}
2.8.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
modelName |
string |
2.8.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.8.3. Produces
-
text/xml
2.9. GET /clds/model/{modelName}
2.9.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
modelName |
string |
2.9.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.9.3. Produces
-
application/json
2.10. PUT /clds/model/{modelName}
2.10.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
modelName |
string |
Body |
body |
2.10.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.10.3. Consumes
-
application/json
2.10.4. Produces
-
application/json
2.11. GET /clds/properties
2.11.1. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.11.2. Produces
-
application/json
2.12. GET /clds/properties/{serviceInvariantUUID}?refresh={refresh}
2.12.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
serviceInvariantUUID}?refresh={refresh |
string |
2.12.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.12.3. Produces
-
application/json
2.13. GET /clds/sdc/services
2.13.1. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.13.2. Produces
-
application/json
2.14. PUT /clds/undeploy/{modelName}
2.14.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
modelName |
string |
Body |
body |
2.14.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.14.3. Consumes
-
application/json
2.14.4. Produces
-
application/json
2.15. GET /cldsTempate/template-names
2.15.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.15.2. Produces
-
application/json
2.16. GET /cldsTempate/template/bpmn/{templateName}
2.16.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
templateName |
string |
2.16.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.16.3. Produces
-
text/xml
2.17. GET /cldsTempate/template/image/{templateName}
2.17.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
templateName |
string |
2.17.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.17.3. Produces
-
text/xml
2.18. GET /cldsTempate/template/{templateName}
2.18.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
templateName |
string |
2.18.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.18.3. Produces
-
application/json
2.19. PUT /cldsTempate/template/{templateName}
2.19.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
templateName |
string |
Body |
body |
2.19.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.19.3. Consumes
-
application/json
2.19.4. Produces
-
application/json
2.20. GET /dictionary
2.20.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.20.2. Produces
-
application/json
2.21. PUT /dictionary/{dictionaryName}
2.21.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
dictionaryName |
string |
Body |
body |
2.21.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.21.3. Consumes
-
application/json
2.21.4. Produces
-
application/json
2.22. GET /dictionary/{dictionaryName}/items
2.22.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
dictionaryName |
string |
2.22.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.22.3. Produces
-
application/json
2.23. PUT /dictionary/{dictionaryName}/items
2.23.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
dictionaryName |
string |
Body |
body |
2.23.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.23.3. Consumes
-
application/json
2.23.4. Produces
-
application/json
2.24. GET /healthcheck
2.24.1. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.24.2. Produces
-
application/json
2.25. GET /tosca/models
2.25.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.25.2. Produces
-
application/json
2.26. GET /tosca/models/policyType/{policyType}
2.26.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
policyType |
string |
2.26.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.26.3. Produces
-
application/json
2.27. GET /tosca/models/{toscaModelName}
2.27.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
toscaModelName |
string |
2.27.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.27.3. Produces
-
application/json
2.28. PUT /tosca/models/{toscaModelName}
2.28.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
toscaModelName |
string |
Body |
body |
2.28.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.28.3. Consumes
-
application/json
2.28.4. Produces
-
application/json
2.29. GET /user/getUser
2.29.1. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.29.2. Produces
-
text/plain
3. Definitions
3.1. CldsDictionary
Name | Schema |
---|---|
cldsDictionaryItems |
< CldsDictionaryItem > array |
createdBy |
string |
dictionaryId |
string |
dictionaryName |
string |
lastUpdatedDate |
string |
updatedBy |
string |
3.2. CldsDictionaryItem
Name | Schema |
---|---|
createdBy |
string |
dictElementDesc |
string |
dictElementId |
string |
dictElementName |
string |
dictElementShortName |
string |
dictElementType |
string |
dictionaryId |
string |
lastUpdatedDate |
string |
updatedBy |
string |
3.3. CldsEvent
Name | Schema |
---|---|
actionCd |
string |
actionStateCd |
string |
id |
string |
processInstanceId |
string |
userid |
string |
3.4. CldsInfo
Name | Schema |
---|---|
cldsVersion |
string |
permissionReadCl |
boolean |
permissionReadTemplate |
boolean |
permissionReadTosca |
boolean |
permissionUpdateCl |
boolean |
permissionUpdateTemplate |
boolean |
permissionUpdateTosca |
boolean |
userName |
string |
3.5. CldsModel
Name | Schema |
---|---|
blueprintText |
string |
bpmnText |
string |
cldsModelInstanceList |
< CldsModelInstance > array |
controlName |
string |
controlNamePrefix |
string |
controlNameUuid |
string |
deploymentId |
string |
docText |
string |
errorMessageForUi |
string |
event |
|
id |
string |
imageText |
string |
name |
string |
permittedActionCd |
< string > array |
propText |
string |
status |
string |
templateId |
string |
templateName |
string |
typeId |
string |
typeName |
string |
3.6. CldsModelInstance
Name | Schema |
---|---|
location |
string |
modelInstanceId |
string |
vmName |
string |
3.7. CldsMonitoringDetails
Name | Schema |
---|---|
action |
string |
closeloopName |
string |
deploymentId |
string |
modelName |
string |
serviceTypeId |
string |
templateName |
string |
timestamp |
string |
userid |
string |
3.8. CldsTemplate
Name | Schema |
---|---|
bpmnId |
string |
bpmnText |
string |
bpmnUserid |
string |
controlNamePrefix |
string |
controlNameUuid |
string |
id |
string |
imageId |
string |
imageText |
string |
imageUserid |
string |
name |
string |
propId |
string |
propText |
string |
propUserid |
string |
userAuthorizedToUpdate |
boolean |
3.9. CldsToscaModel
Name | Schema |
---|---|
createdDate |
string |
id |
string |
lastUpdatedDate |
string |
policyType |
string |
revisionId |
string |
toscaModelJson |
string |
toscaModelName |
string |
toscaModelYaml |
string |
userId |
string |
version |
number (double) |
3.10. DcaeEvent
Name | Schema |
---|---|
artifactName |
string |
cldsActionCd |
string |
controlName |
string |
event |
string |
instances |
< CldsModelInstance > array |
resourceUUID |
string |
serviceUUID |
string |
3.11. ValueItem
Name | Schema |
---|---|
value |
string |