openapi: 3.0.3
info:
  title: Activiti Public Rest About Models History 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: Models History
  description: Model Version history
paths:
  /api/enterprise/models/{modelId}/history:
    get:
      tags:
      - Models History
      summary: To get the version information for a model
      operationId: getModelHistoryCollectionUsingGET
      parameters:
      - name: modelId
        in: path
        description: modelId
        required: true
        schema:
          type: integer
          format: int64
      - name: includeLatestVersion
        in: query
        description: includeLatestVersion
        required: false
        schema:
          type: boolean
      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}/history/{modelHistoryId}:
    get:
      tags:
      - Models History
      summary: To get a particular older version of a model
      operationId: getProcessModelHistoryUsingGET
      parameters:
      - name: modelId
        in: path
        description: modelId
        required: true
        schema:
          type: integer
          format: int64
      - name: modelHistoryId
        in: path
        description: modelHistoryId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
components:
  schemas:
    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
    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
    AbstractRepresentation: {}
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using valid Activiti user credentials