Workflow:Get Step

Search (SHIFT+S)

API Reference


Get Step

GET /vdc/workflows/steps/{stepid}

Returns a single WorkflowStep.

stepid

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • RESTRICTED_SYSTEM_ADMIN
  • SYSTEM_MONITOR
  • TENANT_ADMIN

Response Body

Single WorkflowStep

Field Description Type Notes
<workflow_step>
<controller_name> Returns the name of the controller (long) that will be invoked for this Step. This is used by the Dispatcher. String
<description> Returns a description provided at Step creation time of what the Step is doing. The description is used for logging and history. String
<system_id> This is the URI for the system that will be used for the Step (if known). String
<system_type> Returns the system type (typically from system.getSystemType()). String
<end_time> A String representing the time the Step completed. Date
<execute_method> Returns the execution method in the controller that will be invoked for the Step. String
<message> Returns the message returned from the controller when the Step completed. This generally indicates success or error, and if an error the nature of the error. String
<start_time> A String representing the time the Step was dispatched (started). Date
<state> Returns the Step state has a String (from Workflow.StepState.) Typically this will be SUCCESS or ERROR. String
<step_group> Returns the StepGroup name this step belongs to. Steps do not always belong to a Step Group. This is used for programming dependencies in the Workflow. String
<step_id> Returns the unique stepId identifying this Step. This is how the Step is identified in Zookeeper. This is not the same as the Step's Cassandra URI. String
<wait_for> If present, indicates this Step will not execute until a prerequisite Step or StepGroup has successfully completed Execution. This is the name of the prerequistive Step or StepGroup. This is used to create dependencies between Steps. String
<workflow>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</workflow>      
<child_workflows>
<child_workflow>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</child_workflow>      
</child_workflows>
<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_step>

Examples

Request
GET https://192.168.0.0:4443/vdc/workflows/steps/urn:storageos:WorkflowStep:6e69f786-5f16-4eef-8233-b4d67bdd60e6: 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_step>
       <creation_time>1380568558477</creation_time>
       <id>urn:storageos:WorkflowStep:6e69f786-5f16-4eef-8233-b4d67bdd60e6:</id>
       <inactive>false</inactive>
       <link href="/vdc/workflows/steps/urn:storageos:WorkflowStep:6e69f786-5f16-4eef-8233-b4d67bdd60e6:" rel="self"/>
       <tags/>
       <controller_name>com.emc.storageos.volumecontroller.impl.block.BlockDeviceController</controller_name>
       <description>Deleting volumes:
Volume: HalaVmaxVol (urn:storageos:Volume:af7109ae-b801-46d3-a596-ec01a47f105f:) wwn: 60000970000195701505533030314333 native id: 001C3
       </description>
       <execute_method>deleteVolumes</execute_method>
       <message>Step is being executed</message>
       <start_time>2013-09-30T19:15:58.506Z</start_time>
       <state>EXECUTING</state>
       <step_group>BlockDeviceDeleteVolumes</step_group>
       <step_id>6d574ed9-10f4-4118-8053-085866ce8ceda8630a17-106c-43f0-84b0-20e82add16b2</step_id>
       <system_id>urn:storageos:StorageSystem:cc047b91-3b2f-4acf-9ba0-6dbb2170c7ca:</system_id>
       <system_type>vmax</system_type>
       <workflow>
            <id>urn:storageos:Workflow:0588b55a-c47c-434b-8a9d-d867ece6433e:</id>
            <link href="/vdc/workflows/urn:storageos:Workflow:0588b55a-c47c-434b-8a9d-d867ece6433e:" rel="self"/>
       </workflow>
  </workflow_step>
Notes: