Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

IBM WebSphere Batch API

Jakarta Batch job management

IBM WebSphere Batch API is one of 35 APIs that IBM WebSphere publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Batch. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, an API reference, a JSON-LD context, and 4 JSON Schemas.

This API exposes 6 operations across 6 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 24.0.0.

Requests are made against a single base URL, https://localhost:9443.

6 operations 6 paths 3 schemas 4 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
24.0.0
Base URL
https://localhost:9443/ibm/api
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

IBM WebSphere Batch API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (jwtAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication
  • jwtAuth — MicroProfile JWT authentication

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 4 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Batch 6

Jakarta Batch job management

GET
/ibm/api/batch/jobinstances
List Batch Job Instances
listBatchJobInstances 4 params → 200401
GET
/ibm/api/batch/jobinstances/{jobInstanceId}
Get Batch Job Instance
getBatchJobInstance 1 param → 200401404
GET
/ibm/api/batch/jobinstances/{jobInstanceId}/jobexecutions
List Job Executions for an Instance
listBatchJobExecutions 1 param → 200401404
GET
/ibm/api/batch/jobexecutions/{executionId}
Get Batch Job Execution
getBatchJobExecution 1 param → 200401404
PUT
/ibm/api/batch/jobexecutions/{executionId}/stop
Stop a Batch Job Execution
stopBatchJobExecution 1 param → 200401404
PUT
/ibm/api/batch/jobexecutions/{executionId}/restart
Restart a Batch Job Execution
restartBatchJobExecution 1 param body → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BatchJobExecution (11 properties), BatchJobInstance (9 properties), Error (2 properties). Each schema is shown below with its type and property counts.

BatchJobInstance
object
9 properties
Error
object
2 properties 2 required
BatchJobExecution
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

websphere-batch-api-openapi.yml Raw ↑

Other APIs IBM WebSphere publishes across the network.

WebSphere Application Server JMX API
IBM WebSphere Applications API
IBM WebSphere Authentication API
IBM WebSphere Channels API
IBM WebSphere Clusters API
IBM WebSphere Compliance API
IBM WebSphere Config API
IBM WebSphere Configuration API
IBM WebSphere Controller API
IBM WebSphere Features API
IBM WebSphere File Transfer API
IBM WebSphere Fixes API