From 82be31b8817c8070d5eff1f998098ee476c156ed Mon Sep 17 00:00:00 2001 From: "Kotagiri, Ramprasad (rp5662)" Date: Wed, 8 May 2019 12:50:34 -0400 Subject: Add API specification html page into deployment REST API specification html page included Removed ECOMPC application name from create blueprint screen Issue-ID: CCSDK-1011 Change-Id: Id4b50f91ec7d15a4b7e10c4e775e26fb2850c933 Signed-off-by: Kotagiri, Ramprasad (rp5662) --- ccsdk-app-os/src/main/webapp/oom-api.html | 5901 +++++++++++++++++++++++++++++ 1 file changed, 5901 insertions(+) create mode 100644 ccsdk-app-os/src/main/webapp/oom-api.html (limited to 'ccsdk-app-os/src/main') diff --git a/ccsdk-app-os/src/main/webapp/oom-api.html b/ccsdk-app-os/src/main/webapp/oom-api.html new file mode 100644 index 0000000..5ed224c --- /dev/null +++ b/ccsdk-app-os/src/main/webapp/oom-api.html @@ -0,0 +1,5901 @@ + + + + + + + + + + Operations Manager API + + + + + + + + + + + + + + + + NAV + Navigation + + +
+ + +
+ + + Python + + + + Shell + + +
+ + +
+ +
+
    + +
    + +
    + + + +
    +
    +
    +
    +

    Operations Manager API v1.0.0

    +
    +

    Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

    +
    +

    API interface to manage deployments of blueprints. HTTP Basic authorization schema is required to authenticate users for all the resource endpoints.

    +

    Base URLs:

    + +

    Email: Support

    +

    Authentication

    +
      +
    • HTTP Authentication, scheme: basic
      • +
    +

    Blueprints

    +

    Query blueprint information

    +

    List Blueprints

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Accept': 'application/json'
+}
+
+r = requests.get('https://oom-server:30129/ccsdk-app/api-if/blueprints', params={
+
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X GET https://oom-server:30129/ccsdk-app/api-if/blueprints \
+  -H 'Accept: application/json'
+
+
    +

    GET /blueprints

    +

    Find all blueprint templates

    +

    Fetch the blueprints data from inventory

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    ParameterInTypeRequiredDescription
    _includequeryarray[string]falseblueprint object properties need to be considered for filter
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + + + + + +
    ParameterValue
    _includetypeName
    _includetypeId
    _includetypeVersion
    +
    +

    Example responses

    +
    +
    +

    200 Response

    +
    +
    {
+  "links": {
+    "previousLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    },
+    "nextLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    }
+  },
+  "totalCount": 0,
+  "items": [
+    {
+      "owner": "string",
+      "typeName": "string",
+      "typeVersion": 0,
+      "blueprintTemplate": "string",
+      "serviceIds": [
+        "string"
+      ],
+      "vnfTypes": [
+        "string"
+      ],
+      "serviceLocations": [
+        "string"
+      ],
+      "asdcServiceId": "string",
+      "asdcResourceId": "string",
+      "asdcServiceURL": "string",
+      "typeId": "string",
+      "selfLink": {
+        "title": "string",
+        "rel": "string",
+        "uri": "http://example.com",
+        "uriBuilder": {},
+        "rels": [
+          "string"
+        ],
+        "params": {
+          "property1": "string",
+          "property2": "string"
+        },
+        "type": "string"
+      },
+      "created": "2019-05-08T15:25:24Z",
+      "deactivated": "2019-05-08T15:25:24Z"
+    }
+  ]
+}
+
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKList of DCAEServiceType objectsInlineResponse200
    400Bad RequestInvalid tag valueNone
    401UnauthorizedAuthentication information is missing or invalidNone
    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Create Blueprint

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Content-Type': 'application/json',
+  'Accept': 'application/json'
+}
+
+r = requests.post('https://oom-server:30129/ccsdk-app/api-if/blueprints', params={
+
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X POST https://oom-server:30129/ccsdk-app/api-if/blueprints \
+  -H 'Content-Type: application/json' \
+  -H 'Accept: application/json'
+
+
    +

    POST /blueprints

    +

    Create/Upload a new blueprint template

    +

    Upload a new blueprint template into inventory

    +
    +

    Body parameter

    +
    +
    {
+  "owner": "string",
+  "typeName": "string",
+  "typeVersion": 0,
+  "blueprintTemplate": "string",
+  "application": "string",
+  "component": "string"
+}
+
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    ParameterInTypeRequiredDescription
    bodybodyDCAEServiceTypeRequesttrueupload blueprint request to inventory
    +
    +

    Example responses

    +
    +
    +

    200 Response

    +
    +
    {
+  "links": {
+    "previousLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    },
+    "nextLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    }
+  },
+  "totalCount": 0,
+  "items": [
+    {
+      "owner": "string",
+      "typeName": "string",
+      "typeVersion": 0,
+      "blueprintTemplate": "string",
+      "serviceIds": [
+        "string"
+      ],
+      "vnfTypes": [
+        "string"
+      ],
+      "serviceLocations": [
+        "string"
+      ],
+      "asdcServiceId": "string",
+      "asdcResourceId": "string",
+      "asdcServiceURL": "string",
+      "typeId": "string",
+      "selfLink": {
+        "title": "string",
+        "rel": "string",
+        "uri": "http://example.com",
+        "uriBuilder": {},
+        "rels": [
+          "string"
+        ],
+        "params": {
+          "property1": "string",
+          "property2": "string"
+        },
+        "type": "string"
+      },
+      "created": "2019-05-08T15:25:24Z",
+      "deactivated": "2019-05-08T15:25:24Z"
+    }
+  ]
+}
+
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKA DCAEServiceType objectInlineResponse200
    400Bad RequestInvalid tag valueNone
    401UnauthorizedAuthentication information is missing or invalidNone
    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Delete Blueprint

    +

    +
    +

    Code samples

    +
    +
    import requests
+
+r = requests.delete('https://oom-server:30129/ccsdk-app/api-if/blueprints/{typeId}', params={
+
+)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X DELETE https://oom-server:30129/ccsdk-app/api-if/blueprints/{typeId}
+
+
    +

    DELETE /blueprints/{typeId}

    +

    Delete a blueprint template

    +

    Delete a blueprint template from inventory

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    ParameterInTypeRequiredDescription
    typeIdpathstringtrueID of blueprint to delete
    +

    Responses

    + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKsuccessful operationNone
    + +

    Get Deployments for a blueprint

    +

    +
    +

    Code samples

    +
    +
    import requests
+
+r = requests.get('https://oom-server:30129/ccsdk-app/api-if/blueprints/{typeId}/services', params={
+
+)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X GET https://oom-server:30129/ccsdk-app/api-if/blueprints/{typeId}/services
+
+
    +

    GET /blueprints/{typeId}/services

    +

    Get Services mapped to a blueprint template

    +

    Get Deployment References existing for a blueprint

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    ParameterInTypeRequiredDescription
    typeIdpathstringtrueID of blueprint to query
    +

    Responses

    + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKsuccessful operationNone
    + +

    Get Blueprint

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Accept': 'application/json'
+}
+
+r = requests.get('https://oom-server:30129/ccsdk-app/api-if/blueprints/findByName', params={
+  'name': 'string'
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X GET https://oom-server:30129/ccsdk-app/api-if/blueprints/findByName?name=string \
+  -H 'Accept: application/json'
+
+
    +

    GET /blueprints/findByName

    +

    Find a blueprint by a name pattern

    +

    Fetch the blueprint objects from inventory whose names match a string pattern

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ParameterInTypeRequiredDescription
    namequerystringtruename pattern to filter by
    _includequeryarray[string]falseblueprint object properties need to be considered for filter
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + + + + + +
    ParameterValue
    _includetypeName
    _includetypeId
    _includetypeVersion
    +
    +

    Example responses

    +
    +
    +

    200 Response

    +
    +
    {
+  "links": {
+    "previousLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    },
+    "nextLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    }
+  },
+  "totalCount": 0,
+  "items": [
+    {
+      "owner": "string",
+      "typeName": "string",
+      "typeVersion": 0,
+      "blueprintTemplate": "string",
+      "serviceIds": [
+        "string"
+      ],
+      "vnfTypes": [
+        "string"
+      ],
+      "serviceLocations": [
+        "string"
+      ],
+      "asdcServiceId": "string",
+      "asdcResourceId": "string",
+      "asdcServiceURL": "string",
+      "typeId": "string",
+      "selfLink": {
+        "title": "string",
+        "rel": "string",
+        "uri": "http://example.com",
+        "uriBuilder": {},
+        "rels": [
+          "string"
+        ],
+        "params": {
+          "property1": "string",
+          "property2": "string"
+        },
+        "type": "string"
+      },
+      "created": "2019-05-08T15:25:24Z",
+      "deactivated": "2019-05-08T15:25:24Z"
+    }
+  ]
+}
+
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKList of DCAEServiceType objectsInlineResponse200
    400Bad RequestInvalid tag valueNone
    401UnauthorizedAuthentication information is missing or invalidNone
    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Deployments

    +

    Manage deployments

    +

    List Deployments

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Accept': 'application/json'
+}
+
+r = requests.get('https://oom-server:30129/ccsdk-app/api-if/deployments', params={
+
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X GET https://oom-server:30129/ccsdk-app/api-if/deployments \
+  -H 'Accept: application/json'
+
+
    +

    GET /deployments

    +

    Lists all Deployments

    +

    Query all deployments or Service objects from Inventory

    +
    +

    Example responses

    +
    +
    +

    200 Response

    +
    +
    [
+  {
+    "serviceId": "string",
+    "selfLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    },
+    "created": "2019-05-08T15:25:24Z",
+    "modified": "2019-05-08T15:25:24Z",
+    "typeLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    },
+    "vnfId": "string",
+    "vnfLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    },
+    "vnfType": "string",
+    "vnfLocation": "string",
+    "deploymentRef": "string",
+    "components": [
+      {
+        "componentId": "string",
+        "componentLink": {
+          "title": "string",
+          "rel": "string",
+          "uri": "http://example.com",
+          "uriBuilder": {},
+          "rels": [
+            "string"
+          ],
+          "params": {
+            "property1": "string",
+            "property2": "string"
+          },
+          "type": "string"
+        },
+        "created": "2019-05-08T15:25:24Z",
+        "modified": "2019-05-08T15:25:24Z",
+        "componentType": "string",
+        "componentSource": "DCAEController",
+        "status": "string",
+        "location": "string",
+        "shareable": 0
+      }
+    ],
+    "tenant": "string"
+  }
+]
+
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKsuccessful operationInline
    400Bad RequestInvalid status valueNone
    401UnauthorizedAuthentication information is missing or invalidNone
    +

    Response Schema

    +

    Status Code 200

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    anonymous[DCAEService]falsenonenone
    » serviceIdstringfalsenonenone
    » selfLinkLinkfalsenonenone
    »» titlestringfalsenonenone
    »» relstringfalsenonenone
    »» uristring(uri)falsenonenone
    »» uriBuilderUriBuilderfalsenonenone
    »» rels[string]falsenonenone
    »» paramsobjectfalsenonenone
    »»» additionalPropertiesstringfalsenonenone
    »» typestringfalsenonenone
    » createdstring(date-time)falsenonenone
    » modifiedstring(date-time)falsenonenone
    » typeLinkLinkfalsenonenone
    » vnfIdstringfalsenonenone
    » vnfLinkLinkfalsenonenone
    » vnfTypestringfalsenonenone
    » vnfLocationstringfalsenoneLocation information of the associated VNF
    » deploymentRefstringfalsenoneReference to a Cloudify deployment
    » components[DCAEServiceComponent]falsenonenone
    »» componentIdstringtruenoneThe id format is unique to the source
    »» componentLinkLinktruenonenone
    »» createdstring(date-time)truenonenone
    »» modifiedstring(date-time)truenonenone
    »» componentTypestringtruenonenone
    »» componentSourcestringtruenoneSpecifies the name of the underying source service that is responsible for this components
    »» statusstringfalsenonenone
    »» locationstringfalsenoneLocation information of the component
    »» shareableinteger(int32)truenoneUsed to determine if this component can be shared amongst different DCAE services
    » tenantstringfalsenonecloudify tenant name
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + +
    PropertyValue
    componentSourceDCAEController
    componentSourceDMaaPController
    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Create Deployment

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Content-Type': 'application/json',
+  'Accept': 'application/json'
+}
+
+r = requests.post('https://oom-server:30129/ccsdk-app/api-if/deployments', params={
+
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X POST https://oom-server:30129/ccsdk-app/api-if/deployments \
+  -H 'Content-Type: application/json' \
+  -H 'Accept: application/json'
+
+
    +

    POST /deployments

    +

    Initiate a deployment (install) operation for an application or service

    +

    Controller sends the blueprint and required inputs to Deployment Handler microservice to initiate the deployment process

    +
    +

    Body parameter

    +
    +
    {
+  "component": "string",
+  "tag": "string",
+  "blueprintId": "string",
+  "blueprintName": "string",
+  "blueprintVersion": 0,
+  "tenant": "string",
+  "inputs": {}
+}
+
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    ParameterInTypeRequiredDescription
    bodybodyDeploymentInputtrueInputs to initiate a deployment: blueprint ID from inventory, Cloudify tenant name, blueprint inputs
    +
    +

    Example responses

    +
    +
    +

    200 Response

    +
    +
    {
+  "deployment_id": "string",
+  "links": {
+    "self": "string",
+    "outcome": "string",
+    "status": "string"
+  }
+}
+
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKsuccessful operationDeploymentResource
    401UnauthorizedAuthentication information is missing or invalidNone
    405Method Not AllowedInvalid inputNone
    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Delete Deployment

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Accept': 'application/json'
+}
+
+r = requests.delete('https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}', params={
+  'tenant': 'string'
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X DELETE https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}?tenant=string \
+  -H 'Accept: application/json'
+
+
    +

    DELETE /deployments/{deploymentId}

    +

    Initiate an uninstall operation for an application or service

    +

    Controller sends the deployment reference to Deployment Handler microservice to initiate the uninstall process

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ParameterInTypeRequiredDescription
    deploymentIdpathstringtrueID of deployment to query
    tenantquerystringtrueCloudify Tenant name
    +
    +

    Example responses

    +
    +
    +

    200 Response

    +
    +
    "string"
+
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKsuccessful operationstring
    400Bad RequestInvalid status valueNone
    401UnauthorizedAuthentication information is missing or invalidNone
    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Upgrade_Rollback Deployment

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Content-Type': 'application/json'
+}
+
+r = requests.put('https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}', params={
+
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X PUT https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId} \
+  -H 'Content-Type: application/json'
+
+
    +

    PUT /deployments/{deploymentId}

    +

    Upgrade or Rollback an existing deployment using Cloudify Helm plugin

    +

    Upgrade or Rollback an existing deployment using Cloudify Helm plugin

    +
    +

    Body parameter

    +
    +
    {
+  "chartVersion": "string",
+  "chartRepo": "string",
+  "config_url": "string",
+  "config_format": "string",
+  "tenant": "string",
+  "workflow": "string"
+}
+
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ParameterInTypeRequiredDescription
    deploymentIdpathstringtrueID of deployment in context
    bodybodyCloudifyDeploymentUpgradeRequesttrueCloudify Execution Request object that has parameters to start either an upgrade or a rollback execution workflow
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    400Bad RequestInvalid ID suppliedNone
    401UnauthorizedAuthentication information is missing or invalidNone
    404Not FoundDeployment not foundNone
    405Method Not AllowedValidation exceptionNone
    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Get Deployment

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Accept': 'application/json'
+}
+
+r = requests.get('https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}', params={
+
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X GET https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId} \
+  -H 'Accept: application/json'
+
+
    +

    GET /deployments/{deploymentId}

    +

    Gets a Deployment

    +

    Query a deployment or Service object from Inventory

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    ParameterInTypeRequiredDescription
    deploymentIdpathstringtrueID of deployment to query
    +
    +

    Example responses

    +
    +
    +

    200 Response

    +
    +
    [
+  {
+    "serviceId": "string",
+    "selfLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    },
+    "created": "2019-05-08T15:25:24Z",
+    "modified": "2019-05-08T15:25:24Z",
+    "typeLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    },
+    "vnfId": "string",
+    "vnfLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    },
+    "vnfType": "string",
+    "vnfLocation": "string",
+    "deploymentRef": "string",
+    "components": [
+      {
+        "componentId": "string",
+        "componentLink": {
+          "title": "string",
+          "rel": "string",
+          "uri": "http://example.com",
+          "uriBuilder": {},
+          "rels": [
+            "string"
+          ],
+          "params": {
+            "property1": "string",
+            "property2": "string"
+          },
+          "type": "string"
+        },
+        "created": "2019-05-08T15:25:24Z",
+        "modified": "2019-05-08T15:25:24Z",
+        "componentType": "string",
+        "componentSource": "DCAEController",
+        "status": "string",
+        "location": "string",
+        "shareable": 0
+      }
+    ],
+    "tenant": "string"
+  }
+]
+
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKsuccessful operationInline
    400Bad RequestInvalid status valueNone
    401UnauthorizedAuthentication information is missing or invalidNone
    +

    Response Schema

    +

    Status Code 200

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    anonymous[DCAEService]falsenonenone
    » serviceIdstringfalsenonenone
    » selfLinkLinkfalsenonenone
    »» titlestringfalsenonenone
    »» relstringfalsenonenone
    »» uristring(uri)falsenonenone
    »» uriBuilderUriBuilderfalsenonenone
    »» rels[string]falsenonenone
    »» paramsobjectfalsenonenone
    »»» additionalPropertiesstringfalsenonenone
    »» typestringfalsenonenone
    » createdstring(date-time)falsenonenone
    » modifiedstring(date-time)falsenonenone
    » typeLinkLinkfalsenonenone
    » vnfIdstringfalsenonenone
    » vnfLinkLinkfalsenonenone
    » vnfTypestringfalsenonenone
    » vnfLocationstringfalsenoneLocation information of the associated VNF
    » deploymentRefstringfalsenoneReference to a Cloudify deployment
    » components[DCAEServiceComponent]falsenonenone
    »» componentIdstringtruenoneThe id format is unique to the source
    »» componentLinkLinktruenonenone
    »» createdstring(date-time)truenonenone
    »» modifiedstring(date-time)truenonenone
    »» componentTypestringtruenonenone
    »» componentSourcestringtruenoneSpecifies the name of the underying source service that is responsible for this components
    »» statusstringfalsenonenone
    »» locationstringfalsenoneLocation information of the component
    »» shareableinteger(int32)truenoneUsed to determine if this component can be shared amongst different DCAE services
    » tenantstringfalsenonecloudify tenant name
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + +
    PropertyValue
    componentSourceDCAEController
    componentSourceDMaaPController
    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Update Deployment

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Content-Type': 'application/json'
+}
+
+r = requests.put('https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}/update', params={
+
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X PUT https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}/update \
+  -H 'Content-Type: application/json'
+
+
    +

    PUT /deployments/{deploymentId}/update

    +

    Update an existing deployment

    +

    Dispatch a request to Deployment handler mS to use Cloudify deployment update operation

    +
    +

    Body parameter

    +
    +
    {
+  "component": "string",
+  "tag": "string",
+  "blueprintId": "string",
+  "blueprintName": "string",
+  "blueprintVersion": 0,
+  "tenant": "string",
+  "inputs": {}
+}
+
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ParameterInTypeRequiredDescription
    deploymentIdpathstringtrueID of deployment to update
    bodybodyDeploymentInputtrueInputs to initiate a deployment: blueprint ID from inventory, Cloudify tenant name, blueprint inputs
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    400Bad RequestInvalid ID suppliedNone
    401UnauthorizedAuthentication information is missing or invalidNone
    404Not FoundDeployment not foundNone
    405Method Not AllowedValidation exceptionNone
    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Deployment Status

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Accept': 'application/json'
+}
+
+r = requests.get('https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}/executions', params={
+  'tenant': 'string'
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X GET https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}/executions?tenant=string \
+  -H 'Accept: application/json'
+
+
    +

    GET /deployments/{deploymentId}/executions

    +

    Deployment execution status

    +

    Query deployment workflow execution status

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ParameterInTypeRequiredDescription
    deploymentIdpathstringtrueID of deployment to query execution status
    tenantquerystringtruetenant name associated with the deployment
    +
    +

    Example responses

    +
    +
    +

    200 Response

    +
    +
    [
+  {
+    "created_at": "string",
+    "deployment_id": "string",
+    "id": "string",
+    "status": "string",
+    "workflow_id": "string",
+    "tenant_name": "string"
+  }
+]
+
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKsuccessful operationInline
    400Bad RequestInvalid status valueNone
    401UnauthorizedAuthentication information is missing or invalidNone
    +

    Response Schema

    +

    Status Code 200

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    anonymous[execution]falsenonenone
    » created_atstringfalsenoneThe time the execution was queued at
    » deployment_idstringfalsenoneThe id of the deployment the execution is in the context of
    » idstringfalsenoneA unique identifier for the execution
    » statusstringfalsenoneThe executions status
    » workflow_idstringfalsenoneThe id/name of the workflow the execution is of
    » tenant_namestringfalsenoneCloudify tenant name where the deployment was done
    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Deployment Inputs

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Accept': 'application/json'
+}
+
+r = requests.get('https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}/inputs', params={
+  'tenant': 'string'
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X GET https://oom-server:30129/ccsdk-app/api-if/deployments/{deploymentId}/inputs?tenant=string \
+  -H 'Accept: application/json'
+
+
    +

    GET /deployments/{deploymentId}/inputs

    +

    Deployment inputs

    +

    Get blueprint inputs used to create deployment

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ParameterInTypeRequiredDescription
    deploymentIdpathstringtrueID of deployment to query execution status
    tenantquerystringtruetenant name associated with the deployment
    +
    +

    Example responses

    +
    +
    +

    200 Response

    +
    +
    {}
+
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKsuccessful operationInline
    400Bad RequestInvalid status valueNone
    401UnauthorizedAuthentication information is missing or invalidNone
    +

    Response Schema

    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Tenants

    +

    Query Cloudify Tenants

    +

    List Tenants

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Accept': 'application/json'
+}
+
+r = requests.get('https://oom-server:30129/ccsdk-app/api-if/tenants', params={
+
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X GET https://oom-server:30129/ccsdk-app/api-if/tenants \
+  -H 'Accept: application/json'
+
+
    +

    GET /tenants

    +

    Lists all Cloudify Tenants

    +

    Query all Tenant names from Cloudify

    +
    +

    Example responses

    +
    +
    +

    200 Response

    +
    +
    [
+  {
+    "name": "string"
+  }
+]
+
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKsuccessful operationInline
    400Bad RequestInvalid status valueNone
    401UnauthorizedAuthentication information is missing or invalidNone
    +

    Response Schema

    +

    Status Code 200

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    anonymous[Tenant]falsenonenone
    » namestringfalsenonecloudify tenant name
    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Components

    +

    Query on-boarded components

    +

    List Components

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Accept': 'application/json'
+}
+
+r = requests.get('https://oom-server:30129/ccsdk-app/api-if/components', params={
+
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X GET https://oom-server:30129/ccsdk-app/api-if/components \
+  -H 'Accept: application/json'
+
+
    +

    GET /components

    +

    Lists all application components

    +

    Query all components from database

    +
    +

    Example responses

    +
    +
    +

    200 Response

    +
    +
    [
+  {
+    "compId": 0,
+    "cname": "string",
+    "dname": "string"
+  }
+]
+
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKsuccessful operationInline
    400Bad RequestInvalid status valueNone
    401UnauthorizedAuthentication information is missing or invalidNone
    +

    Response Schema

    +

    Status Code 200

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    anonymous[Component]falsenonenone
    » compIdintegerfalsenonenone
    » cnamestringfalsenonecomponent namespace name
    » dnamestringfalsenonecomponent display name
    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Add Component

    +

    +
    +

    Code samples

    +
    +
    import requests
+headers = {
+  'Content-Type': 'application/json',
+  'Accept': '*/*'
+}
+
+r = requests.post('https://oom-server:30129/ccsdk-app/api-if/components', params={
+
+}, headers = headers)
+
+print r.json()
+
+
    +
    # You can also use wget
+curl -X POST https://oom-server:30129/ccsdk-app/api-if/components \
+  -H 'Content-Type: application/json' \
+  -H 'Accept: */*'
+
+
    +

    POST /components

    +

    add an application component

    +

    Insert a component into database

    +
    +

    Body parameter

    +
    +
    {
+  "cname": "string",
+  "dname": "string"
+}
+
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    ParameterInTypeRequiredDescription
    bodybodyComponentInputtrueNew component input
    +
    +

    Example responses

    +
    +
    +

    200 Response

    +
    +

    Responses

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    StatusMeaningDescriptionSchema
    200OKsuccessful operationInline
    400Bad RequestInvalid status valueNone
    401UnauthorizedAuthentication information is missing or invalidNone
    +

    Response Schema

    +

    Response Headers

    + + + + + + + + + + + + + + + + + + + +
    StatusHeaderTypeFormatDescription
    401WWW_Authenticatestringnone
    + +

    Schemas

    +

    Tenant

    +

    +
    {
+  "name": "string"
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    namestringfalsenonecloudify tenant name
    +

    Component

    +

    +
    {
+  "compId": 0,
+  "cname": "string",
+  "dname": "string"
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    compIdintegerfalsenonenone
    cnamestringfalsenonecomponent namespace name
    dnamestringfalsenonecomponent display name
    +

    ComponentInput

    +

    +
    {
+  "cname": "string",
+  "dname": "string"
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    cnamestringfalsenonecomponent namespace name
    dnamestringfalsenonecomponent display name
    +

    InlineResponse200

    +

    +
    {
+  "links": {
+    "previousLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    },
+    "nextLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    }
+  },
+  "totalCount": 0,
+  "items": [
+    {
+      "owner": "string",
+      "typeName": "string",
+      "typeVersion": 0,
+      "blueprintTemplate": "string",
+      "serviceIds": [
+        "string"
+      ],
+      "vnfTypes": [
+        "string"
+      ],
+      "serviceLocations": [
+        "string"
+      ],
+      "asdcServiceId": "string",
+      "asdcResourceId": "string",
+      "asdcServiceURL": "string",
+      "typeId": "string",
+      "selfLink": {
+        "title": "string",
+        "rel": "string",
+        "uri": "http://example.com",
+        "uriBuilder": {},
+        "rels": [
+          "string"
+        ],
+        "params": {
+          "property1": "string",
+          "property2": "string"
+        },
+        "type": "string"
+      },
+      "created": "2019-05-08T15:25:24Z",
+      "deactivated": "2019-05-08T15:25:24Z"
+    }
+  ]
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    linksInlineResponse200LinksfalsenonePagination links
    totalCountinteger(int32)falsenonenone
    items[DCAEServiceType]falsenonenone
    + +

    +
    {
+  "previousLink": {
+    "title": "string",
+    "rel": "string",
+    "uri": "http://example.com",
+    "uriBuilder": {},
+    "rels": [
+      "string"
+    ],
+    "params": {
+      "property1": "string",
+      "property2": "string"
+    },
+    "type": "string"
+  },
+  "nextLink": {
+    "title": "string",
+    "rel": "string",
+    "uri": "http://example.com",
+    "uriBuilder": {},
+    "rels": [
+      "string"
+    ],
+    "params": {
+      "property1": "string",
+      "property2": "string"
+    },
+    "type": "string"
+  }
+}
+
+
    +

    Pagination links

    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    previousLinkLinkfalsenonenone
    nextLinkLinkfalsenonenone
    +

    ApiResponseMessage

    +

    +
    {
+  "code": 0,
+  "type": "string",
+  "message": "string"
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    codeinteger(int32)falsenonenone
    typestringfalsenonenone
    messagestringfalsenonenone
    +

    DCAEService

    +

    +
    {
+  "serviceId": "string",
+  "selfLink": {
+    "title": "string",
+    "rel": "string",
+    "uri": "http://example.com",
+    "uriBuilder": {},
+    "rels": [
+      "string"
+    ],
+    "params": {
+      "property1": "string",
+      "property2": "string"
+    },
+    "type": "string"
+  },
+  "created": "2019-05-08T15:25:24Z",
+  "modified": "2019-05-08T15:25:24Z",
+  "typeLink": {
+    "title": "string",
+    "rel": "string",
+    "uri": "http://example.com",
+    "uriBuilder": {},
+    "rels": [
+      "string"
+    ],
+    "params": {
+      "property1": "string",
+      "property2": "string"
+    },
+    "type": "string"
+  },
+  "vnfId": "string",
+  "vnfLink": {
+    "title": "string",
+    "rel": "string",
+    "uri": "http://example.com",
+    "uriBuilder": {},
+    "rels": [
+      "string"
+    ],
+    "params": {
+      "property1": "string",
+      "property2": "string"
+    },
+    "type": "string"
+  },
+  "vnfType": "string",
+  "vnfLocation": "string",
+  "deploymentRef": "string",
+  "components": [
+    {
+      "componentId": "string",
+      "componentLink": {
+        "title": "string",
+        "rel": "string",
+        "uri": "http://example.com",
+        "uriBuilder": {},
+        "rels": [
+          "string"
+        ],
+        "params": {
+          "property1": "string",
+          "property2": "string"
+        },
+        "type": "string"
+      },
+      "created": "2019-05-08T15:25:24Z",
+      "modified": "2019-05-08T15:25:24Z",
+      "componentType": "string",
+      "componentSource": "DCAEController",
+      "status": "string",
+      "location": "string",
+      "shareable": 0
+    }
+  ],
+  "tenant": "string"
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    serviceIdstringfalsenonenone
    selfLinkLinkfalsenoneLink.title is serviceId
    createdstring(date-time)falsenonenone
    modifiedstring(date-time)falsenonenone
    typeLinkLinkfalsenoneLink.title is typeId
    vnfIdstringfalsenonenone
    vnfLinkLinkfalsenoneLink.title is vnfId
    vnfTypestringfalsenonenone
    vnfLocationstringfalsenoneLocation information of the associated VNF
    deploymentRefstringfalsenoneReference to a Cloudify deployment
    components[DCAEServiceComponent]falsenonenone
    tenantstringfalsenonecloudify tenant name
    +

    InlineResponse2001

    +

    +
    {
+  "links": {
+    "previousLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    },
+    "nextLink": {
+      "title": "string",
+      "rel": "string",
+      "uri": "http://example.com",
+      "uriBuilder": {},
+      "rels": [
+        "string"
+      ],
+      "params": {
+        "property1": "string",
+        "property2": "string"
+      },
+      "type": "string"
+    }
+  },
+  "totalCount": 0,
+  "items": [
+    {
+      "serviceId": "string",
+      "selfLink": {
+        "title": "string",
+        "rel": "string",
+        "uri": "http://example.com",
+        "uriBuilder": {},
+        "rels": [
+          "string"
+        ],
+        "params": {
+          "property1": "string",
+          "property2": "string"
+        },
+        "type": "string"
+      },
+      "created": "2019-05-08T15:25:24Z",
+      "modified": "2019-05-08T15:25:24Z",
+      "typeLink": {
+        "title": "string",
+        "rel": "string",
+        "uri": "http://example.com",
+        "uriBuilder": {},
+        "rels": [
+          "string"
+        ],
+        "params": {
+          "property1": "string",
+          "property2": "string"
+        },
+        "type": "string"
+      },
+      "vnfId": "string",
+      "vnfLink": {
+        "title": "string",
+        "rel": "string",
+        "uri": "http://example.com",
+        "uriBuilder": {},
+        "rels": [
+          "string"
+        ],
+        "params": {
+          "property1": "string",
+          "property2": "string"
+        },
+        "type": "string"
+      },
+      "vnfType": "string",
+      "vnfLocation": "string",
+      "deploymentRef": "string",
+      "components": [
+        {
+          "componentId": "string",
+          "componentLink": {
+            "title": "string",
+            "rel": "string",
+            "uri": "http://example.com",
+            "uriBuilder": {},
+            "rels": [
+              "string"
+            ],
+            "params": {
+              "property1": "string",
+              "property2": "string"
+            },
+            "type": "string"
+          },
+          "created": "2019-05-08T15:25:24Z",
+          "modified": "2019-05-08T15:25:24Z",
+          "componentType": "string",
+          "componentSource": "DCAEController",
+          "status": "string",
+          "location": "string",
+          "shareable": 0
+        }
+      ],
+      "tenant": "string"
+    }
+  ]
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    linksInlineResponse200LinksfalsenonePagination links
    totalCountinteger(int32)falsenonenone
    items[DCAEService]falsenonenone
    +

    UriBuilder

    +

    +
    {}
+
+
    +

    Properties

    +

    None

    + +

    +
    {
+  "title": "string",
+  "rel": "string",
+  "uri": "http://example.com",
+  "uriBuilder": {},
+  "rels": [
+    "string"
+  ],
+  "params": {
+    "property1": "string",
+    "property2": "string"
+  },
+  "type": "string"
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    titlestringfalsenonenone
    relstringfalsenonenone
    uristring(uri)falsenonenone
    uriBuilderUriBuilderfalsenonenone
    rels[string]falsenonenone
    paramsobjectfalsenonenone
    » additionalPropertiesstringfalsenonenone
    typestringfalsenonenone
    +

    DCAEServiceComponent

    +

    +
    {
+  "componentId": "string",
+  "componentLink": {
+    "title": "string",
+    "rel": "string",
+    "uri": "http://example.com",
+    "uriBuilder": {},
+    "rels": [
+      "string"
+    ],
+    "params": {
+      "property1": "string",
+      "property2": "string"
+    },
+    "type": "string"
+  },
+  "created": "2019-05-08T15:25:24Z",
+  "modified": "2019-05-08T15:25:24Z",
+  "componentType": "string",
+  "componentSource": "DCAEController",
+  "status": "string",
+  "location": "string",
+  "shareable": 0
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    componentIdstringtruenoneThe id format is unique to the source
    componentLinkLinktruenoneLink to the underlying resource of this component
    createdstring(date-time)truenonenone
    modifiedstring(date-time)truenonenone
    componentTypestringtruenonenone
    componentSourcestringtruenoneSpecifies the name of the underying source service that is responsible for this components
    statusstringfalsenonenone
    locationstringfalsenoneLocation information of the component
    shareableinteger(int32)truenoneUsed to determine if this component can be shared amongst different DCAE services
    +

    Enumerated Values

    + + + + + + + + + + + + + + + + + +
    PropertyValue
    componentSourceDCAEController
    componentSourceDMaaPController
    +

    DCAEServiceTypeRequest

    +

    +
    {
+  "owner": "string",
+  "typeName": "string",
+  "typeVersion": 0,
+  "blueprintTemplate": "string",
+  "application": "string",
+  "component": "string"
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    ownerstringtruenonenone
    typeNamestringtruenoneDescriptive name for this DCAE service type
    typeVersioninteger(int32)truenoneVersion number for this DCAE service type
    blueprintTemplatestringtruenoneString representation of a Cloudify blueprint with unbound variables
    applicationstringtruenonecontroller application name
    componentstringtruenoneonboarding component name
    +

    DCAEServiceType

    +

    +
    {
+  "owner": "string",
+  "typeName": "string",
+  "typeVersion": 0,
+  "blueprintTemplate": "string",
+  "serviceIds": [
+    "string"
+  ],
+  "vnfTypes": [
+    "string"
+  ],
+  "serviceLocations": [
+    "string"
+  ],
+  "asdcServiceId": "string",
+  "asdcResourceId": "string",
+  "asdcServiceURL": "string",
+  "typeId": "string",
+  "selfLink": {
+    "title": "string",
+    "rel": "string",
+    "uri": "http://example.com",
+    "uriBuilder": {},
+    "rels": [
+      "string"
+    ],
+    "params": {
+      "property1": "string",
+      "property2": "string"
+    },
+    "type": "string"
+  },
+  "created": "2019-05-08T15:25:24Z",
+  "deactivated": "2019-05-08T15:25:24Z"
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    ownerstringtruenonenone
    typeNamestringtruenoneDescriptive name for this DCAE service type
    typeVersioninteger(int32)truenoneVersion number for this DCAE service type
    blueprintTemplatestringtruenoneString representation of a Cloudify blueprint with unbound variables
    serviceIds[string]falsenoneList of service ids that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service id.
    vnfTypes[string]falsenonenone
    serviceLocations[string]falsenoneList of service locations that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service location.
    asdcServiceIdstringfalsenoneId of service this DCAE service type is associated with. Value source is from ASDC's notification event's field serviceInvariantUUID.
    asdcResourceIdstringfalsenoneId of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field resourceInvariantUUID.
    asdcServiceURLstringfalsenoneURL to the ASDC service model
    typeIdstringtruenoneUnique identifier for this DCAE service type
    selfLinkLinktruenoneLink to self where the Link.title is typeName
    createdstring(date-time)truenoneCreated timestamp for this DCAE service type in epoch time
    deactivatedstring(date-time)falsenoneDeactivated timestamp for this DCAE service type in epoch time
    +

    CloudifyDeploymentUpgradeRequest

    +

    +
    {
+  "chartVersion": "string",
+  "chartRepo": "string",
+  "config_url": "string",
+  "config_format": "string",
+  "tenant": "string",
+  "workflow": "string"
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    chartVersionstringtruenoneHelm package version used for install
    chartRepostringtruenoneHelm repository URL for the chart
    config_urlstringtruenoneHelm repository URL for the chart values to update
    config_formatstringtruenoneyaml format or json format
    tenantstringtruenonecloudify tenant name for the deployment upgrade
    workflowstringtruenoneinput values are upgrade or rollback - helm upgrade workflow or helm rollback workflow
    +

    DeploymentInput

    +

    +
    {
+  "component": "string",
+  "tag": "string",
+  "blueprintId": "string",
+  "blueprintName": "string",
+  "blueprintVersion": 0,
+  "tenant": "string",
+  "inputs": {}
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    componentstringtruenonecomponent or namespace for the service
    tagstringtruenonetag to identify the deployment
    blueprintIdstringfalsenonetypeId from inventory, a unique Id for the blueprint
    blueprintNamestringtruenoneDescriptive name for this DCAE service type
    blueprintVersioninteger(int32)falsenoneVersion number for this DCAE service type, optional. Defaults to latest version.
    tenantstringtruenonecloudify tenant name
    inputsobjecttruenoneJSON object containing the input parameter names and values
    +

    deploymentInputs

    +

    +
    {}
+
+
    +

    Properties

    +

    None

    +

    execution

    +

    +
    {
+  "created_at": "string",
+  "deployment_id": "string",
+  "id": "string",
+  "status": "string",
+  "workflow_id": "string",
+  "tenant_name": "string"
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    created_atstringfalsenoneThe time the execution was queued at
    deployment_idstringfalsenoneThe id of the deployment the execution is in the context of
    idstringfalsenoneA unique identifier for the execution
    statusstringfalsenoneThe executions status
    workflow_idstringfalsenoneThe id/name of the workflow the execution is of
    tenant_namestringfalsenoneCloudify tenant name where the deployment was done
    + +

    +
    {
+  "self": "string",
+  "outcome": "string",
+  "status": "string"
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    selfstringfalsenoneLink to retrieve information about the service being deployed
    outcomestringfalsenoneLink to retrieve information about deployment outcome
    statusstringfalsenoneLink to retrieve information about the status of the installation workflow
    +

    DeploymentResource

    +

    +
    {
+  "deployment_id": "string",
+  "links": {
+    "self": "string",
+    "outcome": "string",
+    "status": "string"
+  }
+}
+
+
    +

    Properties

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeRequiredRestrictionsDescription
    deployment_idstringfalsenoneunique ID for the deployment resource
    linksDeploymentResourceLinksfalsenoneLinks that the API client can access
    + +
    +
    + +
    + + + Python + + + + Shell + + +
    + +
    +
    + + -- cgit 1.2.3-korg