X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=src%2Fmain%2Fresources%2FMETA-INF%2Fresources%2Fswagger.html;h=f1bb1ca5ec0cb359a4672c6eb8723f4425cbdfb3;hb=refs%2Fchanges%2F88%2F103988%2F9;hp=e2bc77a20cb4e2187f73e210a5e1411313101a55;hpb=700f44182b05ef329e00ad6107dd688ce092573d;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..f1bb1ca5 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,287 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • 2. Paths
  • 3. Definitions
  • @@ -655,14 +737,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:42393
    +BasePath : /restservices/clds/
    Schemes : HTTP

    @@ -672,47 +754,47 @@ 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. GET /v1/healthcheck

    -

    2.1.1. Parameters

    - +

    2.1.1. Responses

    +
    ---+++ - - + + - - - - - - - - - - - - - + + +
    TypeNameHTTP CodeDescription Schema

    Path

    action
    -required

    string

    Path

    modelName}?test={test
    -required

    string

    Body

    body
    -required

    CldsModel

    200

    Output type

    CldsHealthCheck

    -

    2.1.2. Responses

    - +

    2.1.2. Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    + + +
    @@ -732,31 +814,21 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.1.3. Consumes

    -
    -
      -
    • -

      application/json

      -
    • -
    -
    -
    -
    -

    2.1.4. Produces

    +

    2.2.2. Produces

    • -

      application/json

      +

      text/plain

    -

    2.2. GET /clds/cldsDetails

    +

    2.3. GET /v2/clampInformation

    -

    2.2.1. Responses

    - +

    2.3.1. Responses

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

    200

    Output type

    CldsMonitoringDetails

    ClampInformation

    -

    2.2.2. Produces

    +

    2.3.2. Produces

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

    2.3. GET /clds/cldsInfo

    +

    2.4. GET /v2/dictionary

    -

    2.3.1. Responses

    - +

    2.4.1. Responses

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

    200

    Output type

    CldsInfo

    Dictionary

    -

    2.3.2. Produces

    +

    2.4.2. Produces

    • @@ -827,10 +899,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.5. PUT /v2/dictionary

    -

    2.4.1. Parameters

    - +

    2.5.1. Parameters

    +
    @@ -848,34 +920,47 @@ 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

    - +

    2.5.2. Responses

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

    200

    No Content

    Output type

    Dictionary

    -

    2.4.3. Consumes

    +

    2.5.3. Consumes

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    +
    +
    +

    2.5.4. Produces

    • @@ -884,8 +969,35 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    +
    +
    +

    2.6. GET /v2/dictionary/secondary/names

    +
    +

    2.6.1. Responses

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

    200

    Output type

    < string > array

    +
    -

    2.4.4. Produces

    +

    2.6.2. Produces

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

    2.5. PUT /clds/deploy/{modelName}

    +

    2.7. GET /v2/dictionary/{dictionaryName}

    -

    2.5.1. Parameters

    - +

    2.7.1. Parameters

    +
    @@ -915,52 +1027,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.7.2. Responses

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

    200

    No Content

    Output type

    Dictionary

    -

    2.5.3. Consumes

    -
    -
      -
    • -

      application/json

      -
    • -
    -
    -
    -
    -

    2.5.4. Produces

    +

    2.7.3. Produces

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

    2.6. GET /clds/model-names

    +

    2.8. PUT /v2/dictionary/{name}

    -

    2.6.1. Responses

    - +

    2.8.1. Parameters

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

    Path

    name
    +required

    string

    Body

    body
    +required

    Dictionary

    +
    +
    +

    2.8.2. Responses

    +@@ -991,13 +1121,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.8.3. Consumes

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    +
    +
    +

    2.8.4. Produces

    • @@ -1008,10 +1148,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.9. DELETE /v2/dictionary/{name}

    -

    2.7.1. Parameters

    - +

    2.9.1. Parameters

    +
    @@ -1027,7 +1167,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -1035,8 +1175,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.9.2. Responses

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

    2.7.3. Produces

    +

    2.9.3. Produces

    • -

      text/xml

      +

      application/json

    -

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

    +

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

    -

    2.8.1. Parameters

    - +

    2.10.1. Parameters

    +
    @@ -1086,7 +1226,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - + + + + + @@ -1094,8 +1240,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.10.2. Responses

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

    2.8.3. Produces

    +

    2.10.3. Produces

    • -

      text/xml

      +

      application/json

    -

    2.9. GET /clds/model/{modelName}

    +

    2.11. PUT /v2/loop/addOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}

    -

    2.9.1. Parameters

    - +

    2.11.1. Parameters

    +
    @@ -1145,7 +1291,19 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - + + + + + + + + + + @@ -1153,8 +1311,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Path

    modelName
    +

    loopName
    +required

    string

    Path

    policyType
    +required

    string

    Path

    policyVersion
    required

    string

    -

    2.9.2. Responses

    - +

    2.11.2. Responses

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

    200

    Output type

    CldsModel

    Loop

    -

    2.9.3. Produces

    +

    2.11.3. Produces

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

    2.10. PUT /clds/model/{modelName}

    +

    2.12. POST /v2/loop/create/{loopName}?templateName={templateName}

    -

    2.10.1. Parameters

    - +

    2.12.1. Parameters

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

    Path

    modelName
    +

    loopName}?templateName={templateName
    required

    string

    Body

    body
    -required

    CldsModel

    -

    2.10.2. Responses

    - +

    2.12.2. Responses

    +
    @@ -1239,13 +1391,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

    +

    2.12.3. Consumes

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

    2.10.4. Produces

    +

    2.12.4. Produces

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

    2.11. GET /clds/properties

    +

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

    +
    +

    2.13.1. Parameters

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

    Path

    loopName
    +required

    string

    +
    -

    2.11.1. Responses

    - +

    2.13.2. Responses

    +
    @@ -1288,22 +1465,12 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -
    -

    2.11.2. Produces

    -
    -
      -
    • -

      application/json

      -
    • -
    -
    -
    -

    2.12. PUT /clds/undeploy/{modelName}

    +

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

    -

    2.12.1. Parameters

    - +

    2.14.1. Parameters

    +
    @@ -1319,52 +1486,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.14.2. Responses

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

    200

    No Content

    Output type

    Loop

    -

    2.12.3. Consumes

    -
    -
      -
    • -

      application/json

      -
    • -
    -
    -
    -
    -

    2.12.4. Produces

    +

    2.14.3. Produces

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

    2.13. GET /cldsTempate/template-names

    +

    2.15. GET /v2/loop/getAllNames

    -

    2.13.1. Responses

    - +

    2.15.1. Responses

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

    200

    Output type

    ValueItem

    < string > array

    -

    2.13.2. Produces

    +

    2.15.2. Produces

    • @@ -1412,10 +1566,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.16. GET /v2/loop/getstatus/{loopName}

    -

    2.14.1. Parameters

    - +

    2.16.1. Parameters

    +
    @@ -1431,7 +1585,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -1439,42 +1593,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.16.2. Responses

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

    200

    No Content

    Output type

    Loop

    -

    2.14.3. Produces

    +

    2.16.3. Produces

    • -

      text/xml

      +

      application/json

    -

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

    +

    2.17. PUT /v2/loop/refreshMicroServicePolicyJsonSchema/{loopName}/{microServicePolicyName}

    -

    2.15.1. Parameters

    - +

    2.17.1. Parameters

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

    Path

    templateName
    +

    loopName
    +required

    string

    Path

    microServicePolicyName
    required

    string

    -

    2.15.2. Responses

    - +

    2.17.2. Responses

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

    200

    No Content

    Output type

    Loop

    -

    2.15.3. Produces

    +

    2.17.3. Produces

    • -

      text/xml

      +

      application/json

    -

    2.16. GET /cldsTempate/template/{templateName}

    +

    2.18. PUT /v2/loop/refreshOperationalPolicyJsonSchema/{loopName}/{operationalPolicyName}

    -

    2.16.1. Parameters

    - +

    2.18.1. Parameters

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

    Path

    templateName
    +

    loopName
    +required

    string

    Path

    operationalPolicyName
    required

    string

    -

    2.16.2. Responses

    - +

    2.18.2. Responses

    +
    @@ -1575,13 +1747,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.18.3. Produces

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

    2.17. PUT /cldsTempate/template/{templateName}

    +

    2.19. PUT /v2/loop/removeOperationaPolicy/{loopName}/policyModel/{policyType}/{policyVersion}

    -

    2.17.1. Parameters

    - +

    2.19.1. Parameters

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

    Path

    templateName
    +

    loopName
    required

    string

    Body

    body
    +

    Path

    policyType
    +required

    string

    Path

    policyVersion
    required

    CldsTemplate

    string

    -

    2.17.2. Responses

    - +

    2.19.2. Responses

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

    200

    Output type

    CldsTemplate

    Loop

    -

    2.17.3. Consumes

    -
    -
      -
    • -

      application/json

      -
    • -
    -
    -
    -
    -

    2.17.4. Produces

    +

    2.19.3. Produces

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

    2.18. GET /dictionary

    +

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

    +
    +

    2.20.1. Parameters

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

    Path

    loopName
    +required

    string

    +
    -

    2.18.1. Responses

    - +

    2.20.2. Responses

    +
    @@ -1690,13 +1883,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.20.3. Produces

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

    2.19. PUT /dictionary/{dictionaryName}

    +

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

    -

    2.19.1. Parameters

    - +

    2.21.1. Parameters

    +
    @@ -1726,22 +1919,16 @@ 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

    -

    2.19.2. Responses

    - +

    2.21.2. Responses

    +
    @@ -1758,23 +1945,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

    -
    -
      -
    • -

      application/json

      -
    • -
    -
    -
    -
    -

    2.19.4. Produces

    +

    2.21.3. Produces

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

    2.20. GET /dictionary/{dictionaryName}/items

    +

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

    -

    2.20.1. Parameters

    - +

    2.22.1. Parameters

    +
    @@ -1804,7 +1981,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -1812,8 +1989,8 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Path

    dictionaryName
    +

    loopName
    required

    string

    -

    2.20.2. Responses

    - +

    2.22.2. Responses

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

    200

    Output type

    CldsDictionary

    Loop

    -

    2.20.3. Produces

    +

    2.22.3. Produces

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

    2.21. PUT /dictionary/{dictionaryName}/items

    +

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

    -

    2.21.1. Parameters

    - +

    2.23.1. Parameters

    +
    @@ -1866,22 +2043,16 @@ 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

    -

    2.21.2. Responses

    - +

    2.23.2. Responses

    +
    @@ -1898,71 +2069,52 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    200

    Output type

    CldsDictionaryItem

    string

    -

    2.21.3. Consumes

    -
    -
      -
    • -

      application/json

      -
    • -
    -
    -
    -
    -

    2.21.4. Produces

    +

    2.23.3. Produces

    • -

      application/json

      +

      application/xml

    -

    2.22. GET /healthcheck

    +

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

    -

    2.22.1. Responses

    - +

    2.24.1. Parameters

    +
    +-+ - + + - - + + +
    HTTP CodeTypeName Schema

    200

    No Content

    Path

    loopName
    +required

    string

    -

    2.22.2. Produces

    -
    -
      -
    • -

      application/json

      -
    • -
    -
    -
    -
    -
    -

    2.23. GET /tosca/models

    -
    -

    2.23.1. Responses

    - +

    2.24.2. Responses

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

    200

    Output type

    CldsToscaModel

    Loop

    -

    2.23.2. Produces

    +

    2.24.3. Produces

    • @@ -1996,10 +2148,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. POST /v2/loop/updateGlobalProperties/{loopName}

    -

    2.24.1. Parameters

    - +

    2.25.1. Parameters

    +
    @@ -2015,36 +2167,55 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - + + + + +

    Path

    policyType
    +

    loopName
    required

    string

    Body

    body
    +required

    JsonObject

    -

    2.24.2. Responses

    - +

    2.25.2. Responses

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

    200

    No Content

    Output type

    Loop

    -

    2.24.3. Produces

    +

    2.25.3. Consumes

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    +
    +
    +

    2.25.4. Produces

    • @@ -2055,10 +2226,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. POST /v2/loop/updateMicroservicePolicy/{loopName}

    -

    2.25.1. Parameters

    - +

    2.26.1. Parameters

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

    Path

    toscaModelName
    +

    loopName
    required

    string

    Body

    body
    +required

    MicroServicePolicy

    -

    2.25.2. Responses

    - +

    2.26.2. Responses

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

    200

    Output type

    CldsToscaModel

    MicroServicePolicy

    -

    2.25.3. Produces

    +

    2.26.3. Consumes

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    +
    +
    +

    2.26.4. Produces

    • @@ -2117,10 +2304,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. POST /v2/loop/updateOperationalPolicies/{loopName}

    -

    2.26.1. Parameters

    - +

    2.27.1. Parameters

    +
    @@ -2136,7 +2323,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -2144,34 +2331,37 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    Path

    toscaModelName
    +

    loopName
    required

    string

    Body

    body
    required

    CldsToscaModel

    JsonArray

    -

    2.26.2. Responses

    - +

    2.27.2. Responses

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

    200

    No Content

    Output type

    Loop

    -

    2.26.3. Consumes

    +

    2.27.3. Consumes

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

    2.26.4. Produces

    +

    2.27.4. Produces

    • @@ -2192,94 +2382,1200 @@ 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/loop/{loopName}

    -

    2.27.1. Responses

    - +

    2.28.1. Parameters

    +
    +-+ - + + - - + + +
    HTTP CodeTypeName Schema

    200

    No Content

    Path

    loopName
    +required

    string

    -

    2.27.2. Produces

    -
    -
      -
    • -

      text/plain

      -
    • -
    -
    -
    -
    -
    -
    -
    -

    3. Definitions

    +

    2.28.2. Responses

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

    200

    Output type

    Loop

    +
    +
    +

    2.28.3. Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    +
    +
    +
    +

    2.29. POST /v2/policyToscaModels

    +
    +

    2.29.1. Parameters

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

    Body

    body
    +required

    string

    +
    +
    +

    2.29.2. Responses

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

    200

    Output type

    PolicyModel

    +
    +
    +

    2.29.3. Consumes

    +
    +
      +
    • +

      plain/text

      +
    • +
    +
    +
    +
    +

    2.29.4. Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    +
    +
    +
    +

    2.30. GET /v2/policyToscaModels

    +
    +

    2.30.1. Responses

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

    200

    Output type

    PolicyModel

    +
    +
    +

    2.30.2. Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    +
    +
    +
    +

    2.31. GET /v2/policyToscaModels/yaml/{policyModelType}/{policyModelVersion}

    +
    +

    2.31.1. Parameters

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

    Path

    policyModelType
    +required

    string

    Path

    policyModelVersion
    +required

    string

    +
    +
    +

    2.31.2. Responses

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

    200

    Output type

    string

    +
    +
    +

    2.31.3. Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    +
    +
    +
    +

    2.32. GET /v2/policyToscaModels/{policyModelType}/{policyModelVersion}

    +
    +

    2.32.1. Parameters

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

    Path

    policyModelType
    +required

    string

    Path

    policyModelVersion
    +required

    string

    +
    +
    +

    2.32.2. Responses

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

    200

    Output type

    PolicyModel

    +
    +
    +

    2.32.3. Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    +
    +
    +
    +

    2.33. PUT /v2/policyToscaModels/{policyModelType}/{policyModelVersion}

    +
    +

    2.33.1. Parameters

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

    Path

    policyModelType
    +required

    string

    Path

    policyModelVersion
    +required

    string

    Body

    body
    +required

    string

    +
    +
    +

    2.33.2. Responses

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

    200

    Output type

    PolicyModel

    +
    +
    +

    2.33.3. Consumes

    +
    +
      +
    • +

      plain/text

      +
    • +
    +
    +
    +
    +

    2.33.4. Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    +
    +
    +
    +

    2.34. GET /v2/templates

    +
    +

    2.34.1. Responses

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

    200

    Output type

    LoopTemplate

    +
    +
    +

    2.34.2. Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    +
    +
    +
    +

    2.35. GET /v2/templates/names

    +
    +

    2.35.1. Responses

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

    200

    Output type

    < string > array

    +
    +
    +

    2.35.2. Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    +
    +
    +
    +

    2.36. GET /v2/templates/{templateName}

    +
    +

    2.36.1. Parameters

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

    Path

    templateName
    +required

    string

    +
    +
    +

    2.36.2. Responses

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

    200

    Output type

    LoopTemplate

    +
    +
    +

    2.36.3. Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    +
    +
    +
    +
    +

    2.37. GET /v2/templates/{templateName}/svgRepresentation

    +
    +

    2.37.1. Parameters

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

    Path

    templateName
    +required

    string

    +
    +
    +

    2.37.2. Responses

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

    200

    Output type

    string

    +
    +
    +

    2.37.3. Produces

    +
    +
      +
    • +

      application/xml

      +
    • +
    +
    +
    +
    +
    +
    +
    +

    3. Definitions

    -

    3.1. CldsDictionary

    - +

    3.1. ClampInformation

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

    allPermissions
    +optional

    < string > array

    cldsVersion
    +optional

    string

    userName
    +optional

    string

    +
    +
    +

    3.2. CldsHealthCheck

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

    description
    +optional

    string

    healthCheckComponent
    +optional

    string

    healthCheckStatus
    +optional

    string

    +
    +
    +

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

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

    componentName
    +optional

    string

    state
    +optional

    ExternalComponentState

    +
    +
    +

    3.6. ExternalComponentState

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

    description
    +optional

    string

    level
    +optional

    integer (int32)

    stateName
    +optional

    string

    +
    +
    +

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

    + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - + - - + - - - + - - + - - + + + + +
    NameSchemaNameSchema

    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)

    cldsDictionaryItems
    +

    asNumber
    optional

    < CldsDictionaryItem > array

    Number

    createdBy
    +

    asShort
    optional

    string

    integer (int32)

    dictionaryId
    +

    asString
    optional

    string

    dictionaryName
    +

    jsonArray
    optional

    string

    boolean

    lastUpdatedDate
    +

    jsonNull
    optional

    string

    boolean

    updatedBy
    +

    jsonObject
    optional

    string

    boolean

    jsonPrimitive
    +optional

    boolean

    -

    3.2. CldsDictionaryItem

    - +

    3.10. JsonPrimitive

    +
    @@ -2292,155 +3588,126 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + - - + - - + - - + - - - + - - + - - + - - + - -

    createdBy
    +

    asBigDecimal
    optional

    string

    number

    dictElementDesc
    +

    asBigInteger
    optional

    string

    integer

    dictElementId
    +

    asBoolean
    optional

    string

    boolean

    dictElementName
    +

    asByte
    optional

    string

    string (byte)

    dictElementShortName
    +

    asCharacter
    optional

    string

    dictElementType
    +

    asDouble
    optional

    string

    number (double)

    dictionaryId
    +

    asFloat
    optional

    string

    number (float)

    lastUpdatedDate
    +

    asInt
    optional

    string

    integer (int32)

    updatedBy
    +

    asJsonArray
    optional

    string

    JsonArray

    -
    -
    -

    3.3. CldsEvent

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

    actionCd
    +

    asJsonNull
    optional

    string

    JsonNull

    actionStateCd
    +

    asJsonObject
    optional

    string

    JsonObject

    id
    +

    asJsonPrimitive
    optional

    string

    JsonPrimitive

    processInstanceId
    +

    asLong
    optional

    string

    integer (int64)

    userid
    +

    asNumber
    optional

    string

    Number

    -
    -
    -

    3.4. CldsInfo

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

    asShort
    +optional

    integer (int32)

    cldsVersion
    +

    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.11. Loop

    +
    @@ -2453,116 +3720,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.12. LoopElementModel

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

    blueprint
    +optional

    string

    propText
    +

    createdBy
    optional

    string

    status
    +

    createdDate
    +optional

    integer (int64)

    dcaeBlueprintId
    optional

    string

    templateId
    +

    loopElementType
    optional

    string

    templateName
    +

    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.13. LoopLog

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

    location
    +

    id
    +optional

    integer (int64)

    logComponent
    optional

    string

    modelInstanceId
    +

    logInstant
    optional

    string

    integer (int64)

    vmName
    +

    logType
    +optional

    enum (INFO, WARNING, ERROR)

    loop
    +optional

    Loop

    message
    optional

    string

    -

    3.7. CldsMonitoringDetails

    - +

    3.14. LoopTemplate

    +
    @@ -2607,56 +3936,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.15. LoopTemplateLoopElementModel

    +
    @@ -2669,81 +4018,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.16. 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.17. Number

    +
    +

    Type : object

    +
    + +
    @@ -2756,61 +4163,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.19. PolicyModel

    +
    @@ -2823,37 +4245,52 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + + + + - - - - + - - + + + + + + + + @@ -2861,8 +4298,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.20. Service

    +
    @@ -2875,7 +4312,27 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - + + + + + + + + + + + + + + + + @@ -2887,7 +4344,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