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

Listing

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

This API exposes 2 operations across 2 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.

2 operations 2 paths 5 schemas 2 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 Listing 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 — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Process Instances Listing 2

Listing

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

Schemas 5

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

ResultListDataRepresentation
object
4 properties
AbstractRepresentation
ProcessInstanceFilterRepresentation
object
6 properties
ProcessInstanceFilterRequestRepresentation
object
5 properties
ObjectNode

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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