HP OneView REST API Reference

global-settings
global-settings.html[10/17/2013 10:35:54 AM]
Method API
GET Generates the 'setting' JSON formatted schema
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Response Description
JsonSchema The JSON schema of 'setting'
Response Codes
REST API Response Codes
Examples
This example returns the JSON schema of 'setting'
GET https://{appl}/rest/global-settings/schema
URI: /rest/global-settings/{id}
Method API
GET Gets the setting corresponding to a given setting ID
Parameter Attributes Description
view Optional Return a specific subset of the attributes of the resource or collection
by specifying the name of a predefined view. The default view is
expand (show all attributes of the resource, and all elements of
collections or resources).
fields Optional Specifies which fields/columns should be returned in the response
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Response Description
Setting The value of the setting for the specified ID
Response Codes
REST API Response Codes
Examples
This example returns the setting for the specified setting ID
GET https://{appl}/rest/global-settings/1234-1234-1234
DELETE Removes the setting with the specified ID