openapi: 3.2.0
info:
  title: Mapp Engage public Process API
  version: '1'
  description: 'Mapp Engage REST API (REST 2.0, incremental version v19). Assembled verbatim from the per-operation OpenAPI fragments Mapp publishes on each endpoint page of https://docs.mapp.com/apidocs/. The base URL is tenant-specific: take your Mapp Engage login host and append /api/rest/v19.'
  contact:
    name: Mapp Technical Support
    url: https://mapp.com/tech-support/
servers:
- url: /api/rest/v19
security:
- basicAuth: []
tags:
- name: Process
paths:
  /process/applyAction:
    post:
      tags:
      - Process
      summary: Apply an action to a process
      description: Changes the status of an existing process.
      operationId: applyAction
      parameters:
      - name: processId
        in: query
        description: Process identifier
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
                enum:
                - FAILED
                - FINISHED
                - PAUSED
                - PROCESSING
            application/xml:
              schema:
                type: string
                enum:
                - FAILED
                - FINISHED
                - PAUSED
                - PROCESSING
        '400':
          description: ''
      requestBody:
        content:
          application/json:
            schema:
              type: string
  /process/getDetails:
    get:
      tags:
      - Process
      summary: Get process details
      description: Returns information for the process identified by the specified process ID.
      operationId: getProcessDetails
      parameters:
      - name: processId
        in: query
        description: Process identifier
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/ProcessDetails'
        '400':
          description: ''
  /process/getProcessList:
    get:
      tags:
      - Process
      summary: List processes
      description: Returns a paginated list of processes, optionally filtered by status. Results are ordered by start date descending. Use 'limit' and 'offset' to page through results.
      operationId: getProcessList
      parameters:
      - name: status
        in: query
        description: 'Optional status filter: PROCESSING, PAUSED, FINISHED, or FAILED'
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of processes to return. Default 500, max 500.
        required: false
        schema:
          type: integer
          format: int64
      - name: offset
        in: query
        description: Number of processes to skip. Default 0.
        required: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
            application/xml:
              schema:
                type: array
                items:
                  type: object
        '400':
          description: ''
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with a Mapp Engage system user of type API (or Hybrid).
x-apievangelist-provenance:
  method: searched
  generated: '2026-08-12'
  source: https://docs.mapp.com/apidocs/ (per-endpoint OpenAPI fragments)
  note: Union of the OpenAPI JSON fragments Mapp publishes on each endpoint page. Mapp does not serve one consolidated document at a public URL; the tenant-served Swagger lives at https://<your-engage-host>/apidoc/swagger.json and requires a tenant. Operation bodies, parameters, responses, tags, summaries and descriptions are verbatim from Mapp. The swagger/basePath/schemes/securityDefinitions envelope is added by API Evangelist from the published Getting Started guide; no operation content was authored.
  duplicate_operation_ids_suffixed: 30