Activiti

Activiti Process API

The Process API from Activiti — 10 operation(s) for process.

GitHub OpenAPI
Business capability
Business Process Management BC-930

Operations 11

GET /api/enterprise/process-definitions Retrieve a list of process definitions #
GET /api/enterprise/process-definitions/{processDefinitionId}/start-form Retrieve the start form for a process definition #
GET /api/enterprise/process-definitions/{processDefinitionId}/start-form-values/{field} Retrieve field values (eg. the typeahead field) #
GET /api/enterprise/process-definitions/{processDefinitionId}/start-form-values/{field}/{column} Retrieve field values (eg. the table field) #
POST /api/enterprise/process-instances Start a process instance #
POST /api/enterprise/process-instances/filter Filter a list of process instances #
POST /api/enterprise/process-instances/query Retrieve a list of process instances #
GET /api/enterprise/process-instances/{processInstanceId} Retrieve a process instance information #
DELETE /api/enterprise/process-instances/{processInstanceId} Delete a process instance #
GET /api/enterprise/process-instances/{processInstanceId}/field-content Retrieve content attached to process instance fields #
GET /api/enterprise/process-instances/{processInstanceId}/start-form Get process start form #

Documentation

📖
Documentation
https://www.activiti.org/userguide/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/activiti/refs/heads/main/openapi/activiti-process-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/activiti-process-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

activiti-process-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Activiti Public Rest Process API
  description: The Alfresco Activiti BPM Suite comes with a REST API.
  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
paths:
  /api/enterprise/process-definitions:
    get:
      tags:
      - Process
      summary: Retrieve a list of process definitions
      description: Get a list of process definitions (visible within the tenant of the user)
      operationId: getProcessDefinitionsUsingGET
      parameters:
      - name: latest
        in: query
        description: latest
        required: false
        schema:
          type: boolean
      - name: appDefinitionId
        in: query
        description: appDefinitionId
        required: false
        schema:
          type: integer
          format: int64
      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-definitions/{processDefinitionId}/start-form:
    get:
      tags:
      - Process
      summary: Retrieve the start form for a process definition
      operationId: getProcessDefinitionStartFormUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormDefinitionRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/process-definitions/{processDefinitionId}/start-form-values/{field}:
    get:
      tags:
      - Process
      summary: Retrieve field values (eg. the typeahead field)
      operationId: getRestFieldValuesUsingGET
      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/process-definitions/{processDefinitionId}/start-form-values/{field}/{column}:
    get:
      tags:
      - Process
      summary: Retrieve field values (eg. the table field)
      operationId: getRestTableFieldValuesUsingGET
      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/process-instances:
    post:
      tags:
      - Process
      summary: Start a process instance
      operationId: startNewProcessInstanceUsingPOST
      requestBody:
        description: startRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProcessInstanceRepresentation'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessInstanceRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/process-instances/filter:
    post:
      tags:
      - Process
      summary: Filter a list of process instances
      operationId: filterProcessInstancesUsingPOST
      requestBody:
        description: filterRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessInstanceFilterRequestRepresentation'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/process-instances/query:
    post:
      tags:
      - Process
      summary: Retrieve a list of process instances
      operationId: getProcessInstancesUsingPOST
      requestBody:
        description: requestNode
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObjectNode'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/process-instances/{processInstanceId}:
    get:
      tags:
      - Process
      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
      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}/field-content:
    get:
      tags:
      - Process
      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}/start-form:
    get:
      tags:
      - Process
      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:
    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
    CreateProcessInstanceRepresentation:
      properties:
        name:
          type: string
        outcome:
          type: string
        processDefinitionId:
          type: string
        values:
          type: object
    FormOutcomeRepresentation:
      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'
    RestVariable:
      properties:
        name:
          type: string
        scope:
          type: string
        type:
          type: string
        value:
          type: object
        valueUrl:
          type: string
    OptionRepresentation:
      properties:
        id:
          type: string
        name:
          type: string
    FormValueRepresentation:
      properties:
        id:
          type: string
        name:
          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'
    ProcessInstanceFilterRepresentation:
      properties:
        asc:
          type: boolean
        name:
          type: string
        processDefinitionId:
          type: string
        processDefinitionKey:
          type: string
        sort:
          type: string
        state:
          type: string
    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'
    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
    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
    ProcessInstanceFilterRequestRepresentation:
      properties:
        appDefinitionId:
          type: integer
          format: int64
        filter:
          $ref: '#/components/schemas/ProcessInstanceFilterRepresentation'
        filterId:
          type: integer
          format: int64
        page:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
    LayoutRepresentation:
      properties:
        colspan:
          type: integer
          format: int32
        column:
          type: integer
          format: int32
        row:
          type: integer
          format: int32
    ObjectNode: {}
    AbstractRepresentation: {}
    FormJavascriptEventRepresentation:
      properties:
        event:
          type: string
        javascriptLogic:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using valid Activiti user credentials