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
223
lib/js-api/src/api/activiti-rest-api/docs/FormModelsApi.md
Normal file
223
lib/js-api/src/api/activiti-rest-api/docs/FormModelsApi.md
Normal file
@@ -0,0 +1,223 @@
|
||||
# Form Models Api
|
||||
|
||||
All URIs are relative to */activiti-app/api*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
|-----------------------------------------|-------------------------------------------------------------------------|-----------------------------|
|
||||
| [getFormEditorJson](#getFormEditorJson) | **GET** /enterprise/forms/{formId}/editorJson | Get form content |
|
||||
| [getFormHistory](#getFormHistory) | **GET** /enterprise/editor/form-models/{formId}/history/{formHistoryId} | Get form history |
|
||||
| [getForm](#getForm) | **GET** /enterprise/editor/form-models/{formId} | Get a form model |
|
||||
| [getForm](#getForm) | **GET** /enterprise/forms/{formId} | Get a form |
|
||||
| [getForms](#getForms) | **GET** /enterprise/editor/form-models/values | Get forms |
|
||||
| [getForms](#getForms) | **GET** /enterprise/editor/form-models | List form models |
|
||||
| [getForms](#getForms) | **GET** /enterprise/forms | Query forms |
|
||||
| [saveForm](#saveForm) | **PUT** /enterprise/editor/form-models/{formId} | Update form model content |
|
||||
| [validateModel](#validateModel) | **PUT** /enterprise/editor/form-models/{formId}/validate | Validate form model content |
|
||||
|
||||
|
||||
# **getFormEditorJson**
|
||||
|
||||
Get form content
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|------------|------------|-------------|
|
||||
| **formId** | **number** | formId |
|
||||
|
||||
**Return type**: [FormDefinitionRepresentation](FormDefinitionRepresentation.md)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import {AlfrescoApi, FormModelsApi } from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const formModelsApi = new FormModelsApi(alfrescoApi);
|
||||
|
||||
formModelsApi.getFormEditorJson(formId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
|
||||
# **getFormHistory**
|
||||
|
||||
Get form history
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|-------------------|--------|---------------|
|
||||
| **formId** | number | formId |
|
||||
| **formHistoryId** | number | formHistoryId |
|
||||
|
||||
**Return type**: [FormRepresentation](FormRepresentation.md)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, FormModelsApi} from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const formModelsApi = new FormModelsApi(alfrescoApi);
|
||||
|
||||
formModelsApi.getFormHistory(formIdformHistoryId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
|
||||
# **getForm**
|
||||
|
||||
Get a form model
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|------------|--------|-------------|
|
||||
| **formId** | number | formId |
|
||||
|
||||
**Return type**: [FormRepresentation](FormRepresentation.md)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, FormModelsApi} from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const formModelsApi = new FormModelsApi(alfrescoApi);
|
||||
|
||||
formModelsApi.getForm(formId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
|
||||
# **getForms**
|
||||
|
||||
Get forms
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|------------|--------|-------------|
|
||||
| **formId** | string | formId |
|
||||
|
||||
**Return type**: [**FormRepresentation**](FormRepresentation.md)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, FormModelsApi } from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const formModelsApi = new FormModelsApi(alfrescoApi);
|
||||
|
||||
formModelsApi.getForms(formId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
|
||||
# **getForms**
|
||||
|
||||
List form models
|
||||
|
||||
**Return type**: [ResultListDataRepresentationFormRepresentation](ResultListDataRepresentationFormRepresentation.md)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, FormModelsApi } from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const formModelsApi = new FormModelsApi(alfrescoApi);
|
||||
|
||||
formModelsApi.getForms().then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
|
||||
# **getForms**
|
||||
|
||||
Query forms
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|----------|--------|-------------|
|
||||
| nameLike | string | nameLike |
|
||||
| appId | number | appId |
|
||||
| tenantId | number | tenantId |
|
||||
| start | number | start |
|
||||
| sort | string | sort |
|
||||
| order | string | order |
|
||||
| size | number | size |
|
||||
|
||||
**Return type**: [ResultListDataRepresentationRuntimeFormRepresentation](ResultListDataRepresentationRuntimeFormRepresentation.md)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, FormModelsApi } from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const formModelsApi = new FormModelsApi(alfrescoApi);
|
||||
const opts = {/*...*/};
|
||||
|
||||
formModelsApi.getForms(opts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
|
||||
# **saveForm**
|
||||
|
||||
Update form model content
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|------------------------|-----------------------------------------------------|--------------------------|
|
||||
| **formId** | number | ID of the form to update |
|
||||
| **saveRepresentation** | [FormSaveRepresentation](FormSaveRepresentation.md) | saveRepresentation |
|
||||
|
||||
**Return type**: [FormRepresentation](FormRepresentation.md)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, FormModelsApi } from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const formModelsApi = new FormModelsApi(alfrescoApi);
|
||||
|
||||
formModelsApi.saveForm(formIdsaveRepresentation).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
|
||||
# **validateModel**
|
||||
|
||||
Validate form model content
|
||||
|
||||
The model content to be validated must be specified in the POST body
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|------------------------|-----------------------------------------------------|--------------------|
|
||||
| **formId** | number | formId |
|
||||
| **saveRepresentation** | [FormSaveRepresentation](FormSaveRepresentation.md) | saveRepresentation |
|
||||
|
||||
**Return type**: [ValidationErrorRepresentation](ValidationErrorRepresentation.md)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, FormModelsApi } from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*...*/);
|
||||
const formModelsApi = new FormModelsApi(alfrescoApi);
|
||||
const payload = {/*...*/};
|
||||
|
||||
formModelsApi.validateModel(payload).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
Reference in New Issue
Block a user