mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
[PRODENG-211] integrate JS-API with monorepo (part 1) (#9081)
* integrate JS-API with monorepo * [ci:force] fix token issue [ci:force] migrate docs folder [ci:force] clean personal tokens * [ci:force] gha workflow support * [ci:force] npm publish target * fix js-api test linting * [ci:force] fix test linting, mocks, https scheme * [ci:force] fix https scheme * [ci:force] typescript mappings * [ci:force] update scripts * lint fixes * linting fixes * fix linting * [ci:force] linting fixes * linting fixes * [ci:force] remove js-api upstream and corresponding scripts * [ci:force] jsdoc fixes * fix jsdoc linting * [ci:force] jsdoc fixes * [ci:force] jsdoc fixes * jsdoc fixes * jsdoc fixes * jsdoc fixes * [ci:force] fix jsdoc * [ci:force] reduce code duplication * replace 'chai' expect with node.js assert * replace 'chai' expect with node.js assert * [ci:force] remove chai and chai-spies for js-api testing * [ci:force] cleanup and fix imports * [ci:force] fix linting * [ci:force] fix unit test * [ci:force] fix sonar linting findings * [ci:force] switch activiti api models to interfaces (-2.5% reduction of bundle) * [ci:force] switch activiti api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch search api models to interfaces * [ci:force] switch content api models to interfaces where applicable
This commit is contained in:
140
lib/js-api/src/api/activiti-rest-api/docs/TemporaryApi.md
Executable file
140
lib/js-api/src/api/activiti-rest-api/docs/TemporaryApi.md
Executable file
@@ -0,0 +1,140 @@
|
||||
# ActivitiPublicRestApi.TemporaryApi
|
||||
|
||||
All URIs are relative to *https://localhost:8080/activiti-app*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**completeTasks**](TemporaryApi.md#completeTasks) | **GET** /api/enterprise/temporary/generate-report-data/complete-tasks | completeTasks
|
||||
[**generateData**](TemporaryApi.md#generateData) | **GET** /api/enterprise/temporary/generate-report-data/start-process | generateData
|
||||
[**getHeaders**](TemporaryApi.md#getHeaders) | **GET** /api/enterprise/temporary/example-headers | getHeaders
|
||||
[**getOptions**](TemporaryApi.md#getOptions) | **GET** /api/enterprise/temporary/example-options | getOptions
|
||||
|
||||
|
||||
<a name="completeTasks"></a>
|
||||
# **completeTasks**
|
||||
> completeTasks(userId, processDefinitionKey)
|
||||
|
||||
completeTasks
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
|
||||
var userId = 789; // Integer | userId
|
||||
|
||||
var processDefinitionKey = "processDefinitionKey_example"; // String | processDefinitionKey
|
||||
|
||||
this.alfrescoJsApi.activiti.temporaryApi.completeTasks(userId, processDefinitionKey);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**userId** | **Integer**| userId |
|
||||
**processDefinitionKey** | **String**| processDefinitionKey |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
<a name="generateData"></a>
|
||||
# **generateData**
|
||||
> generateData(userId, processDefinitionKey)
|
||||
|
||||
generateData
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
|
||||
var userId = 789; // Integer | userId
|
||||
|
||||
var processDefinitionKey = "processDefinitionKey_example"; // String | processDefinitionKey
|
||||
|
||||
this.alfrescoJsApi.activiti.temporaryApi.generateData(userId, processDefinitionKey);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**userId** | **Integer**| userId |
|
||||
**processDefinitionKey** | **String**| processDefinitionKey |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
<a name="getHeaders"></a>
|
||||
# **getHeaders**
|
||||
> ArrayNode getHeaders()
|
||||
|
||||
getHeaders
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
|
||||
this.alfrescoJsApi.activiti.temporaryApi.getHeaders();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ArrayNode**](ArrayNode.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
<a name="getOptions"></a>
|
||||
# **getOptions**
|
||||
> ArrayNode getOptions()
|
||||
|
||||
getOptions
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
|
||||
this.alfrescoJsApi.activiti.temporaryApi.getOptions();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ArrayNode**](ArrayNode.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
Reference in New Issue
Block a user