1. Overview

1.1. Version information

Version : 3.0.0-SNAPSHOT

1.2. URI scheme

BasePath : /clamp/restservices/clds/v1
Schemes : HTTP

2. Paths

2.1. PUT /clds/action/{action}/{modelName}

2.1.1. Description

REST service that saves and processes an action for a CLDS model by name.

2.1.2. Parameters

Type Name Schema

Path

action
required

string

Path

modelName
required

string

Query

test
required

string

Body

body
required

CldsModel

2.1.3. Responses

HTTP Code Description Schema

200

OK

CldsModel

500

Internal Server Error

CldsModel

2.1.4. Consumes

  • application/json

2.1.5. Produces

  • application/json

2.2. GET /clds/cldsDetails

2.2.1. Responses

HTTP Code Description Schema

200

OK

< CldsMonitoringDetails > array

2.2.2. Produces

  • application/json

2.3. GET /clds/cldsInfo

2.3.1. Responses

HTTP Code Description Schema

200

OK

CldsInfo

2.3.2. Produces

  • application/json

2.4. POST /clds/dcae/event

2.4.1. Description

REST service that accepts events for a model.

2.4.2. Parameters

Type Name Schema

Query

test
required

string

Body

body
required

DcaeEvent

2.4.3. Responses

HTTP Code Description Schema

200

OK

string

2.4.4. Consumes

  • application/json

2.4.5. Produces

  • application/json

2.5. PUT /clds/deploy/{modelName}

2.5.1. Parameters

Type Name Schema

Path

modelName
required

string

Body

body
required

CldsModel

2.5.2. Responses

HTTP Code Description Schema

200

OK

CldsModel

500

Internal Server Error

CldsModel

2.5.3. Consumes

  • application/json

2.5.4. Produces

  • application/json

2.6. GET /clds/healthcheck

2.6.1. Description

REST service that retrieves clds healthcheck information.

2.6.2. Responses

HTTP Code Description Schema

200

OK

CldsHealthCheck

500

Internal Server Error

CldsHealthCheck

2.6.3. Produces

  • application/json

2.7. GET /clds/model-names

2.7.1. Description

REST service that retrieves a list of CLDS model names.

2.7.2. Responses

HTTP Code Description Schema

200

OK

< ValueItem > array

2.7.3. Produces

  • application/json

2.8. GET /clds/model/bpmn/{modelName}

2.8.1. Description

REST service that retrieves BPMN for a CLDS model name from the database.
This is subset of the json getModel. This is only expected to be used for
testing purposes, not by the UI.

2.8.2. Parameters

Type Name Schema

Path

modelName
required

string

2.8.3. Responses

HTTP Code Description Schema

200

OK

string

2.8.4. Produces

  • text/xml

2.9. GET /clds/model/image/{modelName}

2.9.1. Description

REST service that retrieves image for a CLDS model name from the
database. This is subset of the json getModel. This is only expected to
be used for testing purposes, not by the UI.

2.9.2. Parameters

Type Name Schema

Path

modelName
required

string

2.9.3. Responses

HTTP Code Description Schema

200

OK

string

2.9.4. Produces

  • text/xml

2.10. GET /clds/model/{modelName}

2.10.1. Description

REST service that retrieves a CLDS model by name from the database.

2.10.2. Parameters

Type Name Schema

Path

modelName
required

string

2.10.3. Responses

HTTP Code Description Schema

200

OK

CldsModel

2.10.4. Produces

  • application/json

2.11. PUT /clds/model/{modelName}

2.11.1. Description

REST service that saves a CLDS model by name in the database.

2.11.2. Parameters

Type Name Schema

Path

modelName
required

string

Body

body
required

CldsModel

2.11.3. Responses

HTTP Code Description Schema

200

OK

CldsModel

2.11.4. Consumes

  • application/json

2.11.5. Produces

  • application/json

2.12. GET /clds/properties

2.12.1. Description

REST service that retrieves total properties required by UI

2.12.2. Responses

HTTP Code Description Schema

200

OK

string

2.12.3. Produces

  • application/json

2.13. GET /clds/properties/{serviceInvariantUUID}

2.13.1. Description

REST service that retrieves total properties by using invariantUUID based
on refresh and non refresh

2.13.2. Parameters

Type Name Schema Default

Path

serviceInvariantUUID
required

string

Query

refresh
optional

boolean

"false"

2.13.3. Responses

HTTP Code Description Schema

200

OK

string

2.13.4. Produces

  • application/json

2.14. GET /clds/sdc/services

2.14.1. Description

REST service that retrieves sdc services

2.14.2. Responses

HTTP Code Description Schema

200

OK

string

2.14.3. Produces

  • application/json

2.15. PUT /clds/undeploy/{modelName}

2.15.1. Parameters

Type Name Schema

Path

modelName
required

string

Body

body
required

CldsModel

2.15.2. Responses

HTTP Code Description Schema

200

OK

CldsModel

500

Internal Server Error

CldsModel

2.15.3. Consumes

  • application/json

2.15.4. Produces

  • application/json

2.16. GET /cldsTempate/template-names

2.16.1. Description

REST service that retrieves a list of CLDS template names.

2.16.2. Responses

HTTP Code Description Schema

200

OK

< ValueItem > array

2.16.3. Produces

  • application/json

2.17. GET /cldsTempate/template/bpmn/{templateName}

2.17.1. Description

REST service that retrieves BPMN for a CLDS template name from the
database. This is subset of the json getModel. This is only expected to
be used for testing purposes, not by the UI.

2.17.2. Parameters

Type Name Schema

Path

templateName
required

string

2.17.3. Responses

HTTP Code Description Schema

200

OK

string

2.17.4. Produces

  • text/xml

2.18. GET /cldsTempate/template/image/{templateName}

2.18.1. Description

REST service that retrieves image for a CLDS template name from the
database. This is subset of the json getModel. This is only expected to
be used for testing purposes, not by the UI.

2.18.2. Parameters

Type Name Schema

Path

templateName
required

string

2.18.3. Responses

HTTP Code Description Schema

200

OK

string

2.18.4. Produces

  • text/xml

2.19. GET /cldsTempate/template/{templateName}

2.19.1. Description

REST service that retrieves a CLDS template by name from the database.

2.19.2. Parameters

Type Name Schema

Path

templateName
required

string

2.19.3. Responses

HTTP Code Description Schema

200

OK

CldsTemplate

2.19.4. Produces

  • application/json

2.20. PUT /cldsTempate/template/{templateName}

2.20.1. Description

REST service that saves a CLDS template by name in the database.

2.20.2. Parameters

Type Name Schema

Path

templateName
required

string

Body

body
required

CldsTemplate

2.20.3. Responses

HTTP Code Description Schema

200

OK

CldsTemplate

2.20.4. Consumes

  • application/json

2.20.5. Produces

  • application/json

2.21. GET /healthcheck

2.21.1. Description

REST service that retrieves clds healthcheck information.

2.21.2. Responses

HTTP Code Description Schema

200

OK

CldsHealthCheck

500

Internal Server Error

CldsHealthCheck

2.21.3. Produces

  • application/json

2.22. GET /user/getUser

2.22.1. Description

REST service that returns the username.

2.22.2. Responses

HTTP Code Description Schema

200

OK

string

2.22.3. Produces

  • text/plain

3. Definitions

3.1. CldsEvent

Name Schema

actionAndStateCd
optional

boolean

actionCd
optional

boolean

actionStateCd
optional

boolean

id
optional

string

processInstanceId
optional

string

userid
optional

string

3.2. CldsHealthCheck

Name Schema

description
optional

string

healthCheckComponent
optional

string

healthCheckStatus
optional

string

3.3. CldsInfo

Name Schema

cldsVersion
optional

string

permissionReadCl
optional

boolean

permissionReadTemplate
optional

boolean

permissionUpdateCl
optional

boolean

permissionUpdateTemplate
optional

boolean

userName
optional

string

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

docText
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.5. CldsModelInstance

Name Schema

location
optional

string

modelInstanceId
optional

string

vmName
optional

string

3.6. CldsMonitoringDetails

Name Schema

action
optional

string

closeloopName
optional

string

deploymentId
optional

string

modelName
optional

string

serviceTypeId
optional

string

templateName
optional

string

timestamp
optional

string

userid
optional

string

3.7. 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.8. 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.9. ValueItem

Name Schema

value
optional

string