Summary
Get All Instances of a Service
Description
Get all instances of a service by service model name.
Route
GET /service_management/service/instance/:name
Roles
admin
engineering
support
apiread
Parameters
DetailsExampleSchema
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | yes | A service model's XPATH. The XPATH can be obtained from the API <a href='#getServiceModelMap'>ServiceManagement.getServiceModelMap(). 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. |
Return
DetailsExampleSchema
| Name | Type | Description |
|---|---|---|
| service_instances | array | An array of objects. Each object holds details on a service instance. Fields key_type and key_value holds the key field names and key field values, respectively, for the instance. Multi-field keys are expressed as a space-delimited list of strings. |