FormModelsApi.md

Form Models Api

All URIs are relative to /activiti-app/api

Method	HTTP request	Description
getFormEditorJson	GET /enterprise/forms/{formId}/editorJson	Get form content
getFormHistory	GET /enterprise/editor/form-models/{formId}/history/{formHistoryId}	Get form history
getForm	GET /enterprise/editor/form-models/{formId}	Get a form model
getForm	GET /enterprise/forms/{formId}	Get a form
getForms	GET /enterprise/editor/form-models/values	Get forms
getForms	GET /enterprise/editor/form-models	List form models
getForms	GET /enterprise/forms	Query forms
saveForm	PUT /enterprise/editor/form-models/{formId}	Update form model content
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

Example

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

Example

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

Example

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

Example

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

Example

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

Example

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	saveRepresentation

Return type: FormRepresentation

Example

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	saveRepresentation

Return type: ValidationErrorRepresentation

Example

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);
});