Workflow:Get Workflow

Search (SHIFT+S)

API Reference


Get Workflow

GET /vdc/workflows/{id}

Returns information about the specified workflow.

idthe URN of a ViPR workflow

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • RESTRICTED_SYSTEM_ADMIN
  • SYSTEM_MONITOR
  • TENANT_ADMIN

Response Body

Information of specific workflow

Field Description Type Notes
<workflow>
<completed> Boolean returns true if Workflow has completed. Boolean
<completion_message> Returns the completionMessage. This is the overall message indicating the completion status of the entire Workflow. String
<completion_state> Returns the Completion State as a String. These are values from Workflow.StepState. Typically SUCCESS or ERROR. String
<orchestration_controller_name> Returns the name or the Orchestration controller. This is used to find the controller in the Dispatcher. String
<orchestration_method> Returns the Orchestration Method. This is the Method that is creating the Workflow and its Steps. String
<orchestration_task_id> Returns the Orchestration task ID. This is generally the task ID passed down from the apisvc. String
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean
</workflow>

Examples

Request
GET https://192.168.0.0:4443/vdc/workflows/urn:storageos:Workflow:0588b55a-c47c-434b-8a9d-d867ece6433e: HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <workflow>
       <creation_time>1380568558465</creation_time>
       <id>urn:storageos:Workflow:0588b55a-c47c-434b-8a9d-d867ece6433e:</id>
       <inactive>false</inactive>
       <link href="/vdc/workflows/urn:storageos:Workflow:0588b55a-c47c-434b-8a9d-d867ece6433e:" rel="self"/>
       <tags/>
       <completed>false</completed>
       <orchestration_controller_name>BlockOrchestrationDeviceController</orchestration_controller_name>
       <orchestration_method>DELETE_VOLUMES_WORKFLOW</orchestration_method>
       <orchestration_task_id>295c03dc-c3ec-4a4e-a93a-45ee8805e439</orchestration_task_id>
  </workflow>
Notes: