Page History: Web Service: Workflows

Compare Page Revisions

3 2 1 0 Current 3 2 1 0

« Older Revision - Back to Page History - Newer Revision »

Page Revision: 2009/10/11 23:32

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

Get Workflows Web Methods¶

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

Get Named Workflows¶

Parameters for this web method include:

• Nexus Ney
• the name of the workflow class
  

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.

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

Get Workflow¶

Parameters for this web method include:

• Nexus Ney
• the value of the workflow guid
  

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.

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

Get Workflows By Subject¶

Parameters for this web method include:

• Nexus Ney
• the name of the workflow class
• the value of the subject being queried
  

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.

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

Get Workflow Structure¶

Parameters for this web method include:

• Nexus Ney
• the value of the workflow guid
  

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.

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

Get Workflows in Current State¶

Parameters for this web method include:

• Nexus Ney
• the name of the workflow class
• The value of the Workflow Current State
  

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.

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

Get Workflows in Workspace¶

Parameters for this web method include:

• Nexus Ney
• The name of the workflow class
• The name of the Workspace
• A flag whether all versions of workflows are required
  

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.

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