HOW-TO

  • Getting Started with AIMMS
  • Licensing
    • Activating Licenses Offline
    • Single-User License
      • Install Single-User License
      • Transfer Single-User License to Other Machine
      • Single-User License Troubleshooting
    • Network License
      • Install and Configure a AIMMS Network License
      • Install the AIMMS Network License on a Client Computer
      • Named Users in License Manager
      • Migrate AIMMS Network License Server
    • Academic and Community License
      • Academic and Community License Troubleshooting
  • AIMMS IDE
    • Installing AIMMS
    • Configuring AIMMS IDE
    • Keyboard Shortcuts
    • Sharing AIMMS Project Files
    • Export Code to Another Project
    • AIMMS IDE Troubleshooting
  • AIMMS Language
    • Version Control in AIMMS Projects
    • Coding
      • Run Batch Commands with AIMMS Command Line Tool
      • NBest Operator
      • Run Executable Files
      • Set Encoding Format
      • Zipping and Unzipping Files
      • Analyze Long Execution Time
      • Measure Execution Time
      • Optimize Execution Time
      • Reduce Memory Usage
      • Monitor Memory Usage and Leaks
      • Investigate Memory in Use
      • What is a dump file?
      • Sending a dump file?
      • In model tracing
      • Tracing Procedures
      • Identify Error
      • Customize Settings for Errors and Warnings
      • Get More Log Information
      • Handle errors and warnings
      • Get Log Files
      • Configuring the logging of sessions ran on a AIMMS PRO On-Premise
      • Handling of Integer Sets and Operators
      • Generate Random Numbers
      • Convert String to Numerical Value
      • Remove Elements from a Set
      • Get Name of an AIMMS Case
      • Save a Case from an AIMMS Procedure
      • Standardize Random Data in Distribution Functions
      • Overview: Set, Subset, Index and Element Parameter
      • Solve with Benders Decomposition in CPLEX
      • Finding Unused Identifiers
      • Simplifying Repetitive Loops in AIMMS
      • Model Category Mapping of Items
      • Multiple Indices for a Set
      • Overview: Calendars in AIMMS
      • Identify Differences
      • Libraries Initialization and Termination
      • Identifier Naming Convention
      • Multi timezone applications
      • Write and Read AIMMS Data in Text Format
      • Local Binding vs. Default Binding
      • Check Computations with Units of Measurement
      • Localize Units of Measurement per User
      • Monitor Identifiers for Changes
      • Modeling composite objects
      • ODBC data exchange of composite objects
      • Deploying AIMMS set functionality to composite objects
      • Reporting data over composite objects
      • Hierarchical composite objects
      • Modeling styles for using reference elements
      • Interrupting Execution During a Single Statement
      • Types of Set
    • Modeling
      • Set Stop Criteria for Math Programs
      • Debug Infeasible or Unbounded Results
      • Element after Last
      • Change the Default Solvers Used
      • Select Constraints and Variables for a Math Program Declaration
      • Solve in a Loop
    • Deploying
      • Create Responding Applications
      • Deploy an Application on AIMMS Cloud
      • Develop Multi-Platform Applications
      • Keep WebUI Active During Solve
      • Schedule Regular Jobs
      • Send and Receive Messages
      • Load solver session Results Manually
      • Number of running and pending solver sessions
      • Use the Progress Window in WebUI
      • Troubleshoot Unresponsive Applications
      • Show Intermediate Solutions
      • Publishing, Running and Deleting Apps on AIMMS Cloud
      • Waiting for sub jobs to complete
      • Interrupt the solver session
      • Investigate Behavior of AIMMS PRO Server Session (Job)
      • Using CI/CD with AIMMS
      • Modifying Session Timeout Duration for WebUI Apps
      • Encrypt Projects to Protect Intellectual Property
      • Communicate Data Changes in WebUI
      • Exporting aimmspack for WinUI or WebUI
      • Reduce Exchange Between Client Session and Solver Session
  • Algorithmic Capabilities
    • Adding a Solver
    • How to Link a Solver to AIMMS
    • Connect AIMMS with Gurobi
    • Adjust Engine and Solver Settings
    • Create Local Solver Configuration
    • Retrieve Solver Log Files in an AIMMS PRO On-Premise Setup
    • Retrieve Solver Log Files in AIMMS Developer
    • Constraint Programming
      • Color a Map with Constraint Programming
      • Use Constraint Programming to Solve ROGO Puzzle
      • Generate Multiple Solutions with CP Optimizer
    • GMP
      • The Generated Mathematical Programs
      • Adapt Solve Procedure with Callbacks for GMP
      • Solve with Lazy Constraints
      • Solve MINLP Problems with AOA
      • Tune CPLEX Options from AIMMS
      • Automatic Benders’ Decomposition
      • Check if Variable Values Satisfy Constraints
      • Solve in Parallel with Asynchronous Solver Sessions
    • Mixed Integer Programming
      • Solve with Lazy Constraints
      • Providing an Initial Solution to MIP Solvers
      • Speed Up MIP Solve
      • Use Alternative MIP Solutions with CPLEX Solution Pool
    • Multi-Objective Optimization
      • Use a Multi-Objective Approach
    • Non-Linear Optimization
      • Solving Convex MINLP Problems with AIMMS
      • AIMMS Outer Approximation Algorithm for MINLP (using GMP functionality)
      • Nonlinear Presolve Algorithm in AIMMS
      • Solve MINLP Problems with AOA
    • Optimization Modeling
      • Model a Rounded Variable
      • Debug an Infeasible Model
      • Model Variables with Limited Values
      • Various (Integer) Linear Modeling Tricks
      • Minimize Objective Containing a min Operator
    • Scheduling and Planning
      • Optimize Shift Schedules
      • Optimize Scheduling for Project Planning
      • Reduce the Time Window for Scheduling Jobs
      • Vehicle Routing
        • Testing the Library
        • Explicit Dantzig-Fulkerson-Johnson Formulation
        • Capacitated Vehicle Routing Problem formulation
        • Implicit Dantzig-Fulkerson-Johnson Formulation
        • Miller-Tucker-Zemlin Formulation
        • Capacitated Vehicle Routing Problem Library
        • Time Windows
  • AIMMS Libraries
    • Add AIMMS Libraries
    • Data for Optimization Libaries
    • Repository Library
      • AIMMSXL Library (AXLL)
        • AIMMS Excel Library - AXLL
        • Read Columns of Data from Excel
        • Determine Data Ranges in Excel Files
        • Exchanging Data with Excel Files
      • DataExchange Library (DEX)
        • How to Integrate the Data Exchange Library
        • How to use the Data Exchange Library for extracting files and data
        • Dealing with Different Data Types
        • How to create mappings for matrix-oriented data via name-binds-to
        • Reading Slices of Data via ExternalBinding Mapping Element
      • Email Client Library
        • Using Email Client Library
        • Create Email Templates
      • HTTP Client Library
        • Using HTTP Client Library
        • Extract Data from an XML File
        • Extract XML File from a Server with the HTTP Library
        • Retrieve Geographic Data with Google Maps API
        • Retrieve Geographic Coordinates with Google Maps API
        • Extract Photos Using the Flickr API
        • Convert Audio File with IBM API
        • Use the IBM Image Recognition API
        • Integrate AIMMS with Models Built in Languages Like Python or R
        • Integrate AIMMS with Python
        • Integrate AIMMS with R
      • Unit Test Library
        • Test Driven Development using the AIMMSUnitTest Library
      • WebUI Library
    • Runtime Library
      • Library of Functions and Procedures
      • Retrieve Value of Dynamic Identifier
      • Repeat Data with Model Query and Model Edit
      • Use Formulas as Data
      • Runtime Functions with Arguments
      • Create a Static AIMMS Library from a Runtime Library
  • AIMMS PRO On-Premise & AIMMS Cloud
    • User Management
      • Create PRO User Groups
    • AIMMS PRO On-Premise
      • Migrate AIMMS PRO On-Premise Server to Another Machine
      • Download Server Session Log
      • Size AIMMS PRO On-Premise Hardware
      • Install CDM Service
      • Log CDM
      • Publishing to Offline Servers
      • Change AIMMS PRO On-Premise Service Account
      • Best Practices for Operating AIMMS Cloud
  • Integrations and Data Exchange
    • Exchange Data with the AIMMS Cloud
    • Linking to AIMMS
    • AIMMS Cloud ADLS
      • Data Integration with AIMMS Cloud Azure Data Lake Storage
      • Accessing Azure Data Lake Storage Externally
    • AIMMS Storage
      • Upload and Download Files on AIMMS Cloud
      • Secure File Access
      • Copy Folder Operations in PRO Storage
    • Databases
      • Connecting to and using the AIMMS Cloud Database
      • Which ODBC Drivers
      • How to Use Direct SQL Queries
      • Reading Relations and Indexed Sets from Databases
      • Adapt Model when Linked Database Table is Modified
      • Write Data to a Table
      • Write to a Database Efficiently
      • Write Selected Database Tables
      • Connection String for Access Database Files
      • Link an SQLite Database to a Project
    • Rest API
      • Creating and Connecting Python Service to AIMMS
      • Using OAuth2 for API Authorization with DEX
      • A Framework for Progress, Logging, and Error Handling of Tasks
      • Develop an AIMMS Service
        • Develop, Test, and Deploy an AIMMS Service
        • Development Architecture of an AIMMS Service
        • Conventions Used in the Examples Provided
        • Creating an AIMMS Server App
        • Using AIMMS Services with a Python Application
        • Using AIMMS Services with a VBA Client
      • OpenAPI
        • Overview OpenAPI in AIMMS
        • Using an API with OpenAPI Spec
        • Taking Multiple into Account Calling an OpenAPI REST API
        • Publishing an AIMMS Service
        • Python Client
    • Other Connectors
      • Writing to a Snowflake Database
      • Sudden Microsoft Access Reporting: “Make Sure this is a Valid Datasource”
      • Start a Job via PRO API using Java
      • Start a Job via AIMMS PRO API using C#
      • Exchange Data with External Source
      • Create an External Function with Visual Studio
  • WebUI
    • Core
      • Best Practices in your Application
      • Dos and Don’ts
      • Showing Progress of Long Running Algorithms
      • Selecting Pages for Workflow Panels
      • Comparing Schedules from Scenarios
      • Disable Standard WebUI Functions
      • Uponchange with Arguments
    • Styling
      • Working with Wonderful WebUI Widgets
      • Create Wonderful WebUI Widgets
      • Add Qualitative Color Palettes
      • Consistent Data Coloring on an AIMMS WebUI Page
      • Hiding Default Values
      • Using Scalar Border Annotation
      • Using Table Background Annotation
      • Hiding Widget Header
      • Centering Cells in Table Widget
      • Change Widget Styles with CSS
      • Adding a Logo to an AIMMS WebUI App
      • Change Hover and Select Effects for WebUI Charts
      • Display an On/Off Switch in Widgets
      • Adding an Icon on your Menu Bar
    • Widgets
      • Zoom and Scroll in a Gantt Chart
      • Sailing Across the World
      • Refreshing an Image Widget Without Changing the File Name
      • Adding an Icon on your Button
  • Software Evolution
    • Update the Project’s AIMMS Version
    • Overview: Deprecation of Compound Sets
    • Prepare for the Deprecation of Compound Sets
    • Support for Defining Procedure in New Compiler
    • Install Side-by-Side Drivers
    • Upgrade WebUI Page Actions
    • Upgrade Old WebUI Maps
    • Convert a GAMS Model or AIMMS 3 Model to an AIMMS 4 Model
    • Convert Files from DAT to DATA
    • Upgrade an AIMMS PRO On-Premise Installation
    • Check Version Dependencies for AIMMS Developer and AIMMS PRO On-Premise
    • Using UNICODE in Maintained AIMMS Applications
    • Update WebUI to Newer AIMMS Version
    • Error Message “tlsv1 alert protocol version”
    • Evolution of AIMMS using Transport Layer Security
    • Unsupported Browser
    • Dollar or Pipe Sign?
    • Empty WebUI After Upgrade
    • Change the Frequency of Progress Updates
    • WinUI
      • Align Objects in WinUI
      • Change Views of 2D Charts in a WinUI Page
      • Enable the Page Manager
      • Add a Custom Startup Image in WinUI
      • More Logging of WinUI Published Applications
      • Openstreetmap Images Missing from Network Object
  • Examples
    • Examples vs Features
    • Demo Applications
      • Contract Allocation
      • Employee Scheduling
      • Knapsack Problem
      • Reindeer Pairing
      • Traveling Salesman
      • Vessel Scheduling
      • EV Charging Location
    • Functional Applications
      • Geolocation AbstractAPI
      • Demand Forecasting
      • Bias in AI
    • Other Applications
      • Bandwidth Allocation
      • Cutting Stock
      • Diet Problem
      • Employee Training
      • Facility Location Choice
      • Farm Planning
      • File Merge
      • Inventory Control
      • Investment Portfolio Selection
      • Media Selection
      • Performance Assessment
      • Power System Expansion
      • Refinery Pooling Planning
      • Telecommunication Network Design
      • Two Level Decision
      • 3D Chart
      • AIMMS API
      • Arcs and Nodes
      • Calendar
      • Camping
      • Chance Constraints
      • Database Inspection
      • Database Interface Generation
      • Data Feed
      • Date Aggregation
      • Distributed Solver Sessions
      • Distributions
      • Email and Sound Support
      • Error Handling
      • Experiment
      • External Procedure
      • Gantt Chart
      • GIS Support
      • Goal Programming
      • Horizon
      • Indexed Page
      • Infeasible Data
      • Interrupt AIMMS Externally
      • Linked Objects
      • Model Edit API
      • Model Edit Functions
      • MPS Functions
      • Multi Start
      • Nested Solve
      • Oil Well Drilling
      • Power System Expansion RO
      • Print Pages
      • Rolling Horizon
      • Stochastic Programming
      • Tea Consumption
      • Chemical Engineering: Blending problem
      • Chemical Engineering: Chemical Equilibrium problem
      • Energy: Oil pipeline design
      • Energy: Water Distribution Network Design
      • Power Systems Planning - Methods and Applications
      • Engineering: 2D Strip Packing
      • Engineering: Goddard rocket
      • Engineering: Hanging chain
      • Engineering: Largest small polygon
      • Engineering: Robot arm
      • Engineering: Structural Optimization
      • Location: Capacitated warehouse location
      • Location: Capacitated facility location problem (CFLP)
      • Lot Sizing: Multi level bucket
      • Lot Sizing: Single level big bucket
      • Lot Sizing: Single level small bucket
      • Lot Sizing: Single level small bucket with two items
      • Miscellaneous: Asynchronous solver sessions
      • Miscellaneous: Multistart
      • Multiple Solutions: Dice problem
      • Production Planning: Machine scheduling
      • Routing: Capacitated Vehicle Routing Problem
      • Routing: Capacitated Vehicle Routing Problem with Time Windows
      • Telecommunications: Delay constrained routing
      • Telecommunications: Filter design
      • Telecommunications: Capacitated network design problem
      • Transportation: Aircraft Assignment
      • Transportation: Aircraft landing
      • Transportation: Piecewise linear transportation
      • Uncertainty: Synchronous Optical Network Ring Design
      • Uncertainty: Production Planning - Robust Optimization
      • Uncertainty: Production Planning - Stochastic Programming
      • Car Selection
      • Circle Packing
      • Data Reconciliation
      • Distribution Center Allocation
      • Economic Exchange Equilibrium
      • Flow Shop
      • Gate Assignment problem
      • Life Cycle Consumption
      • Project Analysis
      • Railway Stock
      • Sudoku
      • Traffic Equilibrium
      • Transport Model
  • Toolkit
    • Comparing Profiler Runs
    • Stopwatch Library
    • Zip Library
    • DataLake Tools
    • Control Panel
  • Recently Added
AIMMS How-To
AIMMS Logo
  • How-To »
  • Integrations and Data Exchange »
  • Rest API »
  • OpenAPI
  • Edit on Github

OpenAPI

These topics help you to use the Data Exchange Library with your AIMMS project.

  • Overview OpenAPI in AIMMS
  • Using an API with OpenAPI Spec
  • Taking Multiple into Account Calling an OpenAPI REST API
  • Publishing an AIMMS Service
  • Python Client
Last updated: Nov 12, 2024

Help & Feedback

Docs

Edit this page to fix an error or add an improvement in a pull request
Create an issue to suggest an improvement to this page

Product

Create a topic if there's something you don't like about this feature
Propose functionality by submitting a feature request

Support

Not what you where looking for? Search the docs

Remember we also have Community support

Still having trouble ? Reach out to us


Next Previous
AIMMS
AIMMS COMMUNITY
AIMMS DOCS
DISCLAIMER
PRIVACY STATEMENT
© 1989 - 2025 AIMMS B.V.