npm package: @ilb/workflow-api
Description: Client library of @ilb/workflow-api
Latest version: 2.0.4

# @ilb/workflow-api

@IlbWorkflowApi - JavaScript client for @ilb/workflow-api
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

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

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install @ilb/workflow-api --save
```

Finally, you need to build the module:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
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:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

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

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
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**](docs/ProcessDefinitionsApi.md#getActivityDefinition) | **GET** /processDefinitions/{processDefinitionId}/activityDefinitions/{activityDefinitionId} | 
*@IlbWorkflowApi.ProcessDefinitionsApi* | [**getProcessDefinition**](docs/ProcessDefinitionsApi.md#getProcessDefinition) | **GET** /processDefinitions/{processDefinitionId} | 
*@IlbWorkflowApi.ProcessDefinitionsApi* | [**getProcessDefinitions**](docs/ProcessDefinitionsApi.md#getProcessDefinitions) | **GET** /processDefinitions | 
*@IlbWorkflowApi.ProcessDefinitionsApi* | [**start**](docs/ProcessDefinitionsApi.md#start) | **POST** /processDefinitions/{processDefinitionId}/activityDefinitions/{activityDefinitionId}/start | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**abort**](docs/ProcessInstancesApi.md#abort) | **POST** /processInstances/{processInstanceId}/abort | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**abort1**](docs/ProcessInstancesApi.md#abort1) | **POST** /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/abort | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**complete**](docs/ProcessInstancesApi.md#complete) | **POST** /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/complete | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**completeAndNext**](docs/ProcessInstancesApi.md#completeAndNext) | **POST** /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/completeAndNext | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**createProcessInstance**](docs/ProcessInstancesApi.md#createProcessInstance) | **POST** /processInstances | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**createProcessInstanceAndNext**](docs/ProcessInstancesApi.md#createProcessInstanceAndNext) | **POST** /processInstances/createProcessInstanceAndNext | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**createProcessInstanceCtx**](docs/ProcessInstancesApi.md#createProcessInstanceCtx) | **GET** /processInstances/createProcessInstanceCtx | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getActivityDefinition1**](docs/ProcessInstancesApi.md#getActivityDefinition1) | **GET** /processInstances/{processInstanceId}/activityDefinitions/{activityDefinitionId} | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getActivityDefinition2**](docs/ProcessInstancesApi.md#getActivityDefinition2) | **GET** /processInstances/{processInstanceId}/processDefinition/activityDefinitions/{activityDefinitionId} | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getActivityForm**](docs/ProcessInstancesApi.md#getActivityForm) | **GET** /processInstances/{processInstanceId}/activityForm | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getActivityForm1**](docs/ProcessInstancesApi.md#getActivityForm1) | **GET** /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/activityForm | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getActivityInstance**](docs/ProcessInstancesApi.md#getActivityInstance) | **GET** /processInstances/{processInstanceId}/activityInstances/{activityInstanceId} | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getJsonSchema**](docs/ProcessInstancesApi.md#getJsonSchema) | **GET** /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/jsonSchema | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getJsonSchema1**](docs/ProcessInstancesApi.md#getJsonSchema1) | **GET** /processInstances/{processInstanceId}/jsonSchema | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getProcessContext**](docs/ProcessInstancesApi.md#getProcessContext) | **GET** /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/processContext | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getProcessContext1**](docs/ProcessInstancesApi.md#getProcessContext1) | **GET** /processInstances/{processInstanceId}/processContext | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getProcessDefinition1**](docs/ProcessInstancesApi.md#getProcessDefinition1) | **GET** /processInstances/{processInstanceId}/processDefinition | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getProcessInstance**](docs/ProcessInstancesApi.md#getProcessInstance) | **GET** /processInstances/{processInstanceId} | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getProcessInstances**](docs/ProcessInstancesApi.md#getProcessInstances) | **GET** /processInstances | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getProcessSteps**](docs/ProcessInstancesApi.md#getProcessSteps) | **GET** /processInstances/{processInstanceId}/processSteps | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**getWorkList**](docs/ProcessInstancesApi.md#getWorkList) | **GET** /processInstances/workList | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**goAnywhere**](docs/ProcessInstancesApi.md#goAnywhere) | **POST** /processInstances/{processInstanceId}/goAnywhere | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**goBack**](docs/ProcessInstancesApi.md#goBack) | **POST** /processInstances/{processInstanceId}/goBack | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**goForth**](docs/ProcessInstancesApi.md#goForth) | **POST** /processInstances/{processInstanceId}/goForth | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**resume**](docs/ProcessInstancesApi.md#resume) | **POST** /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/resume | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**resume1**](docs/ProcessInstancesApi.md#resume1) | **POST** /processInstances/{processInstanceId}/resume | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**start1**](docs/ProcessInstancesApi.md#start1) | **POST** /processInstances/{processInstanceId}/activityDefinitions/{activityDefinitionId}/start | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**start2**](docs/ProcessInstancesApi.md#start2) | **POST** /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/start | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**start3**](docs/ProcessInstancesApi.md#start3) | **POST** /processInstances/{processInstanceId}/processDefinition/activityDefinitions/{activityDefinitionId}/start | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**start4**](docs/ProcessInstancesApi.md#start4) | **POST** /processInstances/{processInstanceId}/start | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**stop**](docs/ProcessInstancesApi.md#stop) | **POST** /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/stop | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**suspend**](docs/ProcessInstancesApi.md#suspend) | **POST** /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/suspend | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**suspend1**](docs/ProcessInstancesApi.md#suspend1) | **POST** /processInstances/{processInstanceId}/suspend | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**terminate**](docs/ProcessInstancesApi.md#terminate) | **POST** /processInstances/{processInstanceId}/activityInstances/{activityInstanceId}/terminate | 
*@IlbWorkflowApi.ProcessInstancesApi* | [**terminate1**](docs/ProcessInstancesApi.md#terminate1) | **POST** /processInstances/{processInstanceId}/terminate | 
*@IlbWorkflowApi.ProcesshistoriesApi* | [**getChangedProcesses**](docs/ProcesshistoriesApi.md#getChangedProcesses) | **POST** /processhistories/changedprocesses | 


## Documentation for Models

 - [@IlbWorkflowApi.ActivityDefinition](docs/ActivityDefinition.md)
 - [@IlbWorkflowApi.ActivityInstance](docs/ActivityInstance.md)
 - [@IlbWorkflowApi.ActivityInstanceState](docs/ActivityInstanceState.md)
 - [@IlbWorkflowApi.ActivityInstances](docs/ActivityInstances.md)
 - [@IlbWorkflowApi.ChangedProcessesRequest](docs/ChangedProcessesRequest.md)
 - [@IlbWorkflowApi.ChangedProcessesResponse](docs/ChangedProcessesResponse.md)
 - [@IlbWorkflowApi.ProcessDefinition](docs/ProcessDefinition.md)
 - [@IlbWorkflowApi.ProcessDefinitions](docs/ProcessDefinitions.md)
 - [@IlbWorkflowApi.ProcessInstance](docs/ProcessInstance.md)
 - [@IlbWorkflowApi.ProcessInstanceState](docs/ProcessInstanceState.md)
 - [@IlbWorkflowApi.ProcessInstances](docs/ProcessInstances.md)
 - [@IlbWorkflowApi.ProcessStep](docs/ProcessStep.md)
 - [@IlbWorkflowApi.ProcessSteps](docs/ProcessSteps.md)
 - [@IlbWorkflowApi.UserType](docs/UserType.md)


## Documentation for Authorization

All endpoints do not require authorization.