Ibm-workload-scheduler-api NPM

ibm-workload-scheduler-api

IbmWorkloadSchedulerApi - JavaScript client for ibm-workload-scheduler-api Workload Scheduler - Application Lab API IBM Workload Scheduler provides different sets of APIs. The Application Lab API is the simplest to use and is the main API used in the Bluemix environment. To use this API on cloud environments, you need to know your tenantId, reported in the service management page (dashboard), or in the service credentials page

The IBM copyright lines of code identified in the source code by (C) Copyright IBM Corp. 2016' are inputs to the Swagger code generator and bug fix in the generated code

This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version: 1.0.0
Build date: 2017-02-01T16:16:32.353+01:00
Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install ibm-workload-scheduler-api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var IbmWorkloadSchedulerApi = require('ibm-workload-scheduler-api');

//var defaultClient = IbmWorkloadSchedulerApi.ApiClient.default;
// added
var defaultClient = IbmWorkloadSchedulerApi.ApiClient.instance;
// end added

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new IbmWorkloadSchedulerApi.AgentApi()

var tenantId = "tenantId_example"; // {String} The id of the Tenant that is making the call

var opts = { 
  'sort': "sort_example", // {String} Sort services based on name..
  'engineName': "engineName_example", // {String} The name of the engine to connect to. Leave default in cloud environments
  'engineOwner': "engineOwner_example" // {String} The owner of the engine definition. Leave default in cloud environments.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAgents(tenantId, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://localhost/ibm/TWSWebUI/Simple/rest

Class	Method	HTTP request	Description
IbmWorkloadSchedulerApi.AgentApi	listAgents	GET /Agent	List of agents
IbmWorkloadSchedulerApi.ProcessApi	createCronProcess	POST /Process/CronProcess	Create process with cron rule
IbmWorkloadSchedulerApi.ProcessApi	createProcess	POST /Process	Create a Process
IbmWorkloadSchedulerApi.ProcessApi	deleteProcess	DELETE /Process/{PROCESS_ID}	Delete a Process
IbmWorkloadSchedulerApi.ProcessApi	getProcess	GET /Process/{PROCESS_ID}	Get Process info
IbmWorkloadSchedulerApi.ProcessApi	listProcess	GET /Process	Lists Processes in a library.
IbmWorkloadSchedulerApi.ProcessApi	runNowProcess	PUT /Process/{PROCESS_ID}/Actions/RunNow	Run the process immediately
IbmWorkloadSchedulerApi.ProcessApi	toggleProcessStatus	PUT /Process/{PROCESS_ID}/Actions/ToggleStatus	Enable or disable a process
IbmWorkloadSchedulerApi.ProcessApi	updateProcess	PUT /Process/{PROCESS_ID}	Update a process
IbmWorkloadSchedulerApi.ProcessHistoryApi	cancelStep	PUT /ProcessHistory/{PROCESS_ID}/{INSTANCEID}/Steps/{STEPID}/Cancel
IbmWorkloadSchedulerApi.ProcessHistoryApi	getStepLog	GET /ProcessHistory/{PROCESS_ID}/{INSTANCEID}/Steps/{STEPID}/Log	Get step output
IbmWorkloadSchedulerApi.ProcessHistoryApi	killStep	PUT /ProcessHistory/{PROCESS_ID}/{INSTANCEID}/Steps/{STEPID}/Kill	Stop a step.
IbmWorkloadSchedulerApi.ProcessHistoryApi	listProcessHistory	GET /ProcessHistory/{PROCESS_ID}	Get the process run history
IbmWorkloadSchedulerApi.ProcessHistoryApi	listSteps	GET /ProcessHistory/{PROCESS_ID}/{INSTANCEID}	The list of steps of a running instance.
IbmWorkloadSchedulerApi.ProcessHistoryApi	rerunStep	PUT /ProcessHistory/{PROCESS_ID}/{INSTANCEID}/Steps/{STEPID}/Rerun	Rerun a step.
IbmWorkloadSchedulerApi.ProcessHistoryApi	startNowStep	PUT /ProcessHistory/{PROCESS_ID}/{INSTANCEID}/Steps/{STEPID}/StartNow	Starts the step
IbmWorkloadSchedulerApi.ProcessLibraryApi	createProcessLibrary	POST /ProcessLibrary	Create a ProcessLibrary
IbmWorkloadSchedulerApi.ProcessLibraryApi	deleteProcessLibrary	DELETE /ProcessLibrary/{PROCESS_LIBRARY_ID}	Delete a ProcessLibrary
IbmWorkloadSchedulerApi.ProcessLibraryApi	exportProcessLibrary	GET /ProcessLibrary/{PROCESS_LIBRARY_ID}/Export
IbmWorkloadSchedulerApi.ProcessLibraryApi	getProcessLibrary	GET /ProcessLibrary/{PROCESS_LIBRARY_ID}	Get ProcessLibrary info
IbmWorkloadSchedulerApi.ProcessLibraryApi	getProcessLibraryChildren	GET /ProcessLibrary/{PROCESS_LIBRARY_ID}/Children	Get the children libraries
IbmWorkloadSchedulerApi.ProcessLibraryApi	listProcessLibrary	GET /ProcessLibrary	List process libraries
IbmWorkloadSchedulerApi.ProcessLibraryApi	listProcessesInLibrary	GET /ProcessLibrary/{PROCESS_LIBRARY_ID}/Processes	Lists processes in the lib
IbmWorkloadSchedulerApi.ProcessLibraryApi	updateProcessLibrary	PUT /ProcessLibrary/{PROCESS_LIBRARY_ID}	Update a Process Library
IbmWorkloadSchedulerApi.SynchGroupApi	synchGroupDelete	DELETE /SynchGroup/{SYNCHGROUP_ID}
IbmWorkloadSchedulerApi.SynchGroupApi	synchGroupIdGet	GET /SynchGroup/{SYNCHGROUP_ID}
IbmWorkloadSchedulerApi.SynchGroupApi	synchGroupsGet	GET /SynchGroup
IbmWorkloadSchedulerApi.SynchGroupApi	synchGroupsPost	POST /SynchGroup
IbmWorkloadSchedulerApi.SynchGroupApi	synchGroupsResourceLink	POST /SynchGroup/{SYNCHGROUP_ID}
IbmWorkloadSchedulerApi.SynchGroupApi	synchGroupsUpdate	PUT /SynchGroup/{SYNCHGROUP_ID}
IbmWorkloadSchedulerApi.TriggerFactoryApi	createMultipleTriggers	POST /TriggerFactory
IbmWorkloadSchedulerApi.TriggerFactoryApi	everyDayAt	POST /TriggerFactory/everyDayAt
IbmWorkloadSchedulerApi.TriggerFactoryApi	repeatDaily	POST /TriggerFactory/repeatDaily	Create trigger to run daily.
IbmWorkloadSchedulerApi.TriggerFactoryApi	repeatEveryDay	GET /TriggerFactory/repeatEveryDay
IbmWorkloadSchedulerApi.TriggerFactoryApi	repeatWeekly	POST /TriggerFactory/repeatWeekly
IbmWorkloadSchedulerApi.TriggerFactoryApi	scheduleOn	POST /TriggerFactory/scheduleOn	Create a trigger to run one time.
IbmWorkloadSchedulerApi.UserPreferencesApi	getTimezone	GET /UserPreferences/timezone
IbmWorkloadSchedulerApi.UserPreferencesApi	setTimezone	POST /UserPreferences/timezone
IbmWorkloadSchedulerApi.UserPreferencesApi	updateTimezone	PUT /UserPreferences/timezone

Documentation for Models

Documentation for Authorization

basicAuth

Type: HTTP basic authentication

superagent

@everything-registry/sub-chunk-1889 @infinitebrahmanuniverse/nolb-ib @zalastax/nolb-ib

1.0.0

7 years ago