Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Activiti Models API

Api Model Resource

Activiti Models API is one of 43 APIs that Activiti publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Models. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 9 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.4.0.

Requests are made against a single base URL, https://{host}/activiti-app.

13 operations 9 paths 5 schemas 1 DELETE5 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.4.0
Base URL
https://your-activiti-host/activiti-rest/service
Authentication
HTTP Basic
License
Resource Areas
1

Authentication & Security 1

Activiti Models API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication using valid Activiti user credentials

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 1 DELETE, 5 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Models 13

Api Model Resource

GET
/api/enterprise/models
List models (process, form, decision rule or app)
getModelsUsingGET 4 params → 200401403404
POST
/api/enterprise/models
To create a new model
createModelUsingPOST body → 200201401403404
GET
/api/enterprise/models-for-app-definition
TODO
getModelsToIncludeInAppDefinitionUsingGET → 200401403404
GET
/api/enterprise/models/{modelId}
To retrieve details about a particular model (process, form, decision rule or app)
getModelUsingGET 2 params → 200401403404
PUT
/api/enterprise/models/{modelId}
Edit a specific model
updateModelUsingPUT 1 param body → 200201401403404
DELETE
/api/enterprise/models/{modelId}
Delete a model
deleteModelUsingDELETE 3 params → 200204401403
POST
/api/enterprise/models/{modelId}/clone
To duplicate an existing model
duplicateModelUsingPOST 1 param body → 200201401403404
GET
/api/enterprise/models/{modelId}/editor/json
Get the JSON model
getModelJSONUsingGET 1 param → 200401403404
POST
/api/enterprise/models/{modelId}/editor/json
Save the JSON model
saveModelUsingPOST 1 param body → 200201401403404
POST
/api/enterprise/models/{modelId}/editor/validate
Validate the JSON model
validateModelUsingPOST 1 param body → 200201401403404
POST
/api/enterprise/models/{modelId}/newversion
Create a new model version
importNewVersionUsingPOST 2 params → 200201401403404
GET
/api/enterprise/models/{modelId}/thumbnail
Get Model thumbnail
getModelThumbnailUsingGET 1 param → 200401403404
POST
/api/enterprise/process-models/import
To import a BPMN 2.0 xml file
importProcessModelUsingPOST 1 param → 200201401403404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ModelRepresentation (16 properties), ValidationErrorRepresentation (7 properties), ResultListDataRepresentation (4 properties). Each schema is shown below with its type and property counts.

ModelRepresentation
object
16 properties
ResultListDataRepresentation
object
4 properties
AbstractRepresentation
ValidationErrorRepresentation
object
7 properties
ObjectNode

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activiti-models-api-openapi.yml Raw ↑

Other APIs Activiti publishes across the network.

Activiti Cloud Runtime Bundle API
Activiti About API
Activiti Admin Endpoints API
Activiti Admin Groups API
Activiti Admin Tenants API
Activiti Admin Users API
Activiti Alfresco API
Activiti Apps API
Activiti Apps Definition API
Activiti Apps Runtime API
Activiti Comments API
Activiti Content API