Skip to content

Latest commit

 

History

History
245 lines (167 loc) · 6.31 KB

TaskformsApi.md

File metadata and controls

245 lines (167 loc) · 6.31 KB
Raw

TaskformsApi

All URIs are relative to https://adfdev.envalfresco.com/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 '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 '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 '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

FormValueRepresentation

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 '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

FormValueRepresentation

getTaskForm

FormDefinitionRepresentation getTaskForm(taskId)

Get a task form

Example

import TaskformsApi from '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

FormDefinitionRepresentation

saveTaskForm

saveTaskForm(taskIdsaveTaskFormRepresentation)

Save a task form

Example

import TaskformsApi from '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)