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 API

Manage Tasks

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

This API exposes 27 operations across 20 paths, and defines 22 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.

27 operations 20 paths 22 schemas 2 DELETE7 GET9 POST9 PUT

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 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 27

Across 20 paths, the API surfaces 27 operations — 2 DELETE, 7 GET, 9 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

Task 27

Manage Tasks

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
POST
/api/enterprise/tasks
Create a Standalone Task
createNewTaskUsingPOST body → 200201401403404
POST
/api/enterprise/tasks/filter
Filter list of Task
filterTasksUsingPOST body → 200201401403404
POST
/api/enterprise/tasks/query
List Task
listTasksUsingPOST body → 200201401403404
GET
/api/enterprise/tasks/{taskId}
Task Details
getTaskUsingGET 1 param → 200401403404
PUT
/api/enterprise/tasks/{taskId}
Update Task Details
updateTaskUsingPUT 1 param body → 200201401403404
DELETE
/api/enterprise/tasks/{taskId}
Delete a Task
deleteTaskUsingDELETE 1 param → 200204401403
PUT
/api/enterprise/tasks/{taskId}/action/assign
Assign a task to a user
assignTaskUsingPUT 1 param body → 200201401403404
PUT
/api/enterprise/tasks/{taskId}/action/attach-form
Attach a form to a task
attachFormUsingPUT 1 param body → 200201401403404
PUT
/api/enterprise/tasks/{taskId}/action/claim
Claim a task
claimTaskUsingPUT 1 param → 200201401403404
PUT
/api/enterprise/tasks/{taskId}/action/complete
Complete Task
completeTaskUsingPUT 1 param → 200201401403404
PUT
/api/enterprise/tasks/{taskId}/action/involve
To involve a user with a task
involveUserUsingPUT 1 param body → 200201401403404
DELETE
/api/enterprise/tasks/{taskId}/action/remove-form
Remove a form to a task
removeFormUsingDELETE 1 param → 200204401403
PUT
/api/enterprise/tasks/{taskId}/action/remove-involved
Remove an involved user from a task
removeInvolvedUserUsingPUT 1 param body → 200201401403404
PUT
/api/enterprise/tasks/{taskId}/action/unclaim
Unclaim a task
unclaimTaskUsingPUT 1 param → 200201401403404
GET
/api/enterprise/tasks/{taskId}/checklist
Retrieve Checklist added to a task
getChecklistUsingGET 1 param → 200401403404
POST
/api/enterprise/tasks/{taskId}/checklist
Create a task checklist
addSubtaskUsingPOST 1 param body → 200201401403404
PUT
/api/enterprise/tasks/{taskId}/checklist
Change the order of items on a checklist
orderChecklistUsingPUT 1 param body → 200201401403404
GET
/api/enterprise/tasks/{taskId}/comments
Comment list added to Task
getTaskCommentsUsingGET 2 params → 200401403404
POST
/api/enterprise/tasks/{taskId}/comments
Add a comment to a Task
addTaskCommentUsingPOST 1 param body → 200201401403404
GET
/api/enterprise/tasks/{taskId}/content
Retrieve which content is attached to a task
getRelatedContentForTaskUsingGET 1 param → 200401403404
POST
/api/enterprise/tasks/{taskId}/content
To relate content (eg from Alfresco) to a task
createRelatedContentOnTaskUsingPOST 2 params body → 200201401403404
POST
/api/enterprise/tasks/{taskId}/raw-content
Upload content to a task
createRelatedContentOnTaskUsingPOST_1 3 params → 200201401403404

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are FormFieldRepresentation (30 properties), TaskRepresentation (28 properties), FormDefinitionRepresentation (19 properties), RelatedContentRepresentation (13 properties). Each schema is shown below with its type and property counts.

SaveFormRepresentation
object
1 property
CompleteFormRepresentation
object
2 properties
OptionRepresentation
object
2 properties
LightUserRepresentation
object
6 properties
ObjectNode
FormJavascriptEventRepresentation
object
2 properties
AbstractRepresentation
TaskRepresentation
object
28 properties
TaskFilterRepresentation
object
9 properties
ResultListDataRepresentation
object
4 properties
TaskUpdateRepresentation
object
6 properties
CommentRepresentation
object
4 properties
FormTabRepresentation
object
3 properties
FormFieldRepresentation
object
30 properties
FormDefinitionRepresentation
object
19 properties
FormOutcomeRepresentation
object
2 properties
RelatedContentRepresentation
object
13 properties
ConditionRepresentation
object
8 properties
LayoutRepresentation
object
3 properties
FormValueRepresentation
object
2 properties
TaskFilterRequestRepresentation
object
5 properties
ChecklistOrderRepresentation
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activiti-task-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