X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=src%2Fmain%2Fresources%2FMETA-INF%2Fresources%2Fswagger.html;h=61b9d26c09f9bf7a0f7b1ee0aae6c5560a4d643b;hb=49ab84a916e96fde4fc39258fa10f8b5ce775f48;hp=17507b662fdd005f7dacfdff6fe41e4fe9b31c08;hpb=a84a7c622ecb0574750038f35195b1534eda7abc;p=clamp.git diff --git a/src/main/resources/META-INF/resources/swagger.html b/src/main/resources/META-INF/resources/swagger.html index 17507b66..61b9d26c 100644 --- a/src/main/resources/META-INF/resources/swagger.html +++ b/src/main/resources/META-INF/resources/swagger.html @@ -444,133 +444,280 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • 2. Paths
  • 3. Definitions
    • @@ -583,13 +730,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    1.1. Version information

    -

    Version : 4.1.2-SNAPSHOT

    +

    Version : 5.0.0-SNAPSHOT

    1.2. URI scheme

    -

    Host : localhost:38405
    +

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

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

    2. Paths

    -

    2.1. GET /v1/clds/cldsInfo

    +

    2.1. GET /v1/healthcheck

    2.1.1. Responses

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

    200

    Output type

    CldsInfo

    CldsHealthCheck
    @@ -637,27 +784,24 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.2. GET /v1/healthcheck

    +

    2.2. GET /v1/user/getUser

    2.2.1. Responses

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

    200

    Output type

    CldsHealthCheck

    No Content
    @@ -667,31 +811,34 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    • -

      application/json

      +

      text/plain

    -

    2.3. GET /v1/user/getUser

    +

    2.3. GET /v2/clampInformation

    2.3.1. Responses

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

    200

    No Content

    Output type

    ClampInformation
    @@ -701,65 +848,53 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    • -

      text/plain

      +

      application/json

    -

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

    -
    -

    2.4.1. Parameters

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

    Path

    loopName
    -required

    string

    -
    +

    2.4. GET /v2/dictionary

    -

    2.4.2. Responses

    +

    2.4.1. Responses

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

    200

    No Content

    Output type

    Dictionary
    +
    +

    2.4.2. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    -

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

    +

    2.5. PUT /v2/dictionary

    -

    2.5.1. Parameters

    +

    2.5.1. Parameters

    @@ -775,10 +910,10 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + - +

    Path

    loopName
    +

    Body

    body
    required

    string

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

    200

    Output type

    -

    Loop

    +

    Dictionary

    -

    2.5.3. Produces

    +

    2.5.3. Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +

    2.5.4. Produces

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

    2.6. GET /v2/loop/getAllNames

    +

    2.6. GET /v2/dictionary/secondary/names

    2.6.1. Responses

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

    2.6.2. Produces

    +

    2.6.2. Produces

    • @@ -856,9 +1001,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

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

    +

    2.7. GET /v2/dictionary/{dictionaryName}

    -

    2.7.1. Parameters

    +

    2.7.1. Parameters

    @@ -875,7 +1020,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -901,13 +1046,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - +

    Path

    loopName
    +

    dictionaryName
    required

    string

    200

    Output type

    Loop

    Dictionary
    -

    2.7.3. Produces

    +

    2.7.3. Produces

    • @@ -918,9 +1063,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

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

    +

    2.8. PUT /v2/dictionary/{name}

    -

    2.8.1. Parameters

    +

    2.8.1. Parameters

    @@ -937,10 +1082,16 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - + + + + +

    Path

    loopName
    +

    name
    required

    string

    Body

    body
    +required

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

    200

    Output type

    -

    Loop

    +

    Dictionary

    -

    2.8.3. Produces

    +

    2.8.3. Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +

    2.8.4. Produces

    • @@ -980,9 +1141,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

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

    +

    2.9. DELETE /v2/dictionary/{name}

    -

    2.9.1. Parameters

    +

    2.9.1. Parameters

    @@ -999,7 +1160,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -1010,28 +1171,25 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    2.9.2. Responses

    Path

    loopName
    +

    name
    required

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

    200

    Output type

    Loop

    No Content
    -

    2.9.3. Produces

    +

    2.9.3. Produces

    • @@ -1042,9 +1200,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

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

    +

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

    -

    2.10.1. Parameters

    +

    2.10.1. Parameters

    @@ -1061,7 +1219,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - + + + + + @@ -1072,28 +1236,25 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    2.10.2. Responses

    Path

    loopName
    +

    name
    +required

    string

    Path

    shortName
    required

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

    200

    Output type

    Loop

    No Content
    -

    2.10.3. Produces

    +

    2.10.3. Produces

    • @@ -1104,9 +1265,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

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

    +

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

    -

    2.11.1. Parameters

    +

    2.11.1. Parameters

    @@ -1127,6 +1288,18 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b required

    + + + + + + + + + +

    string

    Path

    policyType
    +required

    string

    Path

    policyVersion
    +required

    string
    @@ -1149,26 +1322,26 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    200

    Output type

    -

    string

    +

    Loop

    -

    2.11.3. Produces

    +

    2.11.3. Produces

    • -

      application/xml

      +

      application/json

    -

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

    +

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

    -

    2.12.1. Parameters

    +

    2.12.1. Parameters

    @@ -1185,7 +1358,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - @@ -1217,7 +1390,17 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Path

    loopName
    +

    loopName}?templateName={templateName
    required

    string
    -

    2.12.3. Produces

    +

    2.12.3. Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +

    2.12.4. Produces

    • @@ -1228,9 +1411,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

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

    +

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

    -

    2.13.1. Parameters

    +

    2.13.1. Parameters

    @@ -1251,12 +1434,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b required

    - - - - -

    string

    Body

    body
    -required

    JsonObject
    @@ -1264,51 +1441,28 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    2.13.2. Responses

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

    200

    Output type

    Loop

    No Content
    -
    -

    2.13.3. Consumes

    -
    -
      -
    • -

      application/json

      -
      • -
    -
    -
    -
    -

    2.13.4. Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    -
    -
    -

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

    +

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

    -

    2.14.1. Parameters

    +

    2.14.1. Parameters

    @@ -1329,12 +1483,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b required

    - - - - -

    string

    Body

    body
    -required

    MicroServicePolicy
    @@ -1357,13 +1505,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    200

    Output type

    -

    MicroServicePolicy

    +

    Loop

    -

    2.14.3. Consumes

    +

    2.14.3. Produces

    • @@ -1372,21 +1520,48 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -
    -

    2.14.4. Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    +
    +
    +

    2.15. GET /v2/loop/getAllNames

    +
    +

    2.15.1. Responses

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

    200

    Output type

    < string > array

    +
    +
    +

    2.15.2. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    -

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

    +

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

    -

    2.15.1. Parameters

    +

    2.16.1. Parameters

    @@ -1407,17 +1582,147 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b required

    + +

    string
    +
    +
    +

    2.16.2. Responses

    + +++++ + - - + + + + + + + + + + + +

    Body

    body
    +

    		HTTP CodeDescriptionSchema

    200

    Output type

    Loop

    +
    +
    +

    2.16.3. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

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

    +
    +

    2.17.1. Parameters

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

    Path

    loopName
    required

    JsonArray

    string

    +
    +
    +

    2.17.2. Responses

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

    200

    Output type

    Loop

    +
    +
    +

    2.17.3. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

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

    +
    +

    2.18.1. Parameters

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

    Path

    loopName
    +required

    string

    Path

    policyType
    +required

    string

    Path

    policyVersion
    +required

    string
    -

    2.15.2. Responses

    +

    2.18.2. Responses

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

    2.15.3. Consumes

    +

    2.18.3. Produces

    • @@ -1450,8 +1755,60 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    +
    +
    +

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

    +
    +

    2.19.1. Parameters

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

    Path

    loopName
    +required

    string

    +
    +
    +

    2.19.2. Responses

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

    200

    Output type

    Loop

    +
    -

    2.15.4. Produces

    +

    2.19.3. Produces

    • @@ -1462,9 +1819,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.16. GET /v2/loop/{loopName}

    +

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

    -

    2.16.1. Parameters

    +

    2.20.1. Parameters

    @@ -1477,59 +1834,1432 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + + + + + + + + +
    Name Schema

    Path

    loopName
    +required

    string

    +
    +
    +

    2.20.2. Responses

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

    200

    Output type

    Loop

    +
    +
    +

    2.20.3. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

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

    +
    +

    2.21.1. Parameters

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

    Path

    loopName
    +required

    string

    +
    +
    +

    2.21.2. Responses

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

    200

    Output type

    Loop

    +
    +
    +

    2.21.3. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

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

    +
    +

    2.22.1. Parameters

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

    Path

    loopName
    +required

    string

    +
    +
    +

    2.22.2. Responses

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

    200

    Output type

    string

    +
    +
    +

    2.22.3. Produces

    +
    +
      +
    • +

      application/xml

      +
      • +
    +
    +
    +
    +
    +

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

    +
    +

    2.23.1. Parameters

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

    Path

    loopName
    +required

    string

    +
    +
    +

    2.23.2. Responses

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

    200

    Output type

    Loop

    +
    +
    +

    2.23.3. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

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

    +
    +

    2.24.1. Parameters

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

    Path

    loopName
    +required

    string

    Body

    body
    +required

    JsonObject

    +
    +
    +

    2.24.2. Responses

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

    200

    Output type

    Loop

    +
    +
    +

    2.24.3. Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +

    2.24.4. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

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

    +
    +

    2.25.1. Parameters

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

    Path

    loopName
    +required

    string

    Body

    body
    +required

    MicroServicePolicy

    +
    +
    +

    2.25.2. Responses

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

    200

    Output type

    MicroServicePolicy

    +
    +
    +

    2.25.3. Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +

    2.25.4. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

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

    +
    +

    2.26.1. Parameters

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

    Path

    loopName
    +required

    string

    Body

    body
    +required

    JsonArray

    +
    +
    +

    2.26.2. Responses

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

    200

    Output type

    Loop

    +
    +
    +

    2.26.3. Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +

    2.26.4. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

    2.27. GET /v2/loop/{loopName}

    +
    +

    2.27.1. Parameters

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

    Path

    loopName
    +required

    string

    +
    +
    +

    2.27.2. Responses

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

    200

    Output type

    Loop

    +
    +
    +

    2.27.3. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

    2.28. POST /v2/policyToscaModels

    +
    +

    2.28.1. Parameters

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

    Body

    body
    +required

    string

    +
    +
    +

    2.28.2. Responses

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

    200

    Output type

    PolicyModel

    +
    +
    +

    2.28.3. Consumes

    +
    +
      +
    • +

      plain/text

      +
      • +
    +
    +
    +
    +

    2.28.4. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

    2.29. GET /v2/policyToscaModels

    +
    +

    2.29.1. Responses

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

    200

    Output type

    PolicyModel

    +
    +
    +

    2.29.2. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

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

    +
    +

    2.30.1. Parameters

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

    Path

    policyModelType
    +required

    string

    Path

    policyModelVersion
    +required

    string

    +
    +
    +

    2.30.2. Responses

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

    200

    Output type

    string

    +
    +
    +

    2.30.3. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

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

    +
    +

    2.31.1. Parameters

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

    Path

    policyModelType
    +required

    string

    Path

    policyModelVersion
    +required

    string

    +
    +
    +

    2.31.2. Responses

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

    200

    Output type

    PolicyModel

    +
    +
    +

    2.31.3. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

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

    +
    +

    2.32.1. Parameters

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

    Path

    policyModelType
    +required

    string

    Path

    policyModelVersion
    +required

    string

    Body

    body
    +required

    string

    +
    +
    +

    2.32.2. Responses

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

    200

    Output type

    PolicyModel

    +
    +
    +

    2.32.3. Consumes

    +
    +
      +
    • +

      plain/text

      +
      • +
    +
    +
    +
    +

    2.32.4. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

    2.33. GET /v2/templates

    +
    +

    2.33.1. Responses

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

    200

    Output type

    LoopTemplate

    +
    +
    +

    2.33.2. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

    2.34. GET /v2/templates/names

    +
    +

    2.34.1. Responses

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

    200

    Output type

    < string > array

    +
    +
    +

    2.34.2. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

    2.35. GET /v2/templates/{templateName}

    +
    +

    2.35.1. Parameters

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

    Path

    templateName
    +required

    string

    +
    +
    +

    2.35.2. Responses

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

    200

    Output type

    LoopTemplate

    +
    +
    +

    2.35.3. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

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

    +
    +

    2.36.1. Parameters

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

    Path

    templateName
    +required

    string

    +
    +
    +

    2.36.2. Responses

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

    200

    Output type

    string

    +
    +
    +

    2.36.3. Produces

    +
    +
      +
    • +

      application/xml

      +
      • +
    +
    +
    +
    +
    +
    +
    +

    3. Definitions

    +
    +
    +

    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

    Path

    loopName
    -required

    string

    jsonNull
    +optional

    boolean
    -
    -
    -

    2.16.2. Responses

    - ----- - - - - + + - - - - - + +
    HTTP CodeDescriptionSchema

    jsonObject
    +optional

    boolean

    200

    Output type

    Loop

    jsonPrimitive
    +optional

    boolean
    -
    -

    2.16.3. Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    -
    -
    -
    -
    -
    -
    -

    3. Definitions

    -
    -

    3.1. CldsHealthCheck

    +

    3.8. JsonNull

    @@ -1543,141 +3273,110 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + - - + - - + - -

    description
    +

    asBigDecimal
    optional

    string

    number

    healthCheckComponent
    +

    asBigInteger
    optional

    string

    integer

    healthCheckStatus
    +

    asBoolean
    optional

    string

    boolean
    -
    -
    -

    3.2. CldsInfo

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

    asByte
    +optional

    string (byte)

    cldsVersion
    +

    asCharacter
    optional

    string

    permissionReadCl
    +

    asDouble
    optional

    boolean

    number (double)

    permissionReadTemplate
    +

    asFloat
    optional

    boolean

    number (float)

    permissionReadTosca
    +

    asInt
    optional

    boolean

    integer (int32)

    permissionUpdateCl
    +

    asJsonArray
    optional

    boolean

    JsonArray

    permissionUpdateTemplate
    +

    asJsonNull
    optional

    boolean

    JsonNull

    permissionUpdateTosca
    +

    asJsonObject
    optional

    boolean

    JsonObject

    userName
    +

    asJsonPrimitive
    optional

    string

    JsonPrimitive
    -
    -
    -

    3.3. ExternalComponent

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

    asLong
    +optional

    integer (int64)

    componentName
    +

    asNumber
    optional

    string

    Number

    state
    +

    asShort
    optional

    ExternalComponentState

    integer (int32)
    -
    -
    -

    3.4. ExternalComponentState

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

    asString
    +optional

    string

    description
    +

    jsonArray
    optional

    string

    boolean

    level
    +

    jsonNull
    optional

    integer (int32)

    boolean

    stateName
    +

    jsonObject
    optional

    string

    boolean

    jsonPrimitive
    +optional

    boolean
    -

    3.5. JsonArray

    +

    3.9. JsonObject

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

    3.6. JsonNull

    +

    3.10. JsonPrimitive

    @@ -1888,6 +3587,11 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b + + + + @@ -1907,11 +3611,21 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b optional

    + + + + + + + +

    string

    boolean
    +optional

    boolean

    jsonArray
    optional

    boolean

    boolean

    number
    +optional

    boolean

    string
    +optional

    boolean
    -

    3.7. JsonObject

    +

    3.11. Loop

    @@ -1925,110 +3639,162 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + - - + - - + - - + - - - + - - + - - + - - + - - + - + + + + + + + + + + + + + + + + + + + + + + + +

    asBigDecimal
    +

    components
    optional

    number

    < string, ExternalComponent > map

    asBigInteger
    +

    createdBy
    optional

    integer

    string

    asBoolean
    +

    createdDate
    optional

    boolean

    integer (int64)

    asByte
    +

    dcaeDeploymentId
    optional

    string (byte)

    string

    asCharacter
    +

    dcaeDeploymentStatusUrl
    optional

    string

    asDouble
    +

    globalPropertiesJson
    optional

    number (double)

    JsonObject

    asFloat
    +

    lastComputedState
    optional

    number (float)

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

    asInt
    +

    loopLogs
    optional

    integer (int32)

    < LoopLog > array

    asJsonArray
    +

    loopTemplate
    optional

    JsonArray

    LoopTemplate

    asJsonNull
    +

    microServicePolicies
    optional

    JsonNull

    < MicroServicePolicy > array

    asJsonObject
    +

    modelService
    +optional

    Service

    name
    +optional

    string

    operationalPolicies
    +optional

    < OperationalPolicy > array

    svgRepresentation
    +optional

    string

    updatedBy
    +optional

    string

    updatedDate
    +optional

    integer (int64)

    +
    +
    +

    3.12. LoopElementModel

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

    blueprint
    optional

    JsonObject

    string

    asJsonPrimitive
    +

    createdBy
    optional

    JsonPrimitive

    string

    asLong
    +

    createdDate
    optional

    integer (int64)

    asNumber
    +

    dcaeBlueprintId
    optional

    Number

    string

    asShort
    +

    loopElementType
    optional

    integer (int32)

    string

    asString
    +

    name
    optional

    string

    jsonArray
    +

    policyModels
    optional

    boolean

    < PolicyModel > array

    jsonNull
    +

    shortName
    optional

    boolean

    string

    jsonObject
    +

    updatedBy
    optional

    boolean

    string

    jsonPrimitive
    +

    updatedDate
    optional

    boolean

    integer (int64)

    usedByLoopTemplates
    +optional

    < LoopTemplateLoopElementModel > array
    -

    3.8. JsonPrimitive

    +

    3.13. LoopLog

    @@ -2042,125 +3808,154 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + - - + - - + - - + - - + - - + + + +

    asBigDecimal
    +

    id
    optional

    number

    integer (int64)

    asBigInteger
    +

    logComponent
    optional

    integer

    string

    asBoolean
    +

    logInstant
    optional

    boolean

    integer (int64)

    asByte
    +

    logType
    optional

    string (byte)

    enum (INFO, WARNING, ERROR)

    asCharacter
    +

    loop
    optional

    string

    Loop

    asDouble
    +

    message
    optional

    number (double)

    string

    +
    +
    +

    3.14. LoopTemplate

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

    asFloat
    +

    allowedLoopType
    optional

    number (float)

    enum (OPEN, CLOSED, HYBRID)

    asInt
    +

    blueprint
    optional

    integer (int32)

    string

    asJsonArray
    +

    createdBy
    optional

    JsonArray

    string

    asJsonNull
    +

    createdDate
    optional

    JsonNull

    integer (int64)

    asJsonObject
    +

    dcaeBlueprintId
    optional

    JsonObject

    string

    asJsonPrimitive
    +

    loopElementModelsUsed
    optional

    JsonPrimitive

    < LoopTemplateLoopElementModel > array

    asLong
    +

    maximumInstancesAllowed
    optional

    integer (int64)

    integer (int32)

    asNumber
    +

    modelService
    optional

    Number

    Service

    asShort
    +

    name
    optional

    integer (int32)

    string

    asString
    +

    svgRepresentation
    optional

    string

    boolean
    +

    uniqueBlueprint
    optional

    boolean

    jsonArray
    +

    updatedBy
    optional

    boolean

    string

    jsonNull
    +

    updatedDate
    optional

    boolean

    integer (int64)
    +
    +
    +

    3.15. LoopTemplateLoopElementModel

    + ++++ + - - + + + + - - + - - + - - +

    jsonObject
    -optional

    boolean

    		NameSchema

    jsonPrimitive
    +

    flowOrder
    optional

    boolean

    integer (int32)

    number
    +

    loopElementModel
    optional

    boolean

    LoopElementModel

    string
    +

    loopTemplate
    optional

    boolean

    LoopTemplate
    -

    3.9. Loop

    +

    3.16. MicroServicePolicy

    @@ -2174,14 +3969,24 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - + + + + - - + + + + + - - + - - + - - + - - + - - + - - - + - + + + + + + + + + + + +

    blueprint
    +

    configurationsJson
    +optional

    JsonObject

    context
    optional

    string

    components
    +

    createdBy
    optional

    < string, ExternalComponent > map

    string

    createdDate
    +optional

    integer (int64)

    dcaeBlueprintId
    @@ -2199,50 +4004,71 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    string

    globalPropertiesJson
    +

    deviceTypeScope
    optional

    JsonObject

    string

    lastComputedState
    +

    jsonRepresentation
    optional

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

    JsonObject

    loopLogs
    +

    loopElementModel
    optional

    < LoopLog > array

    LoopElementModel

    microServicePolicies
    +

    name
    optional

    < MicroServicePolicy > array

    string

    modelPropertiesJson
    +

    pdpGroup
    optional

    JsonObject

    string

    name
    +

    pdpSubgroup
    optional

    string

    operationalPolicies
    +

    policyModel
    optional

    < OperationalPolicy > array

    PolicyModel

    svgRepresentation
    +

    shared
    +optional

    boolean

    updatedBy
    optional

    string

    updatedDate
    +optional

    integer (int64)

    usedByLoops
    +optional

    < Loop > array
    -

    3.10. LoopLog

    +

    3.17. Number

    +
    +

    Type : object

    +
    +
    +
    +

    3.18. OperationalPolicy

    @@ -2256,24 +4082,29 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + - - - - + + + + + - + + + + + + + + + + + + + + + + + + + + + + + +

    id
    +

    configurationsJson
    optional

    integer (int64)

    JsonObject

    logComponent
    +

    createdBy
    optional

    string

    logInstant
    +

    createdDate
    optional

    integer (int64)

    logType
    +

    jsonRepresentation
    optional

    enum (INFO, WARNING, ERROR)

    JsonObject

    legacy
    +optional

    boolean

    loop
    @@ -2281,15 +4112,45 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Loop

    message
    +

    loopElementModel
    +optional

    LoopElementModel

    name
    +optional

    string

    pdpGroup
    +optional

    string

    pdpSubgroup
    optional

    string

    policyModel
    +optional

    PolicyModel

    updatedBy
    +optional

    string

    updatedDate
    +optional

    integer (int64)
    -

    3.11. MicroServicePolicy

    +

    3.19. PolicyModel

    @@ -2303,51 +4164,60 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - - + + + + + - - - - - - + - - + + + + + + + + +

    jsonRepresentation
    +

    createdBy
    optional

    JsonObject

    string

    createdDate
    +optional

    integer (int64)

    modelType
    +

    policyAcronym
    optional

    string

    name
    +

    policyModelTosca
    optional

    string

    policyTosca
    +

    policyModelType
    optional

    string

    properties
    +

    policyPdpGroup
    optional

    JsonObject

    shared
    +

    updatedBy
    optional

    boolean

    string

    usedByLoops
    +

    updatedDate
    optional

    < Loop > array

    integer (int64)

    usedByElementModels
    +optional

    < LoopElementModel > array

    version
    +optional

    string
    -

    3.12. Number

    -
    -

    Type : object

    -
    -
    -
    -

    3.13. OperationalPolicy

    +

    3.20. Service

    @@ -2361,22 +4231,27 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b - + + + + - - - + - @@ -2388,7 +4263,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    configurationsJson
    +

    name
    +optional

    string

    resourceDetails
    optional

    JsonObject

    jsonRepresentation
    +

    serviceDetails
    optional

    JsonObject

    loop
    +

    serviceUuid
    optional

    Loop

    string

    name
    +

    version
    optional

    string