X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=src%2Fmain%2Fresources%2FMETA-INF%2Fresources%2Fswagger.html;h=9c4c9fff231dd1db8938fb0c0fb5fc7e1abbf5ea;hb=897a3e004a858ef68d989dad15dde91a69e151a5;hp=e2bc77a20cb4e2187f73e210a5e1411313101a55;hpb=aef5d4ba9128c0cc4418b6dd9e12533b3d76bc84;p=clamp.git diff --git a/src/main/resources/META-INF/resources/swagger.html b/src/main/resources/META-INF/resources/swagger.html index e2bc77a2..9c4c9fff 100644 --- a/src/main/resources/META-INF/resources/swagger.html +++ b/src/main/resources/META-INF/resources/swagger.html @@ -4,17 +4,16 @@ - + Clamp Rest API @@ -439,210 +444,236 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • 2. Paths
  • 3. Definitions
    • @@ -655,14 +686,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    1.1. Version information

    -

    Version : 4.0.0-SNAPSHOT

    +

    Version : 5.0.0-SNAPSHOT

    1.2. URI scheme

    -

    Host : 0.0.0.0
    -BasePath : /restservices/clds/v1/
    +

    Host : localhost:39099
    +BasePath : /restservices/clds/
    Schemes : HTTP

    @@ -672,77 +703,33 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    2. Paths

    -

    2.1. PUT /clds/action/{action}/{modelName}?test={test}

    -
    -

    2.1.1. Parameters

    - ----- - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameSchema

    Path

    action
    -required

    string

    Path

    modelName}?test={test
    -required

    string

    Body

    body
    -required

    CldsModel

    -
    +

    2.1. GET /v1/healthcheck

    -

    2.1.2. Responses

    - +

    2.1.1. Responses

    +
    --+++ + - + +
    HTTP CodeDescription Schema

    200

    No Content

    Output type

    CldsHealthCheck
    -

    2.1.3. Consumes

    -
    -
      -
    • -

      application/json

      -
      • -
    -
    -
    -
    -

    2.1.4. Produces

    +

    2.1.2. Produces

    • @@ -753,27 +740,24 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.2. GET /clds/cldsDetails

    +

    2.2. GET /v1/user/getUser

    2.2.1. Responses

    - +
    ---++ - - - +
    HTTP CodeDescription Schema

    200

    Output type

    CldsMonitoringDetails

    No Content
    @@ -783,17 +767,17 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    • -

      application/json

      +

      text/plain

    -

    2.3. GET /clds/cldsInfo

    +

    2.3. GET /v2/dictionary

    2.3.1. Responses

    - +
    @@ -810,7 +794,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    200

    Output type

    CldsInfo

    Dictionary
    @@ -827,10 +811,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

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

    +

    2.4. PUT /v2/dictionary

    -

    2.4.1. Parameters

    - +

    2.4.1. Parameters

    +
    @@ -848,34 +832,37 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    Body

    body
    required

    DcaeEvent

    Dictionary

    2.4.2. Responses

    - +
    --+++ + - + +
    HTTP CodeDescription Schema

    200

    No Content

    Output type

    Dictionary
    -

    2.4.3. Consumes

    +

    2.4.3. Consumes

    • @@ -896,10 +883,47 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.5. PUT /clds/deploy/{modelName}

    +

    2.5. GET /v2/dictionary/secondary/names

    +
    +

    2.5.1. Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    Output type

    < string > array

    +
    +
    +

    2.5.2. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

    2.6. GET /v2/dictionary/{dictionaryName}

    -

    2.5.1. Parameters

    - +

    2.6.1. Parameters

    +
    @@ -915,52 +939,39 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - - - - -

    Path

    modelName
    +

    dictionaryName
    required

    string

    Body

    body
    -required

    CldsModel
    -

    2.5.2. Responses

    - +

    2.6.2. Responses

    +
    --+++ + - + +
    HTTP CodeDescription Schema

    200

    No Content

    Output type

    Dictionary
    -

    2.5.3. Consumes

    -
    -
      -
    • -

      application/json

      -
      • -
    -
    -
    -
    -

    2.5.4. Produces

    +

    2.6.3. Produces

    • @@ -971,10 +982,41 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.6. GET /clds/model-names

    +

    2.7. PUT /v2/dictionary/{name}

    +
    +

    2.7.1. Parameters

    + +++++ + + + + + + + + + + + + + + + + + + + +
    TypeNameSchema

    Path

    name
    +required

    string

    Body

    body
    +required

    Dictionary

    +
    -

    2.6.1. Responses

    - +

    2.7.2. Responses

    +
    @@ -991,13 +1033,23 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    200

    Output type

    ValueItem

    Dictionary
    -

    2.6.2. Produces

    +

    2.7.3. Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +

    2.7.4. Produces

    • @@ -1008,10 +1060,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

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

    +

    2.8. DELETE /v2/dictionary/{name}

    -

    2.7.1. Parameters

    - +

    2.8.1. Parameters

    +
    @@ -1027,7 +1079,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -1035,8 +1087,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Path

    modelName
    +

    name
    required

    string
    -

    2.7.2. Responses

    - +

    2.8.2. Responses

    +
    @@ -1056,21 +1108,21 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.7.3. Produces

    +

    2.8.3. Produces

    • -

      text/xml

      +

      application/json

    -

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

    +

    2.9. DELETE /v2/dictionary/{name}/elements/{shortName}

    -

    2.8.1. Parameters

    - +

    2.9.1. Parameters

    +
    @@ -1086,7 +1138,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - + + + + + @@ -1094,8 +1152,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Path

    modelName
    +

    name
    +required

    string

    Path

    shortName
    required

    string
    -

    2.8.2. Responses

    - +

    2.9.2. Responses

    +
    @@ -1115,21 +1173,21 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.8.3. Produces

    +

    2.9.3. Produces

    • -

      text/xml

      +

      application/json

    -

    2.9. GET /clds/model/{modelName}

    +

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

    -

    2.9.1. Parameters

    - +

    2.10.1. Parameters

    +
    @@ -1145,7 +1203,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -1153,45 +1211,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Path

    modelName
    +

    loopName
    required

    string
    -

    2.9.2. Responses

    - +

    2.10.2. Responses

    +
    ---++ - - - +
    HTTP CodeDescription Schema

    200

    Output type

    CldsModel

    No Content
    -
    -

    2.9.3. Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    -
    -
    -

    2.10. PUT /clds/model/{modelName}

    +

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

    -

    2.10.1. Parameters

    - +

    2.11.1. Parameters

    +
    @@ -1207,22 +1252,16 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - - - - -

    Path

    modelName
    +

    loopName
    required

    string

    Body

    body
    -required

    CldsModel
    -

    2.10.2. Responses

    - +

    2.11.2. Responses

    +
    @@ -1239,23 +1278,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    200

    Output type

    CldsModel

    Loop
    -

    2.10.3. Consumes

    -
    -
      -
    • -

      application/json

      -
      • -
    -
    -
    -
    -

    2.10.4. Produces

    +

    2.11.3. Produces

    • @@ -1266,30 +1295,33 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.11. GET /clds/properties

    +

    2.12. GET /v2/loop/getAllNames

    -

    2.11.1. Responses

    - +

    2.12.1. Responses

    +
    --+++ + - + +
    HTTP CodeDescription Schema

    200

    No Content

    Output type

    < string > array
    -

    2.11.2. Produces

    +

    2.12.2. Produces

    • @@ -1300,10 +1332,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.12. PUT /clds/undeploy/{modelName}

    +

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

    -

    2.12.1. Parameters

    - +

    2.13.1. Parameters

    +
    @@ -1319,52 +1351,39 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - - - - -

    Path

    modelName
    +

    loopName
    required

    string

    Body

    body
    -required

    CldsModel
    -

    2.12.2. Responses

    - +

    2.13.2. Responses

    +
    --+++ + - + +
    HTTP CodeDescription Schema

    200

    No Content

    Output type

    Loop
    -

    2.12.3. Consumes

    -
    -
      -
    • -

      application/json

      -
      • -
    -
    -
    -
    -

    2.12.4. Produces

    +

    2.13.3. Produces

    • @@ -1375,14 +1394,39 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.13. GET /cldsTempate/template-names

    +

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

    -

    2.13.1. Responses

    - +

    2.14.1. Parameters

    +
    ---++++ + + + + + + + + + + + + + + +
    TypeNameSchema

    Path

    loopName
    +required

    string

    +
    +
    +

    2.14.2. Responses

    + ++++ @@ -1395,13 +1439,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    200

    Output type

    ValueItem

    Loop
    -

    2.13.2. Produces

    +

    2.14.3. Produces

    • @@ -1412,10 +1456,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

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

    +

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

    -

    2.14.1. Parameters

    - +

    2.15.1. Parameters

    +
    @@ -1431,7 +1475,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -1439,42 +1483,45 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Path

    templateName
    +

    loopName
    required

    string
    -

    2.14.2. Responses

    - +

    2.15.2. Responses

    +
    --+++ + - + +
    HTTP CodeDescription Schema

    200

    No Content

    Output type

    Loop
    -

    2.14.3. Produces

    +

    2.15.3. Produces

    • -

      text/xml

      +

      application/json

    -

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

    +

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

    -

    2.15.1. Parameters

    - +

    2.16.1. Parameters

    +
    @@ -1490,7 +1537,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -1498,42 +1545,45 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Path

    templateName
    +

    loopName
    required

    string
    -

    2.15.2. Responses

    - +

    2.16.2. Responses

    +
    --+++ + - + +
    HTTP CodeDescription Schema

    200

    No Content

    Output type

    Loop
    -

    2.15.3. Produces

    +

    2.16.3. Produces

    • -

      text/xml

      +

      application/json

    -

    2.16. GET /cldsTempate/template/{templateName}

    +

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

    -

    2.16.1. Parameters

    - +

    2.17.1. Parameters

    +
    @@ -1549,7 +1599,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -1557,8 +1607,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Path

    templateName
    +

    loopName
    required

    string
    -

    2.16.2. Responses

    - +

    2.17.2. Responses

    +
    @@ -1575,13 +1625,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    200

    Output type

    CldsTemplate

    Loop
    -

    2.16.3. Produces

    +

    2.17.3. Produces

    • @@ -1592,10 +1642,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.17. PUT /cldsTempate/template/{templateName}

    +

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

    -

    2.17.1. Parameters

    - +

    2.18.1. Parameters

    +
    @@ -1611,22 +1661,16 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - - - - -

    Path

    templateName
    +

    loopName
    required

    string

    Body

    body
    -required

    CldsTemplate
    -

    2.17.2. Responses

    - +

    2.18.2. Responses

    +
    @@ -1643,37 +1687,52 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    200

    Output type

    CldsTemplate

    string
    -

    2.17.3. Consumes

    -
    -
      -
    • -

      application/json

      -
      • -
    -
    -
    -
    -

    2.17.4. Produces

    +

    2.18.3. Produces

    • -

      application/json

      +

      application/xml

    -

    2.18. GET /dictionary

    +

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

    +
    +

    2.19.1. Parameters

    + +++++ + + + + + + + + + + + + + + +
    TypeNameSchema

    Path

    loopName
    +required

    string

    +
    -

    2.18.1. Responses

    - +

    2.19.2. Responses

    +
    @@ -1690,13 +1749,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    200

    Output type

    CldsDictionary

    Loop
    -

    2.18.2. Produces

    +

    2.19.3. Produces

    • @@ -1707,10 +1766,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.19. PUT /dictionary/{dictionaryName}

    +

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

    -

    2.19.1. Parameters

    - +

    2.20.1. Parameters

    +
    @@ -1726,7 +1785,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -1734,14 +1793,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    Path

    dictionaryName
    +

    loopName
    required

    string

    Body

    body
    required

    CldsDictionary

    JsonObject
    -

    2.19.2. Responses

    - +

    2.20.2. Responses

    +
    @@ -1758,13 +1817,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    200

    Output type

    CldsDictionary

    Loop
    -

    2.19.3. Consumes

    +

    2.20.3. Consumes

    • @@ -1774,7 +1833,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.19.4. Produces

    +

    2.20.4. Produces

    • @@ -1785,10 +1844,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.20. GET /dictionary/{dictionaryName}/items

    +

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

    -

    2.20.1. Parameters

    - +

    2.21.1. Parameters

    +
    @@ -1804,16 +1863,22 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - + + + + +

    Path

    dictionaryName
    +

    loopName
    required

    string

    Body

    body
    +required

    MicroServicePolicy
    -

    2.20.2. Responses

    - +

    2.21.2. Responses

    +
    @@ -1830,13 +1895,23 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    200

    Output type

    CldsDictionary

    MicroServicePolicy
    -

    2.20.3. Produces

    +

    2.21.3. Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +

    2.21.4. Produces

    • @@ -1847,10 +1922,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.21. PUT /dictionary/{dictionaryName}/items

    +

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

    -

    2.21.1. Parameters

    - +

    2.22.1. Parameters

    +
    @@ -1866,7 +1941,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -1874,14 +1949,14 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    Path

    dictionaryName
    +

    loopName
    required

    string

    Body

    body
    required

    CldsDictionaryItem

    JsonArray
    -

    2.21.2. Responses

    - +

    2.22.2. Responses

    +
    @@ -1898,13 +1973,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    200

    Output type

    CldsDictionaryItem

    Loop
    -

    2.21.3. Consumes

    +

    2.22.3. Consumes

    • @@ -1914,7 +1989,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.21.4. Produces

    +

    2.22.4. Produces

    • @@ -1925,30 +2000,58 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.22. GET /healthcheck

    +

    2.23. GET /v2/loop/{loopName}

    -

    2.22.1. Responses

    - +

    2.23.1. Parameters

    +
    +-++ + + + + + + + + + + + + + + +
    TypeNameSchema

    Path

    loopName
    +required

    string

    +
    +
    +

    2.23.2. Responses

    + ++++ + - + +
    HTTP CodeDescription Schema

    200

    No Content

    Output type

    Loop
    -

    2.22.2. Produces

    +

    2.23.3. Produces

    • @@ -1959,10 +2062,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.23. GET /tosca/models

    +

    2.24. GET /v2/policyToscaModels

    -

    2.23.1. Responses

    - +

    2.24.1. Responses

    +
    @@ -1979,13 +2082,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    200

    Output type

    CldsToscaModel

    PolicyModel
    -

    2.23.2. Produces

    +

    2.24.2. Produces

    • @@ -1996,10 +2099,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

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

    +

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

    -

    2.24.1. Parameters

    - +

    2.25.1. Parameters

    +
    @@ -2015,7 +2118,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -2023,28 +2126,31 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Path

    policyType
    +

    policyModelType
    required

    string
    -

    2.24.2. Responses

    - +

    2.25.2. Responses

    +
    --+++ + - + +
    HTTP CodeDescription Schema

    200

    No Content

    Output type

    string
    -

    2.24.3. Produces

    +

    2.25.3. Produces

    • @@ -2055,10 +2161,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.25. GET /tosca/models/{toscaModelName}

    +

    2.26. GET /v2/policyToscaModels/{policyModelType}

    -

    2.25.1. Parameters

    - +

    2.26.1. Parameters

    +
    @@ -2074,7 +2180,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -2082,8 +2188,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Path

    toscaModelName
    +

    policyModelType
    required

    string
    -

    2.25.2. Responses

    - +

    2.26.2. Responses

    +
    @@ -2100,13 +2206,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    200

    Output type

    CldsToscaModel

    PolicyModel
    -

    2.25.3. Produces

    +

    2.26.3. Produces

    • @@ -2117,10 +2223,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.26. PUT /tosca/models/{toscaModelName}

    +

    2.27. PUT /v2/policyToscaModels/{policyModelType}

    -

    2.26.1. Parameters

    - +

    2.27.1. Parameters

    +
    @@ -2136,7 +2242,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -2144,44 +2250,47 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    Path

    toscaModelName
    +

    policyModelType
    required

    string

    Body

    body
    required

    CldsToscaModel

    string
    -

    2.26.2. Responses

    - +

    2.27.2. Responses

    +
    --+++ + - + +
    HTTP CodeDescription Schema

    200

    No Content

    Output type

    PolicyModel
    -

    2.26.3. Consumes

    +

    2.27.3. Consumes

    • -

      application/json

      +

      plain/text

    -

    2.26.4. Produces

    +

    2.27.4. Produces

    • @@ -2192,156 +2301,715 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.27. GET /user/getUser

    +

    2.28. GET /v2/templates

    -

    2.27.1. Responses

    - +

    2.28.1. Responses

    +
    --+++ + - + +
    HTTP CodeDescription Schema

    200

    No Content

    Output type

    LoopTemplate
    -

    2.27.2. Produces

    +

    2.28.2. Produces

    • -

      text/plain

      +

      application/json

    -
    -
    -
    -

    3. Definitions

    -
    -

    3.1. CldsDictionary

    - +

    2.29. GET /v2/templates/names

    +
    +

    2.29.1. Responses

    +
    --+++ - + + - - - - - - - - - - - - - - - - - - - - - - + + +
    NameHTTP CodeDescription Schema

    cldsDictionaryItems
    -optional

    < CldsDictionaryItem > array

    createdBy
    -optional

    string

    dictionaryId
    -optional

    string

    dictionaryName
    -optional

    string

    lastUpdatedDate
    -optional

    string

    updatedBy
    -optional

    string

    200

    Output type

    < string > array
    +
    +

    2.29.2. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    -

    3.2. CldsDictionaryItem

    - +

    2.30. GET /v2/templates/{templateName}

    +
    +

    2.30.1. Parameters

    +
    --+++ + - - - - - - - - - + + - - +
    Type Name Schema

    createdBy
    -optional

    string

    dictElementDesc
    -optional

    string

    dictElementId
    -optional

    Path

    templateName
    +required

    string

    dictElementName
    +

    +
    +
    +

    2.30.2. Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    Output type

    LoopTemplate

    +
    +
    +

    2.30.3. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +
    +
    +

    3. Definitions

    +
    +
    +

    3.1. CldsHealthCheck

    + ++++ + + + + + + + + + + + + + + + + + + + + +
    NameSchema

    description
    +optional

    string

    healthCheckComponent
    +optional

    string

    healthCheckStatus
    +optional

    string

    +
    +
    +

    3.2. Dictionary

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameSchema

    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.3. DictionaryElement

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameSchema

    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.4. ExternalComponent

    + ++++ + + + + + + + + + + + + + + + + +
    NameSchema

    componentName
    +optional

    string

    state
    +optional

    ExternalComponentState

    +
    +
    +

    3.5. ExternalComponentState

    + ++++ + + + + + + + + + + + + + + + + + + + + +
    NameSchema

    description
    +optional

    string

    level
    +optional

    integer (int32)

    stateName
    +optional

    string

    +
    +
    +

    3.6. JsonArray

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameSchema

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

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameSchema

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

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - + - - + - - + - - + - + + + + + + + + + + + + + + + +
    NameSchema

    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

    string

    JsonObject

    dictElementShortName
    +

    asJsonPrimitive
    optional

    string

    JsonPrimitive

    dictElementType
    +

    asLong
    optional

    string

    integer (int64)

    dictionaryId
    +

    asNumber
    optional

    string

    Number

    lastUpdatedDate
    +

    asShort
    optional

    string

    integer (int32)

    updatedBy
    +

    asString
    optional

    string

    jsonArray
    +optional

    boolean

    jsonNull
    +optional

    boolean

    jsonObject
    +optional

    boolean

    jsonPrimitive
    +optional

    boolean
    -

    3.3. CldsEvent

    - +

    3.9. JsonPrimitive

    +
    @@ -2354,93 +3022,126 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + - - + - - + - - + - - -

    actionCd
    +

    asBigDecimal
    optional

    string

    number

    actionStateCd
    +

    asBigInteger
    optional

    string

    integer

    id
    +

    asBoolean
    optional

    string

    boolean

    processInstanceId
    +

    asByte
    optional

    string

    string (byte)

    userid
    +

    asCharacter
    optional

    string
    -
    -
    -

    3.4. CldsInfo

    - ---- - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + + + + + + - - - - - - - - +
    NameSchema

    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)

    cldsVersion
    +

    asNumber
    +optional

    Number

    asShort
    +optional

    integer (int32)

    asString
    optional

    string

    permissionReadCl
    +

    boolean
    optional

    boolean

    permissionReadTemplate
    +

    jsonArray
    optional

    boolean

    permissionReadTosca
    +

    jsonNull
    optional

    boolean

    permissionUpdateCl
    +

    jsonObject
    optional

    boolean

    permissionUpdateTemplate
    +

    jsonPrimitive
    optional

    boolean

    permissionUpdateTosca
    +

    number
    optional

    boolean

    userName
    +

    string
    optional

    string

    boolean
    -

    3.5. CldsModel

    - +

    3.10. Loop

    +
    @@ -2453,116 +3154,163 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + - - - + - - - - + - - + - - + - - + - - + - - + - - + + + + - - - + + + +

    blueprintText
    +

    components
    optional

    string

    < string, ExternalComponent > map

    bpmnText
    +

    createdBy
    optional

    string

    cldsModelInstanceList
    +

    createdDate
    optional

    < CldsModelInstance > array

    integer (int64)

    controlName
    +

    dcaeDeploymentId
    optional

    string

    controlNamePrefix
    +

    dcaeDeploymentStatusUrl
    optional

    string

    controlNameUuid
    +

    globalPropertiesJson
    optional

    string

    JsonObject

    deploymentId
    +

    lastComputedState
    optional

    string

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

    deploymentStatusUrl
    +

    loopLogs
    optional

    string

    < LoopLog > array

    docText
    +

    loopTemplate
    optional

    string

    LoopTemplate

    errorMessageForUi
    +

    microServicePolicies
    optional

    string

    < MicroServicePolicy > array

    event
    +

    modelService
    optional

    CldsEvent

    Service

    id
    +

    name
    optional

    string

    imageText
    +

    operationalPolicies
    +optional

    < OperationalPolicy > array

    svgRepresentation
    optional

    string

    name
    +

    updatedBy
    optional

    string

    permittedActionCd
    +

    updatedDate
    optional

    < string > array

    integer (int64)

    +
    +
    +

    3.11. LoopElementModel

    + ++++ + + + + + + - - - + + + + - + + + + - + + + + - + + + + + + + +
    NameSchema

    propText
    +

    blueprint
    optional

    string

    status
    +

    createdBy
    optional

    string

    templateId
    +

    createdDate
    +optional

    integer (int64)

    dcaeBlueprintId
    optional

    string

    templateName
    +

    loopElementType
    +optional

    string

    name
    optional

    string

    typeId
    +

    policyModels
    +optional

    < PolicyModel > array

    shortName
    optional

    string

    typeName
    +

    updatedBy
    optional

    string

    updatedDate
    +optional

    integer (int64)

    usedByLoopTemplates
    +optional

    < LoopTemplateLoopElementModel > array
    -

    3.6. CldsModelInstance

    - +

    3.12. LoopLog

    +
    @@ -2575,17 +3323,32 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + - - + + + + + + + + + + + + @@ -2593,8 +3356,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    location
    +

    id
    optional

    string

    integer (int64)

    modelInstanceId
    +

    logComponent
    optional

    string

    vmName
    +

    logInstant
    +optional

    integer (int64)

    logType
    +optional

    enum (INFO, WARNING, ERROR)

    loop
    +optional

    Loop

    message
    optional

    string
    -

    3.7. CldsMonitoringDetails

    - +

    3.13. LoopTemplate

    +
    @@ -2607,56 +3370,76 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + - - - - + - - - + - + + + + + + + + - - + + + + + + + +

    action
    +

    allowedLoopType
    optional

    string

    enum (OPEN, CLOSED, HYBRID)

    closeloopName
    +

    blueprint
    optional

    string

    deploymentId
    +

    createdBy
    optional

    string

    modelId
    +

    createdDate
    optional

    string

    integer (int64)

    modelName
    +

    dcaeBlueprintId
    optional

    string

    serviceTypeId
    +

    loopElementModelsUsed
    optional

    string

    < LoopTemplateLoopElementModel > array

    templateName
    +

    maximumInstancesAllowed
    +optional

    integer (int32)

    modelService
    +optional

    Service

    name
    optional

    string

    timestamp
    +

    svgRepresentation
    optional

    string

    userid
    +

    uniqueBlueprint
    +optional

    boolean

    updatedBy
    optional

    string

    updatedDate
    +optional

    integer (int64)
    -

    3.8. CldsTemplate

    - +

    3.14. LoopTemplateLoopElementModel

    +
    @@ -2669,81 +3452,139 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + - - + - - + + + +

    bpmnId
    +

    flowOrder
    optional

    string

    integer (int32)

    bpmnText
    +

    loopElementModel
    optional

    string

    LoopElementModel

    bpmnUserid
    +

    loopTemplate
    optional

    string

    LoopTemplate

    +
    +
    +

    3.15. MicroServicePolicy

    + ++++ + + + + + + + + + + - - - + + + + - - - + + + + + + + + - - - - + - + + + + + + + + + + + +
    NameSchema

    configurationsJson
    +optional

    JsonObject

    controlNamePrefix
    +

    context
    optional

    string

    controlNameUuid
    +

    createdBy
    optional

    string

    id
    +

    createdDate
    +optional

    integer (int64)

    dcaeBlueprintId
    optional

    string

    imageId
    +

    dcaeDeploymentId
    optional

    string

    imageText
    +

    dcaeDeploymentStatusUrl
    optional

    string

    imageUserid
    +

    deviceTypeScope
    optional

    string

    jsonRepresentation
    +optional

    JsonObject

    loopElementModel
    +optional

    LoopElementModel

    name
    optional

    string

    propId
    +

    pdpGroup
    optional

    string

    propText
    +

    pdpSubGroup
    optional

    string

    propUserid
    +

    policyModel
    optional

    string

    PolicyModel

    userAuthorizedToUpdate
    +

    shared
    optional

    boolean

    updatedBy
    +optional

    string

    updatedDate
    +optional

    integer (int64)

    usedByLoops
    +optional

    < Loop > array
    -

    3.9. CldsToscaModel

    - +

    3.16. Number

    +
    +

    Type : object

    +
    + +
    +

    3.17. OperationalPolicy

    +
    @@ -2756,61 +3597,76 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + - - - + - - + - - + + + + + + + + + - - - - + + + + - - +

    createdDate
    +

    configurationsJson
    optional

    string

    JsonObject

    id
    +

    createdBy
    optional

    string

    lastUpdatedDate
    +

    createdDate
    optional

    string

    integer (int64)

    policyType
    +

    jsonRepresentation
    optional

    string

    JsonObject

    revisionId
    +

    legacy
    optional

    string

    boolean

    loop
    +optional

    Loop

    loopElementModel
    +optional

    LoopElementModel

    toscaModelJson
    +

    name
    optional

    string

    toscaModelName
    +

    pdpGroup
    optional

    string

    toscaModelYaml
    +

    pdpSubGroup
    optional

    string

    userId
    +

    policyModel
    +optional

    PolicyModel

    updatedBy
    optional

    string

    version
    +

    updatedDate
    optional

    number (double)

    integer (int64)
    -

    3.10. DcaeEvent

    - +

    3.18. PolicyModel

    +
    @@ -2823,37 +3679,52 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + + + + - - - - + - - + + + + + + + + @@ -2861,8 +3732,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    artifactName
    +

    createdBy
    optional

    string

    cldsActionCd
    +

    createdDate
    +optional

    integer (int64)

    policyAcronym
    optional

    string

    controlName
    +

    policyModelTosca
    optional

    string

    event
    +

    policyModelType
    optional

    string

    instances
    +

    policyPdpGroup
    optional

    < CldsModelInstance > array

    JsonObject

    resourceUUID
    +

    updatedBy
    optional

    string

    serviceUUID
    +

    updatedDate
    +optional

    integer (int64)

    usedByElementModels
    +optional

    < LoopElementModel > array

    version
    optional

    string
    -

    3.11. ValueItem

    - +

    3.19. Service

    +
    @@ -2875,7 +3746,27 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - + + + + + + + + + + + + + + + + @@ -2887,7 +3778,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    value
    +

    name
    +optional

    string

    resourceDetails
    +optional

    JsonObject

    serviceDetails
    +optional

    JsonObject

    serviceUuid
    +optional

    string

    version
    optional

    string