REST API Endpoints

The following REST API endpoints are related to ,or can be used in, Wizards:

  • /create_working_dir: Create a new project working directory. Working directory is created relative to the configured projects directory. The provided base_name is used to create a unique directory name.

  • /get_remote_dispatch_list: Get the submission target list defined in the wizard.

  • /get_wizard_doc: Get the wizard documentation.

  • /get_wizard_hash: Get the wizard integrity hash. This can be used to ensure the wizard integrity during maintenance periods.

  • /monitoring/{project_id}: Display optiSLang project monitoring by project ID. This can be used to redirect directly to the project monitoring after the project has been started and the project ID has been returned by the project starter.

  • /python_command: Execute an wizard Python script on the back end. Only pre-installed wizard Python scripts can be executed. The actual script path is computed server side using the configured Wizards base directory and provided wizard and script file names.

  • /start_project: Uses an wizard Python script for to customize how optiSLang starts. Only the pre-installed wizard Python scripts can be used. The actual script path is computed server side using the configured Wizards base directory and provided wizard and script file names.

  • /upload: Upload a file. Can be an optiSLang project, or an arbitrary project reference file.