5.5.1
Table Of Contents
- Developing a Web Services Client for VMware vCenter Orchestrator
- Contents
- Developing Web Services Client for VMware vCenter Orchestrator
- Developing a Web Services Client
- Using the vCenter Orchestrator REST API
- Authenticating Against Orchestrator and Third-Party Systems
- Accessing the Reference Documentation for the Orchestrator REST API
- Using the Java REST SDK
- Operations with Workflows
- Working with Tasks
- Finding Objects in the Orchestrator Inventory
- Importing and Exporting Orchestrator Objects
- Deleting Orchestrator Objects
- Setting Permissions on Orchestrator Objects
- REST API Permissions
- Retrieve the Permissions of a Workflow
- Delete the Permissions of a Workflow
- Set the Permissions for a Workflow
- Retrieve the Permissions of an Action
- Delete the Permissions of an Action
- Set the Permissions for an Action
- Retrieve the Permissions of a Package
- Delete the Permissions of a Package
- Set the Permissions for a Package
- Retrieve the Permissions of a Resource
- Delete the Permissions of a Resource
- Set the Permissions for a Resource
- Retrieve the Permissions of a Configuration Element
- Delete the Permissions of a Configuration Element
- Set the Permissions for a Configuration Element
- Performing Operations with Plug-Ins
- Performing Server Configuration Operations
- Performing Tagging Operations
- Writing a Client Application for the Orchestrator SOAP Service
- Process for Creating an Orchestrator Web Service Client Application
- Web Service Endpoint
- Generating the Orchestrator Web Service Stubs
- Accessing the Server from Web Service Clients
- Create a Web Service Client
- Connect to the Orchestrator Web Service
- Find Objects in the Orchestrator Server
- Find Objects by Using the find Operation
- Find Objects by Using the findForId Operation
- Find Objects by Using the findRelation Operation
- Find Workflows in the Orchestrator Server
- Find Workflows by Using the getAllWorkflows Operation
- Retrieve the ID of a Workflow
- Find Workflows by Using the getWorkflowsWithName Operation
- Find Workflows by Using the getWorkflowForID Operation
- Run Workflows from a Web Service Client
- Interact with a Workflow While it Runs
- Obtain Workflow Results
- Time Zones and Running Workflows Through Web Services
- Web Service Application Examples
- Web Service API Object Reference
- Web Service API Operation Reference
- answerWorkflowInput Operation
- cancelWorkflow Operation
- echo Operation
- echoWorkflow Operation
- executeWorkflow Operation
- find Operation
- findForId Operation
- findRelation Operation
- getAllPlugins Operation
- getAllWorkflows Operation
- getWorkflowForId Operation
- getWorkflowInputForId Operation
- getWorkflowInputForWorkflowTokenId Operation
- getWorkflowsWithName Operation
- getWorkflowTokenBusinessState Operation
- getWorkflowTokenForId Operation
- getWorkflowTokenResult Operation
- getWorkflowTokenStatus Operation
- hasChildrenInRelation Operation
- hasRights Operation
- sendCustomEvent Operation
- simpleExecuteWorkflow Operation
- Index
Type Value Description
String
endDate
Date and time that this workflow
token ended, if the workflow token has
finished.
The endDate value is filled in at the
moment the workflow reaches the end
of its run.
The endDate is only set when the
workflow finishes in one of the
completed, failed or canceled
states.
String
xmlContent
Defines input parameters, output
parameters, attributes, and the content
of error messages. The values of the
attributes and parameters are set in
CDATA elements and error messages
are set in <exception> tags, as the
following example shows.
<token>
<atts>
<stack>
<att n='attstr' t='string'
e='n'>
<!
[CDATA[attribute]]>Attribute
value</att>
<att n='instr' t='string'
e='n'>
<![CDATA[]]>Input parameter
value</att>
<att n='outstr' t='string'
e='n'>
<![CDATA[]]>Output
parameter value</att>
</stack>
</atts>
<exception encoded='n'>Error
message</exception>
</token>
WorkflowTokenAttribute Object
A WorkflowTokenAttribute object represents an input or output parameter of a running instance of a
workflow.
A WorkflowTokenAttribute is a value that you pass to a predefined WorkflowParameter when a
WorkflowToken begins, or in some cases, at runtime. When you run a workflow, you supply the input
parameters for that particular workflow as WorkflowTokenAttribute objects. The executeWorkflow operation
takes an array of WorkflowTokenAttribute objects as an argument when you call it, as the following example
shows.
public WorkflowToken executeWorkflow(String workflowId, String username,
String password, WorkflowTokenAttribute[] attributes);
Workflows also use WorkflowTokenAttribute as the output parameter of a run workflow.
WorkflowTokenAttribute contains the results of a completed WorkflowToken created by running
executeWorkflow. You can collect the result of a WorkflowToken, in the form of a WorkflowTokenAttribute, by
calling getWorkflowTokenResult, as the following example shows.
public WorkflowTokenAttribute[] getWorkflowTokenResult(String workflowTokenId,
String username, String password);
Developing a Web Services Client for VMware vCenter Orchestrator
76 VMware, Inc.