inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/lib/js-api/src/api/activiti-rest-api/docs/ModelJsonBpmnApi.md
Denys Vuika ea2c0ce229
[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

3.9 KiB
Raw Permalink Blame History

ActivitiPublicRestApi.ModelJsonBpmnApi

All URIs are relative to https://localhost:8080/activiti-app

Method HTTP request Description
getHistoricEditorDisplayJsonClient GET /app/rest/process-instances/{processModelId}/history/{processModelHistoryId}/model-json Export a previous process definition model to JSON
getEditorDisplayJsonClient GET app/rest/models/{processModelId}/model-json Export a process definition model to JSON
getModelJSON GET /app/rest/process-definitions/{processDefinitionId}/model-json Export a process definition model to JSON
getModelJSONForProcessDefinition GET /app/rest/process-instances/{processInstanceId}/model-json Export a process instances model to JSON

getEditorDisplayJsonClient

getEditorDisplayJsonClient(processModelId, processModelHistoryId)

Export a previous process definition model to JSON

Example


var processModelId = 789; // Integer | processModelId

var processModelHistoryId = 789; // Integer | processModelHistoryId

this.alfrescoJsApi.activiti.modelJsonBpmnApi.getHistoricEditorDisplayJsonClient(processModelId, processModelHistoryId);

Parameters

Name Type Description Notes
processModelId Integer processModelId
processModelHistoryId Integer processModelHistoryId

Return type

JSON definition model

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getEditorDisplayJsonClient

getEditorDisplayJsonClient(processModelId)

Export a process instances model to a BPMN 2.0 xml file

Example


var processModelId = 789; // Integer | processModelId

this.alfrescoJsApi.activiti.modelJsonBpmnApi.getEditorDisplayJsonClient(processModelId);

Parameters

Name Type Description Notes
processModelId Integer processModelId

Return type

JSON definition model

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getModelJSON

getModelJSON(processDefinitionId)

Export a process definition model to a BPMN 2.0 xml file

Example


var processDefinitionId = 789; // Stringg | processDefinitionId

this.alfrescoJsApi.activiti.modelJsonBpmnApi.getModelJSON(processDefinitionId);

Parameters

Name Type Description Notes
processDefinitionId String processDefinitionId

Return type

JSON definition model

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getModelJSONForProcessDefinition

getModelJSONForProcessDefinition(processInstanceId)

Export a process definition model to a BPMN 2.0 xml file

Example


var processInstanceId = 789; // String | processInstanceId

this.alfrescoJsApi.activiti.modelJsonBpmnApi.getModelJSONForProcessDefinition(processInstanceId);

Parameters

Name Type Description Notes
processInstanceId String processInstanceId

Return type

JSON definition model

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json