WorkflowRestStepDefinition Data Type

A workflow REST step definition.

Namespace
(Default)
Properties
name data type type namespace min/max occurs description
action string element 0/1 The HTTP action for this REST call, i.e. GET, POST etc.
filter string element 0/1 The JSON Path, XPath, or regex used to filter the response and capture aspects of the output.
payload string element 0/1 The body payload to send to the REST endpoint indicated by the 'url' member
url string element 0/1 Target URL of the REST call
Properties inherited from WorkflowStepDefinition
condition string element 0/1 Gets the condition.
domainCredential ManagedObjectReference element 0/1 Gets the domain credential.
guestOSCredential ManagedObjectReference element 0/1 The credential used to access the Guest OS.
id long element 1/1 Gets the id.
name string element 0/1 Gets the name.
stepNumber int element 1/1 The order in which this step executes. Starts at zero.
type WorkflowStepType element 0/1 Gets the type.
workflowDefinitionId long element 1/1 The workflow definition Id. Not needed when creating step for the first time.
Properties inherited from supportTemplating
xsitype string attribute 0/1  

Example

<WorkflowRestStepDefinition xsitype="...">
  <url>...</url>
  <payload>...</payload>
  <filter>...</filter>
  <action>...</action>
  <guestOSCredential>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </guestOSCredential>
  <domainCredential>
    <displayName>...</displayName>
    <type>...</type>
    <id>...</id>
  </domainCredential>
  <workflowDefinitionId>...</workflowDefinitionId>
  <id>...</id>
  <name>...</name>
  <type>...</type>
  <stepNumber>...</stepNumber>
  <condition>...</condition>
</WorkflowRestStepDefinition>