Summary
Delete Service Instance
Description
This API call will delete one or more service instances from a specified host.
Route
DELETE /service_management/service/instance/delete/:name/:key
Roles
admin
engineering
support
Parameters
DetailsExampleSchema
Name | Type | Required | Description |
---|---|---|---|
name | string | yes | A service model's XPATH. The XPATH is obtained from [API ServiceManager.getServiceModelMap]{@link cogs.ServiceManager#getServiceModelMap}</a>. When using this API over HTTP, this will be a part of the path itself. Therefore (since service models always include '/' character), the path will first need to be URL encoded. A good site for URL encoding text is URL Encoder. |
key | string | yes | A single field object with key keys and value an array. Each element in the array is a string representing the key values for a service model instance. |
Return
DetailsExampleSchema
Name | Type | Description |
---|---|---|
data | string | A string providing status of Delete action on Service Instance. |