Using the REST API

This chapter introduces the RASON REST API function calls that may be used to analyze a model, solve an optimization or stochastic optimization model, run a simulation or perform a data science task using either the Try It Page on www.rason.com or from within your own application.

For small, simple models that can be solved in limited memory within 30 seconds of CPU time, you can run an optimization, simulation or data science task and get results with a single API call: POST rason.net/api/optimize for optimization, POST rason.net/api/simulate for simulation or POST rason.net/api/datamine for data science. To keep your application response time acceptable to your user, you should use this endpoint judiciously.

For larger models that require more time or memory, you can use separate API calls to (i) upload your model plus data files, create a model resource on the RASON server, (ii) start an optimization, simulation or data science task, (iii) check on its status and get progress information and finally (iv) retrieve results when the solution process is complete. If necessary, you can stop a long run in progress with an API call.

Other API calls allow you to diagnose a model to determine its type (linear, quadratic, nonlinear, etc.) and size before solving it (mostly useful in model design and development), retrieve a model resource that you've previously created (including the full text of the model), update the model text of an existing model resource, get a list of all the model resources you've created and delete a model resource.