1. Overview
1.1. Version information
Version : 5.1.0-SNAPSHOT
1.2. URI scheme
Host : localhost:44217
BasePath : /restservices/clds/
Schemes : HTTP
2. Paths
2.1. GET /v1/healthcheck
2.1.1. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.1.2. Produces
-
application/json
2.2. GET /v1/user/getUser
2.2.1. Responses
| HTTP Code | Schema |
|---|---|
200 |
No Content |
2.2.2. Produces
-
text/plain
2.3. GET /v2/clampInformation
2.3.1. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.3.2. Produces
-
application/json
2.4. GET /v2/dictionary
2.4.1. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.4.2. Produces
-
application/json
2.5. PUT /v2/dictionary
2.5.1. Parameters
| Type | Name | Schema |
|---|---|---|
Body |
body |
2.5.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.5.3. Consumes
-
application/json
2.5.4. Produces
-
application/json
2.6. GET /v2/dictionary/secondary/names
2.6.1. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
< string > array |
2.6.2. Produces
-
application/json
2.7. GET /v2/dictionary/{dictionaryName}
2.7.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
dictionaryName |
string |
2.7.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.7.3. Produces
-
application/json
2.8. PUT /v2/dictionary/{name}
2.8.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
name |
string |
Body |
body |
2.8.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.8.3. Consumes
-
application/json
2.8.4. Produces
-
application/json
2.9. DELETE /v2/dictionary/{name}
2.9.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
name |
string |
2.9.2. Responses
| HTTP Code | Schema |
|---|---|
200 |
No Content |
2.9.3. Produces
-
application/json
2.10. DELETE /v2/dictionary/{name}/elements/{shortName}
2.10.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
name |
string |
Path |
shortName |
string |
2.10.2. Responses
| HTTP Code | Schema |
|---|---|
200 |
No Content |
2.10.3. Produces
-
application/json
2.11. PUT /v2/loop/addOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}
2.11.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
Path |
policyType |
string |
Path |
policyVersion |
string |
2.11.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.11.3. Produces
-
application/json
2.12. POST /v2/loop/create/{loopName}?templateName={templateName}
2.12.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName}?templateName={templateName |
string |
2.12.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.12.3. Consumes
-
application/json
2.12.4. Produces
-
application/json
2.13. PUT /v2/loop/delete/{loopName}
2.13.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
2.13.2. Responses
| HTTP Code | Schema |
|---|---|
200 |
No Content |
2.14. PUT /v2/loop/deploy/{loopName}
2.14.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
2.14.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.14.3. Produces
-
application/json
2.15. GET /v2/loop/getAllNames
2.15.1. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
< string > array |
2.15.2. Produces
-
application/json
2.16. GET /v2/loop/getstatus/{loopName}
2.16.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
2.16.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.16.3. Produces
-
application/json
2.17. PUT /v2/loop/refreshMicroServicePolicyJsonSchema/{loopName}/{microServicePolicyName}
2.17.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
Path |
microServicePolicyName |
string |
2.17.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.17.3. Produces
-
application/json
2.18. PUT /v2/loop/refreshOperationalPolicyJsonSchema/{loopName}/{operationalPolicyName}
2.18.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
Path |
operationalPolicyName |
string |
2.18.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.18.3. Produces
-
application/json
2.19. PUT /v2/loop/removeOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}/{policyName}
2.19.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
Path |
policyName |
string |
Path |
policyType |
string |
Path |
policyVersion |
string |
2.19.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.19.3. Produces
-
application/json
2.20. PUT /v2/loop/restart/{loopName}
2.20.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
2.20.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.20.3. Produces
-
application/json
2.21. PUT /v2/loop/stop/{loopName}
2.21.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
2.21.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.21.3. Produces
-
application/json
2.22. PUT /v2/loop/submit/{loopName}
2.22.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
2.22.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.22.3. Produces
-
application/json
2.23. PUT /v2/loop/undeploy/{loopName}
2.23.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
2.23.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.23.3. Produces
-
application/json
2.24. POST /v2/loop/updateGlobalProperties/{loopName}
2.24.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
Body |
body |
2.24.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.24.3. Consumes
-
application/json
2.24.4. Produces
-
application/json
2.25. POST /v2/loop/updateMicroservicePolicy/{loopName}
2.25.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
Body |
body |
2.25.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.25.3. Consumes
-
application/json
2.25.4. Produces
-
application/json
2.26. POST /v2/loop/updateOperationalPolicies/{loopName}
2.26.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
Body |
body |
2.26.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.26.3. Consumes
-
application/json
2.26.4. Produces
-
application/json
2.27. GET /v2/loop/{loopName}
2.27.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
loopName |
string |
2.27.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.27.3. Produces
-
application/json
2.28. POST /v2/policyToscaModels
2.28.1. Parameters
| Type | Name | Schema |
|---|---|---|
Body |
body |
string |
2.28.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.28.3. Consumes
-
plain/text
2.28.4. Produces
-
application/json
2.29. GET /v2/policyToscaModels
2.29.1. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.29.2. Produces
-
application/json
2.30. GET /v2/policyToscaModels/yaml/{policyModelType}/{policyModelVersion}
2.30.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
policyModelType |
string |
Path |
policyModelVersion |
string |
2.30.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
string |
2.30.3. Produces
-
application/json
2.31. GET /v2/policyToscaModels/{policyModelType}/{policyModelVersion}
2.31.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
policyModelType |
string |
Path |
policyModelVersion |
string |
2.31.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.31.3. Produces
-
application/json
2.32. PUT /v2/policyToscaModels/{policyModelType}/{policyModelVersion}
2.32.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
policyModelType |
string |
Path |
policyModelVersion |
string |
Body |
body |
string |
2.32.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.32.3. Consumes
-
plain/text
2.32.4. Produces
-
application/json
2.33. GET /v2/templates
2.33.1. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.33.2. Produces
-
application/json
2.34. GET /v2/templates/names
2.34.1. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
< string > array |
2.34.2. Produces
-
application/json
2.35. GET /v2/templates/{templateName}
2.35.1. Parameters
| Type | Name | Schema |
|---|---|---|
Path |
templateName |
string |
2.35.2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Output type |
2.35.3. Produces
-
application/json
3. Definitions
3.1. ClampInformation
| Name | Schema |
|---|---|
allPermissions |
< string > array |
cldsVersion |
string |
userName |
string |
3.2. CldsHealthCheck
| Name | Schema |
|---|---|
description |
string |
healthCheckComponent |
string |
healthCheckStatus |
string |
3.3. Dictionary
| Name | Schema |
|---|---|
createdBy |
string |
createdDate |
integer (int64) |
dictionaryElements |
< DictionaryElement > array |
name |
string |
secondLevelDictionary |
integer (int32) |
subDictionaryType |
string |
updatedBy |
string |
updatedDate |
integer (int64) |
3.4. DictionaryElement
| Name | Schema |
|---|---|
createdBy |
string |
createdDate |
integer (int64) |
description |
string |
name |
string |
shortName |
string |
subDictionary |
string |
type |
string |
updatedBy |
string |
updatedDate |
integer (int64) |
usedByDictionaries |
< Dictionary > array |
3.5. ExternalComponent
| Name | Schema |
|---|---|
componentName |
string |
state |
3.6. ExternalComponentState
| Name | Schema |
|---|---|
description |
string |
level |
integer (int32) |
stateName |
string |
3.7. 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.8. 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.9. 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.10. 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.11. Loop
| Name | Schema |
|---|---|
components |
< string, ExternalComponent > map |
createdBy |
string |
createdDate |
integer (int64) |
dcaeDeploymentId |
string |
dcaeDeploymentStatusUrl |
string |
globalPropertiesJson |
|
lastComputedState |
enum (DESIGN, SUBMITTED, DEPLOYED, RUNNING, STOPPED, IN_ERROR, WAITING) |
loopLogs |
< LoopLog > array |
loopTemplate |
|
microServicePolicies |
< MicroServicePolicy > array |
modelService |
|
name |
string |
operationalPolicies |
< OperationalPolicy > array |
updatedBy |
string |
updatedDate |
integer (int64) |
3.12. LoopElementModel
| Name | Schema |
|---|---|
blueprint |
string |
createdBy |
string |
createdDate |
integer (int64) |
dcaeBlueprintId |
string |
loopElementType |
string |
name |
string |
policyModels |
< PolicyModel > array |
shortName |
string |
updatedBy |
string |
updatedDate |
integer (int64) |
usedByLoopTemplates |
< LoopTemplateLoopElementModel > array |
3.13. LoopLog
| Name | Schema |
|---|---|
id |
integer (int64) |
logComponent |
string |
logInstant |
integer (int64) |
logType |
enum (INFO, WARNING, ERROR) |
loop |
|
message |
string |
3.14. LoopTemplate
| Name | Schema |
|---|---|
allowedLoopType |
enum (OPEN, CLOSED, HYBRID) |
blueprint |
string |
createdBy |
string |
createdDate |
integer (int64) |
dcaeBlueprintId |
string |
loopElementModelsUsed |
< LoopTemplateLoopElementModel > array |
maximumInstancesAllowed |
integer (int32) |
modelService |
|
name |
string |
uniqueBlueprint |
boolean |
updatedBy |
string |
updatedDate |
integer (int64) |
3.15. LoopTemplateLoopElementModel
| Name | Schema |
|---|---|
flowOrder |
integer (int32) |
loopElementModel |
|
loopTemplate |
3.16. MicroServicePolicy
| Name | Schema |
|---|---|
configurationsJson |
|
context |
string |
createdBy |
string |
createdDate |
integer (int64) |
dcaeBlueprintId |
string |
dcaeDeploymentId |
string |
dcaeDeploymentStatusUrl |
string |
deviceTypeScope |
string |
jsonRepresentation |
|
legacy |
boolean |
loopElementModel |
|
name |
string |
pdpGroup |
string |
pdpSubgroup |
string |
policyModel |
|
shared |
boolean |
updatedBy |
string |
updatedDate |
integer (int64) |
usedByLoops |
< Loop > array |
3.17. Number
Type : object
3.18. OperationalPolicy
| Name | Schema |
|---|---|
configurationsJson |
|
createdBy |
string |
createdDate |
integer (int64) |
jsonRepresentation |
|
legacy |
boolean |
loop |
|
loopElementModel |
|
name |
string |
pdpGroup |
string |
pdpSubgroup |
string |
policyModel |
|
updatedBy |
string |
updatedDate |
integer (int64) |
3.19. PolicyModel
| Name | Schema |
|---|---|
createdBy |
string |
createdDate |
integer (int64) |
policyAcronym |
string |
policyModelTosca |
string |
policyModelType |
string |
policyPdpGroup |
|
updatedBy |
string |
updatedDate |
integer (int64) |
usedByElementModels |
< LoopElementModel > array |
version |
string |
3.20. Service
| Name | Schema |
|---|---|
name |
string |
resourceDetails |
|
serviceDetails |
|
serviceUuid |
string |
version |
string |