Skip to content

Oms API DELETE from user files

amc1999 edited this page Jun 13, 2024 · 1 revision

DELETE file or folder from user files directory on the server.

If user files access enabled in server configuration then user can upload or download files, create or delete folders in user files directory.

This is a beta version and may change in the future.

Method:

DELETE /api/files/delete/:path
DELETE /api/files/delete?path=....

Arguments:

:path - (required) path to the new sub-directory to be creaded.

If sub-directory not exists then method does nothing and return success.

Call examples:

curl -v -X DELETE http://localhost:4040/api/files/delete/dir
curl -v -X DELETE http://localhost:4040/api/files/delete?path=dir%2Fsub-dir

Please notice URL query parameters: ?path=dir%2Fsub-dir which is used to specify dir/sub-dir path.

User files may be located above download and upload directory on the server:

  models/
        home/       -> user personal home directory
            io/        -> user files directory
              download    -> user directory for download files
              upload      -> user directory to upload files

Above is a typical server folder structure with user files directory location by default. This method would not delete download or upload directory if oms server is running with downloads or uploads enabled:

oms -oms.HomeDir models/home -oms.AllowDownload -oms.AllowUpload

Home

Getting Started

Model development in OpenM++

Using OpenM++

Model Development Topics

OpenM++ web-service: API and cloud setup

Using OpenM++ from Python and R

Docker

OpenM++ Development

OpenM++ Design, Roadmap and Status

OpenM++ web-service API

GET Model Metadata

GET Model Extras

GET Model Run results metadata

GET Model Workset metadata: set of input parameters

Read Parameters, Output Tables or Microdata values

GET Parameters, Output Tables or Microdata values

GET Parameters, Output Tables or Microdata as CSV

GET Modeling Task metadata and task run history

Update Model Profile: set of key-value options

Update Model Workset: set of input parameters

Update Model Runs

Update Modeling Tasks

Run Models: run models and monitor progress

Download model, model run results or input parameters

Upload model runs or worksets (input scenarios)

Download and upload user files

User: manage user settings

Model run jobs and service state

Administrative: manage web-service state

Clone this wiki locally