World Modeler Server™ API Programmers Resource Center
If you're a software developer working with Quantellia's World Modeler™ Server, you can access the online documentation
library from this page, along with a live, interactive API test harness that uses
Swagger UI™.
How to find what you're looking for
There are several resources available for World Modeler Server API programmers, and which is appropriate depends on your level of familiarity with the interface, and what you are trying to find out.
What pre-requisite knowledge do I need?
All of the documentation and other resources this site makes available is targeted at programmers and other people with technical skills and assumes you are familiar with the following concepts:
- The REST (Representative State Transfer) protocol for accessing resources on remote systems.
- HTTP, including the concepts of:
- "methods" or "verbs",
- URLs, headers, and bodies of HTTP requests and responses
- The JSON format used for serializing objects to strings.
- Basic knowledge of JavaScript expressions, or at least the expression syntax from a comparable procedural language.
How much do I need to know about Decision Intelligence?
Since World Modeler is a Decision Intelligence platform, you will need to understand basic elements of Decision Intelligence to make sense of what the API calls are intended to do. There are some excellent books available about Decision Intelligence which start with first principles and examine the subject in great depth, for example:
- Link: How Decision Intelligence Connects Data, Actions, and Outcomes for a Better World by Lorien Pratt, and
- The Decision Intelligence Handbook by Lorien Pratt and Nadine Malcolm
In addition, Quantellia offers both self-study and live-attendance courses that let you learn about Decision Intelligence from experts.
While the above are excellent resources for gaining an in-depth understanding of Decision Intelligence (DI), all the DI background you'll require to effectively utilize the documentation on this site is available in the section on Decision Models in the Programmers Guide.
I'm new to World Modeler Server API
If you are learning how to use the World Modeler Server API, begin by reading through the World Modeler Server API Programmers Guide. Then follow up by exploring and trying out the API in the REST API Documentation.
I have a good understanding of the API, but I need specifications for invoking a particular function.
The World Modeler Server REST API Documentation lists all the REST API calls and provides information about how to call each one along with a short description of how it operates. More detailed information on each function may be availabe in the World Modeler.NET API Reference, which contains detailed information covering the entire World Modeler Server system.
Documentation Resources
Links to each of the documentation resources are provided below.