4.0

Type Value Description
Long
totalCount
The total number of objects found.
The QueryResult object contains an array of FinderResult objects. The vso.xml file
for the relevant plug-in sets the number of FinderResult objects the query returns. The
standard plug-ins that Orchestrator provides all return an unlimited number of
FinderResult objects. The totalCount property reports the total number of
FinderResult objects found. If the value of totalCount is greater than the number set
by the plug-in, the array of FinderResults returned does not include all the objects
found in the queried inventory.
FinderResult[] elements
An array of FinderResult objects.
Workflow Object
A Workflow object represents an Orchestrator workflow that defines a certain sequence of tasks, decisions, and
operations.
Users with the correct permissions can obtain specific Workflow objects by name or by ID, or they can obtain
all the workflows they have the permission to see.
Orchestrator provides the following operations to obtain Workflow objects.
public Workflow[] getWorkflowsWithName(String name, String username, String password);
public Workflow getWorkflowForId(String workflowId, String username, String password);
public Workflow[] getAllWorkflows(String username, String password);
The following table shows the properties of the Workflow object.
Type Value Description
String
id
The workflow ID.
The id string is a globally unique ID string. Workflows that Orchestrator
creates have identifiers that are very large strings, with a very low probability
of namespace collision.
String
name
The name of the workflow, as it appears in the workflow's Name text box in
Orchestrator.
String
description
A detailed description of what the workflow does.
WorkflowParameter[] inParameters
The inParameters array is the set of WorkflowParameter objects that are
the workflow's input parameters. The workflow can manipulate these input
parameters or use them directly as the input parameters for tasks and other
workflows.
You can set up arbitrary input parameters to provide any necessary input
parameters. Omitting a required parameter at runtime causes the workflow
to fail.
WorkflowParameter[] outParameters
The outParameters array is the set of WorkflowParameter objects that result
from running a workflow. This array allows the workflow to send errors, the
names of any created objects, and other information as output.
You can set up arbitrary output parameters to generate any information that
you need.
WorkflowParameter[] attributes
The attributes array is a set of WorkflowParameter objects that represent
constants and preset variables for a given workflow. Attributes differ from
inParameters because they are intended to represent environmental
constants or variables, rather than runtime information.
NOTE You cannot retrieve workflow attribute values by using the Web
service. You can only retrieve output parameter values.
vCenter Orchestrator Developer's Guide
264 VMware, Inc.