app-service_management

On this page:

getServiceModel

Summary

Get Details of a Service Model

Description

Get all details on a service model; including its name and the fields that make up its keys

Route

GET /service_management/model/:service_model_path

Roles

admin engineering support apiread

Parameters

DetailsExampleSchema
Name Type Required Description
service_model_path string yes service_model_path - 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.

Return

DetailsExampleSchema
Name Type Description
service_model object {Object} Details on the service model argument including its name, the fields that make up its keys, etc. For service model's with multi-field keys, the key is expressed as a space-delimited string of key-field names.