💧
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
  • corrosion contact surface
  • Response (status = PROCESSED)

Was this helpful?

  1. OLI ENGINE API
  2. Main methods

Corrosion contact surfaces

This function is used to obtain the name of contact surface metals which OLI supports for corrosion rate calculations.

corrosion contact surface

GET https://api.olisystems.com/engine/file/{dbs_file_id}/corrosion-contact-surface

get the corrosion contact surfaces applicable for the given chemistry model

Headers

Name
Type
Description

Authorization

string

Bearer {access_token}

{
	"code": 200,
	"data": {
		"file_id": "dee854a6-59db-487d-ad08-a20dee691133",
		"jobId": "f6b3375e-cd0f-4ace-a5ee-71e047b76754",
		"resultsLink": "https://api.olisystems.com/result/flash/f6b3375e-cd0f-4ace-a5ee-71e047b76754?context=engine",
		"status": "IN PROGRESS"
	},
	"message": "Process execution started Successfully",
	"status": "SUCCESS"
}

Response (status = PROCESSED)

{
    "data": {
        "result": {
            "contactSurfaces": {
                "Aluminum": [
                    "Aluminum 1199 (pure)",
                    "Aluminum 1100"
                ],
                "Copper based alloy": [
                    "Cu",
                    "CuNi 9010",
                    "CuNi 7030"
                ],
                "Iron/Mild steel": [
                    "Fe (zone refined)",
                    "Fe (pure)",
                    "Carbon steel G10100 (generic)",
                    "Carbon steel A212B",
                    "Carbon steel A216",
                    "Carbon steel 1018"
                ],
                "Nickel based alloy": [
                    "Ni",
                    "Alloy 600",
                    "Alloy 690",
                    "Alloy 825",
                    "Alloy 625",
                    "Alloy C-276",
                    "Alloy C-22",
                    "Alloy 28",
                    "Alloy 29",
                    "Alloy 2535",
                    "Alloy 2550"
                ],
                "Stainless steel": [
                    "13%Cr stainless steel",
                    "Super13Cr stainless steel",
                    "Super15Cr stainless steel",
                    "Super17Cr stainless steel",
                    "Stainless steel 304",
                    "Stainless steel 316",
                    "Alloy 254SMO",
                    "Duplex stainless 2205",
                    "Duplex stainless 2507"
                ]
            }
        }
    },
    "message": "Results returned successfully",
    "status": "PROCESSED"
}

The keys inside data.result.contactSurfaces are the class names of contact surface metals. Each class holds the available contact surface metals under it. Not all class names might be shown in the result. This depends on the metal element inflows that are specified in the chemistry model.

data.result.contactSurfaces

type

required inflow in chemistry model

Iron/Mild steel

[string]

FEEL

Stainless steel

[string]

FEEL

Aluminum

[string]

ALEL

Nickel based alloy

[string]

NIEL

Copper based alloy

[string]

CUEL

PreviousCustom flashNextCorrosion rates

Last updated 8 months ago

Was this helpful?