Creates a new project with the specified name and description.

Endpoint

POST http(s)://hostname/api/project/create

Request Parameters

Header field
TypeValue
X-Api-Key
string Required. A valid access token from a registered MT-EQuAl account. The access token must have been issued on behalf of the current user.

Request dataTypeValue
name string Required. The project name.

description string Optional. The project description.

Response

On success, the HTTP status code in the response header is 200 (OK) and the response is structured in JSON as follow:

{
  "header": {
    "date": "Date and time of the response generation process",
    "description": "Description of the invoked method or error message",
    "status": "status/error code"
  },
  "result": {
    "name": "The project name",
    "id": "The project id",
    "link": "The link to the project home page"
  }
}

On error, the header status and description fields contain the error code and message, respectively.

Example

curl -X POST "https://hostname/api/project/create?name=test project" -H "X-Api-Key: {user access token}"
{
  "header": {
    "date": "Monday, 2016-05-16 11:54:17 Europe/Paris",
    "description": "Creates a new project with the specified name and description.",
    "status": "200"
  },
  "result": {
    "name": "test project",
    "id": 1,
    "link": "https://mtequaldev.fbk.eu/admin?pid=1"
  }
}