REST API

DrawML WAS-flask REST API

URI(default)	Method	Description	Default
/	GET	redirect to index
/index	GET	initial page
/auth/signin	GET	signin page
/auth/signout	GET	signout
/auth/register	GET	register
/experiments/	GET	get all user's exp
/experiments/<exp_id>	GET	get specific exp
/experiments/	POST	create exp
/experiments/<exp_id>	PATCH	update exp
/experiments/<exp_id>	DELETE	delete exp
/experiments/<exp_id>run	POST	run exp
/experiments/<exp_id>stop	POST	stop exp
/experiments/<exp_id>status	GET	get experiement status
/data/upload	GET	show upload form
/data/	POST	upload new file
/data/	GET	get all user's data files
/data/<data_id>	GET	get specific data file
/data/<data_id>	PATCH	update data(name)
/data/<data_id>	DELETE	delete data

---

/experiments/ (POST, create)

Params(default) :

{
  "exp_data":{
    "name": "myexp",
    "drawing":"febric...",
    "xml": "<experiment>..</experiment>",
    "input": 2048
  }
}

Return value :

Description :

---

/experiments/exp_id (DELETE)

Params(default) : none

Return value :

Description :

---

/experiments/exp_id (PATCH, update)

Params(default) :

{
  "exp_data":{
    "name": "myexp_after",
    "drawing":"febric..",
    "xml": "<experiment>..</experiment>",
    "input": 2048
  }
}

Return value :

Description :

---

/experiments/run (POST)

Params(default) :

<experiment>
    <input>

    </input>
    <model>
        <type>logistic_regression</type>
        <initializer>
            <type>random_uniform</type> <!-- valid type -->
            <min>-1.0</min>     <!-- float -->
            <max>1.0</max>    <!-- float -->
        </initializer>
        <optimizer>
            <type>gradient_descent</type>           <!-- valid type -->
            <learning_rate>0.01</learning_rate>     <!-- float -->
        </optimizer>
        <regularization>
            <enable>true</enable>
            <lambda>0.0</lambda>
        </regularization>
        <training_epoch>1024</training_epoch>     <!-- unsigned -->
    </model>
</experiment>

Return value :

Description :

---

| /data/<data_id> | PATCH | update data(name) | |

{
  "data":{
    "name": "file_name",
  }
}

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