# 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](https://github.com/swagger-api/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](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell 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: ```shell npm install GIT_USER_ID/GIT_REPO_ID --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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): ```shell browserify main.js > bundle.js ``` Then include *bundle.js* in the HTML pages. ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript 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**](docs/AgentApi.md#listAgents) | **GET** /Agent | List of agents *IbmWorkloadSchedulerApi.ProcessApi* | [**createCronProcess**](docs/ProcessApi.md#createCronProcess) | **POST** /Process/CronProcess | Create process with cron rule *IbmWorkloadSchedulerApi.ProcessApi* | [**createProcess**](docs/ProcessApi.md#createProcess) | **POST** /Process | Create a Process *IbmWorkloadSchedulerApi.ProcessApi* | [**deleteProcess**](docs/ProcessApi.md#deleteProcess) | **DELETE** /Process/{PROCESS_ID} | Delete a Process *IbmWorkloadSchedulerApi.ProcessApi* | [**getProcess**](docs/ProcessApi.md#getProcess) | **GET** /Process/{PROCESS_ID} | Get Process info *IbmWorkloadSchedulerApi.ProcessApi* | [**listProcess**](docs/ProcessApi.md#listProcess) | **GET** /Process | Lists Processes in a library. *IbmWorkloadSchedulerApi.ProcessApi* | [**runNowProcess**](docs/ProcessApi.md#runNowProcess) | **PUT** /Process/{PROCESS_ID}/Actions/RunNow | Run the process immediately *IbmWorkloadSchedulerApi.ProcessApi* | [**toggleProcessStatus**](docs/ProcessApi.md#toggleProcessStatus) | **PUT** /Process/{PROCESS_ID}/Actions/ToggleStatus | Enable or disable a process *IbmWorkloadSchedulerApi.ProcessApi* | [**updateProcess**](docs/ProcessApi.md#updateProcess) | **PUT** /Process/{PROCESS_ID} | Update a process *IbmWorkloadSchedulerApi.ProcessHistoryApi* | [**cancelStep**](docs/ProcessHistoryApi.md#cancelStep) | **PUT** /ProcessHistory/{PROCESS_ID}/{INSTANCEID}/Steps/{STEPID}/Cancel | *IbmWorkloadSchedulerApi.ProcessHistoryApi* | [**getStepLog**](docs/ProcessHistoryApi.md#getStepLog) | **GET** /ProcessHistory/{PROCESS_ID}/{INSTANCEID}/Steps/{STEPID}/Log | Get step output *IbmWorkloadSchedulerApi.ProcessHistoryApi* | [**killStep**](docs/ProcessHistoryApi.md#killStep) | **PUT** /ProcessHistory/{PROCESS_ID}/{INSTANCEID}/Steps/{STEPID}/Kill | Stop a step. *IbmWorkloadSchedulerApi.ProcessHistoryApi* | [**listProcessHistory**](docs/ProcessHistoryApi.md#listProcessHistory) | **GET** /ProcessHistory/{PROCESS_ID} | Get the process run history *IbmWorkloadSchedulerApi.ProcessHistoryApi* | [**listSteps**](docs/ProcessHistoryApi.md#listSteps) | **GET** /ProcessHistory/{PROCESS_ID}/{INSTANCEID} | The list of steps of a running instance. *IbmWorkloadSchedulerApi.ProcessHistoryApi* | [**rerunStep**](docs/ProcessHistoryApi.md#rerunStep) | **PUT** /ProcessHistory/{PROCESS_ID}/{INSTANCEID}/Steps/{STEPID}/Rerun | Rerun a step. *IbmWorkloadSchedulerApi.ProcessHistoryApi* | [**startNowStep**](docs/ProcessHistoryApi.md#startNowStep) | **PUT** /ProcessHistory/{PROCESS_ID}/{INSTANCEID}/Steps/{STEPID}/StartNow | Starts the step *IbmWorkloadSchedulerApi.ProcessLibraryApi* | [**createProcessLibrary**](docs/ProcessLibraryApi.md#createProcessLibrary) | **POST** /ProcessLibrary | Create a ProcessLibrary *IbmWorkloadSchedulerApi.ProcessLibraryApi* | [**deleteProcessLibrary**](docs/ProcessLibraryApi.md#deleteProcessLibrary) | **DELETE** /ProcessLibrary/{PROCESS_LIBRARY_ID} | Delete a ProcessLibrary *IbmWorkloadSchedulerApi.ProcessLibraryApi* | [**exportProcessLibrary**](docs/ProcessLibraryApi.md#exportProcessLibrary) | **GET** /ProcessLibrary/{PROCESS_LIBRARY_ID}/Export | *IbmWorkloadSchedulerApi.ProcessLibraryApi* | [**getProcessLibrary**](docs/ProcessLibraryApi.md#getProcessLibrary) | **GET** /ProcessLibrary/{PROCESS_LIBRARY_ID} | Get ProcessLibrary info *IbmWorkloadSchedulerApi.ProcessLibraryApi* | [**getProcessLibraryChildren**](docs/ProcessLibraryApi.md#getProcessLibraryChildren) | **GET** /ProcessLibrary/{PROCESS_LIBRARY_ID}/Children | Get the children libraries *IbmWorkloadSchedulerApi.ProcessLibraryApi* | [**listProcessLibrary**](docs/ProcessLibraryApi.md#listProcessLibrary) | **GET** /ProcessLibrary | List process libraries *IbmWorkloadSchedulerApi.ProcessLibraryApi* | [**listProcessesInLibrary**](docs/ProcessLibraryApi.md#listProcessesInLibrary) | **GET** /ProcessLibrary/{PROCESS_LIBRARY_ID}/Processes | Lists processes in the lib *IbmWorkloadSchedulerApi.ProcessLibraryApi* | [**updateProcessLibrary**](docs/ProcessLibraryApi.md#updateProcessLibrary) | **PUT** /ProcessLibrary/{PROCESS_LIBRARY_ID} | Update a Process Library *IbmWorkloadSchedulerApi.SynchGroupApi* | [**synchGroupDelete**](docs/SynchGroupApi.md#synchGroupDelete) | **DELETE** /SynchGroup/{SYNCHGROUP_ID} | *IbmWorkloadSchedulerApi.SynchGroupApi* | [**synchGroupIdGet**](docs/SynchGroupApi.md#synchGroupIdGet) | **GET** /SynchGroup/{SYNCHGROUP_ID} | *IbmWorkloadSchedulerApi.SynchGroupApi* | [**synchGroupsGet**](docs/SynchGroupApi.md#synchGroupsGet) | **GET** /SynchGroup | *IbmWorkloadSchedulerApi.SynchGroupApi* | [**synchGroupsPost**](docs/SynchGroupApi.md#synchGroupsPost) | **POST** /SynchGroup | *IbmWorkloadSchedulerApi.SynchGroupApi* | [**synchGroupsResourceLink**](docs/SynchGroupApi.md#synchGroupsResourceLink) | **POST** /SynchGroup/{SYNCHGROUP_ID} | *IbmWorkloadSchedulerApi.SynchGroupApi* | [**synchGroupsUpdate**](docs/SynchGroupApi.md#synchGroupsUpdate) | **PUT** /SynchGroup/{SYNCHGROUP_ID} | *IbmWorkloadSchedulerApi.TriggerFactoryApi* | [**createMultipleTriggers**](docs/TriggerFactoryApi.md#createMultipleTriggers) | **POST** /TriggerFactory | *IbmWorkloadSchedulerApi.TriggerFactoryApi* | [**everyDayAt**](docs/TriggerFactoryApi.md#everyDayAt) | **POST** /TriggerFactory/everyDayAt | *IbmWorkloadSchedulerApi.TriggerFactoryApi* | [**repeatDaily**](docs/TriggerFactoryApi.md#repeatDaily) | **POST** /TriggerFactory/repeatDaily | Create trigger to run daily. *IbmWorkloadSchedulerApi.TriggerFactoryApi* | [**repeatEveryDay**](docs/TriggerFactoryApi.md#repeatEveryDay) | **GET** /TriggerFactory/repeatEveryDay | *IbmWorkloadSchedulerApi.TriggerFactoryApi* | [**repeatWeekly**](docs/TriggerFactoryApi.md#repeatWeekly) | **POST** /TriggerFactory/repeatWeekly | *IbmWorkloadSchedulerApi.TriggerFactoryApi* | [**scheduleOn**](docs/TriggerFactoryApi.md#scheduleOn) | **POST** /TriggerFactory/scheduleOn | Create a trigger to run one time. *IbmWorkloadSchedulerApi.UserPreferencesApi* | [**getTimezone**](docs/UserPreferencesApi.md#getTimezone) | **GET** /UserPreferences/timezone | *IbmWorkloadSchedulerApi.UserPreferencesApi* | [**setTimezone**](docs/UserPreferencesApi.md#setTimezone) | **POST** /UserPreferences/timezone | *IbmWorkloadSchedulerApi.UserPreferencesApi* | [**updateTimezone**](docs/UserPreferencesApi.md#updateTimezone) | **PUT** /UserPreferences/timezone | ## Documentation for Models - [IbmWorkloadSchedulerApi.Agent](docs/Agent.md) - [IbmWorkloadSchedulerApi.CloudantAction](docs/CloudantAction.md) - [IbmWorkloadSchedulerApi.CloudantBody](docs/CloudantBody.md) - [IbmWorkloadSchedulerApi.CloudantConnection](docs/CloudantConnection.md) - [IbmWorkloadSchedulerApi.CloudantStep](docs/CloudantStep.md) - [IbmWorkloadSchedulerApi.CommandStep](docs/CommandStep.md) - [IbmWorkloadSchedulerApi.CronProcess](docs/CronProcess.md) - [IbmWorkloadSchedulerApi.CustomStep](docs/CustomStep.md) - [IbmWorkloadSchedulerApi.DBCommand](docs/DBCommand.md) - [IbmWorkloadSchedulerApi.DBConnection](docs/DBConnection.md) - [IbmWorkloadSchedulerApi.DailyTriggerProperty](docs/DailyTriggerProperty.md) - [IbmWorkloadSchedulerApi.DatabaseStep](docs/DatabaseStep.md) - [IbmWorkloadSchedulerApi.Error](docs/Error.md) - [IbmWorkloadSchedulerApi.FileCreateTriggerProperty](docs/FileCreateTriggerProperty.md) - [IbmWorkloadSchedulerApi.FileDeleteTriggerProperty](docs/FileDeleteTriggerProperty.md) - [IbmWorkloadSchedulerApi.FileModifiedTriggerProperty](docs/FileModifiedTriggerProperty.md) - [IbmWorkloadSchedulerApi.FileTransferStep](docs/FileTransferStep.md) - [IbmWorkloadSchedulerApi.JSR352JavaBatchAction](docs/JSR352JavaBatchAction.md) - [IbmWorkloadSchedulerApi.JSR352JavaBatchConnection](docs/JSR352JavaBatchConnection.md) - [IbmWorkloadSchedulerApi.JSR352JavaBatchStep](docs/JSR352JavaBatchStep.md) - [IbmWorkloadSchedulerApi.JavaStep](docs/JavaStep.md) - [IbmWorkloadSchedulerApi.Jobstream](docs/Jobstream.md) - [IbmWorkloadSchedulerApi.LastWriteTriggerProperty](docs/LastWriteTriggerProperty.md) - [IbmWorkloadSchedulerApi.MQConnection](docs/MQConnection.md) - [IbmWorkloadSchedulerApi.MQOperation](docs/MQOperation.md) - [IbmWorkloadSchedulerApi.MQStep](docs/MQStep.md) - [IbmWorkloadSchedulerApi.MQTTAction](docs/MQTTAction.md) - [IbmWorkloadSchedulerApi.MQTTConnection](docs/MQTTConnection.md) - [IbmWorkloadSchedulerApi.MQTTStep](docs/MQTTStep.md) - [IbmWorkloadSchedulerApi.MonthlyTriggerProperty](docs/MonthlyTriggerProperty.md) - [IbmWorkloadSchedulerApi.MultipleTriggersData](docs/MultipleTriggersData.md) - [IbmWorkloadSchedulerApi.OneTimeTriggerProperty](docs/OneTimeTriggerProperty.md) - [IbmWorkloadSchedulerApi.OozieAction](docs/OozieAction.md) - [IbmWorkloadSchedulerApi.OozieConnection](docs/OozieConnection.md) - [IbmWorkloadSchedulerApi.OozieStep](docs/OozieStep.md) - [IbmWorkloadSchedulerApi.OpenWhiskConnection](docs/OpenWhiskConnection.md) - [IbmWorkloadSchedulerApi.OpenWhiskOperation](docs/OpenWhiskOperation.md) - [IbmWorkloadSchedulerApi.OpenWhiskStep](docs/OpenWhiskStep.md) - [IbmWorkloadSchedulerApi.Process](docs/Process.md) - [IbmWorkloadSchedulerApi.ProcessHistoryInstance](docs/ProcessHistoryInstance.md) - [IbmWorkloadSchedulerApi.ProcessLibrary](docs/ProcessLibrary.md) - [IbmWorkloadSchedulerApi.RemoteCommandConnection](docs/RemoteCommandConnection.md) - [IbmWorkloadSchedulerApi.RemoteCommandStep](docs/RemoteCommandStep.md) - [IbmWorkloadSchedulerApi.RepeatTimeData](docs/RepeatTimeData.md) - [IbmWorkloadSchedulerApi.RestAction](docs/RestAction.md) - [IbmWorkloadSchedulerApi.RestAuthenticationData](docs/RestAuthenticationData.md) - [IbmWorkloadSchedulerApi.RestInput](docs/RestInput.md) - [IbmWorkloadSchedulerApi.RestfulStep](docs/RestfulStep.md) - [IbmWorkloadSchedulerApi.Step](docs/Step.md) - [IbmWorkloadSchedulerApi.StepHistoryInstance](docs/StepHistoryInstance.md) - [IbmWorkloadSchedulerApi.SynchGroup](docs/SynchGroup.md) - [IbmWorkloadSchedulerApi.TimeData](docs/TimeData.md) - [IbmWorkloadSchedulerApi.Trigger](docs/Trigger.md) - [IbmWorkloadSchedulerApi.Variable](docs/Variable.md) - [IbmWorkloadSchedulerApi.WeeklyTriggerProperty](docs/WeeklyTriggerProperty.md) ## Documentation for Authorization ### basicAuth - **Type**: HTTP basic authentication