Moogsoft Workflows API

Workflows for processing and transformation

Operations 12

GET /v1/workflows/{id}/metrics/exceptions Returns the exceptions for the specified workflow #
PATCH /v1/workflows-bulk Modifies workflows #
PATCH /v1/workflows/{id} Modifies a workflow #
GET /v1/workflows/{id} Returns the workflow with the given ID #
DELETE /v1/workflows/{id} Deletes the workflow with the given ID #
PATCH /v1/workflows/{id}/status Modifies the status for a specific workflow #
GET /v1/workflows/{id}/status Returns the status for a specific workflow #
GET /v1/workflows/{id}/metrics Returns the metrics for the workflow with the given ID #
GET /v1/workflows/{id}/test Returns the result of the last async test run #
PATCH /v1/workflows-bulk/priority Modifies the priority for multiple workflows #
GET /v1/workflows Returns all workflows #
POST /v1/workflows Creates a new workflow #

Documentation

📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/4c987d4e03d42-alerts-incidents-api
📖
Documentation
https://docs.moogsoft.com/moogsoft-cloud/en/apis.html
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/07cc903e08dc7-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/98cab8f6ded6e-create-your-own-integration-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/b97257c4537e0-apex-ai-ops-incident-management-cloudwatch-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/16cc8392c9c10-collector-v2-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/a2faf5e9de2e7-config-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/872078c341608-events-integration
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/97383d5459cfb-on-call-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/7d9c8544a63bc-service-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/0f37a18e12cae-metrics-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/6295a1a5fa988-pager-duty-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/1328bccd943e6-probable-root-cause-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/8a70ecaa6cb8f-similar-incidents-service-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/02e00ab7d09f7-ui-services-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/af91225840fe8-user-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/22b7ec881443b-webhook-api
📖
APIReference
https://api.docs.moogsoft.com/docs/latest/branches/main/433fa2324eebd-workflow-engine-api

Specifications

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/moogsoft-workflows-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

moogsoft-workflows-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 1.3.0
  title: Workflow Engine Workflows API
  description: This API enables you to create and manage workflows
  termsOfService: https://www.moogsoft.com/legal-information/express-terms-conditions/
  contact:
    name: API Support
    url: https://docs.moogsoft.com/en/moogsoft-apis.html
    email: support@moogsoft.com
  license:
    url: https://www.moogsoft.com/legal-information
    name: Apex AIOps Incident Management Proprietary
servers:
- url: https://api.moogsoft.ai
- url: https://api.dev.moogsoft.cloud
security:
- ApiKeyAuth: []
tags:
- name: Workflows
  description: Workflows for processing and transformation
paths:
  /v1/workflows/{id}/metrics/exceptions:
    get:
      tags:
      - Workflows
      summary: Returns the exceptions for the specified workflow
      description: Returns the exceptions for the specified workflow.
      operationId: getWorkflowMetricsExceptions
      parameters:
      - name: id
        in: path
        description: ID of the workflow
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseWorkflowMetricsExceptionWrapperDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        description: Required user permissions for this endpoint
        value:
        - workflows:view
  /v1/workflows-bulk:
    patch:
      tags:
      - Workflows
      summary: Modifies workflows
      description: Modifies workflows.
      operationId: modifyWorkflows
      requestBody:
        description: Modified workflow definitions
        required: true
        content:
          application/json:
            schema:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/WorkflowUpdateWrapperDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfWorkflowDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        description: Required user permissions for this endpoint
        value:
        - workflows:edit
  /v1/workflows/{id}:
    patch:
      tags:
      - Workflows
      summary: Modifies a workflow
      description: Modifies a workflow.
      operationId: modifyWorkflow
      parameters:
      - name: id
        in: path
        description: ID of the workflow
        required: true
        schema:
          type: string
      requestBody:
        description: Modified workflow definition
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BaseWorkflowDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseWorkflowDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        description: Required user permissions for this endpoint
        value:
        - workflows:edit
    get:
      tags:
      - Workflows
      summary: Returns the workflow with the given ID
      description: Returns the workflow with the given ID.
      operationId: getWorkflow
      parameters:
      - name: validate
        in: query
        description: Indicates whether validation is to be performed on the workflow
        schema:
          type: boolean
          default: false
      - name: id
        in: path
        description: ID of the workflow
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseWorkflowDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        description: Required user permissions for this endpoint
        value:
        - workflows:view
    delete:
      tags:
      - Workflows
      summary: Deletes the workflow with the given ID
      description: Deletes the workflow with the given ID.
      operationId: deleteWorkflow
      parameters:
      - name: id
        in: path
        description: ID of the workflow
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        description: Required user permissions for this endpoint
        value:
        - workflows:edit
  /v1/workflows/{id}/status:
    patch:
      tags:
      - Workflows
      summary: Modifies the status for a specific workflow
      description: Modifies the status for a specific workflow.
      operationId: setWorkflowStatus
      parameters:
      - name: id
        in: path
        description: ID of the workflow
        required: true
        schema:
          type: string
      requestBody:
        description: The desired workflow status
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowStatusWrapperDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseWorkflowDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        description: Required user permissions for this endpoint
        value:
        - workflows:edit
    get:
      tags:
      - Workflows
      summary: Returns the status for a specific workflow
      description: Returns the status for a specific workflow.
      operationId: getWorkflowStatus
      parameters:
      - name: id
        in: path
        description: ID of the workflow
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseWorkflowStatusWrapperDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        description: Required user permissions for this endpoint
        value:
        - workflows:view
  /v1/workflows/{id}/metrics:
    get:
      tags:
      - Workflows
      summary: Returns the metrics for the workflow with the given ID
      description: Returns the metrics for the workflow with the given ID.
      operationId: getWorkflowMetrics
      parameters:
      - name: id
        in: path
        description: ID of the workflow
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseWorkflowMetricsDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        description: Required user permissions for this endpoint
        value:
        - workflows:view
  /v1/workflows/{id}/test:
    get:
      tags:
      - Workflows
      summary: Returns the result of the last async test run
      description: Returns the result of the last async test run.
      operationId: getWorkflowTest
      parameters:
      - name: id
        in: path
        description: ID of the workflow
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseWorkflowTestResultDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        description: Required user permissions for this endpoint
        value:
        - workflows:view
  /v1/workflows-bulk/priority:
    patch:
      tags:
      - Workflows
      summary: Modifies the priority for multiple workflows
      description: Modifies the priority for multiple workflows.
      operationId: setWorkflowPriorities
      requestBody:
        description: Modified workflow priorities
        required: true
        content:
          application/json:
            schema:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/WorkflowPriorityWrapperDto'
      responses:
        '204':
          description: No Content
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        description: Required user permissions for this endpoint
        value:
        - workflows:edit
  /v1/workflows:
    get:
      tags:
      - Workflows
      summary: Returns all workflows
      description: Returns all workflows.
      operationId: getWorkflows
      parameters:
      - name: status
        in: query
        description: Status filter for the returned workflows
        schema:
          $ref: '#/components/schemas/WorkflowStatus'
      - name: type
        in: query
        description: Workflow type filter for the returned workflows
        schema:
          allOf:
          - $ref: '#/components/schemas/WorkflowType'
          - default: EVENT
      - name: validate
        in: query
        description: Indicates whether validation is to be performed on the workflow
        schema:
          type: boolean
          default: false
      - name: workflowName
        in: query
        description: A string to match against workflow names.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseListOfWorkflowDto'
        '400':
          description: Invalid parameters or data validation violation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        description: Required user permissions for this endpoint
        value:
        - workflows:view
    post:
      tags:
      - Workflows
      summary: Creates a new workflow
      description: Creates a new workflow.
      operationId: createWorkflow
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowCreateWrapperDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogResponseWorkflowDto'
        '400':
          description: Bad Request
        '404':
          description: Requested object(s) not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        4XX:
          description: Authorization or other error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogFailureResponse'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoogErrorResponse'
      security:
      - ApiKeyAuth: []
      servers:
      - url: https://api.moogsoft.ai
      - url: https://api.dev.moogsoft.cloud
      x-permissions:
        description: Required user permissions for this endpoint
        value:
        - workflows:edit
components:
  schemas:
    WorkflowTriggerType:
      type: string
      enum:
      - EVENT_CREATED
      - ALERT_CREATED
      - ALERT_UPDATED
      - ALERT_DEDUPLICATED
      - INCIDENT_CREATED
      - INCIDENT_UPDATED
      - ALERT_CREATED_OR_UPDATED
      - ALERT_CREATED_OR_DEDUPLICATED
      - INCIDENT_CREATED_OR_UPDATED
      - ALERT_INVOKED
      - INCIDENT_INVOKED
      title: Workflow Trigger Type
    WorkflowType:
      type: string
      enum:
      - EVENT
      - ALERT
      - INCIDENT
      - ALERT_STANDALONE
      - INCIDENT_STANDALONE
      title: Workflow Type
    FilterTestDto:
      type: object
      title: Filter Test Dto
      description: Test results for a filter.
      properties:
        input:
          type: object
          description: Input for the filter
        startMillis:
          type: integer
          description: Start time in millis of the filter
          format: int64
        endMillis:
          type: integer
          description: End time in millis of the filter
          format: int64
        result:
          type: boolean
          description: Boolean result of running the filter
        exception:
          type: string
          description: Description of any exceptions that occurred
    ActionTestDto:
      type: object
      title: Action Test Dto
      description: Test results for an action.
      properties:
        actionName:
          type: string
          description: The computer name of the action
        input:
          type: object
          description: Input for the action
        output:
          type: object
          description: Output from the action
        startMillis:
          type: integer
          description: Start time in millis of the workflow action
          format: int64
        endMillis:
          type: integer
          description: End time in millis of the workflow action
          format: int64
        exception:
          type: string
          description: Description of any exceptions that occurred
        skipped:
          type: boolean
          description: Input was skipped by the workflow action
        discarded:
          type: boolean
          description: Input was discarded by the workflow action
        outputViolations:
          type: array
          description: Validation error messages generated while validating the action output
          items:
            type: string
    BaseWorkflowDto:
      type: object
      title: Base Workflow Dto
      description: Base workflow attributes.
      properties:
        name:
          type: string
          description: Name of the workflow. This name cannot be empty and must be unique.
        description:
          type: string
          description: Optional description of the workflow.
        trigger:
          $ref: '#/components/schemas/WorkflowTriggerDto'
          description: Trigger of the workflow.
        type:
          $ref: '#/components/schemas/WorkflowType'
          description: Type of the workflow.
        priority:
          type: integer
          description: The priority of the workflow.
          format: int32
        steps:
          type: array
          description: List of the configured workflow action(s).
          items:
            $ref: '#/components/schemas/WorkflowActionDto'
      required:
      - name
      - trigger
      - type
      - priority
      - steps
    MoogResponseWorkflowTestResultDto:
      type: object
      title: Moog Response Workflow Test Result Dto
      description: Workflow Engine API WorkflowTestResultDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
          - success
        data:
          $ref: '#/components/schemas/WorkflowTestResultDto'
      required:
      - status
      - data
    MoogFailureResponse:
      type: object
      description: Workflow Engine API failure response body
      properties:
        status:
          type: string
          description: Failure status indicator (always "failure")
          examples:
          - failure
        message:
          type: string
        additional:
          type: array
          items:
            type: string
      required:
      - status
      - message
    WorkflowPriorityWrapperDto:
      type: object
      title: Workflow Priority Wrapper Dto
      description: Workflow update workflow priority.
      properties:
        id:
          type: string
          description: ID of the workflow
        priority:
          type: integer
          description: The priority of the workflow.
          format: int32
      required:
      - id
      - priority
    WorkflowMetricsDto:
      type: object
      title: Workflow Metrics Dto
      description: Metrics about a running workflow.
      properties:
        processed:
          type: integer
          description: Number processed
          format: int64
        errors:
          type: integer
          description: Number processed with error
          format: int64
        skipped:
          type: integer
          description: Number of events ignored
          format: int64
        discarded:
          type: integer
          description: Number of events discarded
          format: int64
        filterMetrics:
          $ref: '#/components/schemas/FilterMetricsDto'
          description: The metrics for the workflow filter
        actionMetricsMap:
          type: object
          description: Map of the action name to action metrics
          additionalProperties:
            $ref: '#/components/schemas/ActionMetricsDto'
        highWatermarkProcessingDurationMillis:
          type: integer
          description: The highest watermark for processing duration (0 indicates less then 1ms)
          format: int64
        averageProcessingDurationMillis:
          type: integer
          description: The average processing duration (0 indicates less then 1ms)
          format: int64
        lowWatermarkProcessingDurationMillis:
          type: integer
          description: The lowest watermark for processing duration (0 indicates less then 1ms)
          format: int64
        lastException:
          type: string
          description: A description of the last exception that occurred any where in the workflow
        lastExceptionMillis:
          type: integer
          description: The time in millis when the exception occurred
          format: int64
        generalError:
          type: string
          description: A general error that occurred outside of the workflow
        generalErrorMillis:
          type: integer
          description: The time in millis when the general error occurred
          format: int64
    MoogResponseWorkflowMetricsDto:
      type: object
      title: Moog Response Workflow Metrics Dto
      description: Workflow Engine API WorkflowMetricsDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
          - success
        data:
          $ref: '#/components/schemas/WorkflowMetricsDto'
      required:
      - status
      - data
    WorkflowActionDto:
      type: object
      title: Workflow Action Dto
      description: A configured action.
      properties:
        actionName:
          type: string
          description: Computer name of the action
          minLength: 1
          maxLength: 127
        description:
          type: string
          description: Description of the configured action
        configuration:
          type: object
          description: Configuration for the action
        error:
          type: string
          description: Error message associated with the configured action
          readOnly: true
        valid:
          type: boolean
          description: Indicates if the workflow action is valid
          readOnly: true
      required:
      - actionName
      - configuration
    MoogResponseListOfWorkflowDto:
      type: object
      title: Moog Response List Of Workflow Dto
      description: Workflow Engine API WorkflowDto response body
      properties:
        status:
          type: string
          description: Success status indicator (always "success")
          examples:
          - success
        data:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowDto'
      required:
      - status
      - data
    WorkflowDto:
      type: object
      title: Workflow Dto
      description: Workflow with base and generated attributes.
      properties:
        name:
          type: string
          description: Name of the workflow. This name cannot be empty and must be unique.
        description:
          type: string
          description: Optional description of the workflow.
        trigger:
          $ref: '#/components/schemas/WorkflowTriggerDto'
          description: Trigger of the workflow.
        type:
          $ref: '#/components/schemas/WorkflowType'
          description: Type of the workflow.
        priority:
          type: integer
          description: The priority of the workflow.
          format: int32
        steps:
          type: array
          description: List of the configured workflow action(s).
          items:
            $ref: '#/components/schemas/WorkflowActionDto'
        id:
          type: string
          description: ID of the workflow
          readOnly: true
        createdBy:
          type: string
          description: Creator of the workflow
          readOnly: true
        lastUpdatedBy:
          type: string
          description: Creator of the workflow
          readOnly: true
        status:
          $ref: '#/components/schemas/WorkflowStatus'
          description: Status of the workflow
        metrics:
          $ref: '#/components/schemas/WorkflowMetricsDto'
          description: Metrics about the running workflow
        test:
          $ref: '#/components/schemas/WorkflowTestResultDto'
          description: The last asynchronous test results for the workflow
        lastUpdated:
          $ref: '#/components/schemas/Instant'
          description: The last updated time in milliseconds
        created:
          $ref: '#/components/schemas/Instant'
          description: The created time in milliseconds
        valid:
          type: boolean
          description: Indicates if the workflow-actions are valid
          readOnly: true
      required:
      - name
      - trigger
      - type
      - priority
      - steps
    ActionMetricsDto:
      type: object
      title: Action Metrics Dto
      description: Metrics about a running action.
      properties:
        actionName:
          type: string
          description: The computer name for the action
        processed:
          type: integer
          description: Number processed
          format: int64
        errors:
          type: integer
          description: Number processed with error
          format: int64
        highWatermarkProcessingDurationMillis:
          type: integer
          description: The highest watermark for processing duration (0 indicates less then 1ms)
          format: int64
        averageProcessingDurationMillis:
          type: integer
          description: The average processing duration (0 indicates less then 1ms)
          format: int64
        lowWatermarkProcessingDur

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/moogsoft/refs/heads/main/openapi/moogsoft-workflows-api-openapi.yml