EBP Console API
Version 1.0.3
This is the EBP Console API endpoints.
GDG Operations
GET /api/gdg Search GDG files
Parameters
filename
query
optional
Pass an optional search string for looking up GDG files with the same name
Type: string
pageSize
query
optional
Pass pageSize for pagination purpose. It will be used for size of the records per page.
Type: integer
pageIndex
query
optional
Pass pageIndex for pagination purpose, it implies the which page you want to looking for.
Type: integer
sortBy
query
optional
Sorting the data according to this column
Type: string
sortDirection
query
optional
Sorting the data according to this value. It should be 'asc' or 'desc'
Type: string
Responses
GET /api/gdg/{gdgfile} Get GDG file revisions
Parameters
gdgfile
path
required
Get the revision of the given GDG file
Type: string
Responses
POST /api/gdg/generate Generate GDG file
Parameters
name
query
required
The name of the gdg file to be generated
Type: string
limit
query
required
The limit of the revisions
Type: integer
recordlength
query
required
The record length value of the gdg file
Type: integer
pool
query
optional
The pool prefix added to the filename at creation time
Type: string
Responses
Job Operations
GET /api/job Return jobs list
Retrieve the list of job classes. Supports extensive filtering options.
Parameters (All Optional)
id
query
Filter jobs by id
Type: integer (minimum: 0)
name
query
Filter jobs by job's name
Type: string
class
query
Filter jobs by class name
Type: string
status
query
Filter jobs by status
Type: Status enum (Error, Queued, Running, Terminated, Flushed, Cancelled, Aborted, Held, Suspended, Unknown)
...and more filter parameters available (user, added, started, finished, duration, queue, disposition, priority)
Responses
POST /api/job/submit Add new job
Submit a new job for execution.
Request Body
application/json
required
Schema: JobExecute
deck (string, required) - Job deck content
class (string, optional) - Job class
hold (boolean, optional) - Hold job after submission
type (string, optional) - Job type (JCL, JCS, JEC, COBOL, JAVA, PYTHON, SCRIPT)
Responses
POST /api/job/submit/{fileName} Submit job by file name
Expects 'fileName' value for the JCL File to look all folders of jcllib with '.jcl' extension. Parameters can be passed in the payload.
Parameters
fileName
path
required
Value of the job's class to be updated
Type: string
jobcontrol
query
optional
Optional flag to enable job control (CA-11) functionality
Type: boolean (default: false)
Request Body
application/json
Schema: JobExecute
Responses
POST /api/job/restart Restart a job
Restart job with the given jobId. stepName and procStepName parameters are optional, if passed job will be restarted at given step.
Request Body
application/json
required
Schema: JobRestart
jobId (string, required) - Job identifier to restart
stepName (string, optional) - Step name to restart from
procStepName (string, optional) - Procedure step name
jobControl (boolean, optional) - Job control flag (default: false)
Responses
PUT /api/job/{jobId}/{class}/{disposition}/{priority} Update job
Parameters
jobId
path
required
Job id
Type: integer (minimum: 0)
class
path
required
Value of the job's class to be updated
Type: string
disposition
path
required
Disposition value to be updated
Type: Disposition enum (D, H, K, L)
priority
path
required
Priority value to be updated
Type: integer (minimum: 0)
Responses
GET /api/job/{jobId}/details Get job details
Parameters
jobId
path
required
Job id
Type: integer (minimum: 0)
Responses
POST /api/job/{jobId}/{jobaction} Start/hold/purge job
Parameters
jobId
path
required
Job id
Type: integer (minimum: 0)
jobaction
path
required
Job related action
Type: JobAction enum (start, hold, purge, cancel)
Responses
Additional Job Endpoints
- GET /api/job/{jobId}/downloadfile - Download file for given job step
- GET /api/job/{jobId}/preview - Preview file for given job step
- PUT /api/job/{jobId}/newdest - Change job step destination
- DELETE /api/job/{jobName}/purgeall - Purge all jobs with given name
- PUT /api/job/{jobName}/releaseall - Release all jobs with given name
Initiator Operations
GET /api/initiator Get the initiators list
Responses
POST /api/initiator/{initiatorId}/{initiatorAction} Start/stop initiator
Parameters
initiatorId
path
required
Initiator id
Type: integer (minimum: 0)
initiatorAction
path
required
Initiator related action
Type: string enum (start, stop)
Responses
Job Class Operations
GET /api/jobclass Return job classes list
Retrieve the list of job classes with optional filtering.
Parameters (All Optional)
name
query
Filter for the job class name
Type: string
type
query
Filter for the job class type
Type: Type enum (JCL, JCS, JEC, COBOL, JAVA, PYTHON, SCRIPT)
...and more filter parameters available (maxcputime, maxmemory, maxfile, maxnetwork, maxelapsedtime)
Responses
Spool & Operator Message Operations
GET /api/spool/find Get spool file path
Get a spool file full path based on parameters. Returns the most recently created spool file that matches these parameters.
Parameters
jobName
query
required
Full Job name (case insensitive)
Type: string
type
query
required
Queue type
Type: string enum (LST, PUN)
msgclass
query
required
The class of the queue that is used as a filter
Type: string
Responses
Operator Message Endpoints
- GET /api/operatormessage - Get operator message by ID
- GET /api/operatormessage/list - List all operator messages
- POST /api/operatormessage/post - Post an operator message
- POST /api/operatormessage/reply - Reply to an operator message
Schemas
EBP Console API Documentation v1.0.3
License: Apache 2.0
0 Comments