All URIs are relative to https://localhost:8080/activiti-app
Method | HTTP request | Description |
---|---|---|
createModel | POST /api/enterprise/models | To create a new model |
deleteModel | DELETE /api/enterprise/models/{modelId} | Delete a model |
duplicateModel | POST /api/enterprise/models/{modelId}/clone | To duplicate an existing model |
getModelJSON | GET /api/enterprise/models/{modelId}/editor/json | Get the JSON model |
getModelThumbnail | GET /api/enterprise/models/{modelId}/thumbnail | Get Model thumbnail |
getModel | GET /api/enterprise/models/{modelId} | To retrieve details about a particular model (process, form, decision rule or app) |
getModelsToIncludeInAppDefinition | GET /api/enterprise/models-for-app-definition | TODO |
getModels | GET /api/enterprise/models | List models (process, form, decision rule or app) |
importNewVersion | POST /api/enterprise/models/{modelId}/newversion | Create a new model version |
importProcessModel | POST /api/enterprise/process-models/import | To import a BPMN 2.0 xml file |
saveModel | POST /api/enterprise/models/{modelId}/editor/json | Save the JSON model |
updateModel | PUT /api/enterprise/models/{modelId} | Edit a specific model |
validateModel | POST /api/enterprise/models/{modelId}/editor/validate | Validate the JSON model |
ModelRepresentation createModel(modelRepresentation)
To create a new model
var modelRepresentation = new this.alfrescoJsApi.activiti.ModelRepresentation(); // ModelRepresentation | modelRepresentation
this.alfrescoJsApi.activiti.modelsApi.createModel(modelRepresentation);
Name | Type | Description | Notes |
---|---|---|---|
modelRepresentation | ModelRepresentation | modelRepresentation |
No authorization required
- Content-Type: application/json
- Accept: application/json
deleteModel(modelId, opts)
Delete a model
var modelId = 789; // Integer | modelId
var opts = {
'cascade': true, // Boolean | cascade
'deleteRuntimeApp': true // Boolean | deleteRuntimeApp
};
this.alfrescoJsApi.activiti.modelsApi.deleteModel(modelId, opts);
Name | Type | Description | Notes |
---|---|---|---|
modelId | Integer | modelId | |
cascade | Boolean | cascade | [optional] |
deleteRuntimeApp | Boolean | deleteRuntimeApp | [optional] |
null (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
ModelRepresentation duplicateModel(modelId, modelRepresentation)
To duplicate an existing model
var modelId = 789; // Integer | modelId
var modelRepresentation = new this.alfrescoJsApi.activiti.ModelRepresentation(); // ModelRepresentation | modelRepresentation
this.alfrescoJsApi.activiti.modelsApi.duplicateModel(modelId, modelRepresentation);
Name | Type | Description | Notes |
---|---|---|---|
modelId | Integer | modelId | |
modelRepresentation | ModelRepresentation | modelRepresentation |
No authorization required
- Content-Type: application/json
- Accept: application/json
ObjectNode getModelJSON(modelId)
Get the JSON model
var modelId = 789; // Integer | modelId
this.alfrescoJsApi.activiti.modelsApi.getModelJSON(modelId);
Name | Type | Description | Notes |
---|---|---|---|
modelId | Integer | modelId |
No authorization required
- Content-Type: application/json
- Accept: application/json
['String'] getModelThumbnail(modelId)
Get Model thumbnail
var modelId = 789; // Integer | modelId
this.alfrescoJsApi.activiti.modelsApi.getModelThumbnail(modelId);
Name | Type | Description | Notes |
---|---|---|---|
modelId | Integer | modelId |
['String']
No authorization required
- Content-Type: application/json
- Accept: image/png, application/json
ModelRepresentation getModel(modelId, opts)
To retrieve details about a particular model (process, form, decision rule or app)
var modelId = 789; // Integer | modelId
var opts = {
'includePermissions': true // Boolean | includePermissions
};
this.alfrescoJsApi.activiti.modelsApi.getModel(modelId, opts);
Name | Type | Description | Notes |
---|---|---|---|
modelId | Integer | modelId | |
includePermissions | Boolean | includePermissions | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
ResultListDataRepresentation getModelsToIncludeInAppDefinition()
TODO
this.alfrescoJsApi.activiti.modelsApi.getModelsToIncludeInAppDefinition();
This endpoint does not need any parameter.
No authorization required
- Content-Type: application/json
- Accept: application/json
ResultListDataRepresentation getModels(opts)
List models (process, form, decision rule or app)
var opts = {
'filter': "filter_example", // String | filter
'filterText': "filterText", // String | filterText
'sort': "sort_example", // String | sort
'modelType': 56, // Integer | modelType
'referenceId': 789 // Integer | referenceId
};
this.alfrescoJsApi.activiti.modelsApi.getModels(opts);
Name | Type | Description | Notes |
---|---|---|---|
filter | String | filter | [optional] |
sort | String | sort | [optional] |
modelType | Integer | modelType | [optional] |
referenceId | Integer | referenceId | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
ModelRepresentation importNewVersion(modelId, file)
Create a new model version
var modelId = 789; // Integer | modelId
var file = "/path/to/file.txt"; // File | file
this.alfrescoJsApi.activiti.modelsApi.importNewVersion(modelId, file);
Name | Type | Description | Notes |
---|---|---|---|
modelId | Integer | modelId | |
file | File | file |
No authorization required
- Content-Type: multipart/form-data
- Accept: application/json
ModelRepresentation importProcessModel(file)
To import a BPMN 2.0 xml file
var file = "/path/to/file.txt"; // File | file
this.alfrescoJsApi.activiti.modelsApi.importProcessModel(file);
Name | Type | Description | Notes |
---|---|---|---|
file | File | file |
No authorization required
- Content-Type: multipart/form-data
- Accept: application/json
ModelRepresentation saveModel(modelId, values)
Save the JSON model
var modelId = 789; // Integer | modelId
var values = null; // Object | values
this.alfrescoJsApi.activiti.modelsApi.saveModel(modelId, values);
Name | Type | Description | Notes |
---|---|---|---|
modelId | Integer | modelId | |
values | Object | values |
No authorization required
- Content-Type: application/json
- Accept: application/json
ModelRepresentation updateModel(modelId, updatedModel)
Edit a specific model
var modelId = 789; // Integer | modelId
var updatedModel = new this.alfrescoJsApi.activiti.ModelRepresentation(); // ModelRepresentation | updatedModel
this.alfrescoJsApi.activiti.modelsApi.updateModel(modelId, updatedModel);
Name | Type | Description | Notes |
---|---|---|---|
modelId | Integer | modelId | |
updatedModel | ModelRepresentation | updatedModel |
No authorization required
- Content-Type: application/json
- Accept: application/json
[ValidationErrorRepresentation] validateModel(modelId, opts)
Validate the JSON model
var modelId = 789; // Integer | modelId
var opts = {
'values': null // Object | values
};
this.alfrescoJsApi.activiti.modelsApi.validateModel(modelId, opts);
Name | Type | Description | Notes |
---|---|---|---|
modelId | Integer | modelId | |
values | Object | values | [optional] |
[ValidationErrorRepresentation]
No authorization required
- Content-Type: application/json
- Accept: application/json