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 Definitions Form API

Start Forms

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

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

3 operations 3 paths 9 schemas 3 GET

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 Definitions Form 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 3

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

Process Definitions Form 3

Start Forms

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

Schemas 9

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

FormJavascriptEventRepresentation
object
2 properties
FormOutcomeRepresentation
object
2 properties
ConditionRepresentation
object
8 properties
OptionRepresentation
object
2 properties
LayoutRepresentation
object
3 properties
FormTabRepresentation
object
3 properties
FormValueRepresentation
object
2 properties
FormFieldRepresentation
object
30 properties
FormDefinitionRepresentation
object
19 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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