Activiti Model Bpmn API

OpenAPI Specification

activiti-model-bpmn-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Activiti Public Rest About Model Bpmn 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: Model Bpmn
  description: ' '
paths:
  /api/enterprise/models/{processModelId}/bpmn20:
    get:
      tags:
      - Model Bpmn
      summary: Export a process definition model to a BPMN 2.0 xml file
      operationId: getProcessModelBpmn20XmlUsingGET
      parameters:
      - name: processModelId
        in: path
        description: processModelId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/models/{processModelId}/history/{processModelHistoryId}/bpmn20:
    get:
      tags:
      - Model Bpmn
      summary: Export a previous process definition model to a BPMN 2.0 xml file
      operationId: getHistoricProcessModelBpmn20XmlUsingGET
      parameters:
      - name: processModelId
        in: path
        description: processModelId
        required: true
        schema:
          type: integer
          format: int64
      - name: processModelHistoryId
        in: path
        description: processModelHistoryId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using valid Activiti user credentials