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
170
lib/js-api/src/api/activiti-rest-api/docs/CommentsApi.md
Normal file
170
lib/js-api/src/api/activiti-rest-api/docs/CommentsApi.md
Normal file
@@ -0,0 +1,170 @@
|
||||
# CommentsApi
|
||||
|
||||
All URIs are relative to */activiti-app/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**addProcessInstanceComment**](CommentsApi.md#addProcessInstanceComment) | **POST** /enterprise/process-instances/{processInstanceId}/comments | Add a comment to a process instance
|
||||
[**addTaskComment**](CommentsApi.md#addTaskComment) | **POST** /enterprise/tasks/{taskId}/comments | Add a comment to a task
|
||||
[**getProcessInstanceComments**](CommentsApi.md#getProcessInstanceComments) | **GET** /enterprise/process-instances/{processInstanceId}/comments | Get comments for a process
|
||||
[**getTaskComments**](CommentsApi.md#getTaskComments) | **GET** /enterprise/tasks/{taskId}/comments | Get comments for a task
|
||||
|
||||
|
||||
<a name="addProcessInstanceComment"></a>
|
||||
# **addProcessInstanceComment**
|
||||
> CommentRepresentation addProcessInstanceComment(commentRequestprocessInstanceId)
|
||||
|
||||
Add a comment to a process instance
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import CommentsApi from 'CommentsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let commentsApi = new CommentsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
commentsApi.addProcessInstanceComment(commentRequestprocessInstanceId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**commentRequest** | [**CommentRepresentation**](CommentRepresentation.md)| commentRequest |
|
||||
**processInstanceId** | **string**| processInstanceId |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CommentRepresentation**](CommentRepresentation.md)
|
||||
|
||||
<a name="addTaskComment"></a>
|
||||
# **addTaskComment**
|
||||
> CommentRepresentation addTaskComment(commentRequesttaskId)
|
||||
|
||||
Add a comment to a task
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import CommentsApi from 'CommentsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let commentsApi = new CommentsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
commentsApi.addTaskComment(commentRequesttaskId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**commentRequest** | [**CommentRepresentation**](CommentRepresentation.md)| commentRequest |
|
||||
**taskId** | **string**| taskId |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CommentRepresentation**](CommentRepresentation.md)
|
||||
|
||||
<a name="getProcessInstanceComments"></a>
|
||||
# **getProcessInstanceComments**
|
||||
> ResultListDataRepresentationCommentRepresentation getProcessInstanceComments(processInstanceIdopts)
|
||||
|
||||
Get comments for a process
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import CommentsApi from 'CommentsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let commentsApi = new CommentsApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'latestFirst': true // | latestFirst
|
||||
};
|
||||
|
||||
commentsApi.getProcessInstanceComments(processInstanceIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**processInstanceId** | **string**| processInstanceId |
|
||||
**latestFirst** | **boolean**| latestFirst | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ResultListDataRepresentationCommentRepresentation**](ResultListDataRepresentationCommentRepresentation.md)
|
||||
|
||||
<a name="getTaskComments"></a>
|
||||
# **getTaskComments**
|
||||
> ResultListDataRepresentationCommentRepresentation getTaskComments(taskIdopts)
|
||||
|
||||
Get comments for a task
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import CommentsApi from 'CommentsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let commentsApi = new CommentsApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'latestFirst': true // | latestFirst
|
||||
};
|
||||
|
||||
commentsApi.getTaskComments(taskIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
**latestFirst** | **boolean**| latestFirst | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ResultListDataRepresentationCommentRepresentation**](ResultListDataRepresentationCommentRepresentation.md)
|
||||
|
||||
Reference in New Issue
Block a user