Page History: Web Service: Search Interface

Compare Page Revisions

0 Current 0

« Older Revision - Back to Page History - Current Revision

Page Revision: 2009/08/26 16:45

Table of Contents [Hide/Show]    Web Service: Search Interface       Not Found Action          Error          Create

Web Service: Search Interface¶

The Search interface is represented by the following code:

    <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>

• NexusKey: the login key to the Jetfire Nexus.
• FindWorkflowCriteria: an enumeration used to find workflows.
• ClassName: an optional parameter used to find workflows.
• Sorting: How the workflows should be sorted in the list.
• NotFoundAction: The action to take if the search yields no workflows.
  

Not Found Action¶

The Not Found Action is taken if the search interface finds no workflows. Allowed actions include:

• Error
• Create
  

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.