Page History: Web Service: Web Methods for Create, Save and Execute

Compare Page Revisions

1 0 Current 1 0

« Older Revision - Back to Page History - Current Revision

Page Revision: 2011/10/06 16:41

Table of Contents [Hide/Show]    Create and Save Web Methods for Jetfire Workflows       Create Workflow       Create Workflow in Workspace       Save Workflow       Execute Command

Create and Save Web Methods for Jetfire Workflows¶

The Jetfire Web Service can be used to create, save and execute methods for a workflow.

• Create Workflow
• Create Workflow in Workspace
• Execute Command
• Save Workflow
  

Create Workflow¶

The create method is used to create a workflow.

Prerequisites: Must be logged in.
Send: Parameters for the Create Workflow method include:

• the Nexus Key received during login
• the name of the workflow class
  

<?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>
    <CreateWorkflow xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <workflowName>string</workflowName>
    </CreateWorkflow>
  </soap:Body>
</soap:Envelope>

Receive:

Create Workflow in Workspace¶

The create method is used to create a workflow.

Prerequisites: Must be logged in.
Send: Parameters for the Create Workflow method include:

• the Nexus Key received during login
• the name of the workflow class
  

<?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>
    <CreateWorkflow xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <workflowName>string</workflowName>
    </CreateWorkflow>
  </soap:Body>
</soap:Envelope>

Receive:

Save Workflow¶

The Save method is used to save property values for a workflow.

Prerequsites: Must be logged in
Send: Parameters for the Save Workflow method include:

• the Nexus Key received during login
• an xml description of the workflow with properties names and values
  

<?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>
    <SaveWorkflow xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <workflowString>string</workflowString>
    </SaveWorkflow>
  </soap:Body>
</soap:Envelope>

Receive:

Execute Command¶

The execute method is used to call a command for a workflow. The method call may include optional parameters.

Prerequisites: Must be logged in.
Send: Parameters for the Execute method include:

• the Nexus Key received during login
• an xml description of the workflow containing the called method name and optional parameter properties
  

<?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>
    <ExecuteCommand xmlns="http://Jetfire.ca/WebService">
      <nexusKey>string</nexusKey>
      <workflowString>string</workflowString>
    </ExecuteCommand>
  </soap:Body>
</soap:Envelope>

Receive: