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
172
lib/js-api/src/api/activiti-rest-api/docs/SubmittedFormsApi.md
Normal file
172
lib/js-api/src/api/activiti-rest-api/docs/SubmittedFormsApi.md
Normal file
@@ -0,0 +1,172 @@
|
||||
# SubmittedformsApi
|
||||
|
||||
All URIs are relative to */activiti-app/api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**getFormSubmittedForms**](SubmittedFormsApi.md#getFormSubmittedForms) | **GET** /enterprise/form-submitted-forms/{formId} | List submissions for a form
|
||||
[**getProcessSubmittedForms**](SubmittedFormsApi.md#getProcessSubmittedForms) | **GET** /enterprise/process-submitted-forms/{processId} | List submissions for a process instance
|
||||
[**getSubmittedFrom**](SubmittedFormsApi.md#getSubmittedFrom) | **GET** /enterprise/submitted-forms/{submittedFormId} | Get a form submission
|
||||
[**getTaskSubmittedForms**](SubmittedFormsApi.md#getTaskSubmittedForms) | **GET** /enterprise/task-submitted-form/{taskId} | Get the submitted form for a task
|
||||
|
||||
|
||||
<a name="getFormSubmittedForms"></a>
|
||||
# **getFormSubmittedForms**
|
||||
> ResultListDataRepresentationSubmittedFormRepresentation getFormSubmittedForms(formIdopts)
|
||||
|
||||
List submissions for a form
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import SubmittedformsApi from 'src/api/activiti-rest-api/docs/SubmittedFormsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let submittedformsApi = new SubmittedformsApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'submittedBy': 789 // | submittedBy
|
||||
'start': 56 // | start
|
||||
'size': 56 // | size
|
||||
};
|
||||
|
||||
submittedformsApi.getFormSubmittedForms(formIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**formId** | **number**| formId |
|
||||
**submittedBy** | **number**| submittedBy | [optional]
|
||||
**start** | **number**| start | [optional]
|
||||
**size** | **number**| size | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ResultListDataRepresentationSubmittedFormRepresentation**](ResultListDataRepresentationSubmittedFormRepresentation.md)
|
||||
|
||||
<a name="getProcessSubmittedForms"></a>
|
||||
# **getProcessSubmittedForms**
|
||||
> ResultListDataRepresentationSubmittedFormRepresentation getProcessSubmittedForms(processId)
|
||||
|
||||
List submissions for a process instance
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import SubmittedformsApi from 'src/api/activiti-rest-api/docs/SubmittedFormsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let submittedformsApi = new SubmittedformsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
submittedformsApi.getProcessSubmittedForms(processId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**processId** | **string**| processId |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ResultListDataRepresentationSubmittedFormRepresentation**](ResultListDataRepresentationSubmittedFormRepresentation.md)
|
||||
|
||||
<a name="getSubmittedFrom"></a>
|
||||
# **getSubmittedFrom**
|
||||
> SubmittedFormRepresentation getSubmittedFrom(submittedFormId)
|
||||
|
||||
Get a form submission
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import SubmittedformsApi from 'src/api/activiti-rest-api/docs/SubmittedFormsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let submittedformsApi = new SubmittedformsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
submittedformsApi.getSubmittedFrom(submittedFormId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**submittedFormId** | **number**| submittedFormId |
|
||||
|
||||
### Return type
|
||||
|
||||
[**SubmittedFormRepresentation**](SubmittedFormRepresentation.md)
|
||||
|
||||
<a name="getTaskSubmittedForms"></a>
|
||||
# **getTaskSubmittedForms**
|
||||
> SubmittedFormRepresentation getTaskSubmittedForms(taskId)
|
||||
|
||||
Get the submitted form for a task
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import SubmittedformsApi from 'src/api/activiti-rest-api/docs/SubmittedFormsApi';
|
||||
import {AlfrescoApi} from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let submittedformsApi = new SubmittedformsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
submittedformsApi.getTaskSubmittedForms(taskId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function (error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**taskId** | **string**| taskId |
|
||||
|
||||
### Return type
|
||||
|
||||
[**SubmittedFormRepresentation**](SubmittedFormRepresentation.md)
|
||||
|
||||
Reference in New Issue
Block a user