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

Manage process instances

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

This API exposes 2 operations across 2 paths, and defines 6 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.

2 operations 2 paths 6 schemas 1 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 Information 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 2

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

Process Instances Information 2

Manage process instances

POST
/api/enterprise/process-instances
Start a process instance
startNewProcessInstanceUsingPOST body → 200201401403404
GET
/api/enterprise/process-instances/{processInstanceId}/field-content
Retrieve content attached to process instance fields
getProcessInstanceContentUsingGET 1 param → 200401403404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ProcessInstanceRepresentation (17 properties), LightUserRepresentation (6 properties), RestVariable (5 properties), CreateProcessInstanceRepresentation (4 properties). Each schema is shown below with its type and property counts.

ResultListDataRepresentation
object
4 properties
AbstractRepresentation
CreateProcessInstanceRepresentation
object
4 properties
RestVariable
object
5 properties
LightUserRepresentation
object
6 properties
ProcessInstanceRepresentation
object
17 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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