1. Overview

1.1. Version information

Version : 4.0.3-SNAPSHOT

1.2. URI scheme

Host : localhost:46235
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
required

string

Path

modelName}?test={test
required

string

Body

body
required

CldsModel

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

CldsMonitoringDetails

2.2.2. Produces

  • application/json

2.3. GET /v1/clds/cldsInfo

2.3.1. Responses

HTTP Code Description Schema

200

Output type

CldsInfo

2.3.2. Produces

  • application/json

2.4. POST /v1/clds/dcae/event?test={test}

2.4.1. Parameters

Type Name Schema

Body

body
required

DcaeEvent

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
required

string

Body

body
required

CldsModel

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

ValueItem

2.6.2. Produces

  • application/json

2.7. GET /v1/clds/model/bpmn/{modelName}

2.7.1. Parameters

Type Name Schema

Path

modelName
required

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
required

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
required

string

2.9.2. Responses

HTTP Code Description Schema

200

Output type

CldsModel

2.9.3. Produces

  • application/json

2.10. PUT /v1/clds/model/{modelName}

2.10.1. Parameters

Type Name Schema

Path

modelName
required

string

Body

body
required

CldsModel

2.10.2. Responses

HTTP Code Description Schema

200

Output type

CldsModel

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
required

string

Body

body
required

CldsModel

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

ValueItem

2.13.2. Produces

  • application/json

2.14. GET /v1/cldsTempate/template/bpmn/{templateName}

2.14.1. Parameters

Type Name Schema

Path

templateName
required

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
required

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
required

string

2.16.2. Responses

HTTP Code Description Schema

200

Output type

CldsTemplate

2.16.3. Produces

  • application/json

2.17. PUT /v1/cldsTempate/template/{templateName}

2.17.1. Parameters

Type Name Schema

Path

templateName
required

string

Body

body
required

CldsTemplate

2.17.2. Responses

HTTP Code Description Schema

200

Output type

CldsTemplate

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

CldsDictionary

2.18.2. Produces

  • application/json

2.19. PUT /v1/dictionary/{dictionaryName}

2.19.1. Parameters

Type Name Schema

Path

dictionaryName
required

string

Body

body
required

CldsDictionary

2.19.2. Responses

HTTP Code Description Schema

200

Output type

CldsDictionary

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
required

string

2.20.2. Responses

HTTP Code Description Schema

200

Output type

CldsDictionary

2.20.3. Produces

  • application/json

2.21. PUT /v1/dictionary/{dictionaryName}/items

2.21.1. Parameters

Type Name Schema

Path

dictionaryName
required

string

Body

body
required

CldsDictionaryItem

2.21.2. Responses

HTTP Code Description Schema

200

Output type

CldsDictionaryItem

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

CldsToscaModel

2.23.2. Produces

  • application/json

2.24. GET /v1/tosca/models/policyType/{policyType}

2.24.1. Parameters

Type Name Schema

Path

policyType
required

string

2.24.2. Responses

HTTP Code Description Schema

200

Output type

CldsToscaModel

2.24.3. Produces

  • application/json

2.25. GET /v1/tosca/models/{toscaModelName}

2.25.1. Parameters

Type Name Schema

Path

toscaModelName
required

string

2.25.2. Responses

HTTP Code Description Schema

200

Output type

CldsToscaModel

2.25.3. Produces

  • application/json

2.26. PUT /v1/tosca/models/{toscaModelName}

2.26.1. Parameters

Type Name Schema

Path

toscaModelName
required

string

Body

body
required

CldsToscaModel

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
required

string

2.28.2. Responses

HTTP Code Schema

200

No Content

2.29. PUT /v2/loop/deployLoop/{loopName}

2.29.1. Parameters

Type Name Schema

Path

loopName
required

string

2.29.2. Responses

HTTP Code Description Schema

200

Output type

Loop

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
required

string

2.31.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.31.3. Produces

  • application/json

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

2.32.1. Parameters

Type Name Schema

Path

loopName
required

string

2.32.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.32.3. Produces

  • application/json

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

2.33.1. Parameters

Type Name Schema

Path

loopName
required

string

2.33.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.33.3. Produces

  • application/json

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

2.34.1. Parameters

Type Name Schema

Path

loopName
required

string

2.34.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.34.3. Produces

  • application/json

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

2.35.1. Parameters

Type Name Schema

Path

loopName
required

string

2.35.2. Responses

HTTP Code Description Schema

200

Output type

string

2.35.3. Produces

  • application/xml

2.36. PUT /v2/loop/undeployLoop/{loopName}

2.36.1. Parameters

Type Name Schema

Path

loopName
required

string

2.36.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.36.3. Produces

  • application/json

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

2.37.1. Parameters

Type Name Schema

Path

loopName
required

string

Body

body
required

JsonObject

2.37.2. Responses

HTTP Code Description Schema

200

Output type

Loop

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
required

string

Body

body
required

MicroServicePolicy

2.38.2. Responses

HTTP Code Description Schema

200

Output type

MicroServicePolicy

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
required

string

Body

body
required

JsonArray

2.39.2. Responses

HTTP Code Description Schema

200

Output type

Loop

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
required

string

2.40.2. Responses

HTTP Code Description Schema

200

Output type

Loop

2.40.3. Produces

  • application/json

3. Definitions

3.1. CldsDictionary

Name Schema

cldsDictionaryItems
optional

< CldsDictionaryItem > array

createdBy
optional

string

dictionaryId
optional

string

dictionaryName
optional

string

lastUpdatedDate
optional

string

updatedBy
optional

string

3.2. CldsDictionaryItem

Name Schema

createdBy
optional

string

dictElementDesc
optional

string

dictElementId
optional

string

dictElementName
optional

string

dictElementShortName
optional

string

dictElementType
optional

string

dictionaryId
optional

string

lastUpdatedDate
optional

string

updatedBy
optional

string

3.3. CldsEvent

Name Schema

actionCd
optional

string

actionStateCd
optional

string

id
optional

string

processInstanceId
optional

string

userid
optional

string

3.4. 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.5. CldsModel

Name Schema

blueprintText
optional

string

bpmnText
optional

string

cldsModelInstanceList
optional

< CldsModelInstance > array

controlName
optional

string

controlNamePrefix
optional

string

controlNameUuid
optional

string

deploymentId
optional

string

deploymentStatusUrl
optional

string

docText
optional

string

errorMessageForUi
optional

string

event
optional

CldsEvent

id
optional

string

imageText
optional

string

name
optional

string

permittedActionCd
optional

< string > array

propText
optional

string

status
optional

string

templateId
optional

string

templateName
optional

string

typeId
optional

string

typeName
optional

string

3.6. CldsModelInstance

Name Schema

location
optional

string

modelInstanceId
optional

string

vmName
optional

string

3.7. CldsMonitoringDetails

Name Schema

action
optional

string

closeloopName
optional

string

deploymentId
optional

string

modelId
optional

string

modelName
optional

string

serviceTypeId
optional

string

templateName
optional

string

timestamp
optional

string

userid
optional

string

3.8. CldsTemplate

Name Schema

bpmnId
optional

string

bpmnText
optional

string

bpmnUserid
optional

string

controlNamePrefix
optional

string

controlNameUuid
optional

string

id
optional

string

imageId
optional

string

imageText
optional

string

imageUserid
optional

string

name
optional

string

propId
optional

string

propText
optional

string

propUserid
optional

string

userAuthorizedToUpdate
optional

boolean

3.9. CldsToscaModel

Name Schema

createdDate
optional

string

id
optional

string

lastUpdatedDate
optional

string

policyType
optional

string

revisionId
optional

string

toscaModelJson
optional

string

toscaModelName
optional

string

toscaModelYaml
optional

string

userId
optional

string

version
optional

number (double)

3.10. DcaeEvent

Name Schema

artifactName
optional

string

cldsActionCd
optional

string

controlName
optional

string

event
optional

string

instances
optional

< CldsModelInstance > array

resourceUUID
optional

string

serviceUUID
optional

string

3.11. 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.12. 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.13. 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.14. 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.15. Loop

Name Schema

blueprint
optional

string

dcaeBlueprintId
optional

string

dcaeDeploymentId
optional

string

dcaeDeploymentStatusUrl
optional

string

globalPropertiesJson
optional

JsonObject

lastComputedState
optional

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

loopLogs
optional

< LoopLog > array

microServicePolicies
optional

< MicroServicePolicy > array

modelPropertiesJson
optional

JsonObject

name
optional

string

operationalPolicies
optional

< OperationalPolicy > array

svgRepresentation
optional

string

3.16. LoopLog

Name Schema

id
optional

integer (int64)

logInstant
optional

integer (int64)

logType
optional

enum (INFO, WARNING, ERROR)

loop
optional

Loop

message
optional

string

3.17. MicroServicePolicy

Name Schema

jsonRepresentation
optional

JsonObject

modelType
optional

string

name
optional

string

policyTosca
optional

string

properties
optional

JsonObject

shared
optional

boolean

usedByLoops
optional

< Loop > array

3.18. Number

Type : object

3.19. OperationalPolicy

Name Schema

configurationsJson
optional

JsonObject

jsonRepresentation
optional

JsonObject

loop
optional

Loop

name
optional

string

3.20. ValueItem

Name Schema

value
optional

string