Inventory API

Description

DCAE Inventory is a web service that provides the following:

1. Real-time data on all DCAE services and their components

2. Comprehensive details on available DCAE service types

API name	Swagger YAML
Inventory	link

Contact Information

dcae@lists.openecomp.org

DEFAULT

GET /dcae-service-types

Description

Get a list of `DCAEServiceType` objects.

Parameters

Name	Located in	Required	Type	Format	Properties	Description
typeName	query	No	string			Filter by service type name
onlyLatest	query	No	boolean		{“default”: true}	If set to true, query returns just the latest versions of DCAE service types. If set to false, then all versions are returned. Default is true
onlyActive	query	No	boolean		{“default”: true}	If set to true, query returns only active DCAE service types. If set to false, then all DCAE service types are returned. Default is true
vnfType	query	No	string			Filter by associated vnf type. No wildcards, matches are explicit. This field is treated case insensitive.
serviceId	query	No	string			Filter by assocaited service id. Instances with service id null or empty is always returned.
serviceLocation	query	No	string			Filter by associated service location. Instances with service location null or empty is always returned.
asdcServiceId	query	No	string			Filter by associated asdc design service id. Setting this to NONE will return instances that have asdc service id set to null
asdcResourceId	query	No	string			Filter by associated asdc design resource id. Setting this to NONE will return instances that have asdc resource id set to null
offset	query	No	integer	int32		Query resultset offset used for pagination (zero-based)

Request

Responses

200

List of DCAEServiceType objects

Type: InlineResponse200

Example:

{
    "items": [
        {
            "asdcResourceId": "somestring",
            "asdcServiceId": "somestring",
            "asdcServiceURL": "somestring",
            "blueprintTemplate": "somestring",
            "created": "2015-01-01T15:00:00.000Z",
            "deactivated": "2015-01-01T15:00:00.000Z",
            "owner": "somestring",
            "selfLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "serviceIds": [
                "somestring",
                "somestring"
            ],
            "serviceLocations": [
                "somestring",
                "somestring"
            ],
            "typeId": "somestring",
            "typeName": "somestring",
            "typeVersion": 1,
            "vnfTypes": [
                "somestring",
                "somestring"
            ]
        },
        {
            "asdcResourceId": "somestring",
            "asdcServiceId": "somestring",
            "asdcServiceURL": "somestring",
            "blueprintTemplate": "somestring",
            "created": "2015-01-01T15:00:00.000Z",
            "deactivated": "2015-01-01T15:00:00.000Z",
            "owner": "somestring",
            "selfLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "serviceIds": [
                "somestring",
                "somestring"
            ],
            "serviceLocations": [
                "somestring",
                "somestring"
            ],
            "typeId": "somestring",
            "typeName": "somestring",
            "typeVersion": 1,
            "vnfTypes": [
                "somestring",
                "somestring"
            ]
        }
    ],
    "links": {
        "nextLink": {
            "params": {},
            "rel": "somestring",
            "rels": [
                "somestring",
                "somestring"
            ],
            "title": "somestring",
            "type": "somestring",
            "uri": "somestring",
            "uriBuilder": {}
        },
        "previousLink": {
            "params": {},
            "rel": "somestring",
            "rels": [
                "somestring",
                "somestring"
            ],
            "title": "somestring",
            "type": "somestring",
            "uri": "somestring",
            "uriBuilder": {}
        }
    },
    "totalCount": 1
}

DELETE /dcae-service-types/{typeId}

Description

Deactivates existing `DCAEServiceType` instances

Parameters

Name	Located in	Required	Type	Format	Properties	Description
typeId	path	Yes	string

Request

Responses

200

DCAEServiceType has been deactivated

Type: ApiResponseMessage

Example:

{
    "code": 1,
    "message": "somestring",
    "type": "somestring"
}

404

DCAEServiceType not found

Type: ApiResponseMessage

Example:

{
    "code": 1,
    "message": "somestring",
    "type": "somestring"
}

410

DCAEServiceType already gone

Type: ApiResponseMessage

Example:

{
    "code": 1,
    "message": "somestring",
    "type": "somestring"
}

GET /dcae-service-types/{typeId}

Description

Get a `DCAEServiceType` object.

Parameters

Name	Located in	Required	Type	Format	Properties	Description
typeId	path	Yes	string

Request

Responses

200

Single DCAEServiceType object

Type: DCAEServiceType

Example:

{
    "asdcResourceId": "somestring",
    "asdcServiceId": "somestring",
    "asdcServiceURL": "somestring",
    "blueprintTemplate": "somestring",
    "created": "2015-01-01T15:00:00.000Z",
    "deactivated": "2015-01-01T15:00:00.000Z",
    "owner": "somestring",
    "selfLink": {
        "params": {},
        "rel": "somestring",
        "rels": [
            "somestring",
            "somestring"
        ],
        "title": "somestring",
        "type": "somestring",
        "uri": "somestring",
        "uriBuilder": {}
    },
    "serviceIds": [
        "somestring",
        "somestring"
    ],
    "serviceLocations": [
        "somestring",
        "somestring"
    ],
    "typeId": "somestring",
    "typeName": "somestring",
    "typeVersion": 1,
    "vnfTypes": [
        "somestring",
        "somestring"
    ]
}

404

Resource not found

Type: DCAEServiceType

Example:

{
    "asdcResourceId": "somestring",
    "asdcServiceId": "somestring",
    "asdcServiceURL": "somestring",
    "blueprintTemplate": "somestring",
    "created": "2015-01-01T15:00:00.000Z",
    "deactivated": "2015-01-01T15:00:00.000Z",
    "owner": "somestring",
    "selfLink": {
        "params": {},
        "rel": "somestring",
        "rels": [
            "somestring",
            "somestring"
        ],
        "title": "somestring",
        "type": "somestring",
        "uri": "somestring",
        "uriBuilder": {}
    },
    "serviceIds": [
        "somestring",
        "somestring"
    ],
    "serviceLocations": [
        "somestring",
        "somestring"
    ],
    "typeId": "somestring",
    "typeName": "somestring",
    "typeVersion": 1,
    "vnfTypes": [
        "somestring",
        "somestring"
    ]
}

POST /dcae-service-types

Description

Inserts a new `DCAEServiceType` or updates an existing instance. Updates are only allowed iff there are no running DCAE services of the requested type,

Request

Body

Name	Required	Type	Format	Properties	Description
asdcResourceId	No	string			Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC’s notification event’s field resourceInvariantUUID.
asdcServiceId	No	string			Id of service this DCAE service type is associated with. Value source is from ASDC’s notification event’s field serviceInvariantUUID.
asdcServiceURL	No	string			URL to the ASDC service model
blueprintTemplate	Yes	string			String representation of a Cloudify blueprint with unbound variables
owner	Yes	string
serviceIds	No	array of string			List 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.
serviceLocations	No	array of string			List 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.
typeName	Yes	string			Descriptive name for this DCAE service type
typeVersion	Yes	integer	int32		Version number for this DCAE service type
vnfTypes	No	array of string

{
    "asdcResourceId": "somestring",
    "asdcServiceId": "somestring",
    "asdcServiceURL": "somestring",
    "blueprintTemplate": "somestring",
    "owner": "somestring",
    "serviceIds": [
        "somestring",
        "somestring"
    ],
    "serviceLocations": [
        "somestring",
        "somestring"
    ],
    "typeName": "somestring",
    "typeVersion": 1,
    "vnfTypes": [
        "somestring",
        "somestring"
    ]
}

Responses

200

Single DCAEServiceType object.

Type: DCAEServiceType

Example:

{
    "asdcResourceId": "somestring",
    "asdcServiceId": "somestring",
    "asdcServiceURL": "somestring",
    "blueprintTemplate": "somestring",
    "created": "2015-01-01T15:00:00.000Z",
    "deactivated": "2015-01-01T15:00:00.000Z",
    "owner": "somestring",
    "selfLink": {
        "params": {},
        "rel": "somestring",
        "rels": [
            "somestring",
            "somestring"
        ],
        "title": "somestring",
        "type": "somestring",
        "uri": "somestring",
        "uriBuilder": {}
    },
    "serviceIds": [
        "somestring",
        "somestring"
    ],
    "serviceLocations": [
        "somestring",
        "somestring"
    ],
    "typeId": "somestring",
    "typeName": "somestring",
    "typeVersion": 1,
    "vnfTypes": [
        "somestring",
        "somestring"
    ]
}

400

Bad request provided.

Type: ApiResponseMessage

Example:

{
    "code": 1,
    "message": "somestring",
    "type": "somestring"
}

409

Failed to update because there are still DCAE services of the requested type running.

Type: ApiResponseMessage

Example:

{
    "code": 1,
    "message": "somestring",
    "type": "somestring"
}

GET /dcae-services

Description

Get a list of `DCAEService` objects.

Parameters

Name	Located in	Required	Type	Format	Properties	Description
typeId	query	No	string			DCAE service type name
vnfId	query	No	string
vnfType	query	No	string			Filter by associated vnf type. This field is treated case insensitive.
vnfLocation	query	No	string
componentType	query	No	string			Use to filter by a specific DCAE service component type
shareable	query	No	boolean			Use to filter by DCAE services that have shareable components or not
created	query	No	string			Use to filter by created time
offset	query	No	integer	int32		Query resultset offset used for pagination (zero-based)

Request

Responses

200

List of DCAEService objects

Type: InlineResponse2001

Example:

{
    "items": [
        {
            "components": [
                {
                    "componentId": "somestring",
                    "componentLink": {
                        "params": {},
                        "rel": "somestring",
                        "rels": [
                            "somestring",
                            "somestring"
                        ],
                        "title": "somestring",
                        "type": "somestring",
                        "uri": "somestring",
                        "uriBuilder": {}
                    },
                    "componentSource": "DCAEController",
                    "componentType": "somestring",
                    "created": "2015-01-01T15:00:00.000Z",
                    "location": "somestring",
                    "modified": "2015-01-01T15:00:00.000Z",
                    "shareable": 1,
                    "status": "somestring"
                },
                {
                    "componentId": "somestring",
                    "componentLink": {
                        "params": {},
                        "rel": "somestring",
                        "rels": [
                            "somestring",
                            "somestring"
                        ],
                        "title": "somestring",
                        "type": "somestring",
                        "uri": "somestring",
                        "uriBuilder": {}
                    },
                    "componentSource": "DCAEController",
                    "componentType": "somestring",
                    "created": "2015-01-01T15:00:00.000Z",
                    "location": "somestring",
                    "modified": "2015-01-01T15:00:00.000Z",
                    "shareable": 1,
                    "status": "somestring"
                }
            ],
            "created": "2015-01-01T15:00:00.000Z",
            "deploymentRef": "somestring",
            "modified": "2015-01-01T15:00:00.000Z",
            "selfLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "serviceId": "somestring",
            "typeLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "vnfId": "somestring",
            "vnfLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "vnfLocation": "somestring",
            "vnfType": "somestring"
        },
        {
            "components": [
                {
                    "componentId": "somestring",
                    "componentLink": {
                        "params": {},
                        "rel": "somestring",
                        "rels": [
                            "somestring",
                            "somestring"
                        ],
                        "title": "somestring",
                        "type": "somestring",
                        "uri": "somestring",
                        "uriBuilder": {}
                    },
                    "componentSource": "DCAEController",
                    "componentType": "somestring",
                    "created": "2015-01-01T15:00:00.000Z",
                    "location": "somestring",
                    "modified": "2015-01-01T15:00:00.000Z",
                    "shareable": 1,
                    "status": "somestring"
                },
                {
                    "componentId": "somestring",
                    "componentLink": {
                        "params": {},
                        "rel": "somestring",
                        "rels": [
                            "somestring",
                            "somestring"
                        ],
                        "title": "somestring",
                        "type": "somestring",
                        "uri": "somestring",
                        "uriBuilder": {}
                    },
                    "componentSource": "DCAEController",
                    "componentType": "somestring",
                    "created": "2015-01-01T15:00:00.000Z",
                    "location": "somestring",
                    "modified": "2015-01-01T15:00:00.000Z",
                    "shareable": 1,
                    "status": "somestring"
                }
            ],
            "created": "2015-01-01T15:00:00.000Z",
            "deploymentRef": "somestring",
            "modified": "2015-01-01T15:00:00.000Z",
            "selfLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "serviceId": "somestring",
            "typeLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "vnfId": "somestring",
            "vnfLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "vnfLocation": "somestring",
            "vnfType": "somestring"
        }
    ],
    "links": {
        "nextLink": {
            "params": {},
            "rel": "somestring",
            "rels": [
                "somestring",
                "somestring"
            ],
            "title": "somestring",
            "type": "somestring",
            "uri": "somestring",
            "uriBuilder": {}
        },
        "previousLink": {
            "params": {},
            "rel": "somestring",
            "rels": [
                "somestring",
                "somestring"
            ],
            "title": "somestring",
            "type": "somestring",
            "uri": "somestring",
            "uriBuilder": {}
        }
    },
    "totalCount": 1
}

502

Bad response from DCAE controller

Type: ApiResponseMessage

Example:

{
    "code": 1,
    "message": "somestring",
    "type": "somestring"
}

504

Failed to connect with DCAE controller

Type: ApiResponseMessage

Example:

{
    "code": 1,
    "message": "somestring",
    "type": "somestring"
}

GET /dcae-services-groupby/{propertyName}

Description

Get a list of unique values for the given `propertyName`

Parameters

Name	Located in	Required	Type	Format	Properties	Description
propertyName	path	Yes	string			Property to find unique values. Restricted to type, vnfType, vnfLocation

Request

Responses

200

List of unique property values

Type: DCAEServiceGroupByResults

Example:

{
    "propertyName": "somestring",
    "propertyValues": [
        {
            "count": 1,
            "dcaeServiceQueryLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "propertyValue": "somestring"
        },
        {
            "count": 1,
            "dcaeServiceQueryLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "propertyValue": "somestring"
        }
    ]
}

DELETE /dcae-services/{serviceId}

Description

Remove an existing `DCAEService` object.

Parameters

Name	Located in	Required	Type	Format	Properties	Description
serviceId	path	Yes	string

Request

Responses

200

DCAE service has been removed

404

Unknown DCAE service

Type: ApiResponseMessage

Example:

{
    "code": 1,
    "message": "somestring",
    "type": "somestring"
}

GET /dcae-services/{serviceId}

Description

Get a `DCAEService` object.

Parameters

Name	Located in	Required	Type	Format	Properties	Description
serviceId	path	Yes	string

Request

Responses

200

Single DCAEService object

Type: DCAEService

Example:

{
    "components": [
        {
            "componentId": "somestring",
            "componentLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "componentSource": "DCAEController",
            "componentType": "somestring",
            "created": "2015-01-01T15:00:00.000Z",
            "location": "somestring",
            "modified": "2015-01-01T15:00:00.000Z",
            "shareable": 1,
            "status": "somestring"
        },
        {
            "componentId": "somestring",
            "componentLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "componentSource": "DCAEController",
            "componentType": "somestring",
            "created": "2015-01-01T15:00:00.000Z",
            "location": "somestring",
            "modified": "2015-01-01T15:00:00.000Z",
            "shareable": 1,
            "status": "somestring"
        }
    ],
    "created": "2015-01-01T15:00:00.000Z",
    "deploymentRef": "somestring",
    "modified": "2015-01-01T15:00:00.000Z",
    "selfLink": {
        "params": {},
        "rel": "somestring",
        "rels": [
            "somestring",
            "somestring"
        ],
        "title": "somestring",
        "type": "somestring",
        "uri": "somestring",
        "uriBuilder": {}
    },
    "serviceId": "somestring",
    "typeLink": {
        "params": {},
        "rel": "somestring",
        "rels": [
            "somestring",
            "somestring"
        ],
        "title": "somestring",
        "type": "somestring",
        "uri": "somestring",
        "uriBuilder": {}
    },
    "vnfId": "somestring",
    "vnfLink": {
        "params": {},
        "rel": "somestring",
        "rels": [
            "somestring",
            "somestring"
        ],
        "title": "somestring",
        "type": "somestring",
        "uri": "somestring",
        "uriBuilder": {}
    },
    "vnfLocation": "somestring",
    "vnfType": "somestring"
}

404

DCAE service not found

Type: ApiResponseMessage

Example:

{
    "code": 1,
    "message": "somestring",
    "type": "somestring"
}

502

Bad response from DCAE controller

Type: ApiResponseMessage

Example:

{
    "code": 1,
    "message": "somestring",
    "type": "somestring"
}

504

Failed to connect with DCAE controller

Type: ApiResponseMessage

Example:

{
    "code": 1,
    "message": "somestring",
    "type": "somestring"
}

PUT /dcae-services/{serviceId}

Description

Put a new or update an existing `DCAEService` object.

Parameters

Name	Located in	Required	Type	Format	Properties	Description
serviceId	path	Yes	string

Request

Body

Name	Required	Type	Format	Properties	Description
components	Yes	array of DCAEServiceComponentRequest			List of DCAE service components that this service is composed of
deploymentRef	No	string			Reference to a Cloudify deployment
typeId	Yes	string			Id of the associated DCAE service type
vnfId	Yes	string			Id of the associated VNF that this service is monitoring
vnfLocation	Yes	string			Location identifier of the associated VNF that this service is monitoring
vnfType	Yes	string			The type of the associated VNF that this service is monitoring

{
    "components": [
        {
            "componentId": "somestring",
            "componentSource": "DCAEController",
            "componentType": "somestring",
            "shareable": 1
        },
        {
            "componentId": "somestring",
            "componentSource": "DCAEController",
            "componentType": "somestring",
            "shareable": 1
        }
    ],
    "deploymentRef": "somestring",
    "typeId": "somestring",
    "vnfId": "somestring",
    "vnfLocation": "somestring",
    "vnfType": "somestring"
}

Responses

200

Single DCAEService object

Type: DCAEService

Example:

{
    "components": [
        {
            "componentId": "somestring",
            "componentLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "componentSource": "DCAEController",
            "componentType": "somestring",
            "created": "2015-01-01T15:00:00.000Z",
            "location": "somestring",
            "modified": "2015-01-01T15:00:00.000Z",
            "shareable": 1,
            "status": "somestring"
        },
        {
            "componentId": "somestring",
            "componentLink": {
                "params": {},
                "rel": "somestring",
                "rels": [
                    "somestring",
                    "somestring"
                ],
                "title": "somestring",
                "type": "somestring",
                "uri": "somestring",
                "uriBuilder": {}
            },
            "componentSource": "DCAEController",
            "componentType": "somestring",
            "created": "2015-01-01T15:00:00.000Z",
            "location": "somestring",
            "modified": "2015-01-01T15:00:00.000Z",
            "shareable": 1,
            "status": "somestring"
        }
    ],
    "created": "2015-01-01T15:00:00.000Z",
    "deploymentRef": "somestring",
    "modified": "2015-01-01T15:00:00.000Z",
    "selfLink": {
        "params": {},
        "rel": "somestring",
        "rels": [
            "somestring",
            "somestring"
        ],
        "title": "somestring",
        "type": "somestring",
        "uri": "somestring",
        "uriBuilder": {}
    },
    "serviceId": "somestring",
    "typeLink": {
        "params": {},
        "rel": "somestring",
        "rels": [
            "somestring",
            "somestring"
        ],
        "title": "somestring",
        "type": "somestring",
        "uri": "somestring",
        "uriBuilder": {}
    },
    "vnfId": "somestring",
    "vnfLink": {
        "params": {},
        "rel": "somestring",
        "rels": [
            "somestring",
            "somestring"
        ],
        "title": "somestring",
        "type": "somestring",
        "uri": "somestring",
        "uriBuilder": {}
    },
    "vnfLocation": "somestring",
    "vnfType": "somestring"
}

422

Bad request provided

Type: ApiResponseMessage

Example:

{
    "code": 1,
    "message": "somestring",
    "type": "somestring"
}

Data Structures

ApiResponseMessage Model Structure

Name	Required	Type	Format	Properties	Description
code	No	integer	int32
message	No	string
type	No	string

DCAEService Model Structure

Name	Required	Type	Format	Properties	Description
components	No	array of DCAEServiceComponent
created	No	string	date-time
deploymentRef	No	string			Reference to a Cloudify deployment
modified	No	string	date-time
selfLink	No	Link			Link.title is serviceId
serviceId	No	string
typeLink	No	Link			Link.title is typeId
vnfId	No	string
vnfLink	No	Link			Link.title is vnfId
vnfLocation	No	string			Location information of the associated VNF
vnfType	No	string

DCAEServiceComponent Model Structure

Name	Required	Type	Format	Properties	Description
componentId	Yes	string			The id format is unique to the source
componentLink	Yes	Link			Link to the underlying resource of this component
componentSource	Yes	string		{‘enum’: [‘DCAEController’, ‘DMaaPController’]}	Specifies the name of the underying source service that is responsible for this components
componentType	Yes	string
created	Yes	string	date-time
location	No	string			Location information of the component
modified	Yes	string	date-time
shareable	Yes	integer	int32		Used to determine if this component can be shared amongst different DCAE services
status	No	string

DCAEServiceComponentRequest Model Structure

Name	Required	Type	Format	Properties	Description
componentId	Yes	string			The id format is unique to the source
componentSource	Yes	string		{‘enum’: [‘DCAEController’, ‘DMaaPController’]}	Specifies the name of the underying source service that is responsible for this components
componentType	Yes	string
shareable	Yes	integer	int32		Used to determine if this component can be shared amongst different DCAE services

DCAEServiceGroupByResults Model Structure

Name	Required	Type	Format	Properties	Description
propertyName	No	string			Property name of DCAE service that the group by operation was performed on
propertyValues	No	array of DCAEServiceGroupByResultsPropertyValues

DCAEServiceGroupByResultsPropertyValues Model Structure

Name	Required	Type	Format	Properties	Description
count	No	integer	int32
dcaeServiceQueryLink	No	Link			Link.title is the DCAE service property value. Following this link will provide a list of DCAE services that all have this property value.
propertyValue	No	string

DCAEServiceRequest Model Structure

Name	Required	Type	Format	Properties	Description
components	Yes	array of DCAEServiceComponentRequest			List of DCAE service components that this service is composed of
deploymentRef	No	string			Reference to a Cloudify deployment
typeId	Yes	string			Id of the associated DCAE service type
vnfId	Yes	string			Id of the associated VNF that this service is monitoring
vnfLocation	Yes	string			Location identifier of the associated VNF that this service is monitoring
vnfType	Yes	string			The type of the associated VNF that this service is monitoring

DCAEServiceType Model Structure

Name	Required	Type	Format	Properties	Description
asdcResourceId	No	string			Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC’s notification event’s field resourceInvariantUUID.
asdcServiceId	No	string			Id of service this DCAE service type is associated with. Value source is from ASDC’s notification event’s field serviceInvariantUUID.
asdcServiceURL	No	string			URL to the ASDC service model
blueprintTemplate	Yes	string			String representation of a Cloudify blueprint with unbound variables
created	Yes	string	date-time		Created timestamp for this DCAE service type in epoch time
deactivated	No	string	date-time		Deactivated timestamp for this DCAE service type in epoch time
owner	Yes	string
selfLink	Yes	Link			Link to self where the Link.title is typeName
serviceIds	No	array of string			List 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.
serviceLocations	No	array of string			List 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.
typeId	Yes	string			Unique identifier for this DCAE service type
typeName	Yes	string			Descriptive name for this DCAE service type
typeVersion	Yes	integer	int32		Version number for this DCAE service type
vnfTypes	No	array of string

DCAEServiceTypeRequest Model Structure

Name	Required	Type	Format	Properties	Description
asdcResourceId	No	string			Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC’s notification event’s field resourceInvariantUUID.
asdcServiceId	No	string			Id of service this DCAE service type is associated with. Value source is from ASDC’s notification event’s field serviceInvariantUUID.
asdcServiceURL	No	string			URL to the ASDC service model
blueprintTemplate	Yes	string			String representation of a Cloudify blueprint with unbound variables
owner	Yes	string
serviceIds	No	array of string			List 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.
serviceLocations	No	array of string			List 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.
typeName	Yes	string			Descriptive name for this DCAE service type
typeVersion	Yes	integer	int32		Version number for this DCAE service type
vnfTypes	No	array of string

InlineResponse200 Model Structure

Name	Required	Type	Format	Properties	Description
items	No	array of DCAEServiceType
links	No	InlineResponse200Links
totalCount	No	integer	int32

InlineResponse2001 Model Structure

Name	Required	Type	Format	Properties	Description
items	No	array of DCAEService
links	No	InlineResponse200Links
totalCount	No	integer	int32

InlineResponse200Links Model Structure

Pagination links

Name	Required	Type	Format	Properties	Description
nextLink	No	Link
previousLink	No	Link

Link Model Structure

Name	Required	Type	Format	Properties	Description
params	No	params
rel	No	string
rels	No	array of string
title	No	string
type	No	string
uri	No	string	uri
uriBuilder	No	UriBuilder

Params schema:

Map of {“key”:”string”}

UriBuilder Model Structure