Adaptris

Adaptris /workflow API

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

GitHub OpenAPI

Operations 14

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow} Get 4 #
GET /external/adapter/{adapter}/channel/{channel}/workflow/count Count 2 #
GET /external/adapter/{adapter}/channel/{channel}/workflow List 3 #
GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/state Get state 4 #
PUT /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/state Update state 4 #
GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/configuration Configuration 4 #
GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/details Details 4 #
GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow} Get 5 #
GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/count Count 3 #
GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow List 4 #
GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/state Get state 5 #
PUT /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/state Update state 5 #
GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/configuration Configuration 5 #
GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/details Details 5 #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/adaptris/refs/heads/main/openapi/adaptris-workflow-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-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

adaptris-workflow-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Interlok UI Api Documentation /workflow API
  description: Interlok UI Api web service documentation.
  version: 3.10.2-RELEASE
servers:
- url: /interlok/api
tags:
- name: /workflow
paths:
  /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}:
    get:
      tags:
      - /workflow
      description: Gets a workflow for a channel
      operationId: get_4
      parameters:
      - name: adapter
        in: path
        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/WorkflowEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/WorkflowEntity'
      summary: Get 4
      x-summary-source: derived
  /external/adapter/{adapter}/channel/{channel}/workflow/count:
    get:
      tags:
      - /workflow
      description: Counts workflows for a channel
      operationId: count_2
      parameters:
      - name: adapter
        in: path
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Count'
            application/xml:
              schema:
                $ref: '#/components/schemas/Count'
      summary: Count 2
      x-summary-source: derived
  /external/adapter/{adapter}/channel/{channel}/workflow:
    get:
      tags:
      - /workflow
      description: Lists workflows for a channel
      operationId: list_3
      parameters:
      - name: adapter
        in: path
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
          default: none
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkflowEntity'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkflowEntity'
      summary: List 3
      x-summary-source: derived
  /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/state:
    get:
      tags:
      - /workflow
      description: Get a workflow's state
      operationId: getState_4
      parameters:
      - name: adapter
        in: path
        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/StateWrapper'
            application/xml:
              schema:
                $ref: '#/components/schemas/StateWrapper'
      summary: Get state 4
      x-summary-source: derived
    put:
      tags:
      - /workflow
      description: Update a workflow's state
      operationId: updateState_4
      parameters:
      - name: adapter
        in: path
        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: adpMgmtTimeout
        in: query
        description: adpMgmtTimeout
        schema:
          type: string
      - name: option
        in: query
        schema:
          type: string
          enum:
          - FORCE_CLOSE
          - FORCE_CLOSE_IF_FAIL
          - RESTART
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StateWrapper'
          application/xml:
            schema:
              $ref: '#/components/schemas/StateWrapper'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
            application/xml:
              schema:
                $ref: '#/components/schemas/Result'
      summary: Update state 4
      x-summary-source: derived
  /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/configuration:
    get:
      tags:
      - /workflow
      description: Get a workflow's configuration
      operationId: configuration_4
      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: object
                additionalProperties:
                  type: object
      summary: Configuration 4
      x-summary-source: derived
  /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/details:
    get:
      tags:
      - /workflow
      description: Get details for a workflow
      operationId: details_4
      parameters:
      - name: adapter
        in: path
        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/ComponentDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/ComponentDetails'
      summary: Details 4
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}:
    get:
      tags:
      - /workflow
      description: Gets a workflow for a channel
      operationId: get_5
      parameters:
      - name: url
        in: path
        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/WorkflowEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/WorkflowEntity'
      summary: Get 5
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/count:
    get:
      tags:
      - /workflow
      description: Counts workflows for a channel
      operationId: count_3
      parameters:
      - name: url
        in: path
        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
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Count'
            application/xml:
              schema:
                $ref: '#/components/schemas/Count'
      summary: Count 3
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow:
    get:
      tags:
      - /workflow
      description: Lists workflows for a channel
      operationId: list_4
      parameters:
      - name: url
        in: path
        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
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkflowEntity'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WorkflowEntity'
      summary: List 4
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/state:
    get:
      tags:
      - /workflow
      description: Get a workflow's state
      operationId: getState_5
      parameters:
      - name: url
        in: path
        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/StateWrapper'
            application/xml:
              schema:
                $ref: '#/components/schemas/StateWrapper'
      summary: Get state 5
      x-summary-source: derived
    put:
      tags:
      - /workflow
      description: Update a workflow's state
      operationId: updateState_5
      parameters:
      - name: url
        in: path
        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: adpMgmtTimeout
        in: query
        description: adpMgmtTimeout
        schema:
          type: string
      - name: option
        in: query
        schema:
          type: string
          enum:
          - FORCE_CLOSE
          - FORCE_CLOSE_IF_FAIL
          - RESTART
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StateWrapper'
          application/xml:
            schema:
              $ref: '#/components/schemas/StateWrapper'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
            application/xml:
              schema:
                $ref: '#/components/schemas/Result'
      summary: Update state 5
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/configuration:
    get:
      tags:
      - /workflow
      description: Get a workflow's configuration
      operationId: configuration_5
      parameters:
      - name: url
        in: path
        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: object
                additionalProperties:
                  type: object
      summary: Configuration 5
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/details:
    get:
      tags:
      - /workflow
      description: Get details for a workflow
      operationId: details_5
      parameters:
      - name: url
        in: path
        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/ComponentDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/ComponentDetails'
      summary: Details 5
      x-summary-source: derived
components:
  schemas:
    WorkflowEntity:
      type: object
      properties:
        name:
          type: string
        lifeCycleActionsDisabled:
          type: boolean
        state:
          type: string
          enum:
          - CLOSED
          - INITIALISED
          - STARTED
          - STOPPED
          - DISCONNECTED
        type:
          type: string
        id:
          type: string
      xml:
        name: workflow
    Count:
      type: object
      properties:
        value:
          type: integer
          format: int32
    StateWrapper:
      type: object
      properties:
        id:
          type: string
        state:
          type: string
          enum:
          - CLOSED
          - INITIALISED
          - STARTED
          - STOPPED
          - DISCONNECTED
      xml:
        name: state-wrapper
    Result:
      type: object
      properties:
        id:
          type: string
        value:
          type: boolean
        message:
          type: string
        state:
          type: string
        stackTrace:
          type: string
    ComponentDetails:
      type: object
      properties:
        id:
          type: string
        state:
          type: string
          enum:
          - CLOSED
          - INITIALISED
          - STARTED
          - STOPPED
          - DISCONNECTED
        lastStarted:
          type: string
          format: date-time
        lastStopped:
          type: string
          format: date-time
        inFlight:
          type: integer
          format: int32
        uptime:
          type: string
        downtime:
          type: string
      xml:
        name: component-details