1. Overview

1.1. Version information

Version : 5.0.0-SNAPSHOT

1.2. URI scheme

Host : localhost:33699
BasePath : /restservices/clds/
Schemes : HTTP

2. Paths

2.1. GET /v1/clds/cldsInfo

2.1.1. Responses

HTTP Code Description Schema

200

Output type

CldsInfo

2.1.2. Produces

  • application/json

2.2. GET /v1/healthcheck

2.2.1. Responses

HTTP Code Description Schema

200

Output type

CldsHealthCheck

2.2.2. Produces

  • application/json

2.3. GET /v1/user/getUser

2.3.1. Responses

HTTP Code Schema

200

No Content

2.3.2. Produces

  • text/plain

2.4. GET /v2/dictionary

2.4.1. Responses

HTTP Code Description Schema

200

Output type

Dictionary

2.4.2. Produces

  • application/json

2.5. PUT /v2/dictionary

2.5.1. Parameters

Type Name Schema

Body

body
required

Dictionary

2.5.2. Responses

HTTP Code Description Schema

200

Output type

Dictionary

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
required

string

2.7.2. Responses

HTTP Code Description Schema

200

Output type

Dictionary

2.7.3. Produces

  • application/json

2.8. PUT /v2/dictionary/{name}

2.8.1. Parameters

Type Name Schema

Path

name
required

string

Body

body
required

Dictionary

2.8.2. Responses

HTTP Code Description Schema

200

Output type

Dictionary

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
required

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
required

string

Path

shortName
required

string

2.10.2. Responses

HTTP Code Schema

200

No Content

2.10.3. Produces

  • application/json

2.11. PUT /v2/loop/delete/{loopName}

2.11.1. Parameters

Type Name Schema

Path

loopName
required

string

2.11.2. Responses

HTTP Code Schema

200

No Content

2.12. PUT /v2/loop/deploy/{loopName}

2.12.1. Parameters

Type Name Schema

Path

loopName
required

string

2.12.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.12.3. Produces

  • application/json

2.13. GET /v2/loop/getAllNames

2.13.1. Responses

HTTP Code Description Schema

200

Output type

< string > array

2.13.2. Produces

  • application/json

2.14. GET /v2/loop/getstatus/{loopName}

2.14.1. Parameters

Type Name Schema

Path

loopName
required

string

2.14.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.14.3. Produces

  • application/json

2.15. PUT /v2/loop/refreshOpPolicyJsonSchema/{loopName}

2.15.1. Parameters

Type Name Schema

Path

loopName
required

string

2.15.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.15.3. Produces

  • application/json

2.16. PUT /v2/loop/restart/{loopName}

2.16.1. Parameters

Type Name Schema

Path

loopName
required

string

2.16.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.16.3. Produces

  • application/json

2.17. PUT /v2/loop/stop/{loopName}

2.17.1. Parameters

Type Name Schema

Path

loopName
required

string

2.17.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.17.3. Produces

  • application/json

2.18. PUT /v2/loop/submit/{loopName}

2.18.1. Parameters

Type Name Schema

Path

loopName
required

string

2.18.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.18.3. Produces

  • application/json

2.19. GET /v2/loop/svgRepresentation/{loopName}

2.19.1. Parameters

Type Name Schema

Path

loopName
required

string

2.19.2. Responses

HTTP Code Description Schema

200

Output type

string

2.19.3. Produces

  • application/xml

2.20. PUT /v2/loop/undeploy/{loopName}

2.20.1. Parameters

Type Name Schema

Path

loopName
required

string

2.20.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.20.3. Produces

  • application/json

2.21. POST /v2/loop/updateGlobalProperties/{loopName}

2.21.1. Parameters

Type Name Schema

Path

loopName
required

string

Body

body
required

JsonObject

2.21.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.21.3. Consumes

  • application/json

2.21.4. Produces

  • application/json

2.22. POST /v2/loop/updateMicroservicePolicy/{loopName}

2.22.1. Parameters

Type Name Schema

Path

loopName
required

string

Body

body
required

MicroServicePolicy

2.22.2. Responses

HTTP Code Description Schema

200

Output type

MicroServicePolicy

2.22.3. Consumes

  • application/json

2.22.4. Produces

  • application/json

2.23. POST /v2/loop/updateOperationalPolicies/{loopName}

2.23.1. Parameters

Type Name Schema

Path

loopName
required

string

Body

body
required

JsonArray

2.23.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.23.3. Consumes

  • application/json

2.23.4. Produces

  • application/json

2.24. GET /v2/loop/{loopName}

2.24.1. Parameters

Type Name Schema

Path

loopName
required

string

2.24.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.24.3. Produces

  • application/json

2.25. GET /v2/policyToscaModels

2.25.1. Responses

HTTP Code Description Schema

200

Output type

PolicyModel

2.25.2. Produces

  • application/json

2.26. GET /v2/policyToscaModels/yaml/{policyModelType}

2.26.1. Parameters

Type Name Schema

Path

policyModelType
required

string

2.26.2. Responses

HTTP Code Description Schema

200

Output type

string

2.26.3. Produces

  • application/json

2.27. GET /v2/policyToscaModels/{policyModelType}

2.27.1. Parameters

Type Name Schema

Path

policyModelType
required

string

2.27.2. Responses

HTTP Code Description Schema

200

Output type

PolicyModel

2.27.3. Produces

  • application/json

2.28. PUT /v2/policyToscaModels/{policyModelType}

2.28.1. Parameters

Type Name Schema

Path

policyModelType
required

string

Body

body
required

string

2.28.2. Responses

HTTP Code Description Schema

200

Output type

PolicyModel

2.28.3. Consumes

  • plain/text

2.28.4. Produces

  • application/json

2.29. GET /v2/templates

2.29.1. Responses

HTTP Code Description Schema

200

Output type

LoopTemplate

2.29.2. Produces

  • application/json

2.30. GET /v2/templates/names

2.30.1. Responses

HTTP Code Description Schema

200

Output type

< string > array

2.30.2. Produces

  • application/json

2.31. GET /v2/templates/{templateName}

2.31.1. Parameters

Type Name Schema

Path

templateName
required

string

2.31.2. Responses

HTTP Code Description Schema

200

Output type

LoopTemplate

2.31.3. Produces

  • application/json

3. Definitions

3.1. CldsHealthCheck

Name Schema

description
optional

string

healthCheckComponent
optional

string

healthCheckStatus
optional

string

3.2. CldsInfo

Name Schema

cldsVersion
optional

string

permissionReadCl
optional

boolean

permissionReadTemplate
optional

boolean

permissionReadTosca
optional

boolean

permissionUpdateCl
optional

boolean

permissionUpdateTemplate
optional

boolean

permissionUpdateTosca
optional

boolean

userName
optional

string

3.3. Dictionary

Name Schema

createdBy
optional

string

createdDate
optional

integer (int64)

dictionaryElements
optional

< DictionaryElement > array

name
optional

string

secondLevelDictionary
optional

integer (int32)

subDictionaryType
optional

string

updatedBy
optional

string

updatedDate
optional

integer (int64)

3.4. DictionaryElement

Name Schema

createdBy
optional

string

createdDate
optional

integer (int64)

description
optional

string

name
optional

string

shortName
optional

string

subDictionary
optional

string

type
optional

string

updatedBy
optional

string

updatedDate
optional

integer (int64)

usedByDictionaries
optional

< Dictionary > array

3.5. ExternalComponent

Name Schema

componentName
optional

string

state
optional

ExternalComponentState

3.6. ExternalComponentState

Name Schema

description
optional

string

level
optional

integer (int32)

stateName
optional

string

3.7. JsonArray

Name Schema

asBigDecimal
optional

number

asBigInteger
optional

integer

asBoolean
optional

boolean

asByte
optional

string (byte)

asCharacter
optional

string

asDouble
optional

number (double)

asFloat
optional

number (float)

asInt
optional

integer (int32)

asJsonArray
optional

JsonArray

asJsonNull
optional

JsonNull

asJsonObject
optional

JsonObject

asJsonPrimitive
optional

JsonPrimitive

asLong
optional

integer (int64)

asNumber
optional

Number

asShort
optional

integer (int32)

asString
optional

string

jsonArray
optional

boolean

jsonNull
optional

boolean

jsonObject
optional

boolean

jsonPrimitive
optional

boolean

3.8. JsonNull

Name Schema

asBigDecimal
optional

number

asBigInteger
optional

integer

asBoolean
optional

boolean

asByte
optional

string (byte)

asCharacter
optional

string

asDouble
optional

number (double)

asFloat
optional

number (float)

asInt
optional

integer (int32)

asJsonArray
optional

JsonArray

asJsonNull
optional

JsonNull

asJsonObject
optional

JsonObject

asJsonPrimitive
optional

JsonPrimitive

asLong
optional

integer (int64)

asNumber
optional

Number

asShort
optional

integer (int32)

asString
optional

string

jsonArray
optional

boolean

jsonNull
optional

boolean

jsonObject
optional

boolean

jsonPrimitive
optional

boolean

3.9. JsonObject

Name Schema

asBigDecimal
optional

number

asBigInteger
optional

integer

asBoolean
optional

boolean

asByte
optional

string (byte)

asCharacter
optional

string

asDouble
optional

number (double)

asFloat
optional

number (float)

asInt
optional

integer (int32)

asJsonArray
optional

JsonArray

asJsonNull
optional

JsonNull

asJsonObject
optional

JsonObject

asJsonPrimitive
optional

JsonPrimitive

asLong
optional

integer (int64)

asNumber
optional

Number

asShort
optional

integer (int32)

asString
optional

string

jsonArray
optional

boolean

jsonNull
optional

boolean

jsonObject
optional

boolean

jsonPrimitive
optional

boolean

3.10. JsonPrimitive

Name Schema

asBigDecimal
optional

number

asBigInteger
optional

integer

asBoolean
optional

boolean

asByte
optional

string (byte)

asCharacter
optional

string

asDouble
optional

number (double)

asFloat
optional

number (float)

asInt
optional

integer (int32)

asJsonArray
optional

JsonArray

asJsonNull
optional

JsonNull

asJsonObject
optional

JsonObject

asJsonPrimitive
optional

JsonPrimitive

asLong
optional

integer (int64)

asNumber
optional

Number

asShort
optional

integer (int32)

asString
optional

string

boolean
optional

boolean

jsonArray
optional

boolean

jsonNull
optional

boolean

jsonObject
optional

boolean

jsonPrimitive
optional

boolean

number
optional

boolean

string
optional

boolean

3.11. Loop

Name Schema

components
optional

< string, ExternalComponent > map

createdBy
optional

string

createdDate
optional

integer (int64)

dcaeDeploymentId
optional

string

dcaeDeploymentStatusUrl
optional

string

globalPropertiesJson
optional

JsonObject

lastComputedState
optional

enum (DESIGN, SUBMITTED, DEPLOYED, RUNNING, STOPPED, IN_ERROR, WAITING)

loopLogs
optional

< LoopLog > array

loopTemplate
optional

LoopTemplate

microServicePolicies
optional

< MicroServicePolicy > array

modelService
optional

Service

name
optional

string

operationalPolicies
optional

< OperationalPolicy > array

svgRepresentation
optional

string

updatedBy
optional

string

updatedDate
optional

integer (int64)

3.12. LoopElementModel

Name Schema

blueprint
optional

string

createdBy
optional

string

createdDate
optional

integer (int64)

dcaeBlueprintId
optional

string

loopElementType
optional

string

name
optional

string

policyModels
optional

< PolicyModel > array

shortName
optional

string

updatedBy
optional

string

updatedDate
optional

integer (int64)

usedByLoopTemplates
optional

< LoopTemplateLoopElementModel > array

3.13. LoopLog

Name Schema

id
optional

integer (int64)

logComponent
optional

string

logInstant
optional

integer (int64)

logType
optional

enum (INFO, WARNING, ERROR)

loop
optional

Loop

message
optional

string

3.14. LoopTemplate

Name Schema

allowedLoopType
optional

enum (OPEN, CLOSED, HYBRID)

blueprint
optional

string

createdBy
optional

string

createdDate
optional

integer (int64)

dcaeBlueprintId
optional

string

loopElementModelsUsed
optional

< LoopTemplateLoopElementModel > array

maximumInstancesAllowed
optional

integer (int32)

modelService
optional

Service

name
optional

string

svgRepresentation
optional

string

uniqueBlueprint
optional

boolean

updatedBy
optional

string

updatedDate
optional

integer (int64)

3.15. LoopTemplateLoopElementModel

Name Schema

flowOrder
optional

integer (int32)

loopElementModel
optional

LoopElementModel

loopTemplate
optional

LoopTemplate

3.16. MicroServicePolicy

Name Schema

configurationsJson
optional

JsonObject

context
optional

string

createdBy
optional

string

createdDate
optional

integer (int64)

dcaeBlueprintId
optional

string

dcaeDeploymentId
optional

string

dcaeDeploymentStatusUrl
optional

string

deviceTypeScope
optional

string

jsonRepresentation
optional

JsonObject

loopElementModel
optional

LoopElementModel

modelType
optional

string

name
optional

string

pdpGroup
optional

string

policyTosca
optional

string

shared
optional

boolean

updatedBy
optional

string

updatedDate
optional

integer (int64)

usedByLoops
optional

< Loop > array

3.17. Number

Type : object

3.18. OperationalPolicy

Name Schema

configurationsJson
optional

JsonObject

createdBy
optional

string

createdDate
optional

integer (int64)

jsonRepresentation
optional

JsonObject

loop
optional

Loop

loopElementModel
optional

LoopElementModel

name
optional

string

pdpGroup
optional

string

policyModel
optional

PolicyModel

updatedBy
optional

string

updatedDate
optional

integer (int64)

3.19. PolicyModel

Name Schema

createdBy
optional

string

createdDate
optional

integer (int64)

policyAcronym
optional

string

policyModelTosca
optional

string

policyModelType
optional

string

updatedBy
optional

string

updatedDate
optional

integer (int64)

usedByElementModels
optional

< LoopElementModel > array

version
optional

string

3.20. Service

Name Schema

name
optional

string

resourceDetails
optional

JsonObject

serviceDetails
optional

JsonObject

serviceUuid
optional

string

version
optional

string