Skip to content

Latest commit

 

History

History
executable file
·
485 lines (305 loc) · 11.3 KB

ModelsApi.md

File metadata and controls

executable file
·
485 lines (305 loc) · 11.3 KB
Raw

ActivitiPublicRestApi.ModelsApi

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

createModel

ModelRepresentation createModel(modelRepresentation)

To create a new model

Example

var modelRepresentation = new this.alfrescoJsApi.activiti.ModelRepresentation(); // ModelRepresentation | modelRepresentation

this.alfrescoJsApi.activiti.modelsApi.createModel(modelRepresentation);

Parameters

Name Type Description Notes
modelRepresentation ModelRepresentation modelRepresentation

Return type

ModelRepresentation

Authorization

No authorization required

HTTP request headers

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

deleteModel

deleteModel(modelId, opts)

Delete a model

Example

var modelId = 789; // Integer | modelId

var opts = { 
  'cascade': true, // Boolean | cascade
  'deleteRuntimeApp': true // Boolean | deleteRuntimeApp
};

this.alfrescoJsApi.activiti.modelsApi.deleteModel(modelId, opts);

Parameters

Name Type Description Notes
modelId Integer modelId
cascade Boolean cascade [optional]
deleteRuntimeApp Boolean deleteRuntimeApp [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

duplicateModel

ModelRepresentation duplicateModel(modelId, modelRepresentation)

To duplicate an existing model

Example

var modelId = 789; // Integer | modelId

var modelRepresentation = new this.alfrescoJsApi.activiti.ModelRepresentation(); // ModelRepresentation | modelRepresentation


this.alfrescoJsApi.activiti.modelsApi.duplicateModel(modelId, modelRepresentation);

Parameters

Name Type Description Notes
modelId Integer modelId
modelRepresentation ModelRepresentation modelRepresentation

Return type

ModelRepresentation

Authorization

No authorization required

HTTP request headers

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

getModelJSON

ObjectNode getModelJSON(modelId)

Get the JSON model

Example

var modelId = 789; // Integer | modelId


this.alfrescoJsApi.activiti.modelsApi.getModelJSON(modelId);

Parameters

Name Type Description Notes
modelId Integer modelId

Return type

ObjectNode

Authorization

No authorization required

HTTP request headers

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

getModelThumbnail

['String'] getModelThumbnail(modelId)

Get Model thumbnail

Example

var modelId = 789; // Integer | modelId

this.alfrescoJsApi.activiti.modelsApi.getModelThumbnail(modelId);

Parameters

Name Type Description Notes
modelId Integer modelId

Return type

['String']

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: image/png, application/json

getModel

ModelRepresentation getModel(modelId, opts)

To retrieve details about a particular model (process, form, decision rule or app)

Example

var modelId = 789; // Integer | modelId

var opts = { 
  'includePermissions': true // Boolean | includePermissions
};

this.alfrescoJsApi.activiti.modelsApi.getModel(modelId, opts);

Parameters

Name Type Description Notes
modelId Integer modelId
includePermissions Boolean includePermissions [optional]

Return type

ModelRepresentation

Authorization

No authorization required

HTTP request headers

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

getModelsToIncludeInAppDefinition

ResultListDataRepresentation getModelsToIncludeInAppDefinition()

TODO

Example

this.alfrescoJsApi.activiti.modelsApi.getModelsToIncludeInAppDefinition();

Parameters

This endpoint does not need any parameter.

Return type

ResultListDataRepresentation

Authorization

No authorization required

HTTP request headers

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

getModels

ResultListDataRepresentation getModels(opts)

List models (process, form, decision rule or app)

Example

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

Parameters

Name Type Description Notes
filter String filter [optional]
sort String sort [optional]
modelType Integer modelType [optional]
referenceId Integer referenceId [optional]

Return type

ResultListDataRepresentation

Authorization

No authorization required

HTTP request headers

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

importNewVersion

ModelRepresentation importNewVersion(modelId, file)

Create a new model version

Example

var modelId = 789; // Integer | modelId

var file = "/path/to/file.txt"; // File | file

this.alfrescoJsApi.activiti.modelsApi.importNewVersion(modelId, file);

Parameters

Name Type Description Notes
modelId Integer modelId
file File file

Return type

ModelRepresentation

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

importProcessModel

ModelRepresentation importProcessModel(file)

To import a BPMN 2.0 xml file

Example

var file = "/path/to/file.txt"; // File | file

this.alfrescoJsApi.activiti.modelsApi.importProcessModel(file);

Parameters

Name Type Description Notes
file File file

Return type

ModelRepresentation

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

saveModel

ModelRepresentation saveModel(modelId, values)

Save the JSON model

Example

var modelId = 789; // Integer | modelId

var values = null; // Object | values

this.alfrescoJsApi.activiti.modelsApi.saveModel(modelId, values);

Parameters

Name Type Description Notes
modelId Integer modelId
values Object values

Return type

ModelRepresentation

Authorization

No authorization required

HTTP request headers

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

updateModel

ModelRepresentation updateModel(modelId, updatedModel)

Edit a specific model

Example

var modelId = 789; // Integer | modelId

var updatedModel = new this.alfrescoJsApi.activiti.ModelRepresentation(); // ModelRepresentation | updatedModel

this.alfrescoJsApi.activiti.modelsApi.updateModel(modelId, updatedModel);

Parameters

Name Type Description Notes
modelId Integer modelId
updatedModel ModelRepresentation updatedModel

Return type

ModelRepresentation

Authorization

No authorization required

HTTP request headers

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

validateModel

[ValidationErrorRepresentation] validateModel(modelId, opts)

Validate the JSON model

Example

var modelId = 789; // Integer | modelId

var opts = { 
  'values': null // Object | values
};

this.alfrescoJsApi.activiti.modelsApi.validateModel(modelId, opts);

Parameters

Name Type Description Notes
modelId Integer modelId
values Object values [optional]

Return type

[ValidationErrorRepresentation]

Authorization

No authorization required

HTTP request headers

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