Web Service: Search Interface
(return to
Jetfire Web Service)
The Jetfire Web Service Search method is a powerful tool for retrieving specific workflows from the Nexus.
Prerequisites: Must be logged in.
Send:
- The Nexus Key received during login
- Find Workflow Criteria: an enumeration used to find workflows.
- ClassName: an optional comma-delimited list of workflow class names.
- Sorting: How the workflows should be sorted in the list.
- Filter: a collection of name-value pairs used to reduce the number of workflows found.
- NotFoundAction: The action to take if the search yields no workflows.
<Search xmlns="http://Jetfire.ca/WebService">
<nexusKey>string</nexusKey>
<findWorkflowCriteria>string</findWorkflowCriteria>
<className>string</className>
<sorting>string</sorting>
<filter>string</filter>
<notFoundAction>string</notFoundAction>
</Search>Receive:
Not Found Action
The Not Found Action is taken if the search interface finds no workflows.
Allowed actions include:
None
No action is required.
Error
Error is used to return a message to the client. The Client requesting the search is allowed to identify what the error message is. This allows the client to define a message that is meaningful to the end user.
Create
Create is used to create a new workflow and return it to the client. This is useful where the client is searching for a specific workflow, does not find it and therefore wants to add a workflow with those characteristics.
The client specifies the Class Name of the Workflow to be created and a list or Property/Value pairs that are used to set the values of property names within the workflow. The new Workflow, complete with set properties is returned to the client.
Note: If the property name is not found in the workflow, no error is identified.