1. Overview
1.1. Version information
Version : 4.1.1-SNAPSHOT
1.2. URI scheme
Host : localhost:43819
BasePath : /restservices/clds/
Schemes : HTTP
2. Paths
2.1. PUT /v1/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 /v1/clds/cldsDetails
2.2.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.2.2. Produces
-
application/json
2.3. GET /v1/clds/cldsInfo
2.3.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.3.2. Produces
-
application/json
2.4. POST /v1/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 /v1/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 /v1/clds/model-names
2.6.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.6.2. Produces
-
application/json
2.7. GET /v1/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 /v1/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 /v1/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 /v1/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 /v1/clds/properties
2.11.1. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.11.2. Produces
-
application/json
2.12. PUT /v1/clds/undeploy/{modelName}
2.12.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
modelName |
string |
Body |
body |
2.12.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.12.3. Consumes
-
application/json
2.12.4. Produces
-
application/json
2.13. GET /v1/cldsTempate/template-names
2.13.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.13.2. Produces
-
application/json
2.14. GET /v1/cldsTempate/template/bpmn/{templateName}
2.14.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
templateName |
string |
2.14.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.14.3. Produces
-
text/xml
2.15. GET /v1/cldsTempate/template/image/{templateName}
2.15.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
templateName |
string |
2.15.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.15.3. Produces
-
text/xml
2.16. GET /v1/cldsTempate/template/{templateName}
2.16.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
templateName |
string |
2.16.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.16.3. Produces
-
application/json
2.17. PUT /v1/cldsTempate/template/{templateName}
2.17.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
templateName |
string |
Body |
body |
2.17.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.17.3. Consumes
-
application/json
2.17.4. Produces
-
application/json
2.18. GET /v1/dictionary
2.18.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.18.2. Produces
-
application/json
2.19. PUT /v1/dictionary/{dictionaryName}
2.19.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
dictionaryName |
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 /v1/dictionary/{dictionaryName}/items
2.20.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
dictionaryName |
string |
2.20.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.20.3. Produces
-
application/json
2.21. PUT /v1/dictionary/{dictionaryName}/items
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 /v1/healthcheck
2.22.1. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.22.2. Produces
-
application/json
2.23. GET /v1/tosca/models
2.23.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.23.2. Produces
-
application/json
2.24. GET /v1/tosca/models/policyType/{policyType}
2.24.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
policyType |
string |
2.24.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.24.3. Produces
-
application/json
2.25. GET /v1/tosca/models/{toscaModelName}
2.25.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
toscaModelName |
string |
2.25.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.25.3. Produces
-
application/json
2.26. PUT /v1/tosca/models/{toscaModelName}
2.26.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
toscaModelName |
string |
Body |
body |
2.26.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.26.3. Consumes
-
application/json
2.26.4. Produces
-
application/json
2.27. GET /v1/user/getUser
2.27.1. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.27.2. Produces
-
text/plain
2.28. PUT /v2/loop/delete/{loopName}
2.28.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.28.2. Responses
HTTP Code | Schema |
---|---|
200 |
No Content |
2.29. PUT /v2/loop/deploy/{loopName}
2.29.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.29.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.29.3. Produces
-
application/json
2.30. GET /v2/loop/getAllNames
2.30.1. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
< string > array |
2.30.2. Produces
-
application/json
2.31. GET /v2/loop/getstatus/{loopName}
2.31.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.31.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.31.3. Produces
-
application/json
2.32. PUT /v2/loop/restart/{loopName}
2.32.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.32.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.32.3. Produces
-
application/json
2.33. PUT /v2/loop/stop/{loopName}
2.33.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.33.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.33.3. Produces
-
application/json
2.34. PUT /v2/loop/submit/{loopName}
2.34.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.34.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.34.3. Produces
-
application/json
2.35. GET /v2/loop/svgRepresentation/{loopName}
2.35.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.35.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
string |
2.35.3. Produces
-
application/xml
2.36. PUT /v2/loop/undeploy/{loopName}
2.36.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.36.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.36.3. Produces
-
application/json
2.37. POST /v2/loop/updateGlobalProperties/{loopName}
2.37.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
Body |
body |
2.37.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.37.3. Consumes
-
application/json
2.37.4. Produces
-
application/json
2.38. POST /v2/loop/updateMicroservicePolicy/{loopName}
2.38.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
Body |
body |
2.38.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.38.3. Consumes
-
application/json
2.38.4. Produces
-
application/json
2.39. POST /v2/loop/updateOperationalPolicies/{loopName}
2.39.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
Body |
body |
2.39.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.39.3. Consumes
-
application/json
2.39.4. Produces
-
application/json
2.40. GET /v2/loop/{loopName}
2.40.1. Parameters
Type | Name | Schema |
---|---|---|
Path |
loopName |
string |
2.40.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Output type |
2.40.3. Produces
-
application/json
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 |
deploymentStatusUrl |
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 |
modelId |
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. ExternalComponent
Name | Schema |
---|---|
componentName |
string |
state |
3.12. ExternalComponentState
Name | Schema |
---|---|
description |
string |
level |
integer (int32) |
stateName |
string |
3.13. JsonArray
Name | Schema |
---|---|
asBigDecimal |
number |
asBigInteger |
integer |
asBoolean |
boolean |
asByte |
string (byte) |
asCharacter |
string |
asDouble |
number (double) |
asFloat |
number (float) |
asInt |
integer (int32) |
asJsonArray |
|
asJsonNull |
|
asJsonObject |
|
asJsonPrimitive |
|
asLong |
integer (int64) |
asNumber |
|
asShort |
integer (int32) |
asString |
string |
jsonArray |
boolean |
jsonNull |
boolean |
jsonObject |
boolean |
jsonPrimitive |
boolean |
3.14. JsonNull
Name | Schema |
---|---|
asBigDecimal |
number |
asBigInteger |
integer |
asBoolean |
boolean |
asByte |
string (byte) |
asCharacter |
string |
asDouble |
number (double) |
asFloat |
number (float) |
asInt |
integer (int32) |
asJsonArray |
|
asJsonNull |
|
asJsonObject |
|
asJsonPrimitive |
|
asLong |
integer (int64) |
asNumber |
|
asShort |
integer (int32) |
asString |
string |
jsonArray |
boolean |
jsonNull |
boolean |
jsonObject |
boolean |
jsonPrimitive |
boolean |
3.15. JsonObject
Name | Schema |
---|---|
asBigDecimal |
number |
asBigInteger |
integer |
asBoolean |
boolean |
asByte |
string (byte) |
asCharacter |
string |
asDouble |
number (double) |
asFloat |
number (float) |
asInt |
integer (int32) |
asJsonArray |
|
asJsonNull |
|
asJsonObject |
|
asJsonPrimitive |
|
asLong |
integer (int64) |
asNumber |
|
asShort |
integer (int32) |
asString |
string |
jsonArray |
boolean |
jsonNull |
boolean |
jsonObject |
boolean |
jsonPrimitive |
boolean |
3.16. JsonPrimitive
Name | Schema |
---|---|
asBigDecimal |
number |
asBigInteger |
integer |
asBoolean |
boolean |
asByte |
string (byte) |
asCharacter |
string |
asDouble |
number (double) |
asFloat |
number (float) |
asInt |
integer (int32) |
asJsonArray |
|
asJsonNull |
|
asJsonObject |
|
asJsonPrimitive |
|
asLong |
integer (int64) |
asNumber |
|
asShort |
integer (int32) |
asString |
string |
boolean |
boolean |
jsonArray |
boolean |
jsonNull |
boolean |
jsonObject |
boolean |
jsonPrimitive |
boolean |
number |
boolean |
string |
boolean |
3.17. Loop
Name | Schema |
---|---|
blueprint |
string |
components |
< string, ExternalComponent > map |
dcaeBlueprintId |
string |
dcaeDeploymentId |
string |
dcaeDeploymentStatusUrl |
string |
globalPropertiesJson |
|
lastComputedState |
enum (DESIGN, SUBMITTED, DEPLOYED, RUNNING, STOPPED, IN_ERROR, WAITING) |
loopLogs |
< LoopLog > array |
microServicePolicies |
< MicroServicePolicy > array |
modelPropertiesJson |
|
name |
string |
operationalPolicies |
< OperationalPolicy > array |
svgRepresentation |
string |
3.18. LoopLog
Name | Schema |
---|---|
id |
integer (int64) |
logComponent |
string |
logInstant |
integer (int64) |
logType |
enum (INFO, WARNING, ERROR) |
loop |
|
message |
string |
3.19. MicroServicePolicy
Name | Schema |
---|---|
jsonRepresentation |
|
modelType |
string |
name |
string |
policyTosca |
string |
properties |
|
shared |
boolean |
usedByLoops |
< Loop > array |
3.20. Number
Type : object
3.21. OperationalPolicy
Name | Schema |
---|---|
configurationsJson |
|
jsonRepresentation |
|
loop |
|
name |
string |
3.22. ValueItem
Name | Schema |
---|---|
value |
string |