HP OneView REST API Reference

global-settings
global-settings.html[10/17/2013 10:35:54 AM]
A general query string that narrows the list of resources
returned by a multi-resource GET (read) request and
DELETE (delete) request. The default is no query (all
resources are returned). One advantage query has over
filter is that it can have embedded ORs. A single
query parameter can do what would take multiple
parameters or multiple GET requests using filter. Use
query for more complex queries.
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
filter Experimental This parameter is experimental for this release: While
generally functional when used in simple cases,
restrictions might be noted in the implementation
description.
A general filter/query string that narrows the list of
resources returned by a multi-resource GET (read) request
and DELETE (delete) request. The default is no filter (all
resources are returned).
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
SettingsPaginatedCollection Returns an array of settings
Response Codes
REST API Response Codes
Examples
This example returns the list of settings, starting with index 10, and
with a maximum count of 10.
GET https://{appl}/rest/global-settings?start=10&count=10
POST Adds a global setting
Parameter Attributes Description
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"
Request
Body
Attributes Description
Setting Required Contains the 'setting' object parameters like name,