💧
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
  • Uploading a package using the API
  • upload a Process API package
  • Response description

Was this helpful?

  1. OLI Process API

Uploading a Process API package

A process API package that is exported from OLI Flowsheet, and needs to be uploaded into the users account.

Uploading a package using the API

upload a Process API package

POST https://api.olisystems.com/channel/upload/package?status=Published

uploads the process API package to the OLI cloud as multipart/form-data

Headers

Name
Type
Description

Authorization*

String

Bearer {access_token}

Request Body

Name
Type
Description

files*

String

{
    "file": [
        {
            "filename": "OLIProcessAPI.pkg",
            "id": "6408237f-286c-402b-890a-e67f2453761b"
        }
    ],
    "status": "UPLOADED",
    "type": "package"
}
{
    "message": "Authorization 'Bearer ' Token not found",
    "status": "FAILED"
}

Response description

field
type
description

file

array object

uploaded package information:

file.filename

string

name of file with extension

file.id

string

unique identifier for the uploaded file ProcessId

status

string

"UPLOADED" or "FAILED"

type

string

type of file "package"

PreviousDefinition of termsNextCreating a Process API package

Last updated 2 years ago

Was this helpful?