2016-03-11 16:16:09 +00:00
|
|
|
/v2/projects/{project_id}/close
|
2016-03-11 14:21:21 +00:00
|
|
|
------------------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
.. contents::
|
|
|
|
|
|
2016-03-11 16:16:09 +00:00
|
|
|
POST /v2/projects/**{project_id}**/close
|
2016-03-11 14:21:21 +00:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
Close a project
|
|
|
|
|
|
|
|
|
|
Parameters
|
|
|
|
|
**********
|
2016-06-04 08:40:39 +00:00
|
|
|
- **project_id**: Project UUID
|
2016-03-11 14:21:21 +00:00
|
|
|
|
|
|
|
|
Response status codes
|
|
|
|
|
**********************
|
|
|
|
|
- **404**: The project doesn't exist
|
|
|
|
|
- **204**: The project has been closed
|
|
|
|
|
|
2016-06-17 09:12:22 +00:00
|
|
|
Output
|
|
|
|
|
*******
|
|
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
|
|
<table>
|
|
|
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
|
|
|
|
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
|
|
|
|
|
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
|
|
|
|
|
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
|
|
|
|
|
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
|
|
|
|
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
2016-03-11 16:20:09 +00:00
|
|
|
Sample session
|
|
|
|
|
***************
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: ../../../examples/controller_post_projectsprojectidclose.txt
|
|
|
|
|
|
