OpenAPI Specification
openapi: 3.0.3
info:
title: Activiti Public Rest About Content 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: Content
description: Manage Contents
paths:
/api/enterprise/content:
post:
tags:
- Content
summary: createTemporaryRelatedContent
operationId: createTemporaryRelatedContentUsingPOST
requestBody:
description: relatedContent
content:
application/json:
schema:
$ref: '#/components/schemas/RelatedContentRepresentation'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RelatedContentRepresentation'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/content/raw:
post:
tags:
- Content
summary: createTemporaryRawRelatedContent
operationId: createTemporaryRawRelatedContentUsingPOST_1
parameters:
- name: file
in: formData
description: file
required: true
schema:
type: file
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RelatedContentRepresentation'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/content/{contentId}:
get:
tags:
- Content
summary: getContent
operationId: getContentUsingGET_1
parameters:
- name: contentId
in: path
description: contentId
required: true
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RelatedContentRepresentation'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
delete:
tags:
- Content
summary: deleteContent
operationId: deleteContentUsingDELETE_1
parameters:
- name: contentId
in: path
description: contentId
required: true
schema:
type: integer
format: int64
responses:
'200':
description: OK
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
/api/enterprise/content/{contentId}/raw:
get:
tags:
- Content
summary: getRawContent
operationId: getRawContentUsingGET_3
parameters:
- name: contentId
in: path
description: contentId
required: true
schema:
type: integer
format: int64
responses:
'200':
description: OK
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/process-instances/{processInstanceId}/content:
get:
tags:
- Content
summary: getRelatedContentForProcessInstance
operationId: getRelatedContentForProcessInstanceUsingGET
parameters:
- name: processInstanceId
in: path
description: processInstanceId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResultListDataRepresentation'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
post:
tags:
- Content
summary: createRelatedContentOnProcessInstance
operationId: createRelatedContentOnProcessInstanceUsingPOST
parameters:
- name: processInstanceId
in: path
description: processInstanceId
required: true
schema:
type: string
requestBody:
description: relatedContent
content:
application/json:
schema:
$ref: '#/components/schemas/RelatedContentRepresentation'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RelatedContentRepresentation'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/process-instances/{processInstanceId}/field-content:
get:
tags:
- Content
summary: Retrieve content attached to process instance fields
operationId: getProcessInstanceContentUsingGET
parameters:
- name: processInstanceId
in: path
description: processInstanceId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResultListDataRepresentation'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/process-instances/{processInstanceId}/raw-content:
post:
tags:
- Content
summary: createRelatedContentOnProcessInstance
operationId: createRelatedContentOnProcessInstanceUsingPOST_1
parameters:
- name: processInstanceId
in: path
description: processInstanceId
required: true
schema:
type: string
- name: file
in: formData
description: file
required: true
schema:
type: file
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RelatedContentRepresentation'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/tasks/{taskId}/content:
get:
tags:
- Content
summary: Retrieve which content is attached to a task
operationId: getRelatedContentForTaskUsingGET
parameters:
- name: taskId
in: path
description: taskId
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResultListDataRepresentation'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
post:
tags:
- Content
summary: To relate content (eg from Alfresco) to a task
operationId: createRelatedContentOnTaskUsingPOST
parameters:
- name: taskId
in: path
description: taskId
required: true
schema:
type: string
- name: isRelatedContent
in: query
description: isRelatedContent
required: false
schema:
type: boolean
requestBody:
description: relatedContent
content:
application/json:
schema:
$ref: '#/components/schemas/RelatedContentRepresentation'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RelatedContentRepresentation'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/tasks/{taskId}/raw-content:
post:
tags:
- Content
summary: Upload content to a task
operationId: createRelatedContentOnTaskUsingPOST_1
parameters:
- name: taskId
in: path
description: taskId
required: true
schema:
type: string
- name: file
in: formData
description: file
required: true
schema:
type: file
- name: isRelatedContent
in: query
description: isRelatedContent
required: false
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RelatedContentRepresentation'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
components:
schemas:
RelatedContentRepresentation:
properties:
contentAvailable:
type: boolean
created:
type: string
format: date-time
createdBy:
$ref: '#/components/schemas/LightUserRepresentation'
id:
type: integer
format: int64
link:
type: boolean
linkUrl:
type: string
mimeType:
type: string
name:
type: string
previewStatus:
type: string
simpleType:
type: string
source:
type: string
sourceId:
type: string
thumbnailStatus:
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
LightUserRepresentation:
properties:
email:
type: string
externalId:
type: string
firstName:
type: string
id:
type: integer
format: int64
lastName:
type: string
pictureId:
type: integer
format: int64
AbstractRepresentation: {}
securitySchemes:
basicAuth:
type: http
scheme: basic
description: HTTP Basic Authentication using valid Activiti user credentials