OpenAPI Specification
openapi: 3.0.3
info:
title: Activiti Public Rest About Task Forms API
description: " The Alfresco Activiti BPM Suite comes with a REST API. It includes both an Enterprise equivalent of the Activiti Open Source REST API exposing the generic Activiti Engine operations, and a dedicated set op REST API endpoints specific for the functionality in the Alfresco Activiti BPM Suite. \n Note that there is also an 'internal' REST API, which are the REST endpoints used by the Javascript UI. It is advised not to use this API, these REST API urls and way of using it will change and evolve with the product and are unsupported. The supported API is stable. Also, the internal REST API uses a different authentication mechanism tailored towards web browser usage.\n"
version: 1.4.0
contact:
name: Activiti Community
url: https://www.activiti.org/
email: activiti-community@alfresco.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{host}/activiti-app
description: Activiti BPM Server
variables:
host:
default: localhost:8080
description: The Activiti server host
security:
- basicAuth: []
tags:
- name: Task Forms
description: Manage Task Forms
paths:
/api/enterprise/task-forms/{taskId}:
get:
tags:
- Task Forms
summary: Retrieve Task Form
operationId: getTaskFormUsingGET
parameters:
- name: taskId
in: path
description: taskId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/FormDefinitionRepresentation'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
post:
tags:
- Task Forms
summary: Complete a Task Form
operationId: completeTaskFormUsingPOST
parameters:
- name: taskId
in: path
description: taskId
required: true
schema:
type: string
requestBody:
description: completeTaskFormRepresentation
content:
application/json:
schema:
$ref: '#/components/schemas/CompleteFormRepresentation'
required: true
responses:
'200':
description: OK
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/task-forms/{taskId}/form-values/{field}:
get:
tags:
- Task Forms
summary: Retrieve Populated Field Values
description: Form field values that are populated through a REST backend, can be retrieved via this service
operationId: getRestFieldValuesUsingGET_2
parameters:
- name: taskId
in: path
description: taskId
required: true
schema:
type: string
- name: field
in: path
description: field
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FormValueRepresentation'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/task-forms/{taskId}/form-values/{field}/{column}:
get:
tags:
- Task Forms
summary: Retrieve Column Field Values
description: Specific case to retrieve information on a specific column
operationId: getRestFieldValuesUsingGET_1
parameters:
- name: taskId
in: path
description: taskId
required: true
schema:
type: string
- name: field
in: path
description: field
required: true
schema:
type: string
- name: column
in: path
description: column
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FormValueRepresentation'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/task-forms/{taskId}/save-form:
post:
tags:
- Task Forms
summary: Save Task Form
operationId: saveTaskFormUsingPOST
parameters:
- name: taskId
in: path
description: taskId
required: true
schema:
type: string
requestBody:
description: saveTaskFormRepresentation
content:
application/json:
schema:
$ref: '#/components/schemas/SaveFormRepresentation'
required: true
responses:
'200':
description: OK
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
components:
schemas:
FormJavascriptEventRepresentation:
properties:
event:
type: string
javascriptLogic:
type: string
SaveFormRepresentation:
properties:
values:
type: object
FormOutcomeRepresentation:
properties:
id:
type: string
name:
type: string
CompleteFormRepresentation:
properties:
outcome:
type: string
values:
type: object
ConditionRepresentation:
properties:
leftFormFieldId:
type: string
leftRestResponseId:
type: string
nextConditionOperator:
type: string
operator:
type: string
rightFormFieldId:
type: string
rightRestResponseId:
type: string
rightType:
type: string
rightValue:
type: object
OptionRepresentation:
properties:
id:
type: string
name:
type: string
LayoutRepresentation:
properties:
colspan:
type: integer
format: int32
column:
type: integer
format: int32
row:
type: integer
format: int32
FormTabRepresentation:
properties:
id:
type: string
title:
type: string
visibilityCondition:
$ref: '#/components/schemas/ConditionRepresentation'
FormValueRepresentation:
properties:
id:
type: string
name:
type: string
FormFieldRepresentation:
properties:
className:
type: string
col:
type: integer
format: int32
colspan:
type: integer
format: int32
hasEmptyValue:
type: boolean
id:
type: string
layout:
$ref: '#/components/schemas/LayoutRepresentation'
maxLength:
type: integer
format: int32
maxValue:
type: string
minLength:
type: integer
format: int32
minValue:
type: string
name:
type: string
optionType:
type: string
options:
type: array
items:
$ref: '#/components/schemas/OptionRepresentation'
overrideId:
type: boolean
params:
type: object
placeholder:
type: string
readOnly:
type: boolean
regexPattern:
type: string
required:
type: boolean
restIdProperty:
type: string
restLabelProperty:
type: string
restResponsePath:
type: string
restUrl:
type: string
row:
type: integer
format: int32
sizeX:
type: integer
format: int32
sizeY:
type: integer
format: int32
tab:
type: string
type:
type: string
value:
type: object
visibilityCondition:
$ref: '#/components/schemas/ConditionRepresentation'
FormDefinitionRepresentation:
properties:
className:
type: string
customFieldTemplates:
type: object
additionalProperties:
type: string
fields:
type: array
items:
$ref: '#/components/schemas/FormFieldRepresentation'
gridsterForm:
type: boolean
id:
type: integer
format: int64
javascriptEvents:
type: array
items:
$ref: '#/components/schemas/FormJavascriptEventRepresentation'
metadata:
type: object
additionalProperties:
type: string
name:
type: string
outcomeTarget:
type: string
outcomes:
type: array
items:
$ref: '#/components/schemas/FormOutcomeRepresentation'
processDefinitionId:
type: string
processDefinitionKey:
type: string
processDefinitionName:
type: string
selectedOutcome:
type: string
style:
type: string
tabs:
type: array
items:
$ref: '#/components/schemas/FormTabRepresentation'
taskDefinitionKey:
type: string
taskId:
type: string
taskName:
type: string
securitySchemes:
basicAuth:
type: http
scheme: basic
description: HTTP Basic Authentication using valid Activiti user credentials