HP OneView REST API Reference

tasks
tasks.html[10/17/2013 10:35:11 AM]
This example returns the task V2 with task ID: 1234-1234-1234
GET https://{appl}/rest/tasks/1234-1234-1234
PUT Updates the task V2 corresponding to a given task ID
Parameter Attributes Description
force Optional If set to true, the operation completes even if there are network
connectivity issues or resource errors. The default is false.
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
TaskUpdateV2 Required
Response Description
TaskResourceV2 Represents the task V2 with the specified ID
Response Codes
REST API Response Codes
Examples
This example updates the task V2 of task ID: 1234-1234-1234 using the
specified parameters
PUT https://{appl}/rest/tasks/1234-1234-1234
{
"type":"TaskUpdateV2",
"percentComplete":20,
"taskStatus":"myresults",
"taskState":"Interrupted",
"totalSteps":0,
"completedSteps":10,
"expectedDuration":0,
"taskType":"Background",
"hidden":"true",
"associatedResource":
{
"resourceName": "mytask1",
"resourceUri": "/rest/enclosures/ABCD12345",
"resourceCategory": "enclosures",
"associationType": "MANAGED_BY"
}
}
GET Gets the tree corresponding to a given task ID
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