app-service_management

On this page:

getInstance

Summary

Get Details of a Service Instance

Description

Get all properties for a service model instance

Route

GET /service_management/getInstance/:model/:value

Roles

admin apiread

Parameters

DetailsExampleSchema
Name Type Required Description
model string yes A service model's XPATH. The XPATH is obtained from 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.
value string yes A service model instance's keys learned from ServiceManager.getInstancesOfService(). Keys are expressed as a space delimited list of key values.

Return

DetailsExampleSchema
Name Type Description
result object An object with a single field with the service model's XPATH as its key. The field's value is an array of objects. Each element of the array is an object representing the properties of a service model instance.