Activiti Apps API

The Apps API from Activiti — 5 operation(s) for apps.

Operations 6

POST /api/enterprise/app-definitions/import Import App Definition #
GET /api/enterprise/app-definitions/{modelId}/export Export App Definition #
POST /api/enterprise/app-definitions/{modelId}/import Import App #
POST /api/enterprise/app-definitions/{modelId}/publish Publish App #
GET /api/enterprise/runtime-app-definitions List runtime apps #
POST /api/enterprise/runtime-app-definitions Deploy published app #

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-apps-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.

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

OpenAPI Specification

activiti-apps-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Activiti Public Rest Apps 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: Apps
paths:
  /api/enterprise/app-definitions/import:
    post:
      tags:
      - Apps
      summary: Import App Definition
      description: This is useful to bootstrap an environment (for users or continous integration).
      operationId: importAppDefinitionUsingPOST
      parameters:
      - name: file
        in: formData
        description: file
        required: true
        schema:
          type: file
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppDefinitionRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/app-definitions/{modelId}/export:
    get:
      tags:
      - Apps
      summary: Export App Definition
      description: This will return a zip file containing the app definition model and all related models (process definitions and forms).
      operationId: exportAppDefinitionUsingGET
      parameters:
      - name: modelId
        in: path
        description: modelId from a runtime app or the id of an app definition model
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/app-definitions/{modelId}/import:
    post:
      tags:
      - Apps
      summary: Import App
      description: To import an app to an existing app definition to create a new version instead of importing a new app definition.
      operationId: importAppDefinitionUsingPOST_1
      parameters:
      - name: modelId
        in: path
        description: modelId
        required: true
        schema:
          type: integer
          format: int64
      - name: file
        in: formData
        description: file
        required: true
        schema:
          type: file
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppDefinitionRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/app-definitions/{modelId}/publish:
    post:
      tags:
      - Apps
      summary: Publish App
      description: Before an app model can be used, it need to be published
      operationId: publishAppDefinitionUsingPOST
      parameters:
      - name: modelId
        in: path
        description: modelId
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: publishModel
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppDefinitionPublishRepresentation'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppDefinitionUpdateResultRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/runtime-app-definitions:
    get:
      tags:
      - Apps
      summary: List runtime apps
      description: When a user logs in into the Alfresco Activiti BPM Suite, the landing page is displayed containing all the apps that the user is allowed to see and use.
      operationId: getAppDefinitionsUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    post:
      tags:
      - Apps
      summary: Deploy published app
      description: After creating and puclished an app the user can add it to his/her landing page.
      operationId: deployAppDefinitionsUsingPOST
      requestBody:
        description: saveObject
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuntimeAppDefinitionSaveRepresentation'
        required: true
      responses:
        '200':
          description: OK
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
components:
  schemas:
    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
    AppDefinitionUpdateResultRepresentation:
      properties:
        appDefinition:
          $ref: '#/components/schemas/AppDefinitionRepresentation'
        customData:
          type: object
        error:
          type: boolean
        errorDescription:
          type: string
        errorType:
          type: integer
          format: int32
        message:
          type: string
        messageKey:
          type: string
    AbstractRepresentation: {}
    AppDefinitionPublishRepresentation:
      properties:
        comment:
          type: string
        force:
          type: boolean
    RuntimeAppDefinitionSaveRepresentation:
      properties:
        appDefinitions:
          type: array
          items:
            $ref: '#/components/schemas/AppDefinitionRepresentation'
    AppDefinitionRepresentation:
      properties:
        defaultAppId:
          type: string
        deploymentId:
          type: string
        description:
          type: string
        icon:
          type: string
        id:
          type: integer
          format: int64
        modelId:
          type: integer
          format: int64
        name:
          type: string
        tenantId:
          type: integer
          format: int64
        theme:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using valid Activiti user credentials