REST API for Embedded Python Execution

All REST Endpoints

Export Environment

The operations from the Export Environment category.

Export conda environment to YAML: Method: get
Path: /py-scripts/v2/envs/{envName}

Get Version Metadata

The operations from the Get Version Metadata category.

Retrieve metadata of available versions: Method: get
Path: /py-scripts
Retrieve Metadata of Version 2: Method: get
Path: /py-scripts/v2

List Environments

The operations from the List Environments category.

List OML4Py Conda Environments: Method: get
Path: /py-scripts/v2/envs

List Scripts

The operations from the List Scripts category.

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

Preload Environments

The operations from the Preload Environments category.

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

Run Scripts

The operations from the Run Scripts category.

Delete an Asynchronous Job: Method: delete
Path: /py-scripts/v2/jobs/{jobId}
Retrieve All Asynchronous Jobs: Method: get
Path: /py-scripts/v2/jobs
Retrieve Asynchronous Job Result: Method: get
Path: /py-scripts/v2/jobs/{jobId}/result
Retrieve Asynchronous Job Status: Method: get
Path: /py-scripts/v2/jobs/{jobId}
Run a Python Function: Method: post
Path: /py-scripts/v2/do-eval/{scriptName}
Run a Python Function multiple times: Method: post
Path: /py-scripts/v2/index-apply/{scriptName}
Run a Python Function multiple times with Script Owner Specified: Method: post
Path: /py-scripts/v2/index-apply/{scriptName}/{ownerName}
Run a Python Function on Chunks of Rows: Method: post
Path: /py-scripts/v2/row-apply/{scriptName}
Run a Python Function on Chunks of Rows with Script Owner Specified: Method: post
Path: /py-scripts/v2/row-apply/{scriptName}/{ownerName}
Run a Python Function on Grouped Data: Method: post
Path: /py-scripts/v2/group-apply/{scriptName}
Run a Python Function on Grouped Data with Script Owner Specified: Method: post
Path: /py-scripts/v2/group-apply/{scriptName}/{ownerName}
Run a Python Function on Specified Data: Method: post
Path: /py-scripts/v2/table-apply/{scriptName}
Run a Python Function on Specified Data with Script Owner Specified: Method: post
Path: /py-scripts/v2/table-apply/{scriptName}/{ownerName}
Run a Python Function with Script Owner Specified: Method: post
Path: /py-scripts/v2/do-eval/{scriptName}/{ownerName}