Page History: Web Service: Workflows

Compare Page Revisions

3 2 1 0 Current 3 2 1 0

« Older Revision - Back to Page History - Current Revision

Page Revision: 2011/10/06 17:07

Table of Contents [Hide/Show]    Get Workflows Web Methods       Get Workflows       Get Named Workflows       Get Workflow       Get Workflow By Subject       Get Workflow Structure       Get Workflows in Current State       Get Workflows in Workspace       Get Collection       Get List       Get Named Workflows for List Items       Workflows       Workspaces

Get Workflows Web Methods¶

This page contains a number of web methods that are used to get workflows.

• Get Collection
• Get List
• Get Named Workflows
• Get Named Workflows for List Items
• Get Named Workflows in Current State
• Get Workflow
• Get Workflow by Subject
• Get Workflow Structure
• Get Workflows
• Get Workflow in Workspace
• Workflows
• Workspaces
  

Get Workflows¶

Get Named Workflows¶

This methods gets the workflows requested by the class name.

Prerequisites: Must be logged in. Send: Parameters for this web method include:

• Nexus Key received during login
• a comma-delimited list of workflow class names
  

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetNamedWorkflows xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <workflowName>string</workflowName>
    </GetNamedWorkflows>
  </soap:Body>
</soap:Envelope>

Receive: The return value is an xml string that contains a list of Workflows. If Workflows are not found, then the xml string contains an error message.

Get Workflow¶

This method retrieves the properties and methods for a specific workflow, identified by the Guid.

Prerequisites: Must be logged in. Send: Parameters for this web method include:

• Nexus Key received during login
• the value of the workflow guid
  

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetWorkflow xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <guid>string</guid>
    </GetWorkflow>
  </soap:Body>
</soap:Envelope>

Receive: The return value is an xml string that contains a Workflows. The first Workflow is the found Workflow. If Workflows are not found, then the xml string contains an error message.

Get Workflow By Subject¶

This method gets a workflow by its subject.

Prerequisites: Must be logged in. Send: Parameters for this web method include:

• Nexus Key received during login
• the name of the workflow class
• the value of the subject being queried
  

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetWorkflowBySubject xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <workflowName>string</workflowName>
      <subject>string</subject>
    </GetWorkflowBySubject>
  </soap:Body>
</soap:Envelope>

Receive: The return value is an xml string that contains a list of Workflows. If Workflows are not found, then the xml string contains an error message.

Get Workflow Structure¶

This method gets the properties and methods for a workflow identified by a Guid, as well as any workflows contained in workflow properties.

Prerequisites: Must be logged in. Send: Parameters for this web method include:

• Nexus Key received during login
• the value of the workflow guid
  

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetWorkflowStructure xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <guid>string</guid>
    </GetWorkflowStructure>
  </soap:Body>
</soap:Envelope>

Receive: The return value is an xml string that contains a list of Workflows. The list contains all workflows found in the target workflow. If Workflows are not found, then the xml string contains an error message.

Get Workflows in Current State¶

This method gets all workflows where the workflow is in the requested state.

Prerequisites: Must be logged in. Send: Parameters for this web method include:

• Nexus Key received during login
• the name of the workflow class
• The value of the Workflow Current State
  

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetNamedWorkflowsInCurrentState xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <workflowName>string</workflowName>
      <currentState>string</currentState>
    </GetNamedWorkflowsInCurrentState>
  </soap:Body>
</soap:Envelope>

Receive: The return value is an xml string that contains a list of Workflows. If Workflows are not found, then the xml string contains an error message.

Get Workflows in Workspace¶

This methods retrieves all workflows for the requested workspace.

Prerequisites: Must be logged in. Send: Parameters for this web method include:

• Nexus Key received during login
• The name of the workflow class
• The name of the Workspace
• A flag whether all versions of workflows are required
  

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetWorkflowsInWorkspace xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <workflowName>string</workflowName>
      <wsName>string</wsName>
      <allVersions>boolean</allVersions>
    </GetWorkflowsInWorkspace>
  </soap:Body>
</soap:Envelope>

Received: The return value is an xml string that contains a list of Workflows. If Workflows are not found, then the xml string contains an error message.

Get Collection¶

This method retrieves a collection of workflows based on the name of the collection.

Prerequisites: Must be logged in. Send: Parameters for this web method include:

• Nexus Key received during login
  

Received:

Get List¶

This method retrieves a list of workflows for a named list.

Prerequisites: Must be logged in. Send: Parameters for this web method include:

• Nexus Key received during login
  

Received:

Get Named Workflows for List Items¶

This method retrieves a trimmed list of workflows that can be used to populate a drop down list. The displayed text is the subject and the value of the option in the list is the Guid.

Prerequisites: Must be logged in. Send: Parameters for this web method include:

• Nexus Key received during login
  

Received:

Workflows¶

This method retrieves all workflows from the Nexus. Warning: this method may time out, if there are too many workflows.

Prerequisites: Must be logged in. Send: Parameters for this web method include:

• Nexus Key received during login
  

Received:

Workspaces¶

This method retrieves all workspaces from the Nexus.

Prerequisites: Must be logged in. Send: Parameters for this web method include:

• Nexus Key received during login
  

Received: