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 Process API

The Process API from Activiti — 10 operation(s) for process.

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

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

This API exposes 11 operations across 10 paths, and defines 18 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.

11 operations 10 paths 18 schemas 1 DELETE7 GET3 POST

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 Process 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 11

Across 10 paths, the API surfaces 11 operations — 1 DELETE, 7 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Process 11
GET
/api/enterprise/process-definitions
Retrieve a list of process definitions
getProcessDefinitionsUsingGET 2 params → 200401403404
GET
/api/enterprise/process-definitions/{processDefinitionId}/start-form
Retrieve the start form for a process definition
getProcessDefinitionStartFormUsingGET → 200401403404
GET
/api/enterprise/process-definitions/{processDefinitionId}/start-form-values/{field}
Retrieve field values (eg. the typeahead field)
getRestFieldValuesUsingGET → 200401403404
GET
/api/enterprise/process-definitions/{processDefinitionId}/start-form-values/{field}/{column}
Retrieve field values (eg. the table field)
getRestTableFieldValuesUsingGET → 200401403404
POST
/api/enterprise/process-instances
Start a process instance
startNewProcessInstanceUsingPOST body → 200201401403404
POST
/api/enterprise/process-instances/filter
Filter a list of process instances
filterProcessInstancesUsingPOST body → 200201401403404
POST
/api/enterprise/process-instances/query
Retrieve a list of process instances
getProcessInstancesUsingPOST body → 200201401403404
GET
/api/enterprise/process-instances/{processInstanceId}
Retrieve a process instance information
getProcessInstanceUsingGET 1 param → 200401403404
DELETE
/api/enterprise/process-instances/{processInstanceId}
Delete a process instance
deleteProcessInstanceUsingDELETE 1 param → 200204401403
GET
/api/enterprise/process-instances/{processInstanceId}/field-content
Retrieve content attached to process instance fields
getProcessInstanceContentUsingGET 1 param → 200401403404
GET
/api/enterprise/process-instances/{processInstanceId}/start-form
Get process start form
getProcessInstanceStartFormUsingGET 1 param → 200401403404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are FormFieldRepresentation (30 properties), FormDefinitionRepresentation (19 properties), ProcessInstanceRepresentation (17 properties), ConditionRepresentation (8 properties). Each schema is shown below with its type and property counts.

FormJavascriptEventRepresentation
object
2 properties
ResultListDataRepresentation
object
4 properties
AbstractRepresentation
FormOutcomeRepresentation
object
2 properties
ObjectNode
CreateProcessInstanceRepresentation
object
4 properties
RestVariable
object
5 properties
ConditionRepresentation
object
8 properties
OptionRepresentation
object
2 properties
LayoutRepresentation
object
3 properties
LightUserRepresentation
object
6 properties
ProcessInstanceFilterRepresentation
object
6 properties
FormTabRepresentation
object
3 properties
ProcessInstanceFilterRequestRepresentation
object
5 properties
FormValueRepresentation
object
2 properties
FormFieldRepresentation
object
30 properties
ProcessInstanceRepresentation
object
17 properties
FormDefinitionRepresentation
object
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activiti-process-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