/v1/projects
----------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v1/projects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
List projects opened on the server
Response status codes
**********************
- **200**: Project list
Sample session
***************
.. literalinclude:: ../../examples/get_projects.txt
POST /v1/projects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new project on the server
Response status codes
**********************
- **201**: Project created
- **409**: Project already created
Input
*******
.. raw:: html
Name | Mandatory | Type | Description |
name | | ['string', 'null'] | Project name |
path | | ['string', 'null'] | Project directory |
project_id | | ['string', 'null'] | Project UUID |
temporary | | boolean | If project is a temporary project |
Output
*******
.. raw:: html
Name | Mandatory | Type | Description |
location | ✔ | string | Base directory where the project should be created on remote server |
name | | ['string', 'null'] | Project name |
path | | string | Directory of the project on the server |
project_id | ✔ | string | Project UUID |
temporary | ✔ | boolean | If project is a temporary project |
Sample session
***************
.. literalinclude:: ../../examples/post_projects.txt