Workflow Engine .NET  2
Static Public Member Functions | List of all members
OptimaJet.Workflow.Designer Class Reference

Extension which provides API for HTML5 Workflow Designer More...

Static Public Member Functions

static string DesignerAPI (this WorkflowRuntime runtime, NameValueCollection form, Stream filestream=null, bool setIsObsoleForOperationSave=true)
 API for HTML5 Workflow Designer. Contains following operations: More...
 
static void RegisterTypesFromAssembly (Assembly assembly, Func< Type, bool > filter=null)
 

Detailed Description

Extension which provides API for HTML5 Workflow Designer

Member Function Documentation

◆ DesignerAPI()

static string OptimaJet.Workflow.Designer.DesignerAPI ( this WorkflowRuntime  runtime,
NameValueCollection  form,
Stream  filestream = null,
bool  setIsObsoleForOperationSave = true 
)
static

API for HTML5 Workflow Designer. Contains following operations:

  • bool exists(schemecode, schemeid, processid) Checks existence of the scheme of the process with specific code, id or id of the process
  • JSON load(schemecode, schemeid, processid) Returns the scheme of the process in JSON format by specific code, id or id of the process
  • JSON save(schemecode, data) Saves the scheme with specified code. Ruturns updated scheme.
  • JSON uploadscheme(filestream) Converts scheme uploaded as XML file to JSON.
  • XML downloadscheme(data) Converts scheme from JSON object to XML.
  • object compile(data) Method for test compile of code actions
  • JSON getemptytype(typename) returns serialized empty type
  • array getautocompletesuggestions (category, value) returns a list of autocomplete suggestions
  • JSON uploadschemebpmn(filestream) Converts BPMN scheme uploaded as XML file to JSON.
  • XML downloadschemebpmn(data) Converts BPMN scheme from JSON object to XML. Type of the operation determined by "operation" parameter from request parameters
Parameters
runtimeThe instance of the runtime
formParameters from request. Allowed parameters is: "operation", "schemecode", "schemeid", "processid", "data"
filestreamStream which represent uploaded file
setIsObsoleForOperationSaveIf true and operation is "save" IsObsolete property will be set to all shemes of processes with specified code
Returns
Operation execution result