💧
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
  • Get list of packages in a private channel
  • Download package by file id
  • Delete uploaded package by file id

Was this helpful?

  1. OLI ScaleChem API

Get list of uploaded ScaleChem model files

method returns a paginated list of all ScaleChem model files.

Get list of packages in a private channel

GET https://api.olisystems.com/channel/scalechem

Name
Type
Description

Authorization

String

Bearer {access_tokentabl

Parameters

Name
Type
Description
Default Value
Max Value

page (optional)

Integer

Start page

0

100000

count (optional)

Integer

Results per page

20

100

{
  "data": {
    "files": [
      {
        "createdAt": "Tue, 15 Mar 2022 17:28:01 GMT",
        "createdBy": "bbb27a13-bf4b-45c3-af76-a8a4ea8fd27d",
        "creatorName": "creater name",
        "fileId": "6d73c011-8eaf-4a1c-9ced-27aa1e27e614",
        "name": "mixerAll.zip",
        "path": "OLI_APP_FILES/00130000000JsxhAAC/scalechem/bbb27a13-bf4b-45c3-af76-a8a4ea8fd27d/6d73c011-8eaf-4a1c-9ced-27aa1e27e614/mixerAll.zip",
        "status": "ACTIVE",
        "updatedAt": "Tue, 15 Mar 2022 17:28:01 GMT",
        "updatedBy": "bbb27a13-bf4b-45c3-af76-a8a4ea8fd27d",
        "updatorName": "update name"
      },
      {
        "createdAt": "Tue, 15 Mar 2022 17:30:10 GMT",
        "createdBy": "bbb27a13-bf4b-45c3-af76-a8a4ea8fd27d",
        "creatorName": "creater name",
        "fileId": "3a078037-2bd8-4e75-91d0-c10ba322d3b0",
        "name": "mixerAll2.zip",
        "path": "OLI_APP_FILES/00130000000JsxhAAC/scalechem/bbb27a13-bf4b-45c3-af76-a8a4ea8fd27d/3a078037-2bd8-4e75-91d0-c10ba322d3b0/mixerAll.zip",
        "status": "ACTIVE",
        "updatedAt": "Tue, 15 Mar 2022 17:30:10 GMT",
        "updatedBy": "bbb27a13-bf4b-45c3-af76-a8a4ea8fd27d",
        "updatorName": "update name"
      }]
    },
  "message": "Channel file and package list returned successfully",
  "status": "SUCCESS"
  }
}

Download package by file id

GET https://api.olisystems.com/channel/download/file/{fileId}

Headers

Name
Type
Description

Authorization

String

Bearer {access_token}

Delete uploaded package by file id

DELETE https://api.olisystems.com/channel/file/{fileId}

Headers

Name
Type
Description

Authorization

String

Bearer {access_token}

{
  "message": "File deleted successfully",
  "status": "SUCCESS"
}
PreviousUploading chemistry model files for ScaleChem APINextMain methods

Last updated 5 months ago

Was this helpful?