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 Task Forms API

Manage Task Forms

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

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

This API exposes 5 operations across 4 paths, and defines 11 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 4 paths 11 schemas 3 GET2 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 Task Forms 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 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Task Forms 5

Manage Task Forms

GET
/api/enterprise/task-forms/{taskId}
Retrieve Task Form
getTaskFormUsingGET 1 param → 200401403404
POST
/api/enterprise/task-forms/{taskId}
Complete a Task Form
completeTaskFormUsingPOST 1 param body → 200201401403404
GET
/api/enterprise/task-forms/{taskId}/form-values/{field}
Retrieve Populated Field Values
getRestFieldValuesUsingGET_2 2 params → 200401403404
GET
/api/enterprise/task-forms/{taskId}/form-values/{field}/{column}
Retrieve Column Field Values
getRestFieldValuesUsingGET_1 3 params → 200401403404
POST
/api/enterprise/task-forms/{taskId}/save-form
Save Task Form
saveTaskFormUsingPOST 1 param body → 200201401403404

Schemas 11

The contract defines 11 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
SaveFormRepresentation
object
1 property
FormOutcomeRepresentation
object
2 properties
CompleteFormRepresentation
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-task-forms-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