mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +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

2023-11-21 05:27:51 -05:00

26 KiB

Raw Blame History

Process Instances Api

All URIs are relative to /activiti-app/api

Method	HTTP request	Description
activateProcessInstance	PUT /enterprise/process-instances/{processInstanceId}/activate	Activate a process instance
createIdentityLink	POST /enterprise/process-instances/{processInstanceId}/identitylinks	Add a user or group involvement to a process instance
deleteIdentityLink	DELETE /enterprise/process-instances/{processInstanceId}/identitylinks/{family}/{identityId}/{type}	Remove a user or group involvement from a process instance
deleteProcessInstance	DELETE /enterprise/process-instances/{processInstanceId}	Cancel or remove a process instance
filterProcessInstances	POST /enterprise/process-instances/filter	List process instances using a filter
getHistoricProcessInstanceDecisionTasks	GET /enterprise/process-instances/{processInstanceId}/decision-tasks	Get decision tasks in a process instance
getHistoricProcessInstanceVariables	GET /enterprise/process-instances/{processInstanceId}/historic-variables	Get historic variables for a process instance
getHistoricProcessInstances	POST /enterprise/historic-process-instances/query	Query historic process instances
getIdentityLinkType	GET /enterprise/process-instances/{processInstanceId}/identitylinks/{family}/{identityId}/{type}	Get a user or group involvement with a process instance
getIdentityLinksForFamily	GET /enterprise/process-instances/{processInstanceId}/identitylinks/{family}	List either the users or groups involved with a process instance
getIdentityLinks	GET /enterprise/process-instances/{processInstanceId}/identitylinks	List the users and groups involved with a process instance
getProcessInstanceContent	GET /enterprise/process-instances/{processInstanceId}/field-content	List content attached to process instance fields
getProcessInstanceDiagram	GET /enterprise/process-instances/{processInstanceId}/diagram	Get the process diagram for the process instance
getProcessInstanceStartForm	GET /enterprise/process-instances/{processInstanceId}/start-form	Get a process instance start form
getProcessInstance	GET /enterprise/process-instances/{processInstanceId}	Get a process instance
getProcessInstances	POST /enterprise/process-instances/query	Query process instances
getTaskAuditLog	GET /enterprise/process-instances/{processInstanceId}/audit-log	Get the audit log for a process instance
startNewProcessInstance	POST /enterprise/process-instances	Start a process instance
suspendProcessInstance	PUT /enterprise/process-instances/{processInstanceId}/suspend	Suspend a process instance
getProcessAuditPdf	GET /app/rest/process-instances/{processId}/audit	Retrieve the process audit infromation in pdf format

activateProcessInstance

ProcessInstanceRepresentation activateProcessInstance(processInstanceId)

Activate a process instance

Example

import { AlfrescoApi, ProcessiIstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessiIstancesApi(alfrescoApi);

processinstancesApi.activateProcessInstance(processInstanceId).then(
    (data) => {
        console.log('API called successfully. Returned data: ' + data);
    }, 
    (error) => {
        console.error(error);
    });

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId

Return type

ProcessInstanceRepresentation

createIdentityLink

IdentityLinkRepresentation createIdentityLink(processInstanceIdidentityLinkRepresentation)

Add a user or group involvement to a process instance

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(alfrescoApi);

processInstancesApi.createIdentityLink(processInstanceIdidentityLinkRepresentation).then(
    (data) => {
      console.log('API called successfully. Returned data: ' + data);
    }, 
    (error) => {
      console.error(error);
    });

Parameters

Name	Type	Description
processInstanceId	String	processInstanceId
identityLinkRepresentation	IdentityLinkRepresentation	identityLinkRepresentation

Return type

IdentityLinkRepresentation

deleteIdentityLink

deleteIdentityLink(processInstanceId,family, identityId, type)

Remove a user or group involvement from a process instance

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(alfrescoApi);

processInstancesApi.deleteIdentityLink(processInstanceIdfamilyidentityIdtype).then(
    () => {
        console.log('API called successfully.');
    }, 
    (error) => {
        console.error(error);
    });

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId
family	string	family
identityId	string	identityId
type	string	type

deleteProcessInstance

deleteProcessInstance(processInstanceId)

Cancel or remove a process instance

If the process instance has not yet been completed, it will be cancelled. If it has already finished or been cancelled then the process instance will be removed and will no longer appear in queries.

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(alfrescoApi);

processInstancesApi.deleteProcessInstance(processInstanceId).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId

filterProcessInstances

ResultListDataRepresentationProcessInstanceRepresentation filterProcessInstances(filterRequest)

List process instances using a filter

The request body provided must define either a valid filterId value or filter object

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(alfrescoApi);

processInstancesApi.filterProcessInstances(filterRequest).then(
    (data) => {
        console.log('API called successfully. Returned data: ' + data);
    }, (error) => {
        console.error(error);
    });

Parameters

Name	Type	Description
filterRequest	ProcessInstanceFilterRequestRepresentation	filterRequest

Return type

ResultListDataRepresentationProcessInstanceRepresentation

getHistoricProcessInstanceDecisionTasks

ResultListDataRepresentationDecisionTaskRepresentation getHistoricProcessInstanceDecisionTasks(processInstanceId)

Get decision tasks in a process instance

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(alfrescoApi);

processInstancesApi.getHistoricProcessInstanceDecisionTasks(processInstanceId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId

Return type

ResultListDataRepresentationDecisionTaskRepresentation

getHistoricProcessInstanceVariables

ProcessInstanceVariableRepresentation getHistoricProcessInstanceVariables(processInstanceId)

Get historic variables for a process instance

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(alfrescoApi);

processInstancesApi.getHistoricProcessInstanceVariables(processInstanceId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId

Return type

ProcessInstanceVariableRepresentation

getHistoricProcessInstances

ResultListDataRepresentationProcessInstanceRepresentation getHistoricProcessInstances(queryRequest)

Query historic process instances

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(this.alfrescoApi);

processinstancesApi.getHistoricProcessInstances(queryRequest).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description
queryRequest	HistoricProcessInstanceQueryRepresentation	queryRequest

Return type

ResultListDataRepresentationProcessInstanceRepresentation

getIdentityLinkType

IdentityLinkRepresentation getIdentityLinkType(processInstanceIdfamilyidentityIdtype)

Get a user or group involvement with a process instance

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(this.alfrescoApi);

processinstancesApi.getIdentityLinkType(processInstanceIdfamilyidentityIdtype).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId
family	string	family
identityId	string	identityId
type	string	type

Return type

IdentityLinkRepresentation

getIdentityLinksForFamily

IdentityLinkRepresentation getIdentityLinksForFamily(processInstanceIdfamily)

List either the users or groups involved with a process instance

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(this.alfrescoApi);

processinstancesApi.getIdentityLinksForFamily(processInstanceIdfamily).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId
family	string	family

Return type

IdentityLinkRepresentation

getIdentityLinks

IdentityLinkRepresentation getIdentityLinks(processInstanceId)

List the users and groups involved with a process instance

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(this.alfrescoApi);

processinstancesApi.getIdentityLinks(processInstanceId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId

Return type

IdentityLinkRepresentation

getProcessInstanceContent

ResultListDataRepresentationProcessContentRepresentation getProcessInstanceContent(processInstanceId)

List content attached to process instance fields

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(this.alfrescoApi);

processinstancesApi.getProcessInstanceContent(processInstanceId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId

Return type

ResultListDataRepresentationProcessContentRepresentation

getProcessInstanceDiagram

string getProcessInstanceDiagram(processInstanceId)

Get the process diagram for the process instance

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(this.alfrescoApi);

processinstancesApi.getProcessInstanceDiagram(processInstanceId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId

Return type

string

getProcessInstanceStartForm

FormDefinitionRepresentation getProcessInstanceStartForm(processInstanceId)

Get a process instance start form

The start form for a process instance can be retrieved when the process definition has a start form defined (hasStartForm = true on the process instance)

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(this.alfrescoApi);

processinstancesApi.getProcessInstanceStartForm(processInstanceId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId

Return type

FormDefinitionRepresentation

getProcessInstance

ProcessInstanceRepresentation getProcessInstance(processInstanceId)

Get a process instance

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(this.alfrescoApi);

processInstancesApi.getProcessInstance(processInstanceId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId

Return type

ProcessInstanceRepresentation

getProcessInstances

ResultListDataRepresentationProcessInstanceRepresentation getProcessInstances(processInstancesQuery)

Query process instances

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(this.alfrescoApi);

processInstancesApi.getProcessInstances(processInstancesQuery).then(
    (data) => {
        console.log('API called successfully. Returned data: ' + data);
    }, 
    (error) => {
      console.error(error);
    });

Parameters

Name	Type	Description	Notes
processInstancesQuery	ProcessInstanceQueryRepresentation	processInstancesQuery

Return type

ResultListDataRepresentationProcessInstanceRepresentation

getTaskAuditLog

ProcessInstanceAuditInfoRepresentation getTaskAuditLog(processInstanceId)

Get the audit log for a process instance

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(this.alfrescoApi);

processInstancesApi.getTaskAuditLog(processInstanceId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId

Return type

ProcessInstanceAuditInfoRepresentation

startNewProcessInstance

ProcessInstanceRepresentation startNewProcessInstance(startRequest)

Start a process instance

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(this.alfrescoApi);

processinstancesApi.startNewProcessInstance(startRequest).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description
startRequest	CreateProcessInstanceRepresentation	startRequest

Return type

ProcessInstanceRepresentation

suspendProcessInstance

ProcessInstanceRepresentation suspendProcessInstance(processInstanceId)

Suspend a process instance

Example

import { AlfrescoApi, ProcessInstancesApi } from '@alfresco/js-api';

const alfrescoApi = new AlfrescoApi({
    hostEcm: 'http://127.0.0.1:8080'
});

const processInstancesApi = new ProcessInstancesApi(this.alfrescoApi);

processinstancesApi.suspendProcessInstance(processInstanceId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description
processInstanceId	string	processInstanceId

Return type

ProcessInstanceRepresentation

getProcessAuditPdf

Blob getProcessAuditPdf(processId)

Retrieve process audit information in pdf format

Example

const processId = "processId_example";

processInstancesApi.getProcessAuditPdf(processId);

Parameters

Name	Type	Description
processId	String	processId

Return type

[Blob]

26 KiB Raw Blame History

Process Instances Api

activateProcessInstance

createIdentityLink

deleteIdentityLink

deleteProcessInstance

filterProcessInstances

getHistoricProcessInstanceDecisionTasks

getHistoricProcessInstanceVariables

getHistoricProcessInstances

getIdentityLinkType

getIdentityLinksForFamily

getIdentityLinks

getProcessInstanceContent

getProcessInstanceDiagram

getProcessInstanceStartForm

getProcessInstance

getProcessInstances

getTaskAuditLog

startNewProcessInstance

suspendProcessInstance

getProcessAuditPdf

26 KiB

Raw Blame History