OpenAPI Specification
openapi: 3.0.3
info:
title: Activiti Public Rest About Process Instances 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: Process Instances
description: Manage Process Instances
paths:
/api/enterprise/process-instances/{processInstanceId}:
get:
tags:
- Process Instances
summary: Retrieve a process instance information
operationId: getProcessInstanceUsingGET
parameters:
- name: processInstanceId
in: path
description: processInstanceId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessInstanceRepresentation'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
delete:
tags:
- Process Instances
summary: Delete a process instance
operationId: deleteProcessInstanceUsingDELETE
parameters:
- name: processInstanceId
in: path
description: processInstanceId
required: true
schema:
type: string
responses:
'200':
description: OK
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
/api/enterprise/process-instances/{processInstanceId}/comments:
get:
tags:
- Process Instances
summary: Comment list added to Process
operationId: getProcessInstanceCommentsUsingGET
parameters:
- name: processInstanceId
in: path
description: processInstanceId
required: true
schema:
type: string
- name: latestFirst
in: query
description: latestFirst
required: false
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResultListDataRepresentation'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
post:
tags:
- Process Instances
summary: Add a comment to a Process
operationId: addProcessInstanceCommentUsingPOST
parameters:
- name: processInstanceId
in: path
description: processInstanceId
required: true
schema:
type: string
requestBody:
description: commentRequest
content:
application/json:
schema:
$ref: '#/components/schemas/CommentRepresentation'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CommentRepresentation'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/process-instances/{processInstanceId}/start-form:
get:
tags:
- Process Instances
summary: Get process start form
description: When a process definitions has a start form (hasStartForm is true in the call above), the start form can be retrieved
operationId: getProcessInstanceStartFormUsingGET
parameters:
- name: processInstanceId
in: path
description: processInstanceId
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
components:
schemas:
FormJavascriptEventRepresentation:
properties:
event:
type: string
javascriptLogic:
type: string
ResultListDataRepresentation:
properties:
data:
type: array
items:
$ref: '#/components/schemas/AbstractRepresentation'
size:
type: integer
format: int32
start:
type: integer
format: int32
total:
type: integer
format: int32
AbstractRepresentation: {}
FormOutcomeRepresentation:
properties:
id:
type: string
name:
type: string
RestVariable:
properties:
name:
type: string
scope:
type: string
type:
type: string
value:
type: object
valueUrl:
type: string
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
CommentRepresentation:
properties:
created:
type: string
format: date-time
createdBy:
$ref: '#/components/schemas/LightUserRepresentation'
id:
type: integer
format: int64
message:
type: string
LightUserRepresentation:
properties:
email:
type: string
externalId:
type: string
firstName:
type: string
id:
type: integer
format: int64
lastName:
type: string
pictureId:
type: integer
format: int64
FormTabRepresentation:
properties:
id:
type: string
title:
type: string
visibilityCondition:
$ref: '#/components/schemas/ConditionRepresentation'
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'
ProcessInstanceRepresentation:
properties:
businessKey:
type: string
ended:
type: string
format: date-time
graphicalNotationDefined:
type: boolean
id:
type: string
name:
type: string
processDefinitionCategory:
type: string
processDefinitionDeploymentId:
type: string
processDefinitionDescription:
type: string
processDefinitionId:
type: string
processDefinitionKey:
type: string
processDefinitionName:
type: string
processDefinitionVersion:
type: integer
format: int32
startFormDefined:
type: boolean
started:
type: string
format: date-time
startedBy:
$ref: '#/components/schemas/LightUserRepresentation'
tenantId:
type: string
variables:
type: array
items:
$ref: '#/components/schemas/RestVariable'
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