Adaptris

Adaptris /workflow/metrics API

The /workflow/metrics API from Adaptris — 10 operation(s) for /workflow/metrics.

Documentation GitHub OpenAPI

Operations 14

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics-ids Message metadata statistics ids #

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics-ids Message metrics statistics ids #

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id} Get message metrics statistics 9 #

DELETE /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id} Clear message metrics statistics #

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id} Get metadata statistics #

DELETE /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id} Clear metadata statistics #

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics Get message metrics statistics 8 #

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics-ids Message metadata statistics ids 1 #

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics-ids Message metrics statistics ids 1 #

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id} Get message metrics statistics 11 #

DELETE /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id} Clear message metrics statistics 1 #

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id} Get metadata statistics 1 #

DELETE /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id} Clear metadata statistics 1 #

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics Get message metrics statistics 10 #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/adaptris/refs/heads/main/openapi/adaptris-workflow-metrics-api-openapi.yml

Schemas & Data

📊

JSONSchema

https://raw.githubusercontent.com/api-evangelist/adaptris/refs/heads/main/json-schema/adaptris-adapter-jmx-interlok-details-schema.json

📊

JSONSchema

https://raw.githubusercontent.com/api-evangelist/adaptris/refs/heads/main/json-schema/adaptris-component-check-wrapper-schema.json

📊

JSONSchema

https://raw.githubusercontent.com/api-evangelist/adaptris/refs/heads/main/json-schema/adaptris-state-wrapper-schema.json

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/adaptris:adaptris-workflow-metrics-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Interlok UI Api Documentation /workflow/metrics API
  description: Interlok UI Api web service documentation.
  version: 3.10.2-RELEASE
servers:
- url: /interlok/api
tags:
- name: /workflow/metrics
paths:
  /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics-ids:
    get:
      tags:
      - /workflow/metrics
      description: Get all the metadata statistics ids for a workflow
      operationId: messageMetadataStatisticsIds
      parameters:
      - name: adapter
        in: path
        description: The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
            application/xml:
              schema:
                type: array
                items:
                  type: string
      summary: Message metadata statistics ids
      x-summary-source: derived
  /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics-ids:
    get:
      tags:
      - /workflow/metrics
      description: Get all the message metrics statistics ids for a workflow
      operationId: messageMetricsStatisticsIds
      parameters:
      - name: adapter
        in: path
        description: The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
            application/xml:
              schema:
                type: array
                items:
                  type: string
      summary: Message metrics statistics ids
      x-summary-source: derived
  /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id}:
    get:
      tags:
      - /workflow/metrics
      description: Get a workflow message metrics statistics for the given id
      operationId: getMessageMetricsStatistics_9
      parameters:
      - name: adapter
        in: path
        description: The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
            text/plain:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
            text/csv:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
      summary: Get message metrics statistics 9
      x-summary-source: derived
    delete:
      tags:
      - /workflow/metrics
      description: Delete the workflow message metrics statistics for the given id
      operationId: clearMessageMetricsStatistics
      parameters:
      - name: adapter
        in: path
        description: The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
            application/xml:
              schema:
                $ref: '#/components/schemas/Result'
      summary: Clear message metrics statistics
      x-summary-source: derived
  /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id}:
    get:
      tags:
      - /workflow/metrics
      description: Get a workflow matadata statistics for the given id
      operationId: getMetadataStatistics
      parameters:
      - name: adapter
        in: path
        description: The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataStatisticsEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/MetadataStatisticsEntity'
            text/plain:
              schema:
                $ref: '#/components/schemas/MetadataStatisticsEntity'
            text/csv:
              schema:
                $ref: '#/components/schemas/MetadataStatisticsEntity'
      summary: Get metadata statistics
      x-summary-source: derived
    delete:
      tags:
      - /workflow/metrics
      description: Delete the workflow matadata statistics for the given id
      operationId: clearMetadataStatistics
      parameters:
      - name: adapter
        in: path
        description: The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
            application/xml:
              schema:
                $ref: '#/components/schemas/Result'
      summary: Clear metadata statistics
      x-summary-source: derived
  /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics:
    get:
      tags:
      - /workflow/metrics
      description: Get a workflow message metrics statistics. The first found will be returned
      operationId: getMessageMetricsStatistics_8
      parameters:
      - name: adapter
        in: path
        description: The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
            text/plain:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
            text/csv:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
      summary: Get message metrics statistics 8
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics-ids:
    get:
      tags:
      - /workflow/metrics
      description: Get all the metadata statistics ids for a workflow
      operationId: messageMetadataStatisticsIds_1
      parameters:
      - name: url
        in: path
        description: The JMX URL used to connect to an Adapter.
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        description: The unique identifier used in the Adapter configuration XML.
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        description: The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.
        schema:
          type: string
      - name: jmxEnv
        in: query
        description: The JMX environment parameters used to connect to an Adapter.
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
            application/xml:
              schema:
                type: array
                items:
                  type: string
      summary: Message metadata statistics ids 1
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics-ids:
    get:
      tags:
      - /workflow/metrics
      description: Get all the message metrics statistics ids for a workflow
      operationId: messageMetricsStatisticsIds_1
      parameters:
      - name: url
        in: path
        description: The JMX URL used to connect to an Adapter.
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        description: The unique identifier used in the Adapter configuration XML.
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        description: The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.
        schema:
          type: string
      - name: jmxEnv
        in: query
        description: The JMX environment parameters used to connect to an Adapter.
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
            application/xml:
              schema:
                type: array
                items:
                  type: string
      summary: Message metrics statistics ids 1
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id}:
    get:
      tags:
      - /workflow/metrics
      description: Get a workflow message metrics statistics for the given id
      operationId: getMessageMetricsStatistics_11
      parameters:
      - name: url
        in: path
        description: The JMX URL used to connect to an Adapter.
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        description: The unique identifier used in the Adapter configuration XML.
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        description: The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.
        schema:
          type: string
      - name: jmxEnv
        in: query
        description: The JMX environment parameters used to connect to an Adapter.
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
            text/plain:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
            text/csv:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
      summary: Get message metrics statistics 11
      x-summary-source: derived
    delete:
      tags:
      - /workflow/metrics
      description: Delete the workflow message metrics statistics for the given id
      operationId: clearMessageMetricsStatistics_1
      parameters:
      - name: url
        in: path
        description: The JMX URL used to connect to an Adapter.
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        description: The unique identifier used in the Adapter configuration XML.
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        description: The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.
        schema:
          type: string
      - name: jmxEnv
        in: query
        description: The JMX environment parameters used to connect to an Adapter.
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
            application/xml:
              schema:
                $ref: '#/components/schemas/Result'
      summary: Clear message metrics statistics 1
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id}:
    get:
      tags:
      - /workflow/metrics
      description: Get a workflow matadata statistics for the given id
      operationId: getMetadataStatistics_1
      parameters:
      - name: url
        in: path
        description: The JMX URL used to connect to an Adapter.
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        description: The unique identifier used in the Adapter configuration XML.
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        description: The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.
        schema:
          type: string
      - name: jmxEnv
        in: query
        description: The JMX environment parameters used to connect to an Adapter.
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataStatisticsEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/MetadataStatisticsEntity'
            text/plain:
              schema:
                $ref: '#/components/schemas/MetadataStatisticsEntity'
            text/csv:
              schema:
                $ref: '#/components/schemas/MetadataStatisticsEntity'
      summary: Get metadata statistics 1
      x-summary-source: derived
    delete:
      tags:
      - /workflow/metrics
      description: Delete the workflow matadata statistics for the given id
      operationId: clearMetadataStatistics_1
      parameters:
      - name: url
        in: path
        description: The JMX URL used to connect to an Adapter.
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        description: The unique identifier used in the Adapter configuration XML.
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        description: The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.
        schema:
          type: string
      - name: jmxEnv
        in: query
        description: The JMX environment parameters used to connect to an Adapter.
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
            application/xml:
              schema:
                $ref: '#/components/schemas/Result'
      summary: Clear metadata statistics 1
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics:
    get:
      tags:
      - /workflow/metrics
      description: Get a workflow message metrics statistics. The first found will be returned
      operationId: getMessageMetricsStatistics_10
      parameters:
      - name: url
        in: path
        description: The JMX URL used to connect to an Adapter.
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        description: The unique identifier used in the Adapter configuration XML.
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        description: The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.
        schema:
          type: string
      - name: jmxEnv
        in: query
        description: The JMX environment parameters used to connect to an Adapter.
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      - name: workflow
        in: path
        description: The workflow unique id.
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
            text/plain:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
            text/csv:
              schema:
                $ref: '#/components/schemas/MessageMetricsStatisticsEntity'
      summary: Get message metrics statistics 10
      x-summary-source: derived
components:
  schemas:
    Result:
      type: object
      properties:
        id:
          type: string
        value:
          type: boolean
        message:
          type: string
        state:
          type: string
        stackTrace:
          type: string
    MessageMetricsStatisticsEntity:
      type: object
      properties:
        id:
          type: string
        endMillisForTimeSliceIndex:
          type: array
          items:
            type: integer
            format: int64
        timeSliceDurationSeconds:
          type: integer
          format: int32
        parentChannelName:
          type: string
        parentWorkflowName:
          type: string
        numberOfMessagesForTimeSliceIndex:
          type: array
          items:
            type: integer
            format: int32
        numberOfErrorMessagesForTimeSliceIndex:
          type: array
          items:
            type: integer
            format: int32
        totalSizeOfMessagesForTimeSliceIndex:
          type: array
          items:
            type: integer
            format: int64
        totalStringStats:
          type: string
        numberOfTimeSlices:
          type: integer
          format: int32
    MetadataStatisticsEntity:
      type: object
      properties:
        id:
          type: string
        endMillisForTimeSliceIndex:
          type: array
          items:
            type: integer
            format: int64
        timeSliceDurationSeconds:
          type: integer
          format: int32
        parentChannelName:
          type: string
        parentWorkflowName:
          type: string
        metadataKeys:
          uniqueItems: true
          type: array
          items:
            type: string
        totalCountForTimeSliceIndex:
          type: array
          items:
            type: object
            additionalProperties:
              type: integer
              format: int32
        numberOfTimeSlices:
          type: integer
          format: int32