Skip to content

REST API

ovekyc edited this page Aug 30, 2016 · 25 revisions

DrawML WAS-flask REST API

URI(default) Method Description Default
/ GET redirect to index
/index GET initial page index
/experiment/<user_id> GET get all user's exp index
/experiment/<user_id>/<exp_name> GET get specific exp index, ''
/experiment/ POST create exp
/experiment/<user_id>/<exp_name> PATCH update exp
/experiment/<user_id>/<exp_name> DELETE delete exp
/data/upload GET show upload form
/data/upload POST upload new file
/data/<user_id> GET get all user's data files index
/data/<user_id>/<data_name> GET get specific data file index, ''
/data/<user_id>/<data_name> DELETE delete data

/experiment/ (POST, create)

Params(default) :
{
  "exp_data":{
    "name": "myexp",
    "user_id": "user1",
    "drawing":"febric...",
    "xml": "<experiment>..</experiment>",
    "input": 2048
  }
}
Return value :
Description :

/experiment/delete

Params(default) :
{
  "exp_data":{
    "name": "myexp",
    "user_id": "user1"
  }
}
Return value :
Description :

/experiment/ (PUT, update)

Params(default) :
{
  "exp_name":"myexp_before",
  "exp_data":{
    "name": "myexp_after",
    "user_id": "user1",
    "drawing":"febric..",
    "xml": "<experiment>..</experiment>",
    "input": 2048
  }
}
Return value :
Description :

Reference http://blog.mwaysolutions.com/2014/06/05/10-best-practices-for-better-restful-api/

Clone this wiki locally