💧
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. OLI Process API

Get list of all uploaded ProcessAPI packages

Retrieve all uploaded ProcessAPI packages

GET https://api.olisystems.com/process/all

method returns a paginated list of all process packages.

Headers

Name
Type
Description

Authorization*

String

Bearer {access_token}

Parameters

Name
Type
Description
Default Value
Max Value

page (optional)

Integer

Start page

1

100000

limit (optional)

Integer

Results per page

20

100

 {
    "data": [
        {
            "channelId": "aa76fabf-06d2-4c98-a8fa-4caad454b20f",
            "comments": "This is a comment",
            "createdAt": 1590122290.23704,
            "createdBy": "5e44bec6-1cfd-472f-8e85-eb7fe715f47d",
            "creatorName": "John Smith",
            "processId": "afd5a8c1-eec5-4bf7-bd39-13e6a3f38c4b",
            "processName": "case_1:pH nuetralization with tear",
            "processStatus": "PUBLISHED",
            "totalcount": 1184,
            "updatedAt": 1590122820.73076,
            "updatedBy": "5e44bec6-1cfd-472f-8e85-eb7fe715f47d",
            "updatorName": "John Smith"
        },
        {...},
        {...}
   ],
    "message": "Process list returned successfully",
    "metadata": {
        "count": 20,
        "page": 1,
        "totalCount": 1184
    },
    "status": "SUCCESS"
}
PreviousCreating a Process API packageNextGet input specs for Process API package

Last updated 6 months ago

Was this helpful?