HP OneView REST API Reference

tasks
tasks.html[10/17/2013 10:35:11 AM]
query Experimental This parameter is experimental for this release: While generally
functional when used in simple cases, restrictions might be noted
in the implementation description.
If the query is supported, the following is the way it works. 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
TaskResourcePaginatedCollectionV2 Paginated list of all V2 tasks
Response Codes
REST API Response Codes
Examples
These examples return V2 tasks based on the filters provided.
GET https://{appl}/rest/tasks
Filtering examples:
-https://{appl}/rest/tasks?filter="taskState='New'"
-https://{appl}/rest/tasks?
filter="taskState='Running'&filter="associatedResource.resourceCatgory='appliance'"
-https://{appl}/rest/tasks?
filter="taskState='Running'&filter="associatedResource.resourceUri='/rest/abcd/123'"
-https://{appl}/rest/tasks?
filter="taskState='Running'&filter="associatedResource.resourceName='myresource'"