Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Authenticate
• Send Requests
• Return Values
• Status Codes
• Specify a Service Level
• Asynchronous Script Execution
• Timeouts for Synchronous and Asynchronous Scripts Execution
• Scripts Used in Examples
• Use Conda Environments

Tasks

• Get Version Metadata
  • Retrieve metadata of available versions
  • Retrieve Metadata of Version 1
  • Retrieve Metadata of Version 2
• List Environments
  • List OML4R Conda Environments
  • List OML4R Conda Environments V1
• List Scripts
  • List Scripts
  • List Scripts V1
  • List Scripts with Specific Type
• Run Scripts
  • Delete an Asynchronous Job
  • Retrieve All Asynchronous Jobs
  • Retrieve Asynchronous Job Result
  • Retrieve Asynchronous Job Status
  • Run an R Function
  • Run an R Function multiple times
  • Run an R Function multiple times with Script Owner Specified
  • Run an R Function on Chunks of Rows
  • Run an R Function on Chunks of Rows with Script Owner Specified
  • Run an R Function on Grouped Data
  • Run an R Function on Grouped Data with Script Owner Specified
  • Run an R Function on Specified Data
  • Run an R Function on Specified Data with Script Owner Specified
  • Run an R Function with Script Owner Specified
• Run Scripts V1 - Deprecated
  • Delete Asynchronous Job
  • Retrieve Asynchronous Job Result
  • Retrieve Asynchronous Job Status
  • Run an R Function
  • Run an R Function multiple times
  • Run an R Function multiple times with Script Owner Specified
  • Run an R Function on Chunks of Rows
  • Run an R Function on Chunks of Rows with Script Owner Specified
  • Run an R Function on Grouped Data
  • Run an R Function on Grouped Data with Script Owner Specified
  • Run an R Function on Specified Data
  • Run an R Function on Specified Data with Script Owner Specified
  • Run an R Function with Script Owner Specified