OpenAPI Specification
openapi: 3.0.3
info:
title: Activiti Public Rest About Temporary 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: Temporary
description: Api Example Form Option Resource
paths:
/api/enterprise/temporary/example-headers:
get:
tags:
- Temporary
summary: getHeaders
operationId: getHeadersUsingGET
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayNode'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/temporary/example-options:
get:
tags:
- Temporary
summary: getOptions
operationId: getOptionsUsingGET
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayNode'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/temporary/generate-report-data/complete-tasks:
get:
tags:
- Temporary
summary: completeTasks
operationId: completeTasksUsingGET
parameters:
- name: userId
in: query
description: userId
required: true
schema:
type: integer
format: int64
- name: processDefinitionKey
in: query
description: processDefinitionKey
required: true
schema:
type: string
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/temporary/generate-report-data/start-process:
get:
tags:
- Temporary
summary: generateData
operationId: generateDataUsingGET
parameters:
- name: userId
in: query
description: userId
required: true
schema:
type: integer
format: int64
- name: processDefinitionKey
in: query
description: processDefinitionKey
required: true
schema:
type: string
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
components:
schemas:
ArrayNode:
properties:
array:
type: boolean
bigDecimal:
type: boolean
bigInteger:
type: boolean
binary:
type: boolean
boolean:
type: boolean
containerNode:
type: boolean
double:
type: boolean
float:
type: boolean
floatingPointNumber:
type: boolean
int:
type: boolean
integralNumber:
type: boolean
long:
type: boolean
missingNode:
type: boolean
nodeType:
type: string
enum:
- ARRAY
- BINARY
- BOOLEAN
- MISSING
- 'NULL'
- NUMBER
- OBJECT
- POJO
- STRING
'null':
type: boolean
number:
type: boolean
object:
type: boolean
pojo:
type: boolean
short:
type: boolean
textual:
type: boolean
valueNode:
type: boolean
securitySchemes:
basicAuth:
type: http
scheme: basic
description: HTTP Basic Authentication using valid Activiti user credentials