node-red-contrib-docloud-api

Node-RED nodes to integrate optimization service into your application.

Pre-requisite

To run this you need a subscription on IBM Decision Optimization on Cloud. For details see IBM Decision Optimization on Cloud.

IBM Decision Optimization on Cloud

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 the API to integrate the service into your application. This module provides a wrapper over the REST API.

Install

Run the following command in the root directory of your Node-RED install.

    npm install node-red-contrib-docloud-api

Usage

Access IBM Decision Optimization on Cloud service.

docloud config

You can find your base URL and API key from Developer -> Get your API Key & base URL link

• url property: the base URL
• key property: your API Key,

'docloud default config' node

You can define a configuaration for each docloud node. If you don't specify a special configuartion for your docloud node, the default one will be used, which is defined in the 'docloud default config' node.

'docloud' node

You can do 3 operations:

• execute
• create
• submit

Check info panel in Node-RED admin console for detailed documents

This nodes emits following events:

• CREATED
• PROCESSED
• INTERRUPTED
• FAILED
• ERROR

You can use 'docloud event' node to catch them.

'docloud job' node

You can do following operations:

• list jobs
• delete jobs
• get job
• delete job
• abort job
• get job execution status
• upload attachment
• download attachment
• get log items
• download log