IBM WebSphere

IBM WebSphere Batch API

Jakarta Batch job management

GitHub OpenAPI

Documentation

📖
Documentation
https://www.ibm.com/docs/en/was/9.0.5?topic=overview-administrative-rest-api
📖
Authentication
https://www.ibm.com/docs/en/was/9.0.5?topic=api-authentication-authorization
📖
GettingStarted
https://www.ibm.com/docs/en/was-nd/9.0.5?topic=specifications-discovering-rest-api-documentation
📖
APIReference
https://www.ibm.com/docs/en/was/9.0.5?topic=javadoc-apis-application-programming-interfaces
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-admin-rest-api
📖
GettingStarted
https://www.ibm.com/docs/en/was-liberty/base?topic=api-getting-started
📖
APIReference
https://openliberty.io/docs/latest/reference/feature/restConnector-2.0.html
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=center-setting-up-admin
📖
Documentation
https://openliberty.io/docs/latest/reference/feature/restConnector-2.0.html
📖
APIReference
https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html
📖
Documentation
https://openliberty.io/docs/latest/configuring-jmx-connection.html
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/core?topic=features-admin-rest-connector-20
📖
Documentation
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-introduction
📖
APIReference
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-reference
📖
Authentication
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=api-rest-authentication
📖
GettingStarted
https://developer.ibm.com/tutorials/mq-develop-mq-rest-api/
📖
Documentation
https://www.ibm.com/docs/en/ibm-mq/9.3?topic=mq-messaging-using-rest-api
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=liberty-collective-rest-api
📖
APIReference
https://www.ibm.com/docs/en/was-liberty/base?topic=api-collective-reference
📖
Documentation
https://www.ibm.com/docs/en/was-liberty/base?topic=deploying-applications-in-liberty
📖
Documentation
https://www.ibm.com/docs/en/ws-automation?topic=apis
📖
APIReference
https://www.ibm.com/docs/en/ws-automation?topic=reference-rest-api
📖
Documentation
https://www.ibm.com/docs/en/ws-automation?topic=viewing-rest-api
📖
Documentation
https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html
📖
APIReference
https://openliberty.io/docs/latest/documentation-openapi.html
📖
GettingStarted
https://openliberty.io/guides/rest-intro.html
📖
Documentation
https://openliberty.io/docs/latest/microprofile.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/websphere/refs/heads/main/openapi/websphere-batch-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/websphere/refs/heads/main/json-schema/application.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/websphere/refs/heads/main/json-schema/server.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/websphere/refs/heads/main/json-schema/cluster.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/websphere/refs/heads/main/json-schema/message-queue.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/websphere/refs/heads/main/json-ld/context.jsonld
🔗
Blog
https://openliberty.io/blog/

OpenAPI Specification

websphere-batch-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Open Liberty APIs Applications Batch API
  description: Open Liberty provides application programming interfaces that extend and complement Jakarta EE and MicroProfile APIs. Includes APIs for security, admin connectors, batch processing, messaging, health checking, metrics, OpenAPI documentation, and more. Open Liberty is the open-source foundation for WebSphere Liberty.
  version: 24.0.0
  license:
    name: Eclipse Public License 1.0
    url: https://www.eclipse.org/legal/epl-v10.html
  contact:
    name: Open Liberty Community
    url: https://openliberty.io/
servers:
- url: https://localhost:9443
  description: Default Open Liberty Server
security:
- basicAuth: []
tags:
- name: Batch
  description: Jakarta Batch job management
paths:
  /ibm/api/batch/jobinstances:
    get:
      operationId: listBatchJobInstances
      summary: List Batch Job Instances
      description: Returns a list of Jakarta Batch job instances.
      tags:
      - Batch
      parameters:
      - name: jobName
        in: query
        description: Filter by job name
        schema:
          type: string
        example: example_value
      - name: page
        in: query
        description: Page number
        schema:
          type: integer
          default: 0
        example: 10
      - name: pageSize
        in: query
        description: Number of items per page
        schema:
          type: integer
          default: 50
        example: 10
      - name: sortBy
        in: query
        description: Sort field
        schema:
          type: string
          enum:
          - jobInstanceId
          - createTime
          - instanceState
        example: jobInstanceId
      responses:
        '200':
          description: List of job instances
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BatchJobInstance'
              examples:
                Listbatchjobinstances200Example:
                  summary: Default listBatchJobInstances 200 response
                  x-microcks-default: true
                  value:
                  - jobInstanceId: '500123'
                    jobName: example_value
                    appName: example_value
                    submitter: example_value
                    batchStatus: STARTING
                    createTime: '2026-01-15T10:30:00Z'
                    lastUpdatedTime: '2026-01-15T10:30:00Z'
                    jobParameters: example_value
                    _links:
                    - rel: example_value
                      href: https://www.example.com
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ibm/api/batch/jobinstances/{jobInstanceId}:
    get:
      operationId: getBatchJobInstance
      summary: Get Batch Job Instance
      description: Returns details of a specific batch job instance.
      tags:
      - Batch
      parameters:
      - name: jobInstanceId
        in: path
        required: true
        description: Job instance identifier
        schema:
          type: integer
        example: '500123'
      responses:
        '200':
          description: Job instance details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchJobInstance'
              examples:
                Getbatchjobinstance200Example:
                  summary: Default getBatchJobInstance 200 response
                  x-microcks-default: true
                  value:
                    jobInstanceId: '500123'
                    jobName: example_value
                    appName: example_value
                    submitter: example_value
                    batchStatus: STARTING
                    createTime: '2026-01-15T10:30:00Z'
                    lastUpdatedTime: '2026-01-15T10:30:00Z'
                    jobParameters: example_value
                    _links:
                    - rel: example_value
                      href: https://www.example.com
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ibm/api/batch/jobinstances/{jobInstanceId}/jobexecutions:
    get:
      operationId: listBatchJobExecutions
      summary: List Job Executions for an Instance
      description: Returns a list of executions for a specific batch job instance.
      tags:
      - Batch
      parameters:
      - name: jobInstanceId
        in: path
        required: true
        schema:
          type: integer
        example: '500123'
      responses:
        '200':
          description: List of job executions
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BatchJobExecution'
              examples:
                Listbatchjobexecutions200Example:
                  summary: Default listBatchJobExecutions 200 response
                  x-microcks-default: true
                  value:
                  - executionId: '500123'
                    jobInstanceId: '500123'
                    jobName: example_value
                    batchStatus: STARTING
                    exitStatus: example_value
                    createTime: '2026-01-15T10:30:00Z'
                    startTime: '2026-01-15T10:30:00Z'
                    endTime: '2026-01-15T10:30:00Z'
                    lastUpdatedTime: '2026-01-15T10:30:00Z'
                    jobParameters: example_value
                    stepExecutions:
                    - stepExecutionId: '500123'
                      stepName: example_value
                      batchStatus: example_value
                      exitStatus: example_value
                      startTime: '2026-01-15T10:30:00Z'
                      endTime: '2026-01-15T10:30:00Z'
                      readCount: 10
                      writeCount: 10
                      commitCount: 10
                      rollbackCount: 10
                      filterCount: 10
                      processSkipCount: 10
                      readSkipCount: 10
                      writeSkipCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ibm/api/batch/jobexecutions/{executionId}:
    get:
      operationId: getBatchJobExecution
      summary: Get Batch Job Execution
      description: Returns details of a specific batch job execution.
      tags:
      - Batch
      parameters:
      - name: executionId
        in: path
        required: true
        description: Job execution identifier
        schema:
          type: integer
        example: '500123'
      responses:
        '200':
          description: Job execution details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchJobExecution'
              examples:
                Getbatchjobexecution200Example:
                  summary: Default getBatchJobExecution 200 response
                  x-microcks-default: true
                  value:
                    executionId: '500123'
                    jobInstanceId: '500123'
                    jobName: example_value
                    batchStatus: STARTING
                    exitStatus: example_value
                    createTime: '2026-01-15T10:30:00Z'
                    startTime: '2026-01-15T10:30:00Z'
                    endTime: '2026-01-15T10:30:00Z'
                    lastUpdatedTime: '2026-01-15T10:30:00Z'
                    jobParameters: example_value
                    stepExecutions:
                    - stepExecutionId: '500123'
                      stepName: example_value
                      batchStatus: example_value
                      exitStatus: example_value
                      startTime: '2026-01-15T10:30:00Z'
                      endTime: '2026-01-15T10:30:00Z'
                      readCount: 10
                      writeCount: 10
                      commitCount: 10
                      rollbackCount: 10
                      filterCount: 10
                      processSkipCount: 10
                      readSkipCount: 10
                      writeSkipCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ibm/api/batch/jobexecutions/{executionId}/stop:
    put:
      operationId: stopBatchJobExecution
      summary: Stop a Batch Job Execution
      description: Stops a running batch job execution.
      tags:
      - Batch
      parameters:
      - name: executionId
        in: path
        required: true
        schema:
          type: integer
        example: '500123'
      responses:
        '200':
          description: Job execution stopped
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchJobExecution'
              examples:
                Stopbatchjobexecution200Example:
                  summary: Default stopBatchJobExecution 200 response
                  x-microcks-default: true
                  value:
                    executionId: '500123'
                    jobInstanceId: '500123'
                    jobName: example_value
                    batchStatus: STARTING
                    exitStatus: example_value
                    createTime: '2026-01-15T10:30:00Z'
                    startTime: '2026-01-15T10:30:00Z'
                    endTime: '2026-01-15T10:30:00Z'
                    lastUpdatedTime: '2026-01-15T10:30:00Z'
                    jobParameters: example_value
                    stepExecutions:
                    - stepExecutionId: '500123'
                      stepName: example_value
                      batchStatus: example_value
                      exitStatus: example_value
                      startTime: '2026-01-15T10:30:00Z'
                      endTime: '2026-01-15T10:30:00Z'
                      readCount: 10
                      writeCount: 10
                      commitCount: 10
                      rollbackCount: 10
                      filterCount: 10
                      processSkipCount: 10
                      readSkipCount: 10
                      writeSkipCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ibm/api/batch/jobexecutions/{executionId}/restart:
    put:
      operationId: restartBatchJobExecution
      summary: Restart a Batch Job Execution
      description: Restarts a failed or stopped batch job execution.
      tags:
      - Batch
      parameters:
      - name: executionId
        in: path
        required: true
        schema:
          type: integer
        example: '500123'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                jobParameters:
                  type: object
                  additionalProperties:
                    type: string
                  description: Job parameters for the restart
            examples:
              RestartbatchjobexecutionRequestExample:
                summary: Default restartBatchJobExecution request
                x-microcks-default: true
                value:
                  jobParameters: example_value
      responses:
        '200':
          description: Job execution restarted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchJobExecution'
              examples:
                Restartbatchjobexecution200Example:
                  summary: Default restartBatchJobExecution 200 response
                  x-microcks-default: true
                  value:
                    executionId: '500123'
                    jobInstanceId: '500123'
                    jobName: example_value
                    batchStatus: STARTING
                    exitStatus: example_value
                    createTime: '2026-01-15T10:30:00Z'
                    startTime: '2026-01-15T10:30:00Z'
                    endTime: '2026-01-15T10:30:00Z'
                    lastUpdatedTime: '2026-01-15T10:30:00Z'
                    jobParameters: example_value
                    stepExecutions:
                    - stepExecutionId: '500123'
                      stepName: example_value
                      batchStatus: example_value
                      exitStatus: example_value
                      startTime: '2026-01-15T10:30:00Z'
                      endTime: '2026-01-15T10:30:00Z'
                      readCount: 10
                      writeCount: 10
                      commitCount: 10
                      rollbackCount: 10
                      filterCount: 10
                      processSkipCount: 10
                      readSkipCount: 10
                      writeSkipCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    BatchJobInstance:
      type: object
      properties:
        jobInstanceId:
          type: integer
          example: '500123'
        jobName:
          type: string
          example: example_value
        appName:
          type: string
          example: example_value
        submitter:
          type: string
          example: example_value
        batchStatus:
          type: string
          enum:
          - STARTING
          - STARTED
          - STOPPING
          - STOPPED
          - FAILED
          - COMPLETED
          - ABANDONED
          example: STARTING
        createTime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        lastUpdatedTime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        jobParameters:
          type: object
          additionalProperties:
            type: string
          example: example_value
        _links:
          type: array
          items:
            type: object
            properties:
              rel:
                type: string
              href:
                type: string
                format: uri
          example: []
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
      required:
      - code
      - message
    BatchJobExecution:
      type: object
      properties:
        executionId:
          type: integer
          example: '500123'
        jobInstanceId:
          type: integer
          example: '500123'
        jobName:
          type: string
          example: example_value
        batchStatus:
          type: string
          enum:
          - STARTING
          - STARTED
          - STOPPING
          - STOPPED
          - FAILED
          - COMPLETED
          - ABANDONED
          example: STARTING
        exitStatus:
          type: string
          example: example_value
        createTime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        startTime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        endTime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        lastUpdatedTime:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        jobParameters:
          type: object
          additionalProperties:
            type: string
          example: example_value
        stepExecutions:
          type: array
          items:
            type: object
            properties:
              stepExecutionId:
                type: integer
              stepName:
                type: string
              batchStatus:
                type: string
              exitStatus:
                type: string
              startTime:
                type: string
                format: date-time
              endTime:
                type: string
                format: date-time
              readCount:
                type: integer
              writeCount:
                type: integer
              commitCount:
                type: integer
              rollbackCount:
                type: integer
              filterCount:
                type: integer
              processSkipCount:
                type: integer
              readSkipCount:
                type: integer
              writeSkipCount:
                type: integer
          example: []
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: MicroProfile JWT authentication
externalDocs:
  description: Open Liberty API Reference
  url: https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html