mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
* 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
6.5 KiB
6.5 KiB
TaskformsApi
All URIs are relative to /activiti-app/api
Method | HTTP request | Description |
---|---|---|
completeTaskForm | POST /enterprise/task-forms/{taskId} | Complete a task form |
getProcessInstanceVariables | GET /enterprise/task-forms/{taskId}/variables | Get task variables |
getRestFieldValues | GET /enterprise/task-forms/{taskId}/form-values/{field}/{column} | Retrieve column field values |
getRestFieldValues | GET /enterprise/task-forms/{taskId}/form-values/{field} | Retrieve populated field values |
getTaskForm | GET /enterprise/task-forms/{taskId} | Get a task form |
saveTaskForm | POST /enterprise/task-forms/{taskId}/save-form | Save a task form |
completeTaskForm
completeTaskForm(taskIdcompleteTaskFormRepresentation)
Complete a task form
Example
import TaskformsApi from 'src/api/activiti-rest-api/docs/TaskFormsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let taskformsApi = new TaskformsApi(this.alfrescoApi);
taskformsApi.completeTaskForm(taskIdcompleteTaskFormRepresentation).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
Parameters
Name | Type | Description | Notes |
---|---|---|---|
taskId | string | taskId | |
completeTaskFormRepresentation | CompleteFormRepresentation | completeTaskFormRepresentation |
Return type
null (empty response body)
getProcessInstanceVariables
ProcessInstanceVariableRepresentation getProcessInstanceVariables(taskId)
Get task variables
Example
import TaskformsApi from 'src/api/activiti-rest-api/docs/TaskFormsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let taskformsApi = new TaskformsApi(this.alfrescoApi);
taskformsApi.getProcessInstanceVariables(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
ProcessInstanceVariableRepresentation
getRestFieldValues
FormValueRepresentation getRestFieldValues(taskIdfieldcolumn)
Retrieve column field values
Specific case to retrieve information on a specific column
Example
import TaskformsApi from 'src/api/activiti-rest-api/docs/TaskFormsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let taskformsApi = new TaskformsApi(this.alfrescoApi);
taskformsApi.getRestFieldValues(taskIdfieldcolumn).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
Parameters
Name | Type | Description | Notes |
---|---|---|---|
taskId | string | taskId | |
field | string | field | |
column | string | column |
Return type
getRestFieldValues
FormValueRepresentation getRestFieldValues(taskIdfield)
Retrieve populated field values
Form field values that are populated through a REST backend, can be retrieved via this service
Example
import TaskformsApi from 'src/api/activiti-rest-api/docs/TaskFormsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let taskformsApi = new TaskformsApi(this.alfrescoApi);
taskformsApi.getRestFieldValues(taskIdfield).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
Parameters
Name | Type | Description | Notes |
---|---|---|---|
taskId | string | taskId | |
field | string | field |
Return type
getTaskForm
FormDefinitionRepresentation getTaskForm(taskId)
Get a task form
Example
import TaskformsApi from 'src/api/activiti-rest-api/docs/TaskFormsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let taskformsApi = new TaskformsApi(this.alfrescoApi);
taskformsApi.getTaskForm(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
saveTaskForm
saveTaskForm(taskIdsaveTaskFormRepresentation)
Save a task form
Example
import TaskformsApi from 'src/api/activiti-rest-api/docs/TaskFormsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let taskformsApi = new TaskformsApi(this.alfrescoApi);
taskformsApi.saveTaskForm(taskIdsaveTaskFormRepresentation).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
Parameters
Name | Type | Description | Notes |
---|---|---|---|
taskId | string | taskId | |
saveTaskFormRepresentation | SaveFormRepresentation | saveTaskFormRepresentation |
Return type
null (empty response body)