mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +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:
Denys Vuika
GitHub
489
lib/js-api/src/api/activiti-rest-api/docs/TaskActionsApi.md
Normal file
489
lib/js-api/src/api/activiti-rest-api/docs/TaskActionsApi.md
Normal file
@@ -0,0 +1,489 @@
|
||||
# TaskactionsApi
|
||||
|
||||
All URIs are relative to */activiti-app/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**assignTask**](TaskActionsApi.md#assignTask) | **PUT** /enterprise/tasks/{taskId}/action/assign | Assign a task to a user
|
||||
[**attachForm**](TaskActionsApi.md#attachForm) | **PUT** /enterprise/tasks/{taskId}/action/attach-form | Attach a form to a task
|
||||
[**claimTask**](TaskActionsApi.md#claimTask) | **PUT** /enterprise/tasks/{taskId}/action/claim | Claim a task
|
||||
[**completeTask**](TaskActionsApi.md#completeTask) | **PUT** /enterprise/tasks/{taskId}/action/complete | Complete a task
|
||||
[**delegateTask**](TaskActionsApi.md#delegateTask) | **PUT** /enterprise/tasks/{taskId}/action/delegate | Delegate a task
|
||||
[**involveGroup**](TaskActionsApi.md#involveGroup) | **POST** /enterprise/tasks/{taskId}/groups/{groupId} | Involve a group with a task
|
||||
[**involveUser**](TaskActionsApi.md#involveUser) | **PUT** /enterprise/tasks/{taskId}/action/involve | Involve a user with a task
|
||||
[**removeForm**](TaskActionsApi.md#removeForm) | **DELETE** /enterprise/tasks/{taskId}/action/remove-form | Remove a form from a task
|
||||
[**removeInvolvedUser**](TaskActionsApi.md#removeInvolvedUser) | **DELETE** /enterprise/tasks/{taskId}/groups/{groupId} | Remove an involved group from a task
|
||||
[**removeInvolvedUser**](TaskActionsApi.md#removeInvolvedUser) | **PUT** /enterprise/tasks/{taskId}/action/remove-involved | Remove an involved user from a task
|
||||
[**resolveTask**](TaskActionsApi.md#resolveTask) | **PUT** /enterprise/tasks/{taskId}/action/resolve | Resolve a task
|
||||
[**unclaimTask**](TaskActionsApi.md#unclaimTask) | **PUT** /enterprise/tasks/{taskId}/action/unclaim | Unclaim a task
|
||||
|
||||
|
||||
<a name="assignTask"></a>
|
||||
# **assignTask**
|
||||
> TaskRepresentation assignTask(taskIduserIdentifier)
|
||||
|
||||
Assign a task to a user
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import TaskactionsApi from 'src/api/activiti-rest-api/docs/TaskActionsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let taskactionsApi = new TaskactionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
taskactionsApi.assignTask(taskIduserIdentifier).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
**userIdentifier** | [**AssigneeIdentifierRepresentation**](AssigneeIdentifierRepresentation.md)| userIdentifier |
|
||||
|
||||
### Return type
|
||||
|
||||
[**TaskRepresentation**](TaskRepresentation.md)
|
||||
|
||||
<a name="attachForm"></a>
|
||||
# **attachForm**
|
||||
> attachForm(taskIdformIdentifier)
|
||||
|
||||
Attach a form to a task
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import TaskactionsApi from 'src/api/activiti-rest-api/docs/TaskActionsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let taskactionsApi = new TaskactionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
taskactionsApi.attachForm(taskIdformIdentifier).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
**formIdentifier** | [**FormIdentifierRepresentation**](FormIdentifierRepresentation.md)| formIdentifier |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="claimTask"></a>
|
||||
# **claimTask**
|
||||
> claimTask(taskId)
|
||||
|
||||
Claim a task
|
||||
|
||||
To claim a task (in case the task is assigned to a group)
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import TaskactionsApi from 'src/api/activiti-rest-api/docs/TaskActionsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let taskactionsApi = new TaskactionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
taskactionsApi.claimTask(taskId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="completeTask"></a>
|
||||
# **completeTask**
|
||||
> completeTask(taskId)
|
||||
|
||||
Complete a task
|
||||
|
||||
Use this endpoint to complete a standalone task or task without a form
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import TaskactionsApi from 'src/api/activiti-rest-api/docs/TaskActionsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let taskactionsApi = new TaskactionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
taskactionsApi.completeTask(taskId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="delegateTask"></a>
|
||||
# **delegateTask**
|
||||
> delegateTask(taskIduserIdentifier)
|
||||
|
||||
Delegate a task
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import TaskactionsApi from 'src/api/activiti-rest-api/docs/TaskActionsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let taskactionsApi = new TaskactionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
taskactionsApi.delegateTask(taskIduserIdentifier).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
**userIdentifier** | [**UserIdentifierRepresentation**](UserIdentifierRepresentation.md)| userIdentifier |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="involveGroup"></a>
|
||||
# **involveGroup**
|
||||
> involveGroup(taskIdgroupId)
|
||||
|
||||
Involve a group with a task
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import TaskactionsApi from 'src/api/activiti-rest-api/docs/TaskActionsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let taskactionsApi = new TaskactionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
taskactionsApi.involveGroup(taskIdgroupId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
**groupId** | **string**| groupId |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="involveUser"></a>
|
||||
# **involveUser**
|
||||
> involveUser(taskIduserIdentifier)
|
||||
|
||||
Involve a user with a task
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import TaskactionsApi from 'src/api/activiti-rest-api/docs/TaskActionsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let taskactionsApi = new TaskactionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
taskactionsApi.involveUser(taskIduserIdentifier).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
**userIdentifier** | [**UserIdentifierRepresentation**](UserIdentifierRepresentation.md)| userIdentifier |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="removeForm"></a>
|
||||
# **removeForm**
|
||||
> removeForm(taskId)
|
||||
|
||||
Remove a form from a task
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import TaskactionsApi from 'src/api/activiti-rest-api/docs/TaskActionsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let taskactionsApi = new TaskactionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
taskactionsApi.removeForm(taskId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="removeInvolvedUser"></a>
|
||||
# **removeInvolvedUser**
|
||||
> removeInvolvedUser(taskIdgroupId)
|
||||
|
||||
Remove an involved group from a task
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import TaskactionsApi from 'src/api/activiti-rest-api/docs/TaskActionsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let taskactionsApi = new TaskactionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
taskactionsApi.removeInvolvedUser(taskIdgroupId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
**groupId** | **string**| groupId |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="removeInvolvedUser"></a>
|
||||
# **removeInvolvedUser**
|
||||
> removeInvolvedUser(taskIduserIdentifier)
|
||||
|
||||
Remove an involved user from a task
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import TaskactionsApi from 'src/api/activiti-rest-api/docs/TaskActionsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let taskactionsApi = new TaskactionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
taskactionsApi.removeInvolvedUser(taskIduserIdentifier).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
**userIdentifier** | [**UserIdentifierRepresentation**](UserIdentifierRepresentation.md)| userIdentifier |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="resolveTask"></a>
|
||||
# **resolveTask**
|
||||
> resolveTask(taskId)
|
||||
|
||||
Resolve a task
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import TaskactionsApi from 'src/api/activiti-rest-api/docs/TaskActionsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let taskactionsApi = new TaskactionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
taskactionsApi.resolveTask(taskId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="unclaimTask"></a>
|
||||
# **unclaimTask**
|
||||
> unclaimTask(taskId)
|
||||
|
||||
Unclaim a task
|
||||
|
||||
To unclaim a task (in case the task was assigned to a group)
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import TaskactionsApi from 'src/api/activiti-rest-api/docs/TaskActionsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let taskactionsApi = new TaskactionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
taskactionsApi.unclaimTask(taskId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
Reference in New Issue
Block a user