Activiti Models API

Api Model Resource

Business capability
Process Modeling and Documentation BC-930.20

Operations 13

GET /api/enterprise/models List models (process, form, decision rule or app) #
POST /api/enterprise/models To create a new model #
GET /api/enterprise/models-for-app-definition TODO #
GET /api/enterprise/models/{modelId} To retrieve details about a particular model (process, form, decision rule or… #
PUT /api/enterprise/models/{modelId} Edit a specific model #
DELETE /api/enterprise/models/{modelId} Delete a model #
POST /api/enterprise/models/{modelId}/clone To duplicate an existing model #
GET /api/enterprise/models/{modelId}/editor/json Get the JSON model #
POST /api/enterprise/models/{modelId}/editor/json Save the JSON model #
POST /api/enterprise/models/{modelId}/editor/validate Validate the JSON model #
POST /api/enterprise/models/{modelId}/newversion Create a new model version #
GET /api/enterprise/models/{modelId}/thumbnail Get Model thumbnail #
POST /api/enterprise/process-models/import To import a BPMN 2.0 xml file #

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-models-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-models-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Activiti Public Rest Models 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: Models
  description: Api Model Resource
paths:
  /api/enterprise/models:
    get:
      tags:
      - Models
      summary: List models (process, form, decision rule or app)
      operationId: getModelsUsingGET
      parameters:
      - name: filter
        in: query
        description: filter
        required: false
        schema:
          type: string
      - name: sort
        in: query
        description: sort
        required: false
        schema:
          type: string
      - name: modelType
        in: query
        description: modelType
        required: false
        schema:
          type: integer
          format: int32
      - name: referenceId
        in: query
        description: referenceId
        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
    post:
      tags:
      - Models
      summary: To create a new model
      operationId: createModelUsingPOST
      requestBody:
        description: modelRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelRepresentation'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/models-for-app-definition:
    get:
      tags:
      - Models
      summary: TODO
      operationId: getModelsToIncludeInAppDefinitionUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultListDataRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/models/{modelId}:
    get:
      tags:
      - Models
      summary: To retrieve details about a particular model (process, form, decision rule or…
      operationId: getModelUsingGET
      parameters:
      - name: modelId
        in: path
        description: modelId
        required: true
        schema:
          type: integer
          format: int64
      - name: includePermissions
        in: query
        description: includePermissions
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    put:
      tags:
      - Models
      summary: Edit a specific model
      operationId: updateModelUsingPUT
      parameters:
      - name: modelId
        in: path
        description: modelId
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: updatedModel
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelRepresentation'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    delete:
      tags:
      - Models
      summary: Delete a model
      operationId: deleteModelUsingDELETE
      parameters:
      - name: modelId
        in: path
        description: modelId
        required: true
        schema:
          type: integer
          format: int64
      - name: cascade
        in: query
        description: cascade
        required: false
        schema:
          type: boolean
      - name: deleteRuntimeApp
        in: query
        description: deleteRuntimeApp
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /api/enterprise/models/{modelId}/clone:
    post:
      tags:
      - Models
      summary: To duplicate an existing model
      operationId: duplicateModelUsingPOST
      parameters:
      - name: modelId
        in: path
        description: modelId
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: modelRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelRepresentation'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/models/{modelId}/editor/json:
    get:
      tags:
      - Models
      summary: Get the JSON model
      operationId: getModelJSONUsingGET
      parameters:
      - name: modelId
        in: path
        description: modelId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectNode'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    post:
      tags:
      - Models
      summary: Save the JSON model
      operationId: saveModelUsingPOST
      parameters:
      - name: modelId
        in: path
        description: modelId
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: values
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/List'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/models/{modelId}/editor/validate:
    post:
      tags:
      - Models
      summary: Validate the JSON model
      operationId: validateModelUsingPOST
      parameters:
      - name: modelId
        in: path
        description: modelId
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: values
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/List'
        required: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ValidationErrorRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/models/{modelId}/newversion:
    post:
      tags:
      - Models
      summary: Create a new model version
      operationId: importNewVersionUsingPOST
      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/ModelRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/models/{modelId}/thumbnail:
    get:
      tags:
      - Models
      summary: Get Model thumbnail
      operationId: getModelThumbnailUsingGET
      parameters:
      - name: modelId
        in: path
        description: modelId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                  format: byte
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/process-models/import:
    post:
      tags:
      - Models
      summary: To import a BPMN 2.0 xml file
      operationId: importProcessModelUsingPOST
      parameters:
      - name: file
        in: formData
        description: file
        required: true
        schema:
          type: file
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
components:
  schemas:
    ObjectNode: {}
    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
    ModelRepresentation:
      properties:
        comment:
          type: string
        createdBy:
          type: integer
          format: int64
        createdByFullName:
          type: string
        description:
          type: string
        favorite:
          type: boolean
        id:
          type: integer
          format: int64
        lastUpdated:
          type: string
          format: date-time
        lastUpdatedBy:
          type: integer
          format: int64
        lastUpdatedByFullName:
          type: string
        latestVersion:
          type: boolean
        modelType:
          type: integer
          format: int32
        name:
          type: string
        permission:
          type: string
        referenceId:
          type: integer
          format: int64
        stencilSet:
          type: integer
          format: int64
        version:
          type: integer
          format: int32
    ValidationErrorRepresentation:
      properties:
        defaultDescription:
          type: string
        id:
          type: string
        name:
          type: string
        problem:
          type: string
        problemReference:
          type: string
        validatorSetName:
          type: string
        warning:
          type: boolean
    AbstractRepresentation: {}
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using valid Activiti user credentials