💧
OLI API
  • Welcome to the OLI API documentation
  • Basic workflow
  • Authentication
    • Bearer Token
    • API Keys
      • Generate a Key
      • List All Keys
      • Delete a Key
  • Generating chemistry model files
    • ChemBuilder API
      • Getting Started with ChemBuilder
        • Set Thermodynamic Framework
        • Include Private Databanks
        • Include Inflows
          • Include Assays
          • Include Pseudocomponent
        • Choose Phases
        • Specify Model Name
        • Choose Redox
        • Choose Solids
        • Add Kinetics
      • ChemBuilder Query
        • Species Query
        • Redox Query
        • Solid Phase Query
        • Databank Query
        • Kinetics Query
        • Query Output Results
      • Supporting Information for ChemBuilder
        • Add Comment
        • "enabled" Keyword
        • ChemBuilder Errors
    • Chemistry Wizard
  • Uploading chemistry model files
  • Get list of uploaded files
  • Quickstart example: Python
  • Known issues and Limitations
  • OLI ENGINE API
    • Main methods
      • API call blueprint
      • Chemistry information
      • Isothermal flash
      • Isenthalpic flash
      • Bubble point flash
      • Dew point flash
      • Vapor amount flash
      • Vapor fraction flash
      • Isochoric flash
      • set pH flash
      • Precipitation point flash
      • Autoclave
      • Custom flash
      • Corrosion contact surfaces
      • Corrosion rates
      • Water analysis
  • Additional methods
    • Flash history - Chemistry model
    • Result - by jobId
    • delete file
    • cancel run
  • Inflows input
  • Optional inputs
  • Kinetic calculation inputs
  • Kinetic calculation outputs
  • Input units
  • User defined output unit set
  • Survey calculation
  • Stream output
  • Error/Warning output
  • Definition of terms
  • OLI Process API
    • Uploading a Process API package
      • Creating a Process API package
    • Get list of all uploaded ProcessAPI packages
    • Get input specs for Process API package
    • Get output specs for ProcessAPI package
    • Run a Process API calculation
    • Get calculation status and results
  • Deleting a process package
  • Undelete a process package
  • Process API input specification
    • "data" object
      • "flowsheet" object
        • "chemical-info" object
        • "general-info" object
        • "properties" object
        • "units_set_info" object
  • OLI ScaleChem API
    • Uploading chemistry model files for ScaleChem API
    • Get list of uploaded ScaleChem model files
    • Main methods
      • Brine analysis
      • Gas analysis
      • Oil analysis
      • Mixer calculation
      • Scale scenario
Powered by GitBook
On this page

Was this helpful?

  1. Generating chemistry model files
  2. ChemBuilder API
  3. Supporting Information for ChemBuilder

ChemBuilder Errors

This page outlines several error messages that users may encounter when utilizing Chemistry Builder. The following errors occur specifically when the thermodynamic framework value is misspelled:

{
    "data": {
        "error": {
            "error": {
                "messages": [
                    {
                        "code": 0,
                        "functionName": "oli_process_api::ChemistryBuilderAPI::setChemModel::<lambda_76b84038b7c916aae3a6b0c08ba8103d>::operator ()",
                        "message": [
                            "The input name of thermodynamic framework 'Aueous (H+ ion)' is not supported; Please enter a valid name of supported thermodynamic frameworks"
                        ],
                        "messageType": "error",
                        "objectType": "ChemistryBuilderAPI"
                    },
                    {
                        "code": 0,
                        "functionName": "oli_process_api::ChemistryBuilderAPI::initialize::<lambda_3f42c0f8e472529a61e2551c61fd79a7>::()::<lambda_280f20c46ba155cc50138f64d484b31a>::operator ()",
                        "message": [
                            "Fail to create the chemistry model; Query species exits"
                        ],
                        "messageType": "error",
                        "objectType": "ChemistryBuilderAPI"
                    }
                ]
            }
        },
        "metaData": {
            "executionTime": {
                "unit": "ms",
                "value": 1.0
            }
        }
    },
    "message": "Chemistry could not be generated",
    "status": "FAILED"
}

JSON Format Errors

Users may occasionally encounter issues with formatting JSON input files, as illustrated in the following example:

{ 
    "name": "H2O" // A comma is missing following the input 
    "enabled": false 
} 

Missing commas or parentheses in the JSON input file can lead to the following error:

"Errors in parsing input JSON file; Check the format and argument of every keyword in the JSON file"

Previous"enabled" KeywordNextChemistry Wizard

Last updated 11 months ago

Was this helpful?