docloud-api

Notice

IBM Decision Optimization on Cloud or DOcloud for short is a service that lets you solve CPLEX and OPL problems on the Cloud. You can access the interactive service called DropSolve or you can use use the API to integrate the service into your application. Here is a quick introduction with useful links. This module provides a wrapper over the REST API using Promises. The command line client for DOcloud is also a good tool and example showing how to use this API.

Example

In this following example, we submit an OPL project made of several files. The execute function takes an object to configure how the job will be created and monitored. This object provides the client with the list of attachments to create (attachments property) and where to get their streams. It also indicates if the live log must be streamed (logstream property) and to which stream. Additional parameters can be declared as well (parameters property). The execute function will create the job, upload the attachments, and monitor the execution asynchronously. It will fire events when the job is created, processed, interrupted, failed, or if an error occurred.

var docloud = require('docloud-api');
var fs = require('fs');
var client = docloud({
      url : process.env.URL,
      clientId : process.env.KEY
    })
    
client.execute({
        logstream : process.stdout,
        parameters : { "oaas.TIME_LIMIT" : 3*60*1000},
        attachments : [
            {name : '.oplproject', 
        	 stream : fs.createReadStream('test/warehouse-location/.oplproject')},
            {name : 'warehouse_cloud.dat', 
             stream : fs.createReadStream('test/warehouse-location/warehouse_cloud.dat')},
            {name : 'warehouse_cloud.mod', 
             stream : fs.createReadStream('test/warehouse-location/warehouse_cloud.mod')},
            {name : 'warehouse_data.mod', 
             stream : fs.createReadStream('test/warehouse-location/warehouse_data.mod')},
        ]})
       .on('created', function(jobid){console.log(jobid+" created")})
       .on('processed', function(jobid){
           console.log(jobid+" processed");
           client.downloadAttachment(jobid,'solution.json',fs.createWriteStream('test/warehouse-location/solution.json'))
                 .then(function () {return client.downloadLog(jobid,fs.createWriteStream('test/warehouse-location/solution.log'))})
       })
       .on('interrupted', function(jobid){console.log("job was interrupted")})
       .on('failed', function(jobid){console.log("job failed")})
       .on('error', function(error){console.log(error)})
       		

Basic API

The basic API is a simple wrapper of the DOcloud REST API returning Promises. It can be used to perform simple actions and chain them using promises.To know more about the different actions, parameters and returned information, you can refer to the REST API documentation.

client.listJobs()

• Returns the list of jobs
• @see GET /jobs

client.deleteJobs()

• Deletes all the jobs.
• @see DELETE /jobs

client.createJob(data)

• Creates a new job.
• @param data the creation parameters
• @see POST /jobs

client.getJob(jobid)

• Returns a job.
• @param jobid the job id
• @see GET /jobs/{id}

client.deleteJob(jobid)

• Deletes a job.
• @param jobid the job id
• @see DELETE /jobs/{id}

client.executeJob(jobid)

• Executes a job.
• @param jobid the job id
• @see POST /jobs/{id}/execute

client.getJobExecutionStatus(jobid)

• Returns the job execution status.
• @param jobid the job id
• @see GET /jobs/{id}/execute

client.abortJob(jobid, kill)

• Aborts a job
• @param jobid the job id
• @param kill sets the abort mode to kill
• @see DELETE /jobs/{id}/execute

client.uploadAttachment(jobid, attid, stream)

• Upload an attachment, attachment will be compressed automatically.
• @param jobid the job id
• @param attid the attachment name
• @param stream the stream to read from
• @see PUT /jobs/{id}/attachments/{attid}/blob

client.downloadAttachment(jobid, attid, stream)

• Download an attachment
• @param jobid the job id
• @param attid the attachment name
• @param stream the stream to write to
• @see GET /jobs/{id}/attachments/{attid}/blob

client.getLogItems(jobid,start,continuous) 

• Returns the log items
• @param jobid the job id
• @param start the starting index
• @param continuous continuous mode indicator
• @see GET /jobs/{id}/log/items

client.downloadLog(jobid, stream)

• Download the log
• @param jobid the job id
• @param stream the stream to write to
• @see GET /jobs/{id}/log/blob

Event API

The event API let you submit and monitor your jobs in a very simple way.

client.execute(data)

• Submits and monitor a job execution
• @param data the data containing attachments, parameters
• @return the event emitter to attach event callbacks

client.submit(data)

• Submits but do not monitor the job
• @param data the data containing attachments, parameters
• @return the event emitter to attach event callbacks

client.create(data)

• Creates the job, but do not submit nor monitor it.
• @param data the data containing attachments, parameters
• @return the event emitter to attach event callbacks (error and created only)

Status

Under development, module API can change without notice.