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

Manage Process Instances

Activiti Process Instances 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 Instances. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 14 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.

5 operations 3 paths 14 schemas 1 DELETE3 GET1 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 Instances 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 5

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

Process Instances 5

Manage Process Instances

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}/comments
Comment list added to Process
getProcessInstanceCommentsUsingGET 2 params → 200401403404
POST
/api/enterprise/process-instances/{processInstanceId}/comments
Add a comment to a Process
addProcessInstanceCommentUsingPOST 1 param body → 200201401403404
GET
/api/enterprise/process-instances/{processInstanceId}/start-form
Get process start form
getProcessInstanceStartFormUsingGET 1 param → 200401403404

Schemas 14

The contract defines 14 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
RestVariable
object
5 properties
ConditionRepresentation
object
8 properties
OptionRepresentation
object
2 properties
LayoutRepresentation
object
3 properties
CommentRepresentation
object
4 properties
LightUserRepresentation
object
6 properties
FormTabRepresentation
object
3 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-instances-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