@ilb/workflow-api

@IlbWorkflowApi - JavaScript client for @ilb/workflow-api This SDK is automatically generated by the OpenAPI Generator project:

• API version:
• Package version: 2.0.4
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @ilb/workflow-api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @ilb/workflow-api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var @IlbWorkflowApi = require('@ilb/workflow-api');


var api = new @IlbWorkflowApi.ProcessDefinitionsApi()
var activityDefinitionId = "activityDefinitionId_example"; // {String} 
var processDefinitionId = "processDefinitionId_example"; // {String} 
var opts = {
  'xRemoteUser': "xRemoteUser_example" // {String} 
};
api.getActivityDefinition(activityDefinitionId, processDefinitionId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
@IlbWorkflowApi.ProcessDefinitionsApi	getActivityDefinition	GET /processDefinitions/{processDefinitionId}/activityDefinitions/{activityDefinitionId}
@IlbWorkflowApi.ProcessDefinitionsApi	getProcessDefinition	GET /processDefinitions/{processDefinitionId}
@IlbWorkflowApi.ProcessDefinitionsApi	getProcessDefinitions	GET /processDefinitions
@IlbWorkflowApi.ProcessDefinitionsApi	start	POST /processDefinitions/{processDefinitionId}/activityDefinitions/{activityDefinitionId}/start
@IlbWorkflowApi.ProcessInstancesApi	abort	POST /processInstances/{processInstanceId}/abort
@IlbWorkflowApi.ProcessInstancesApi	abort1	POST /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/abort
@IlbWorkflowApi.ProcessInstancesApi	complete	POST /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/complete
@IlbWorkflowApi.ProcessInstancesApi	completeAndNext	POST /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/completeAndNext
@IlbWorkflowApi.ProcessInstancesApi	createProcessInstance	POST /processInstances
@IlbWorkflowApi.ProcessInstancesApi	createProcessInstanceAndNext	POST /processInstances/createProcessInstanceAndNext
@IlbWorkflowApi.ProcessInstancesApi	createProcessInstanceCtx	GET /processInstances/createProcessInstanceCtx
@IlbWorkflowApi.ProcessInstancesApi	getActivityDefinition1	GET /processInstances/{processInstanceId}/activityDefinitions/{activityDefinitionId}
@IlbWorkflowApi.ProcessInstancesApi	getActivityDefinition2	GET /processInstances/{processInstanceId}/processDefinition/activityDefinitions/{activityDefinitionId}
@IlbWorkflowApi.ProcessInstancesApi	getActivityForm	GET /processInstances/{processInstanceId}/activityForm
@IlbWorkflowApi.ProcessInstancesApi	getActivityForm1	GET /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/activityForm
@IlbWorkflowApi.ProcessInstancesApi	getActivityInstance	GET /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}
@IlbWorkflowApi.ProcessInstancesApi	getJsonSchema	GET /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/jsonSchema
@IlbWorkflowApi.ProcessInstancesApi	getJsonSchema1	GET /processInstances/{processInstanceId}/jsonSchema
@IlbWorkflowApi.ProcessInstancesApi	getProcessContext	GET /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/processContext
@IlbWorkflowApi.ProcessInstancesApi	getProcessContext1	GET /processInstances/{processInstanceId}/processContext
@IlbWorkflowApi.ProcessInstancesApi	getProcessDefinition1	GET /processInstances/{processInstanceId}/processDefinition
@IlbWorkflowApi.ProcessInstancesApi	getProcessInstance	GET /processInstances/{processInstanceId}
@IlbWorkflowApi.ProcessInstancesApi	getProcessInstances	GET /processInstances
@IlbWorkflowApi.ProcessInstancesApi	getProcessSteps	GET /processInstances/{processInstanceId}/processSteps
@IlbWorkflowApi.ProcessInstancesApi	getWorkList	GET /processInstances/workList
@IlbWorkflowApi.ProcessInstancesApi	goAnywhere	POST /processInstances/{processInstanceId}/goAnywhere
@IlbWorkflowApi.ProcessInstancesApi	goBack	POST /processInstances/{processInstanceId}/goBack
@IlbWorkflowApi.ProcessInstancesApi	goForth	POST /processInstances/{processInstanceId}/goForth
@IlbWorkflowApi.ProcessInstancesApi	resume	POST /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/resume
@IlbWorkflowApi.ProcessInstancesApi	resume1	POST /processInstances/{processInstanceId}/resume
@IlbWorkflowApi.ProcessInstancesApi	start1	POST /processInstances/{processInstanceId}/activityDefinitions/{activityDefinitionId}/start
@IlbWorkflowApi.ProcessInstancesApi	start2	POST /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/start
@IlbWorkflowApi.ProcessInstancesApi	start3	POST /processInstances/{processInstanceId}/processDefinition/activityDefinitions/{activityDefinitionId}/start
@IlbWorkflowApi.ProcessInstancesApi	start4	POST /processInstances/{processInstanceId}/start
@IlbWorkflowApi.ProcessInstancesApi	stop	POST /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/stop
@IlbWorkflowApi.ProcessInstancesApi	suspend	POST /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/suspend
@IlbWorkflowApi.ProcessInstancesApi	suspend1	POST /processInstances/{processInstanceId}/suspend
@IlbWorkflowApi.ProcessInstancesApi	terminate	POST /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/terminate
@IlbWorkflowApi.ProcessInstancesApi	terminate1	POST /processInstances/{processInstanceId}/terminate
@IlbWorkflowApi.ProcesshistoriesApi	getChangedProcesses	POST /processhistories/changedprocesses

Documentation for Models

• @IlbWorkflowApi.ActivityDefinition
• @IlbWorkflowApi.ActivityInstance
• @IlbWorkflowApi.ActivityInstanceState
• @IlbWorkflowApi.ActivityInstances
• @IlbWorkflowApi.ChangedProcessesRequest
• @IlbWorkflowApi.ChangedProcessesResponse
• @IlbWorkflowApi.ProcessDefinition
• @IlbWorkflowApi.ProcessDefinitions
• @IlbWorkflowApi.ProcessInstance
• @IlbWorkflowApi.ProcessInstanceState
• @IlbWorkflowApi.ProcessInstances
• @IlbWorkflowApi.ProcessStep
• @IlbWorkflowApi.ProcessSteps
• @IlbWorkflowApi.UserType

Documentation for Authorization

All endpoints do not require authorization.