@openfilz-sdk/typescript-ee 1.9.8 → 1.9.10

package/docs/WorkflowsApi.md

@@ -0,0 +1,791 @@
+# WorkflowsApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**cancel**](#cancel) | **POST** /api/v1/workflows/instances/{id}/cancel | Cancel a running instance (initiator)|
+|[**complete**](#complete) | **POST** /api/v1/workflows/tasks/{id}/complete | Take a transition on a task I am a candidate of|
+|[**createDefinition**](#createdefinition) | **POST** /api/v1/workflows/definitions | Create a workflow definition (400 with the problem list when invalid)|
+|[**deleteDefinition**](#deletedefinition) | **DELETE** /api/v1/workflows/definitions/{id} | Delete a workflow definition (409 while instances are running)|
+|[**getDefinition**](#getdefinition) | **GET** /api/v1/workflows/definitions/{id} | Get a workflow definition|
+|[**getInstance**](#getinstance) | **GET** /api/v1/workflows/instances/{id} | One instance with its snapshot spec, open task and history|
+|[**listDefinitions**](#listdefinitions) | **GET** /api/v1/workflows/definitions | List workflow definitions|
+|[**listInstances**](#listinstances) | **GET** /api/v1/workflows/instances | List instances (monitor), newest first|
+|[**myTasks**](#mytasks) | **GET** /api/v1/workflows/tasks/mine | Open tasks I can act on (by e-mail or role)|
+|[**myTasksCount**](#mytaskscount) | **GET** /api/v1/workflows/tasks/mine/count | Number of open tasks I can act on (sidebar badge)|
+|[**reassign**](#reassign) | **POST** /api/v1/workflows/tasks/{id}/reassign | Hand a task to other people (initiator or current candidate)|
+|[**start**](#start) | **POST** /api/v1/workflows/instances | Start a workflow on a document (409 when one is already running)|
+|[**summary**](#summary) | **GET** /api/v1/workflows/instances/summary | Counts for the monitor header|
+|[**updateDefinition**](#updatedefinition) | **PUT** /api/v1/workflows/definitions/{id} | Update a workflow definition (running instances keep their snapshot)|
+|[**validateDefinition**](#validatedefinition) | **POST** /api/v1/workflows/definitions/validate | Validate a definition without saving it|
+
+# **cancel**
+> WorkflowInstanceDTO cancel()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration,
+    CancelInstanceRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; // (default to undefined)
+let cancelInstanceRequest: CancelInstanceRequest; // (optional)
+
+const { status, data } = await apiInstance.cancel(
+    id,
+    cancelInstanceRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cancelInstanceRequest** | **CancelInstanceRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**WorkflowInstanceDTO**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **complete**
+> WorkflowInstanceDTO complete(completeTaskRequest)
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration,
+    CompleteTaskRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; // (default to undefined)
+let completeTaskRequest: CompleteTaskRequest; //
+
+const { status, data } = await apiInstance.complete(
+    id,
+    completeTaskRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **completeTaskRequest** | **CompleteTaskRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**WorkflowInstanceDTO**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **createDefinition**
+> WorkflowDefinitionDTO createDefinition(saveWorkflowDefinitionRequest)
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration,
+    SaveWorkflowDefinitionRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest; //
+
+const { status, data } = await apiInstance.createDefinition(
+    saveWorkflowDefinitionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **saveWorkflowDefinitionRequest** | **SaveWorkflowDefinitionRequest**|  | |
+
+
+### Return type
+
+**WorkflowDefinitionDTO**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Created |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteDefinition**
+> deleteDefinition()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteDefinition(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Content |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getDefinition**
+> WorkflowDefinitionDTO getDefinition()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getDefinition(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**WorkflowDefinitionDTO**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getInstance**
+> WorkflowInstanceDetailDTO getInstance()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getInstance(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**WorkflowInstanceDetailDTO**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listDefinitions**
+> Array<WorkflowDefinitionDTO> listDefinitions()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let active: boolean; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listDefinitions(
+    active
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **active** | [**boolean**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<WorkflowDefinitionDTO>**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listInstances**
+> WorkflowInstancePage listInstances()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let documentId: string; // (optional) (default to undefined)
+let definitionId: string; // (optional) (default to undefined)
+let status: 'RUNNING' | 'COMPLETED' | 'CANCELLED'; // (optional) (default to undefined)
+let state: string; // (optional) (default to undefined)
+let mine: boolean; // (optional) (default to false)
+let page: number; // (optional) (default to 0)
+let size: number; // (optional) (default to 25)
+
+const { status, data } = await apiInstance.listInstances(
+    documentId,
+    definitionId,
+    status,
+    state,
+    mine,
+    page,
+    size
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] |  | (optional) defaults to undefined|
+| **definitionId** | [**string**] |  | (optional) defaults to undefined|
+| **status** | [**&#39;RUNNING&#39; | &#39;COMPLETED&#39; | &#39;CANCELLED&#39;**]**Array<&#39;RUNNING&#39; &#124; &#39;COMPLETED&#39; &#124; &#39;CANCELLED&#39;>** |  | (optional) defaults to undefined|
+| **state** | [**string**] |  | (optional) defaults to undefined|
+| **mine** | [**boolean**] |  | (optional) defaults to false|
+| **page** | [**number**] |  | (optional) defaults to 0|
+| **size** | [**number**] |  | (optional) defaults to 25|
+
+
+### Return type
+
+**WorkflowInstancePage**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **myTasks**
+> Array<WorkflowTaskDTO> myTasks()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+const { status, data } = await apiInstance.myTasks();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<WorkflowTaskDTO>**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **myTasksCount**
+> MyTasksCountDTO myTasksCount()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+const { status, data } = await apiInstance.myTasksCount();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**MyTasksCountDTO**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **reassign**
+> WorkflowInstanceDTO reassign(reassignTaskRequest)
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration,
+    ReassignTaskRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; // (default to undefined)
+let reassignTaskRequest: ReassignTaskRequest; //
+
+const { status, data } = await apiInstance.reassign(
+    id,
+    reassignTaskRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reassignTaskRequest** | **ReassignTaskRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**WorkflowInstanceDTO**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **start**
+> WorkflowInstanceDTO start(startWorkflowRequest)
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration,
+    StartWorkflowRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let startWorkflowRequest: StartWorkflowRequest; //
+let acceptLanguage: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.start(
+    startWorkflowRequest,
+    acceptLanguage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **startWorkflowRequest** | **StartWorkflowRequest**|  | |
+| **acceptLanguage** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**WorkflowInstanceDTO**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Created |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **summary**
+> WorkflowSummaryDTO summary()
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+const { status, data } = await apiInstance.summary();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**WorkflowSummaryDTO**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updateDefinition**
+> WorkflowDefinitionDTO updateDefinition(saveWorkflowDefinitionRequest)
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration,
+    SaveWorkflowDefinitionRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let id: string; // (default to undefined)
+let saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest; //
+
+const { status, data } = await apiInstance.updateDefinition(
+    id,
+    saveWorkflowDefinitionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **saveWorkflowDefinitionRequest** | **SaveWorkflowDefinitionRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**WorkflowDefinitionDTO**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **validateDefinition**
+> WorkflowValidationResult validateDefinition(saveWorkflowDefinitionRequest)
+
+
+### Example
+
+```typescript
+import {
+    WorkflowsApi,
+    Configuration,
+    SaveWorkflowDefinitionRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new WorkflowsApi(configuration);
+
+let saveWorkflowDefinitionRequest: SaveWorkflowDefinitionRequest; //
+
+const { status, data } = await apiInstance.validateDefinition(
+    saveWorkflowDefinitionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **saveWorkflowDefinitionRequest** | **SaveWorkflowDefinitionRequest**|  | |
+
+
+### Return type
+
+**WorkflowValidationResult**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+