REST API for Embedded R Execution

All REST Endpoints

Conda Environments

The operations from the Conda Environments category.

Get Version Metadata

The operations from the Get Version Metadata category.

Job Management

The operations from the Job Management category.

Cancel an Asynchronous Job: Method: post
Path: /r-scripts/v2/jobs/{jobId}/cancel
Delete an Asynchronous Job: Method: delete
Path: /r-scripts/v2/jobs/{jobId}
Delete Asynchronous Jobs Matching Filters: Method: delete
Path: /r-scripts/v2/jobs
Retrieve All Asynchronous Jobs or Based on Matching Filters: Method: get
Path: /r-scripts/v2/jobs
Retrieve Asynchronous Job Result: Method: get
Path: /r-scripts/v2/jobs/{jobId}/result
Retrieve Asynchronous Job Status: Method: get
Path: /r-scripts/v2/jobs/{jobId}

List Scripts

The operations from the List Scripts category.

List Scripts: Method: get
Path: /r-scripts/v2/scripts
List Scripts with Specific Type: Method: get
Path: /r-scripts/v2/scripts/{scriptType}

Preload Environments

The operations from the Preload Environments category.

Delete a Preloaded Conda Environment for OML4R: Method: delete
Path: /r-scripts/v2/preload/conda/{envName}
List Preloaded Conda Environments for OML4R: Method: get
Path: /r-scripts/v2/preload/conda
Preload a Conda Environment for OML4R: Method: post
Path: /r-scripts/v2/preload/conda

Run Scripts

The operations from the Run Scripts category.

Run an R Function: Method: post
Path: /r-scripts/v2/do-eval/{scriptName}
Run an R Function multiple times: Method: post
Path: /r-scripts/v2/index-apply/{scriptName}
Run an R Function multiple times with Script Owner Specified: Method: post
Path: /r-scripts/v2/index-apply/{scriptName}/{ownerName}
Run an R Function on Chunks of Rows: Method: post
Path: /r-scripts/v2/row-apply/{scriptName}
Run an R Function on Chunks of Rows with Script Owner Specified: Method: post
Path: /r-scripts/v2/row-apply/{scriptName}/{ownerName}
Run an R Function on Grouped Data: Method: post
Path: /r-scripts/v2/group-apply/{scriptName}
Run an R Function on Grouped Data with Script Owner Specified: Method: post
Path: /r-scripts/v2/group-apply/{scriptName}/{ownerName}
Run an R Function on Specified Data: Method: post
Path: /r-scripts/v2/table-apply/{scriptName}
Run an R Function on Specified Data with Script Owner Specified: Method: post
Path: /r-scripts/v2/table-apply/{scriptName}/{ownerName}
Run an R Function with Script Owner Specified: Method: post
Path: /r-scripts/v2/do-eval/{scriptName}/{ownerName}