Workflow:Get Step

Search (SHIFT+S)

API Reference

Get Step

GET /vdc/workflows/steps/{stepid}

Returns a single WorkflowStep.


Required Roles

Requires one of the following roles:


Response Body

Single WorkflowStep

Field Description Type Notes
<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
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
<child_workflow>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
<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
<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
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
<internal> Whether or not the resource is an internal resource. Boolean



Content-Type: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
       <link href="/vdc/workflows/steps/urn:storageos:WorkflowStep:6e69f786-5f16-4eef-8233-b4d67bdd60e6:" rel="self"/>
       <description>Deleting volumes:
Volume: HalaVmaxVol (urn:storageos:Volume:af7109ae-b801-46d3-a596-ec01a47f105f:) wwn: 60000970000195701505533030314333 native id: 001C3
       <message>Step is being executed</message>
            <link href="/vdc/workflows/urn:storageos:Workflow:0588b55a-c47c-434b-8a9d-d867ece6433e:" rel="self"/>